Win32: patch Windows environment on startup
[git/mingw/4msysgit/kblees.git] / Documentation / config.txt
blobda824c92ec9758dc4e55236a3de6cf0133a98996
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 and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
18 Syntax
19 ~~~~~~
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored.  The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables.  A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins.  Section names are not case sensitive.  Only alphanumeric
28 characters, `-` and `.` are allowed in section names.  Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections.  To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively).  Section headers cannot span multiple
44 lines.  Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
48 There is also a deprecated `[section.subsection]` syntax. With this
49 syntax, the subsection name is converted to lower-case and is also
50 compared case sensitively. These subsection names follow the same
51 restrictions as section names.
53 All the other lines (and the remainder of the line after the section
54 header) are recognized as setting variables, in the form
55 'name = value'.  If there is no equal sign on the line, the entire line
56 is taken as 'name' and the variable is recognized as boolean "true".
57 The variable names are case-insensitive and only alphanumeric
58 characters and `-` are allowed.  There can be more than one value
59 for a given variable; we say then that variable is multivalued.
61 Leading and trailing whitespace in a variable value is discarded.
62 Internal whitespace within a variable value is retained verbatim.
64 The values following the equals sign in variable assign are all either
65 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
66 1/0, true/false or on/off.  Case is not significant in boolean values, when
67 converting value to the canonical form using '--bool' type specifier;
68 'git config' will ensure that the output is "true" or "false".
70 String values may be entirely or partially enclosed in double quotes.
71 You need to enclose variable values in double quotes if you want to
72 preserve leading or trailing whitespace, or if the variable value contains
73 comment characters (i.e. it contains '#' or ';').
74 Double quote `"` and backslash `\` characters in variable values must
75 be escaped: use `\"` for `"` and `\\` for `\`.
77 The following escape sequences (beside `\"` and `\\`) are recognized:
78 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
79 and `\b` for backspace (BS).  No other char escape sequence, nor octal
80 char sequences are valid.
82 Variable values ending in a `\` are continued on the next line in the
83 customary UNIX fashion.
85 Some variables may require a special value format.
87 Example
88 ~~~~~~~
90         # Core variables
91         [core]
92                 ; Don't trust file modes
93                 filemode = false
95         # Our diff algorithm
96         [diff]
97                 external = /usr/local/bin/diff-wrapper
98                 renames = true
100         [branch "devel"]
101                 remote = origin
102                 merge = refs/heads/devel
104         # Proxy settings
105         [core]
106                 gitProxy="ssh" for "kernel.org"
107                 gitProxy=default-proxy ; for the rest
109 Variables
110 ~~~~~~~~~
112 Note that this list is non-comprehensive and not necessarily complete.
113 For command-specific variables, you will find a more detailed description
114 in the appropriate manual page. You will find a description of non-core
115 porcelain configuration variables in the respective porcelain documentation.
117 advice.*::
118         When set to 'true', display the given optional help message.
119         When set to 'false', do not display. The configuration variables
120         are:
123         pushNonFastForward::
124                 Advice shown when linkgit:git-push[1] refuses
125                 non-fast-forward refs. Default: true.
126         statusHints::
127                 Directions on how to stage/unstage/add shown in the
128                 output of linkgit:git-status[1] and the template shown
129                 when writing commit messages. Default: true.
130         commitBeforeMerge::
131                 Advice shown when linkgit:git-merge[1] refuses to
132                 merge to avoid overwriting local changes.
133                 Default: true.
134         resolveConflict::
135                 Advices shown by various commands when conflicts
136                 prevent the operation from being performed.
137                 Default: true.
138         implicitIdentity::
139                 Advice on how to set your identity configuration when
140                 your information is guessed from the system username and
141                 domain name. Default: true.
143         detachedHead::
144                 Advice shown when you used linkgit::git-checkout[1] to
145                 move to the detach HEAD state, to instruct how to create
146                 a local branch after the fact.  Default: true.
149 core.fileMode::
150         If false, the executable bit differences between the index and
151         the working tree are ignored; useful on broken filesystems like FAT.
152         See linkgit:git-update-index[1].
154 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
155 will probe and set core.fileMode false if appropriate when the
156 repository is created.
158 core.hideDotFiles::
159         (Windows-only) If true (which is the default), mark newly-created
160         directories and files whose name starts with a dot as hidden.
161         If 'dotGitOnly', only the .git/ directory is hidden, but no other
162         files starting with a dot.
164 core.ignoreCygwinFSTricks::
165         This option is only used by Cygwin implementation of Git. If false,
166         the Cygwin stat() and lstat() functions are used. This may be useful
167         if your repository consists of a few separate directories joined in
168         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
169         whenever it is possible and falls back to Cygwin functions only to
170         handle symbol links. The native mode is more than twice faster than
171         normal Cygwin l/stat() functions. True by default, unless core.filemode
172         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
173         POSIX emulation is required to support core.filemode.
175 core.ignorecase::
176         If true, this option enables various workarounds to enable
177         git to work better on filesystems that are not case sensitive,
178         like FAT. For example, if a directory listing finds
179         "makefile" when git expects "Makefile", git will assume
180         it is really the same file, and continue to remember it as
181         "Makefile".
183 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
184 will probe and set core.ignorecase true if appropriate when the repository
185 is created.
187 core.trustctime::
188         If false, the ctime differences between the index and the
189         working tree are ignored; useful when the inode change time
190         is regularly modified by something outside Git (file system
191         crawlers and some backup systems).
192         See linkgit:git-update-index[1]. True by default.
194 core.quotepath::
195         The commands that output paths (e.g. 'ls-files',
196         'diff'), when not given the `-z` option, will quote
197         "unusual" characters in the pathname by enclosing the
198         pathname in a double-quote pair and with backslashes the
199         same way strings in C source code are quoted.  If this
200         variable is set to false, the bytes higher than 0x80 are
201         not quoted but output as verbatim.  Note that double
202         quote, backslash and control characters are always
203         quoted without `-z` regardless of the setting of this
204         variable.
206 core.eol::
207         Sets the line ending type to use in the working directory for
208         files that have the `text` property set.  Alternatives are
209         'lf', 'crlf' and 'native', which uses the platform's native
210         line ending.  The default value is `native`.  See
211         linkgit:gitattributes[5] for more information on end-of-line
212         conversion.
214 core.safecrlf::
215         If true, makes git check if converting `CRLF` is reversible when
216         end-of-line conversion is active.  Git will verify if a command
217         modifies a file in the work tree either directly or indirectly.
218         For example, committing a file followed by checking out the
219         same file should yield the original file in the work tree.  If
220         this is not the case for the current setting of
221         `core.autocrlf`, git will reject the file.  The variable can
222         be set to "warn", in which case git will only warn about an
223         irreversible conversion but continue the operation.
225 CRLF conversion bears a slight chance of corrupting data.
226 When it is enabled, git will convert CRLF to LF during commit and LF to
227 CRLF during checkout.  A file that contains a mixture of LF and
228 CRLF before the commit cannot be recreated by git.  For text
229 files this is the right thing to do: it corrects line endings
230 such that we have only LF line endings in the repository.
231 But for binary files that are accidentally classified as text the
232 conversion can corrupt data.
234 If you recognize such corruption early you can easily fix it by
235 setting the conversion type explicitly in .gitattributes.  Right
236 after committing you still have the original file in your work
237 tree and this file is not yet corrupted.  You can explicitly tell
238 git that this file is binary and git will handle the file
239 appropriately.
241 Unfortunately, the desired effect of cleaning up text files with
242 mixed line endings and the undesired effect of corrupting binary
243 files cannot be distinguished.  In both cases CRLFs are removed
244 in an irreversible way.  For text files this is the right thing
245 to do because CRLFs are line endings, while for binary files
246 converting CRLFs corrupts data.
248 Note, this safety check does not mean that a checkout will generate a
249 file identical to the original file for a different setting of
250 `core.eol` and `core.autocrlf`, but only for the current one.  For
251 example, a text file with `LF` would be accepted with `core.eol=lf`
252 and could later be checked out with `core.eol=crlf`, in which case the
253 resulting file would contain `CRLF`, although the original file
254 contained `LF`.  However, in both work trees the line endings would be
255 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
256 file with mixed line endings would be reported by the `core.safecrlf`
257 mechanism.
259 core.autocrlf::
260         Setting this variable to "true" is almost the same as setting
261         the `text` attribute to "auto" on all files except that text
262         files are not guaranteed to be normalized: files that contain
263         `CRLF` in the repository will not be touched.  Use this
264         setting if you want to have `CRLF` line endings in your
265         working directory even though the repository does not have
266         normalized line endings.  This variable can be set to 'input',
267         in which case no output conversion is performed.
269 core.symlinks::
270         If false, symbolic links are checked out as small plain files that
271         contain the link text. linkgit:git-update-index[1] and
272         linkgit:git-add[1] will not change the recorded type to regular
273         file. Useful on filesystems like FAT that do not support
274         symbolic links.
276 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
277 will probe and set core.symlinks false if appropriate when the repository
278 is created.
280 core.gitProxy::
281         A "proxy command" to execute (as 'command host port') instead
282         of establishing direct connection to the remote server when
283         using the git protocol for fetching. If the variable value is
284         in the "COMMAND for DOMAIN" format, the command is applied only
285         on hostnames ending with the specified domain string. This variable
286         may be set multiple times and is matched in the given order;
287         the first match wins.
289 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
290 (which always applies universally, without the special "for"
291 handling).
293 The special string `none` can be used as the proxy command to
294 specify that no proxy be used for a given domain pattern.
295 This is useful for excluding servers inside a firewall from
296 proxy use, while defaulting to a common proxy for external domains.
298 core.ignoreStat::
299         If true, commands which modify both the working tree and the index
300         will mark the updated paths with the "assume unchanged" bit in the
301         index. These marked files are then assumed to stay unchanged in the
302         working tree, until you mark them otherwise manually - Git will not
303         detect the file changes by lstat() calls. This is useful on systems
304         where those are very slow, such as Microsoft Windows.
305         See linkgit:git-update-index[1].
306         False by default.
308 core.preferSymlinkRefs::
309         Instead of the default "symref" format for HEAD
310         and other symbolic reference files, use symbolic links.
311         This is sometimes needed to work with old scripts that
312         expect HEAD to be a symbolic link.
314 core.bare::
315         If true this repository is assumed to be 'bare' and has no
316         working directory associated with it.  If this is the case a
317         number of commands that require a working directory will be
318         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
320 This setting is automatically guessed by linkgit:git-clone[1] or
321 linkgit:git-init[1] when the repository was created.  By default a
322 repository that ends in "/.git" is assumed to be not bare (bare =
323 false), while all other repositories are assumed to be bare (bare
324 = true).
326 core.worktree::
327         Set the path to the root of the working tree.
328         This can be overridden by the GIT_WORK_TREE environment
329         variable and the '--work-tree' command line option.
330         The value can be an absolute path or relative to the path to
331         the .git directory, which is either specified by --git-dir
332         or GIT_DIR, or automatically discovered.
333         If --git-dir or GIT_DIR is specified but none of
334         --work-tree, GIT_WORK_TREE and core.worktree is specified,
335         the current working directory is regarded as the top level
336         of your working tree.
338 Note that this variable is honored even when set in a configuration
339 file in a ".git" subdirectory of a directory and its value differs
340 from the latter directory (e.g. "/path/to/.git/config" has
341 core.worktree set to "/different/path"), which is most likely a
342 misconfiguration.  Running git commands in the "/path/to" directory will
343 still use "/different/path" as the root of the work tree and can cause
344 confusion unless you know what you are doing (e.g. you are creating a
345 read-only snapshot of the same index to a location different from the
346 repository's usual working tree).
348 core.logAllRefUpdates::
349         Enable the reflog. Updates to a ref <ref> is logged to the file
350         "$GIT_DIR/logs/<ref>", by appending the new and old
351         SHA1, the date/time and the reason of the update, but
352         only when the file exists.  If this configuration
353         variable is set to true, missing "$GIT_DIR/logs/<ref>"
354         file is automatically created for branch heads (i.e. under
355         refs/heads/), remote refs (i.e. under refs/remotes/),
356         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
358 This information can be used to determine what commit
359 was the tip of a branch "2 days ago".
361 This value is true by default in a repository that has
362 a working directory associated with it, and false by
363 default in a bare repository.
365 core.repositoryFormatVersion::
366         Internal variable identifying the repository format and layout
367         version.
369 core.sharedRepository::
370         When 'group' (or 'true'), the repository is made shareable between
371         several users in a group (making sure all the files and objects are
372         group-writable). When 'all' (or 'world' or 'everybody'), the
373         repository will be readable by all users, additionally to being
374         group-shareable. When 'umask' (or 'false'), git will use permissions
375         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
376         files in the repository will have this mode value. '0xxx' will override
377         user's umask value (whereas the other options will only override
378         requested parts of the user's umask value). Examples: '0660' will make
379         the repo read/write-able for the owner and group, but inaccessible to
380         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
381         repository that is group-readable but not group-writable.
382         See linkgit:git-init[1]. False by default.
384 core.warnAmbiguousRefs::
385         If true, git will warn you if the ref name you passed it is ambiguous
386         and might match multiple refs in the .git/refs/ tree. True by default.
388 core.compression::
389         An integer -1..9, indicating a default compression level.
390         -1 is the zlib default. 0 means no compression,
391         and 1..9 are various speed/size tradeoffs, 9 being slowest.
392         If set, this provides a default to other compression variables,
393         such as 'core.loosecompression' and 'pack.compression'.
395 core.loosecompression::
396         An integer -1..9, indicating the compression level for objects that
397         are not in a pack file. -1 is the zlib default. 0 means no
398         compression, and 1..9 are various speed/size tradeoffs, 9 being
399         slowest.  If not set,  defaults to core.compression.  If that is
400         not set,  defaults to 1 (best speed).
402 core.packedGitWindowSize::
403         Number of bytes of a pack file to map into memory in a
404         single mapping operation.  Larger window sizes may allow
405         your system to process a smaller number of large pack files
406         more quickly.  Smaller window sizes will negatively affect
407         performance due to increased calls to the operating system's
408         memory manager, but may improve performance when accessing
409         a large number of large pack files.
411 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
412 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
413 be reasonable for all users/operating systems.  You probably do
414 not need to adjust this value.
416 Common unit suffixes of 'k', 'm', or 'g' are supported.
418 core.packedGitLimit::
419         Maximum number of bytes to map simultaneously into memory
420         from pack files.  If Git needs to access more than this many
421         bytes at once to complete an operation it will unmap existing
422         regions to reclaim virtual address space within the process.
424 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
425 This should be reasonable for all users/operating systems, except on
426 the largest projects.  You probably do not need to adjust this value.
428 Common unit suffixes of 'k', 'm', or 'g' are supported.
430 core.deltaBaseCacheLimit::
431         Maximum number of bytes to reserve for caching base objects
432         that may be referenced by multiple deltified objects.  By storing the
433         entire decompressed base objects in a cache Git is able
434         to avoid unpacking and decompressing frequently used base
435         objects multiple times.
437 Default is 16 MiB on all platforms.  This should be reasonable
438 for all users/operating systems, except on the largest projects.
439 You probably do not need to adjust this value.
441 Common unit suffixes of 'k', 'm', or 'g' are supported.
443 core.bigFileThreshold::
444         Files larger than this size are stored deflated, without
445         attempting delta compression.  Storing large files without
446         delta compression avoids excessive memory usage, at the
447         slight expense of increased disk usage.
449 Default is 512 MiB on all platforms.  This should be reasonable
450 for most projects as source code and other text files can still
451 be delta compressed, but larger binary media files won't be.
453 Common unit suffixes of 'k', 'm', or 'g' are supported.
455 core.excludesfile::
456         In addition to '.gitignore' (per-directory) and
457         '.git/info/exclude', git looks into this file for patterns
458         of files which are not meant to be tracked.  "{tilde}/" is expanded
459         to the value of `$HOME` and "{tilde}user/" to the specified user's
460         home directory.  See linkgit:gitignore[5].
462 core.askpass::
463         Some commands (e.g. svn and http interfaces) that interactively
464         ask for a password can be told to use an external program given
465         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
466         environment variable. If not set, fall back to the value of the
467         'SSH_ASKPASS' environment variable or, failing that, a simple password
468         prompt. The external program shall be given a suitable prompt as
469         command line argument and write the password on its STDOUT.
471 core.attributesfile::
472         In addition to '.gitattributes' (per-directory) and
473         '.git/info/attributes', git looks into this file for attributes
474         (see linkgit:gitattributes[5]). Path expansions are made the same
475         way as for `core.excludesfile`.
477 core.editor::
478         Commands such as `commit` and `tag` that lets you edit
479         messages by launching an editor uses the value of this
480         variable when it is set, and the environment variable
481         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
483 sequence.editor::
484         Text editor used by `git rebase -i` for editing the rebase insn file.
485         The value is meant to be interpreted by the shell when it is used.
486         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
487         When not configured the default commit message editor is used instead.
489 core.pager::
490         The command that git will use to paginate output.  Can
491         be overridden with the `GIT_PAGER` environment
492         variable.  Note that git sets the `LESS` environment
493         variable to `FRSX` if it is unset when it runs the
494         pager.  One can change these settings by setting the
495         `LESS` variable to some other value.  Alternately,
496         these settings can be overridden on a project or
497         global basis by setting the `core.pager` option.
498         Setting `core.pager` has no affect on the `LESS`
499         environment variable behaviour above, so if you want
500         to override git's default settings this way, you need
501         to be explicit.  For example, to disable the S option
502         in a backward compatible manner, set `core.pager`
503         to `less -+$LESS -FRX`.  This will be passed to the
504         shell by git, which will translate the final command to
505         `LESS=FRSX less -+FRSX -FRX`.
507 core.whitespace::
508         A comma separated list of common whitespace problems to
509         notice.  'git diff' will use `color.diff.whitespace` to
510         highlight them, and 'git apply --whitespace=error' will
511         consider them as errors.  You can prefix `-` to disable
512         any of them (e.g. `-trailing-space`):
514 * `blank-at-eol` treats trailing whitespaces at the end of the line
515   as an error (enabled by default).
516 * `space-before-tab` treats a space character that appears immediately
517   before a tab character in the initial indent part of the line as an
518   error (enabled by default).
519 * `indent-with-non-tab` treats a line that is indented with 8 or more
520   space characters as an error (not enabled by default).
521 * `tab-in-indent` treats a tab character in the initial indent part of
522   the line as an error (not enabled by default).
523 * `blank-at-eof` treats blank lines added at the end of file as an error
524   (enabled by default).
525 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
526   `blank-at-eof`.
527 * `cr-at-eol` treats a carriage-return at the end of line as
528   part of the line terminator, i.e. with it, `trailing-space`
529   does not trigger if the character before such a carriage-return
530   is not a whitespace (not enabled by default).
531 * `tabwidth=<n>` tells how many character positions a tab occupies; this
532   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
533   errors. The default tab width is 8. Allowed values are 1 to 63.
535 core.fsyncobjectfiles::
536         This boolean will enable 'fsync()' when writing object files.
538 This is a total waste of time and effort on a filesystem that orders
539 data writes properly, but can be useful for filesystems that do not use
540 journalling (traditional UNIX filesystems) or that only journal metadata
541 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
543 core.preloadindex::
544         Enable parallel index preload for operations like 'git diff'
546 This can speed up operations like 'git diff' and 'git status' especially
547 on filesystems like NFS that have weak caching semantics and thus
548 relatively high IO latencies.  With this set to 'true', git will do the
549 index comparison to the filesystem data in parallel, allowing
550 overlapping IO's.
552 core.createObject::
553         You can set this to 'link', in which case a hardlink followed by
554         a delete of the source are used to make sure that object creation
555         will not overwrite existing objects.
557 On some file system/operating system combinations, this is unreliable.
558 Set this config setting to 'rename' there; However, This will remove the
559 check that makes sure that existing object files will not get overwritten.
561 core.notesRef::
562         When showing commit messages, also show notes which are stored in
563         the given ref.  The ref must be fully qualified.  If the given
564         ref does not exist, it is not an error but means that no
565         notes should be printed.
567 This setting defaults to "refs/notes/commits", and it can be overridden by
568 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
570 core.sparseCheckout::
571         Enable "sparse checkout" feature. See section "Sparse checkout" in
572         linkgit:git-read-tree[1] for more information.
574 core.abbrev::
575         Set the length object names are abbreviated to.  If unspecified,
576         many commands abbreviate to 7 hexdigits, which may not be enough
577         for abbreviated object names to stay unique for sufficiently long
578         time.
580 add.ignore-errors::
581 add.ignoreErrors::
582         Tells 'git add' to continue adding files when some files cannot be
583         added due to indexing errors. Equivalent to the '--ignore-errors'
584         option of linkgit:git-add[1].  Older versions of git accept only
585         `add.ignore-errors`, which does not follow the usual naming
586         convention for configuration variables.  Newer versions of git
587         honor `add.ignoreErrors` as well.
589 alias.*::
590         Command aliases for the linkgit:git[1] command wrapper - e.g.
591         after defining "alias.last = cat-file commit HEAD", the invocation
592         "git last" is equivalent to "git cat-file commit HEAD". To avoid
593         confusion and troubles with script usage, aliases that
594         hide existing git commands are ignored. Arguments are split by
595         spaces, the usual shell quoting and escaping is supported.
596         quote pair and a backslash can be used to quote them.
598 If the alias expansion is prefixed with an exclamation point,
599 it will be treated as a shell command.  For example, defining
600 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
601 "git new" is equivalent to running the shell command
602 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
603 executed from the top-level directory of a repository, which may
604 not necessarily be the current directory.
605 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
606 from the original current directory. See linkgit:git-rev-parse[1].
608 am.keepcr::
609         If true, git-am will call git-mailsplit for patches in mbox format
610         with parameter '--keep-cr'. In this case git-mailsplit will
611         not remove `\r` from lines ending with `\r\n`. Can be overridden
612         by giving '--no-keep-cr' from the command line.
613         See linkgit:git-am[1], linkgit:git-mailsplit[1].
615 apply.ignorewhitespace::
616         When set to 'change', tells 'git apply' to ignore changes in
617         whitespace, in the same way as the '--ignore-space-change'
618         option.
619         When set to one of: no, none, never, false tells 'git apply' to
620         respect all whitespace differences.
621         See linkgit:git-apply[1].
623 apply.whitespace::
624         Tells 'git apply' how to handle whitespaces, in the same way
625         as the '--whitespace' option. See linkgit:git-apply[1].
627 branch.autosetupmerge::
628         Tells 'git branch' and 'git checkout' to set up new branches
629         so that linkgit:git-pull[1] will appropriately merge from the
630         starting point branch. Note that even if this option is not set,
631         this behavior can be chosen per-branch using the `--track`
632         and `--no-track` options. The valid settings are: `false` -- no
633         automatic setup is done; `true` -- automatic setup is done when the
634         starting point is a remote-tracking branch; `always` --
635         automatic setup is done when the starting point is either a
636         local branch or remote-tracking
637         branch. This option defaults to true.
639 branch.autosetuprebase::
640         When a new branch is created with 'git branch' or 'git checkout'
641         that tracks another branch, this variable tells git to set
642         up pull to rebase instead of merge (see "branch.<name>.rebase").
643         When `never`, rebase is never automatically set to true.
644         When `local`, rebase is set to true for tracked branches of
645         other local branches.
646         When `remote`, rebase is set to true for tracked branches of
647         remote-tracking branches.
648         When `always`, rebase will be set to true for all tracking
649         branches.
650         See "branch.autosetupmerge" for details on how to set up a
651         branch to track another branch.
652         This option defaults to never.
654 branch.<name>.remote::
655         When in branch <name>, it tells 'git fetch' and 'git push' which
656         remote to fetch from/push to.  It defaults to `origin` if no remote is
657         configured. `origin` is also used if you are not on any branch.
659 branch.<name>.merge::
660         Defines, together with branch.<name>.remote, the upstream branch
661         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
662         branch to merge and can also affect 'git push' (see push.default).
663         When in branch <name>, it tells 'git fetch' the default
664         refspec to be marked for merging in FETCH_HEAD. The value is
665         handled like the remote part of a refspec, and must match a
666         ref which is fetched from the remote given by
667         "branch.<name>.remote".
668         The merge information is used by 'git pull' (which at first calls
669         'git fetch') to lookup the default branch for merging. Without
670         this option, 'git pull' defaults to merge the first refspec fetched.
671         Specify multiple values to get an octopus merge.
672         If you wish to setup 'git pull' so that it merges into <name> from
673         another branch in the local repository, you can point
674         branch.<name>.merge to the desired branch, and use the special setting
675         `.` (a period) for branch.<name>.remote.
677 branch.<name>.mergeoptions::
678         Sets default options for merging into branch <name>. The syntax and
679         supported options are the same as those of linkgit:git-merge[1], but
680         option values containing whitespace characters are currently not
681         supported.
683 branch.<name>.rebase::
684         When true, rebase the branch <name> on top of the fetched branch,
685         instead of merging the default branch from the default remote when
686         "git pull" is run.
687         When the value is `interactive`, the rebase is run in interactive mode.
688         *NOTE*: this is a possibly dangerous operation; do *not* use
689         it unless you understand the implications (see linkgit:git-rebase[1]
690         for details).
692 browser.<tool>.cmd::
693         Specify the command to invoke the specified browser. The
694         specified command is evaluated in shell with the URLs passed
695         as arguments. (See linkgit:git-web{litdd}browse[1].)
697 browser.<tool>.path::
698         Override the path for the given tool that may be used to
699         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
700         working repository in gitweb (see linkgit:git-instaweb[1]).
702 clean.requireForce::
703         A boolean to make git-clean do nothing unless given -f
704         or -n.   Defaults to true.
706 color.branch::
707         A boolean to enable/disable color in the output of
708         linkgit:git-branch[1]. May be set to `always`,
709         `false` (or `never`) or `auto` (or `true`), in which case colors are used
710         only when the output is to a terminal. Defaults to false.
712 color.branch.<slot>::
713         Use customized color for branch coloration. `<slot>` is one of
714         `current` (the current branch), `local` (a local branch),
715         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
716         refs).
718 The value for these configuration variables is a list of colors (at most
719 two) and attributes (at most one), separated by spaces.  The colors
720 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
721 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
722 `blink` and `reverse`.  The first color given is the foreground; the
723 second is the background.  The position of the attribute, if any,
724 doesn't matter.
726 color.diff::
727         Whether to use ANSI escape sequences to add color to patches.
728         If this is set to `always`, linkgit:git-diff[1],
729         linkgit:git-log[1], and linkgit:git-show[1] will use color
730         for all patches.  If it is set to `true` or `auto`, those
731         commands will only use color when output is to the terminal.
732         Defaults to false.
734 This does not affect linkgit:git-format-patch[1] nor the
735 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
736 command line with the `--color[=<when>]` option.
738 color.diff.<slot>::
739         Use customized color for diff colorization.  `<slot>` specifies
740         which part of the patch to use the specified color, and is one
741         of `plain` (context text), `meta` (metainformation), `frag`
742         (hunk header), 'func' (function in hunk header), `old` (removed lines),
743         `new` (added lines), `commit` (commit headers), or `whitespace`
744         (highlighting whitespace errors). The values of these variables may be
745         specified as in color.branch.<slot>.
747 color.decorate.<slot>::
748         Use customized color for 'git log --decorate' output.  `<slot>` is one
749         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
750         branches, remote-tracking branches, tags, stash and HEAD, respectively.
752 color.grep::
753         When set to `always`, always highlight matches.  When `false` (or
754         `never`), never.  When set to `true` or `auto`, use color only
755         when the output is written to the terminal.  Defaults to `false`.
757 color.grep.<slot>::
758         Use customized color for grep colorization.  `<slot>` specifies which
759         part of the line to use the specified color, and is one of
762 `context`;;
763         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
764 `filename`;;
765         filename prefix (when not using `-h`)
766 `function`;;
767         function name lines (when using `-p`)
768 `linenumber`;;
769         line number prefix (when using `-n`)
770 `match`;;
771         matching text
772 `selected`;;
773         non-matching text in selected lines
774 `separator`;;
775         separators between fields on a line (`:`, `-`, and `=`)
776         and between hunks (`--`)
779 The values of these variables may be specified as in color.branch.<slot>.
781 color.interactive::
782         When set to `always`, always use colors for interactive prompts
783         and displays (such as those used by "git-add --interactive").
784         When false (or `never`), never.  When set to `true` or `auto`, use
785         colors only when the output is to the terminal. Defaults to false.
787 color.interactive.<slot>::
788         Use customized color for 'git add --interactive'
789         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
790         four distinct types of normal output from interactive
791         commands.  The values of these variables may be specified as
792         in color.branch.<slot>.
794 color.pager::
795         A boolean to enable/disable colored output when the pager is in
796         use (default is true).
798 color.showbranch::
799         A boolean to enable/disable color in the output of
800         linkgit:git-show-branch[1]. May be set to `always`,
801         `false` (or `never`) or `auto` (or `true`), in which case colors are used
802         only when the output is to a terminal. Defaults to false.
804 color.status::
805         A boolean to enable/disable color in the output of
806         linkgit:git-status[1]. May be set to `always`,
807         `false` (or `never`) or `auto` (or `true`), in which case colors are used
808         only when the output is to a terminal. Defaults to false.
810 color.status.<slot>::
811         Use customized color for status colorization. `<slot>` is
812         one of `header` (the header text of the status message),
813         `added` or `updated` (files which are added but not committed),
814         `changed` (files which are changed but not added in the index),
815         `untracked` (files which are not tracked by git),
816         `branch` (the current branch), or
817         `nobranch` (the color the 'no branch' warning is shown in, defaulting
818         to red). The values of these variables may be specified as in
819         color.branch.<slot>.
821 color.ui::
822         This variable determines the default value for variables such
823         as `color.diff` and `color.grep` that control the use of color
824         per command family. Its scope will expand as more commands learn
825         configuration to set a default for the `--color` option.  Set it
826         to `always` if you want all output not intended for machine
827         consumption to use color, to `true` or `auto` if you want such
828         output to use color when written to the terminal, or to `false` or
829         `never` if you prefer git commands not to use color unless enabled
830         explicitly with some other configuration or the `--color` option.
832 commit.status::
833         A boolean to enable/disable inclusion of status information in the
834         commit message template when using an editor to prepare the commit
835         message.  Defaults to true.
837 commit.template::
838         Specify a file to use as the template for new commit messages.
839         "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
840         specified user's home directory.
842 include::diff-config.txt[]
844 difftool.<tool>.path::
845         Override the path for the given tool.  This is useful in case
846         your tool is not in the PATH.
848 difftool.<tool>.cmd::
849         Specify the command to invoke the specified diff tool.
850         The specified command is evaluated in shell with the following
851         variables available:  'LOCAL' is set to the name of the temporary
852         file containing the contents of the diff pre-image and 'REMOTE'
853         is set to the name of the temporary file containing the contents
854         of the diff post-image.
856 difftool.prompt::
857         Prompt before each invocation of the diff tool.
859 diff.wordRegex::
860         A POSIX Extended Regular Expression used to determine what is a "word"
861         when performing word-by-word difference calculations.  Character
862         sequences that match the regular expression are "words", all other
863         characters are *ignorable* whitespace.
865 fetch.recurseSubmodules::
866         This option can be either set to a boolean value or to 'on-demand'.
867         Setting it to a boolean changes the behavior of fetch and pull to
868         unconditionally recurse into submodules when set to true or to not
869         recurse at all when set to false. When set to 'on-demand' (the default
870         value), fetch and pull will only recurse into a populated submodule
871         when its superproject retrieves a commit that updates the submodule's
872         reference.
874 fetch.fsckObjects::
875         If it is set to true, git-fetch-pack will check all fetched
876         objects. It will abort in the case of a malformed object or a
877         broken link. The result of an abort are only dangling objects.
878         Defaults to false. If not set, the value of `transfer.fsckObjects`
879         is used instead.
881 fetch.unpackLimit::
882         If the number of objects fetched over the git native
883         transfer is below this
884         limit, then the objects will be unpacked into loose object
885         files. However if the number of received objects equals or
886         exceeds this limit then the received pack will be stored as
887         a pack, after adding any missing delta bases.  Storing the
888         pack from a push can make the push operation complete faster,
889         especially on slow filesystems.  If not set, the value of
890         `transfer.unpackLimit` is used instead.
892 format.attach::
893         Enable multipart/mixed attachments as the default for
894         'format-patch'.  The value can also be a double quoted string
895         which will enable attachments as the default and set the
896         value as the boundary.  See the --attach option in
897         linkgit:git-format-patch[1].
899 format.numbered::
900         A boolean which can enable or disable sequence numbers in patch
901         subjects.  It defaults to "auto" which enables it only if there
902         is more than one patch.  It can be enabled or disabled for all
903         messages by setting it to "true" or "false".  See --numbered
904         option in linkgit:git-format-patch[1].
906 format.headers::
907         Additional email headers to include in a patch to be submitted
908         by mail.  See linkgit:git-format-patch[1].
910 format.to::
911 format.cc::
912         Additional recipients to include in a patch to be submitted
913         by mail.  See the --to and --cc options in
914         linkgit:git-format-patch[1].
916 format.subjectprefix::
917         The default for format-patch is to output files with the '[PATCH]'
918         subject prefix. Use this variable to change that prefix.
920 format.signature::
921         The default for format-patch is to output a signature containing
922         the git version number. Use this variable to change that default.
923         Set this variable to the empty string ("") to suppress
924         signature generation.
926 format.suffix::
927         The default for format-patch is to output files with the suffix
928         `.patch`. Use this variable to change that suffix (make sure to
929         include the dot if you want it).
931 format.pretty::
932         The default pretty format for log/show/whatchanged command,
933         See linkgit:git-log[1], linkgit:git-show[1],
934         linkgit:git-whatchanged[1].
936 format.thread::
937         The default threading style for 'git format-patch'.  Can be
938         a boolean value, or `shallow` or `deep`.  `shallow` threading
939         makes every mail a reply to the head of the series,
940         where the head is chosen from the cover letter, the
941         `\--in-reply-to`, and the first patch mail, in this order.
942         `deep` threading makes every mail a reply to the previous one.
943         A true boolean value is the same as `shallow`, and a false
944         value disables threading.
946 format.signoff::
947     A boolean value which lets you enable the `-s/--signoff` option of
948     format-patch by default. *Note:* Adding the Signed-off-by: line to a
949     patch should be a conscious act and means that you certify you have
950     the rights to submit this work under the same open source license.
951     Please see the 'SubmittingPatches' document for further discussion.
953 filter.<driver>.clean::
954         The command which is used to convert the content of a worktree
955         file to a blob upon checkin.  See linkgit:gitattributes[5] for
956         details.
958 filter.<driver>.smudge::
959         The command which is used to convert the content of a blob
960         object to a worktree file upon checkout.  See
961         linkgit:gitattributes[5] for details.
963 gc.aggressiveWindow::
964         The window size parameter used in the delta compression
965         algorithm used by 'git gc --aggressive'.  This defaults
966         to 250.
968 gc.auto::
969         When there are approximately more than this many loose
970         objects in the repository, `git gc --auto` will pack them.
971         Some Porcelain commands use this command to perform a
972         light-weight garbage collection from time to time.  The
973         default value is 6700.  Setting this to 0 disables it.
975 gc.autopacklimit::
976         When there are more than this many packs that are not
977         marked with `*.keep` file in the repository, `git gc
978         --auto` consolidates them into one larger pack.  The
979         default value is 50.  Setting this to 0 disables it.
981 gc.packrefs::
982         Running `git pack-refs` in a repository renders it
983         unclonable by Git versions prior to 1.5.1.2 over dumb
984         transports such as HTTP.  This variable determines whether
985         'git gc' runs `git pack-refs`. This can be set to `notbare`
986         to enable it within all non-bare repos or it can be set to a
987         boolean value.  The default is `true`.
989 gc.pruneexpire::
990         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
991         Override the grace period with this config variable.  The value
992         "now" may be used to disable this  grace period and always prune
993         unreachable objects immediately.
995 gc.reflogexpire::
996 gc.<pattern>.reflogexpire::
997         'git reflog expire' removes reflog entries older than
998         this time; defaults to 90 days.  With "<pattern>" (e.g.
999         "refs/stash") in the middle the setting applies only to
1000         the refs that match the <pattern>.
1002 gc.reflogexpireunreachable::
1003 gc.<ref>.reflogexpireunreachable::
1004         'git reflog expire' removes reflog entries older than
1005         this time and are not reachable from the current tip;
1006         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1007         in the middle, the setting applies only to the refs that
1008         match the <pattern>.
1010 gc.rerereresolved::
1011         Records of conflicted merge you resolved earlier are
1012         kept for this many days when 'git rerere gc' is run.
1013         The default is 60 days.  See linkgit:git-rerere[1].
1015 gc.rerereunresolved::
1016         Records of conflicted merge you have not resolved are
1017         kept for this many days when 'git rerere gc' is run.
1018         The default is 15 days.  See linkgit:git-rerere[1].
1020 gitcvs.commitmsgannotation::
1021         Append this string to each commit message. Set to empty string
1022         to disable this feature. Defaults to "via git-CVS emulator".
1024 gitcvs.enabled::
1025         Whether the CVS server interface is enabled for this repository.
1026         See linkgit:git-cvsserver[1].
1028 gitcvs.logfile::
1029         Path to a log file where the CVS server interface well... logs
1030         various stuff. See linkgit:git-cvsserver[1].
1032 gitcvs.usecrlfattr::
1033         If true, the server will look up the end-of-line conversion
1034         attributes for files to determine the '-k' modes to use. If
1035         the attributes force git to treat a file as text,
1036         the '-k' mode will be left blank so CVS clients will
1037         treat it as text. If they suppress text conversion, the file
1038         will be set with '-kb' mode, which suppresses any newline munging
1039         the client might otherwise do. If the attributes do not allow
1040         the file type to be determined, then 'gitcvs.allbinary' is
1041         used. See linkgit:gitattributes[5].
1043 gitcvs.allbinary::
1044         This is used if 'gitcvs.usecrlfattr' does not resolve
1045         the correct '-kb' mode to use. If true, all
1046         unresolved files are sent to the client in
1047         mode '-kb'. This causes the client to treat them
1048         as binary files, which suppresses any newline munging it
1049         otherwise might do. Alternatively, if it is set to "guess",
1050         then the contents of the file are examined to decide if
1051         it is binary, similar to 'core.autocrlf'.
1053 gitcvs.dbname::
1054         Database used by git-cvsserver to cache revision information
1055         derived from the git repository. The exact meaning depends on the
1056         used database driver, for SQLite (which is the default driver) this
1057         is a filename. Supports variable substitution (see
1058         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1059         Default: '%Ggitcvs.%m.sqlite'
1061 gitcvs.dbdriver::
1062         Used Perl DBI driver. You can specify any available driver
1063         for this here, but it might not work. git-cvsserver is tested
1064         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1065         reported *not* to work with 'DBD::mysql'. Experimental feature.
1066         May not contain double colons (`:`). Default: 'SQLite'.
1067         See linkgit:git-cvsserver[1].
1069 gitcvs.dbuser, gitcvs.dbpass::
1070         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1071         since SQLite has no concept of database users and/or passwords.
1072         'gitcvs.dbuser' supports variable substitution (see
1073         linkgit:git-cvsserver[1] for details).
1075 gitcvs.dbTableNamePrefix::
1076         Database table name prefix.  Prepended to the names of any
1077         database tables used, allowing a single database to be used
1078         for several repositories.  Supports variable substitution (see
1079         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1080         characters will be replaced with underscores.
1082 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1083 'gitcvs.allbinary' can also be specified as
1084 'gitcvs.<access_method>.<varname>' (where 'access_method'
1085 is one of "ext" and "pserver") to make them apply only for the given
1086 access method.
1088 gitweb.category::
1089 gitweb.description::
1090 gitweb.owner::
1091 gitweb.url::
1092         See linkgit:gitweb[1] for description.
1094 gitweb.avatar::
1095 gitweb.blame::
1096 gitweb.grep::
1097 gitweb.highlight::
1098 gitweb.patches::
1099 gitweb.pickaxe::
1100 gitweb.remote_heads::
1101 gitweb.showsizes::
1102 gitweb.snapshot::
1103         See linkgit:gitweb.conf[5] for description.
1105 grep.lineNumber::
1106         If set to true, enable '-n' option by default.
1108 grep.extendedRegexp::
1109         If set to true, enable '--extended-regexp' option by default.
1111 gui.commitmsgwidth::
1112         Defines how wide the commit message window is in the
1113         linkgit:git-gui[1]. "75" is the default.
1115 gui.diffcontext::
1116         Specifies how many context lines should be used in calls to diff
1117         made by the linkgit:git-gui[1]. The default is "5".
1119 gui.encoding::
1120         Specifies the default encoding to use for displaying of
1121         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1122         It can be overridden by setting the 'encoding' attribute
1123         for relevant files (see linkgit:gitattributes[5]).
1124         If this option is not set, the tools default to the
1125         locale encoding.
1127 gui.matchtrackingbranch::
1128         Determines if new branches created with linkgit:git-gui[1] should
1129         default to tracking remote branches with matching names or
1130         not. Default: "false".
1132 gui.newbranchtemplate::
1133         Is used as suggested name when creating new branches using the
1134         linkgit:git-gui[1].
1136 gui.pruneduringfetch::
1137         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1138         performing a fetch. The default value is "false".
1140 gui.trustmtime::
1141         Determines if linkgit:git-gui[1] should trust the file modification
1142         timestamp or not. By default the timestamps are not trusted.
1144 gui.spellingdictionary::
1145         Specifies the dictionary used for spell checking commit messages in
1146         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1147         off.
1149 gui.fastcopyblame::
1150         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1151         location detection. It makes blame significantly faster on huge
1152         repositories at the expense of less thorough copy detection.
1154 gui.copyblamethreshold::
1155         Specifies the threshold to use in 'git gui blame' original location
1156         detection, measured in alphanumeric characters. See the
1157         linkgit:git-blame[1] manual for more information on copy detection.
1159 gui.blamehistoryctx::
1160         Specifies the radius of history context in days to show in
1161         linkgit:gitk[1] for the selected commit, when the `Show History
1162         Context` menu item is invoked from 'git gui blame'. If this
1163         variable is set to zero, the whole history is shown.
1165 guitool.<name>.cmd::
1166         Specifies the shell command line to execute when the corresponding item
1167         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1168         mandatory for every tool. The command is executed from the root of
1169         the working directory, and in the environment it receives the name of
1170         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1171         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1172         the head is detached, 'CUR_BRANCH' is empty).
1174 guitool.<name>.needsfile::
1175         Run the tool only if a diff is selected in the GUI. It guarantees
1176         that 'FILENAME' is not empty.
1178 guitool.<name>.noconsole::
1179         Run the command silently, without creating a window to display its
1180         output.
1182 guitool.<name>.norescan::
1183         Don't rescan the working directory for changes after the tool
1184         finishes execution.
1186 guitool.<name>.confirm::
1187         Show a confirmation dialog before actually running the tool.
1189 guitool.<name>.argprompt::
1190         Request a string argument from the user, and pass it to the tool
1191         through the 'ARGS' environment variable. Since requesting an
1192         argument implies confirmation, the 'confirm' option has no effect
1193         if this is enabled. If the option is set to 'true', 'yes', or '1',
1194         the dialog uses a built-in generic prompt; otherwise the exact
1195         value of the variable is used.
1197 guitool.<name>.revprompt::
1198         Request a single valid revision from the user, and set the
1199         'REVISION' environment variable. In other aspects this option
1200         is similar to 'argprompt', and can be used together with it.
1202 guitool.<name>.revunmerged::
1203         Show only unmerged branches in the 'revprompt' subdialog.
1204         This is useful for tools similar to merge or rebase, but not
1205         for things like checkout or reset.
1207 guitool.<name>.title::
1208         Specifies the title to use for the prompt dialog. The default
1209         is the tool name.
1211 guitool.<name>.prompt::
1212         Specifies the general prompt string to display at the top of
1213         the dialog, before subsections for 'argprompt' and 'revprompt'.
1214         The default value includes the actual command.
1216 help.browser::
1217         Specify the browser that will be used to display help in the
1218         'web' format. See linkgit:git-help[1].
1220 help.format::
1221         Override the default help format used by linkgit:git-help[1].
1222         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1223         the default. 'web' and 'html' are the same.
1225 help.autocorrect::
1226         Automatically correct and execute mistyped commands after
1227         waiting for the given number of deciseconds (0.1 sec). If more
1228         than one command can be deduced from the entered text, nothing
1229         will be executed.  If the value of this option is negative,
1230         the corrected command will be executed immediately. If the
1231         value is 0 - the command will be just shown but not executed.
1232         This is the default.
1234 http.proxy::
1235         Override the HTTP proxy, normally configured using the 'http_proxy'
1236         environment variable (see linkgit:curl[1]).  This can be overridden
1237         on a per-remote basis; see remote.<name>.proxy
1239 http.cookiefile::
1240         File containing previously stored cookie lines which should be used
1241         in the git http session, if they match the server. The file format
1242         of the file to read cookies from should be plain HTTP headers or
1243         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1244         NOTE that the file specified with http.cookiefile is only used as
1245         input. No cookies will be stored in the file.
1247 http.sslVerify::
1248         Whether to verify the SSL certificate when fetching or pushing
1249         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1250         variable.
1252 http.sslCert::
1253         File containing the SSL certificate when fetching or pushing
1254         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1255         variable.
1257 http.sslKey::
1258         File containing the SSL private key when fetching or pushing
1259         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1260         variable.
1262 http.sslCertPasswordProtected::
1263         Enable git's password prompt for the SSL certificate.  Otherwise
1264         OpenSSL will prompt the user, possibly many times, if the
1265         certificate or private key is encrypted.  Can be overridden by the
1266         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1268 http.sslCAInfo::
1269         File containing the certificates to verify the peer with when
1270         fetching or pushing over HTTPS. Can be overridden by the
1271         'GIT_SSL_CAINFO' environment variable.
1273 http.sslCAPath::
1274         Path containing files with the CA certificates to verify the peer
1275         with when fetching or pushing over HTTPS. Can be overridden
1276         by the 'GIT_SSL_CAPATH' environment variable.
1278 http.maxRequests::
1279         How many HTTP requests to launch in parallel. Can be overridden
1280         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1282 http.minSessions::
1283         The number of curl sessions (counted across slots) to be kept across
1284         requests. They will not be ended with curl_easy_cleanup() until
1285         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1286         value will be capped at 1. Defaults to 1.
1288 http.postBuffer::
1289         Maximum size in bytes of the buffer used by smart HTTP
1290         transports when POSTing data to the remote system.
1291         For requests larger than this buffer size, HTTP/1.1 and
1292         Transfer-Encoding: chunked is used to avoid creating a
1293         massive pack file locally.  Default is 1 MiB, which is
1294         sufficient for most requests.
1296 http.lowSpeedLimit, http.lowSpeedTime::
1297         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1298         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1299         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1300         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1302 http.noEPSV::
1303         A boolean which disables using of EPSV ftp command by curl.
1304         This can helpful with some "poor" ftp servers which don't
1305         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1306         environment variable. Default is false (curl will use EPSV).
1308 http.useragent::
1309         The HTTP USER_AGENT string presented to an HTTP server.  The default
1310         value represents the version of the client git such as git/1.7.1.
1311         This option allows you to override this value to a more common value
1312         such as Mozilla/4.0.  This may be necessary, for instance, if
1313         connecting through a firewall that restricts HTTP connections to a set
1314         of common USER_AGENT strings (but not including those like git/1.7.1).
1315         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1317 i18n.commitEncoding::
1318         Character encoding the commit messages are stored in; git itself
1319         does not care per se, but this information is necessary e.g. when
1320         importing commits from emails or in the gitk graphical history
1321         browser (and possibly at other places in the future or in other
1322         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1324 i18n.logOutputEncoding::
1325         Character encoding the commit messages are converted to when
1326         running 'git log' and friends.
1328 imap::
1329         The configuration variables in the 'imap' section are described
1330         in linkgit:git-imap-send[1].
1332 init.templatedir::
1333         Specify the directory from which templates will be copied.
1334         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1336 instaweb.browser::
1337         Specify the program that will be used to browse your working
1338         repository in gitweb. See linkgit:git-instaweb[1].
1340 instaweb.httpd::
1341         The HTTP daemon command-line to start gitweb on your working
1342         repository. See linkgit:git-instaweb[1].
1344 instaweb.local::
1345         If true the web server started by linkgit:git-instaweb[1] will
1346         be bound to the local IP (127.0.0.1).
1348 instaweb.modulepath::
1349         The default module path for linkgit:git-instaweb[1] to use
1350         instead of /usr/lib/apache2/modules.  Only used if httpd
1351         is Apache.
1353 instaweb.port::
1354         The port number to bind the gitweb httpd to. See
1355         linkgit:git-instaweb[1].
1357 interactive.singlekey::
1358         In interactive commands, allow the user to provide one-letter
1359         input with a single key (i.e., without hitting enter).
1360         Currently this is used by the `\--patch` mode of
1361         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1362         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1363         setting is silently ignored if portable keystroke input
1364         is not available.
1366 log.abbrevCommit::
1367         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1368         linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1369         override this option with `\--no-abbrev-commit`.
1371 log.date::
1372         Set the default date-time mode for the 'log' command.
1373         Setting a value for log.date is similar to using 'git log''s
1374         `\--date` option.  Possible values are `relative`, `local`,
1375         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1376         for details.
1378 log.decorate::
1379         Print out the ref names of any commits that are shown by the log
1380         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1381         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1382         specified, the full ref name (including prefix) will be printed.
1383         This is the same as the log commands '--decorate' option.
1385 log.showroot::
1386         If true, the initial commit will be shown as a big creation event.
1387         This is equivalent to a diff against an empty tree.
1388         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1389         normally hide the root commit will now show it. True by default.
1391 mailmap.file::
1392         The location of an augmenting mailmap file. The default
1393         mailmap, located in the root of the repository, is loaded
1394         first, then the mailmap file pointed to by this variable.
1395         The location of the mailmap file may be in a repository
1396         subdirectory, or somewhere outside of the repository itself.
1397         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1399 man.viewer::
1400         Specify the programs that may be used to display help in the
1401         'man' format. See linkgit:git-help[1].
1403 man.<tool>.cmd::
1404         Specify the command to invoke the specified man viewer. The
1405         specified command is evaluated in shell with the man page
1406         passed as argument. (See linkgit:git-help[1].)
1408 man.<tool>.path::
1409         Override the path for the given tool that may be used to
1410         display help in the 'man' format. See linkgit:git-help[1].
1412 include::merge-config.txt[]
1414 mergetool.<tool>.path::
1415         Override the path for the given tool.  This is useful in case
1416         your tool is not in the PATH.
1418 mergetool.<tool>.cmd::
1419         Specify the command to invoke the specified merge tool.  The
1420         specified command is evaluated in shell with the following
1421         variables available: 'BASE' is the name of a temporary file
1422         containing the common base of the files to be merged, if available;
1423         'LOCAL' is the name of a temporary file containing the contents of
1424         the file on the current branch; 'REMOTE' is the name of a temporary
1425         file containing the contents of the file from the branch being
1426         merged; 'MERGED' contains the name of the file to which the merge
1427         tool should write the results of a successful merge.
1429 mergetool.<tool>.trustExitCode::
1430         For a custom merge command, specify whether the exit code of
1431         the merge command can be used to determine whether the merge was
1432         successful.  If this is not set to true then the merge target file
1433         timestamp is checked and the merge assumed to have been successful
1434         if the file has been updated, otherwise the user is prompted to
1435         indicate the success of the merge.
1437 mergetool.keepBackup::
1438         After performing a merge, the original file with conflict markers
1439         can be saved as a file with a `.orig` extension.  If this variable
1440         is set to `false` then this file is not preserved.  Defaults to
1441         `true` (i.e. keep the backup files).
1443 mergetool.keepTemporaries::
1444         When invoking a custom merge tool, git uses a set of temporary
1445         files to pass to the tool. If the tool returns an error and this
1446         variable is set to `true`, then these temporary files will be
1447         preserved, otherwise they will be removed after the tool has
1448         exited. Defaults to `false`.
1450 mergetool.prompt::
1451         Prompt before each invocation of the merge resolution program.
1453 notes.displayRef::
1454         The (fully qualified) refname from which to show notes when
1455         showing commit messages.  The value of this variable can be set
1456         to a glob, in which case notes from all matching refs will be
1457         shown.  You may also specify this configuration variable
1458         several times.  A warning will be issued for refs that do not
1459         exist, but a glob that does not match any refs is silently
1460         ignored.
1462 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1463 environment variable, which must be a colon separated list of refs or
1464 globs.
1466 The effective value of "core.notesRef" (possibly overridden by
1467 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1468 displayed.
1470 notes.rewrite.<command>::
1471         When rewriting commits with <command> (currently `amend` or
1472         `rebase`) and this variable is set to `true`, git
1473         automatically copies your notes from the original to the
1474         rewritten commit.  Defaults to `true`, but see
1475         "notes.rewriteRef" below.
1477 notes.rewriteMode::
1478         When copying notes during a rewrite (see the
1479         "notes.rewrite.<command>" option), determines what to do if
1480         the target commit already has a note.  Must be one of
1481         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1482         `concatenate`.
1484 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1485 environment variable.
1487 notes.rewriteRef::
1488         When copying notes during a rewrite, specifies the (fully
1489         qualified) ref whose notes should be copied.  The ref may be a
1490         glob, in which case notes in all matching refs will be copied.
1491         You may also specify this configuration several times.
1493 Does not have a default value; you must configure this variable to
1494 enable note rewriting.  Set it to `refs/notes/commits` to enable
1495 rewriting for the default commit notes.
1497 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1498 environment variable, which must be a colon separated list of refs or
1499 globs.
1501 pack.window::
1502         The size of the window used by linkgit:git-pack-objects[1] when no
1503         window size is given on the command line. Defaults to 10.
1505 pack.depth::
1506         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1507         maximum depth is given on the command line. Defaults to 50.
1509 pack.windowMemory::
1510         The window memory size limit used by linkgit:git-pack-objects[1]
1511         when no limit is given on the command line.  The value can be
1512         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1513         limit.
1515 pack.compression::
1516         An integer -1..9, indicating the compression level for objects
1517         in a pack file. -1 is the zlib default. 0 means no
1518         compression, and 1..9 are various speed/size tradeoffs, 9 being
1519         slowest.  If not set,  defaults to core.compression.  If that is
1520         not set,  defaults to -1, the zlib default, which is "a default
1521         compromise between speed and compression (currently equivalent
1522         to level 6)."
1524 Note that changing the compression level will not automatically recompress
1525 all existing objects. You can force recompression by passing the -F option
1526 to linkgit:git-repack[1].
1528 pack.deltaCacheSize::
1529         The maximum memory in bytes used for caching deltas in
1530         linkgit:git-pack-objects[1] before writing them out to a pack.
1531         This cache is used to speed up the writing object phase by not
1532         having to recompute the final delta result once the best match
1533         for all objects is found.  Repacking large repositories on machines
1534         which are tight with memory might be badly impacted by this though,
1535         especially if this cache pushes the system into swapping.
1536         A value of 0 means no limit. The smallest size of 1 byte may be
1537         used to virtually disable this cache. Defaults to 256 MiB.
1539 pack.deltaCacheLimit::
1540         The maximum size of a delta, that is cached in
1541         linkgit:git-pack-objects[1]. This cache is used to speed up the
1542         writing object phase by not having to recompute the final delta
1543         result once the best match for all objects is found. Defaults to 1000.
1545 pack.threads::
1546         Specifies the number of threads to spawn when searching for best
1547         delta matches.  This requires that linkgit:git-pack-objects[1]
1548         be compiled with pthreads otherwise this option is ignored with a
1549         warning. This is meant to reduce packing time on multiprocessor
1550         machines. The required amount of memory for the delta search window
1551         is however multiplied by the number of threads.
1552         Specifying 0 will cause git to auto-detect the number of CPU's
1553         and set the number of threads accordingly.
1555 pack.indexVersion::
1556         Specify the default pack index version.  Valid values are 1 for
1557         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1558         the new pack index with capabilities for packs larger than 4 GB
1559         as well as proper protection against the repacking of corrupted
1560         packs.  Version 2 is the default.  Note that version 2 is enforced
1561         and this config option ignored whenever the corresponding pack is
1562         larger than 2 GB.
1564 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1565 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1566 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1567 other side may give you a repository that cannot be accessed with your
1568 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1569 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1570 the `{asterisk}.idx` file.
1572 pack.packSizeLimit::
1573         The maximum size of a pack.  This setting only affects
1574         packing to a file when repacking, i.e. the git:// protocol
1575         is unaffected.  It can be overridden by the `\--max-pack-size`
1576         option of linkgit:git-repack[1]. The minimum size allowed is
1577         limited to 1 MiB. The default is unlimited.
1578         Common unit suffixes of 'k', 'm', or 'g' are
1579         supported.
1581 pager.<cmd>::
1582         If the value is boolean, turns on or off pagination of the
1583         output of a particular git subcommand when writing to a tty.
1584         Otherwise, turns on pagination for the subcommand using the
1585         pager specified by the value of `pager.<cmd>`.  If `\--paginate`
1586         or `\--no-pager` is specified on the command line, it takes
1587         precedence over this option.  To disable pagination for all
1588         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1590 pretty.<name>::
1591         Alias for a --pretty= format string, as specified in
1592         linkgit:git-log[1]. Any aliases defined here can be used just
1593         as the built-in pretty formats could. For example,
1594         running `git config pretty.changelog "format:{asterisk} %H %s"`
1595         would cause the invocation `git log --pretty=changelog`
1596         to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1597         Note that an alias with the same name as a built-in format
1598         will be silently ignored.
1600 pull.octopus::
1601         The default merge strategy to use when pulling multiple branches
1602         at once.
1604 pull.twohead::
1605         The default merge strategy to use when pulling a single branch.
1607 push.default::
1608         Defines the action git push should take if no refspec is given
1609         on the command line, no refspec is configured in the remote, and
1610         no refspec is implied by any of the options given on the command
1611         line. Possible values are:
1613 * `nothing` - do not push anything.
1614 * `matching` - push all matching branches.
1615   All branches having the same name in both ends are considered to be
1616   matching. This is the default.
1617 * `upstream` - push the current branch to its upstream branch.
1618 * `tracking` - deprecated synonym for `upstream`.
1619 * `current` - push the current branch to a branch of the same name.
1621 rebase.stat::
1622         Whether to show a diffstat of what changed upstream since the last
1623         rebase. False by default.
1625 rebase.autosquash::
1626         If set to true enable '--autosquash' option by default.
1628 receive.autogc::
1629         By default, git-receive-pack will run "git-gc --auto" after
1630         receiving data from git-push and updating refs.  You can stop
1631         it by setting this variable to false.
1633 receive.fsckObjects::
1634         If it is set to true, git-receive-pack will check all received
1635         objects. It will abort in the case of a malformed object or a
1636         broken link. The result of an abort are only dangling objects.
1637         Defaults to false. If not set, the value of `transfer.fsckObjects`
1638         is used instead.
1640 receive.unpackLimit::
1641         If the number of objects received in a push is below this
1642         limit then the objects will be unpacked into loose object
1643         files. However if the number of received objects equals or
1644         exceeds this limit then the received pack will be stored as
1645         a pack, after adding any missing delta bases.  Storing the
1646         pack from a push can make the push operation complete faster,
1647         especially on slow filesystems.  If not set, the value of
1648         `transfer.unpackLimit` is used instead.
1650 receive.denyDeletes::
1651         If set to true, git-receive-pack will deny a ref update that deletes
1652         the ref. Use this to prevent such a ref deletion via a push.
1654 receive.denyDeleteCurrent::
1655         If set to true, git-receive-pack will deny a ref update that
1656         deletes the currently checked out branch of a non-bare repository.
1658 receive.denyCurrentBranch::
1659         If set to true or "refuse", git-receive-pack will deny a ref update
1660         to the currently checked out branch of a non-bare repository.
1661         Such a push is potentially dangerous because it brings the HEAD
1662         out of sync with the index and working tree. If set to "warn",
1663         print a warning of such a push to stderr, but allow the push to
1664         proceed. If set to false or "ignore", allow such pushes with no
1665         message. Defaults to "refuse".
1667 There are two more options that are meant for Git experts: "updateInstead"
1668 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1669 the HEAD so it does not need to change.  Both options come with their own
1670 set of possible *complications*, but can be appropriate in rare workflows.
1672 receive.denyNonFastForwards::
1673         If set to true, git-receive-pack will deny a ref update which is
1674         not a fast-forward. Use this to prevent such an update via a push,
1675         even if that push is forced. This configuration variable is
1676         set when initializing a shared repository.
1678 receive.updateserverinfo::
1679         If set to true, git-receive-pack will run git-update-server-info
1680         after receiving data from git-push and updating refs.
1682 remote.<name>.url::
1683         The URL of a remote repository.  See linkgit:git-fetch[1] or
1684         linkgit:git-push[1].
1686 remote.<name>.pushurl::
1687         The push URL of a remote repository.  See linkgit:git-push[1].
1689 remote.<name>.proxy::
1690         For remotes that require curl (http, https and ftp), the URL to
1691         the proxy to use for that remote.  Set to the empty string to
1692         disable proxying for that remote.
1694 remote.<name>.fetch::
1695         The default set of "refspec" for linkgit:git-fetch[1]. See
1696         linkgit:git-fetch[1].
1698 remote.<name>.push::
1699         The default set of "refspec" for linkgit:git-push[1]. See
1700         linkgit:git-push[1].
1702 remote.<name>.mirror::
1703         If true, pushing to this remote will automatically behave
1704         as if the `\--mirror` option was given on the command line.
1706 remote.<name>.skipDefaultUpdate::
1707         If true, this remote will be skipped by default when updating
1708         using linkgit:git-fetch[1] or the `update` subcommand of
1709         linkgit:git-remote[1].
1711 remote.<name>.skipFetchAll::
1712         If true, this remote will be skipped by default when updating
1713         using linkgit:git-fetch[1] or the `update` subcommand of
1714         linkgit:git-remote[1].
1716 remote.<name>.receivepack::
1717         The default program to execute on the remote side when pushing.  See
1718         option \--receive-pack of linkgit:git-push[1].
1720 remote.<name>.uploadpack::
1721         The default program to execute on the remote side when fetching.  See
1722         option \--upload-pack of linkgit:git-fetch-pack[1].
1724 remote.<name>.tagopt::
1725         Setting this value to \--no-tags disables automatic tag following when
1726         fetching from remote <name>. Setting it to \--tags will fetch every
1727         tag from remote <name>, even if they are not reachable from remote
1728         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1729         override this setting. See options \--tags and \--no-tags of
1730         linkgit:git-fetch[1].
1732 remote.<name>.vcs::
1733         Setting this to a value <vcs> will cause git to interact with
1734         the remote with the git-remote-<vcs> helper.
1736 remotes.<group>::
1737         The list of remotes which are fetched by "git remote update
1738         <group>".  See linkgit:git-remote[1].
1740 repack.usedeltabaseoffset::
1741         By default, linkgit:git-repack[1] creates packs that use
1742         delta-base offset. If you need to share your repository with
1743         git older than version 1.4.4, either directly or via a dumb
1744         protocol such as http, then you need to set this option to
1745         "false" and repack. Access from old git versions over the
1746         native protocol are unaffected by this option.
1748 rerere.autoupdate::
1749         When set to true, `git-rerere` updates the index with the
1750         resulting contents after it cleanly resolves conflicts using
1751         previously recorded resolution.  Defaults to false.
1753 rerere.enabled::
1754         Activate recording of resolved conflicts, so that identical
1755         conflict hunks can be resolved automatically, should they
1756         be encountered again.  linkgit:git-rerere[1] command is by
1757         default enabled if you create `rr-cache` directory under
1758         `$GIT_DIR`, but can be disabled by setting this option to false.
1760 sendemail.identity::
1761         A configuration identity. When given, causes values in the
1762         'sendemail.<identity>' subsection to take precedence over
1763         values in the 'sendemail' section. The default identity is
1764         the value of 'sendemail.identity'.
1766 sendemail.smtpencryption::
1767         See linkgit:git-send-email[1] for description.  Note that this
1768         setting is not subject to the 'identity' mechanism.
1770 sendemail.smtpssl::
1771         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1773 sendemail.<identity>.*::
1774         Identity-specific versions of the 'sendemail.*' parameters
1775         found below, taking precedence over those when the this
1776         identity is selected, through command-line or
1777         'sendemail.identity'.
1779 sendemail.aliasesfile::
1780 sendemail.aliasfiletype::
1781 sendemail.bcc::
1782 sendemail.cc::
1783 sendemail.cccmd::
1784 sendemail.chainreplyto::
1785 sendemail.confirm::
1786 sendemail.envelopesender::
1787 sendemail.from::
1788 sendemail.multiedit::
1789 sendemail.signedoffbycc::
1790 sendemail.smtppass::
1791 sendemail.suppresscc::
1792 sendemail.suppressfrom::
1793 sendemail.to::
1794 sendemail.smtpdomain::
1795 sendemail.smtpserver::
1796 sendemail.smtpserverport::
1797 sendemail.smtpserveroption::
1798 sendemail.smtpuser::
1799 sendemail.thread::
1800 sendemail.validate::
1801         See linkgit:git-send-email[1] for description.
1803 sendemail.signedoffcc::
1804         Deprecated alias for 'sendemail.signedoffbycc'.
1806 showbranch.default::
1807         The default set of branches for linkgit:git-show-branch[1].
1808         See linkgit:git-show-branch[1].
1810 status.relativePaths::
1811         By default, linkgit:git-status[1] shows paths relative to the
1812         current directory. Setting this variable to `false` shows paths
1813         relative to the repository root (this was the default for git
1814         prior to v1.5.4).
1816 status.showUntrackedFiles::
1817         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1818         files which are not currently tracked by Git. Directories which
1819         contain only untracked files, are shown with the directory name
1820         only. Showing untracked files means that Git needs to lstat() all
1821         all the files in the whole repository, which might be slow on some
1822         systems. So, this variable controls how the commands displays
1823         the untracked files. Possible values are:
1826 * `no` - Show no untracked files.
1827 * `normal` - Show untracked files and directories.
1828 * `all` - Show also individual files in untracked directories.
1831 If this variable is not specified, it defaults to 'normal'.
1832 This variable can be overridden with the -u|--untracked-files option
1833 of linkgit:git-status[1] and linkgit:git-commit[1].
1835 status.submodulesummary::
1836         Defaults to false.
1837         If this is set to a non zero number or true (identical to -1 or an
1838         unlimited number), the submodule summary will be enabled and a
1839         summary of commits for modified submodules will be shown (see
1840         --summary-limit option of linkgit:git-submodule[1]).
1842 submodule.<name>.path::
1843 submodule.<name>.url::
1844 submodule.<name>.update::
1845         The path within this project, URL, and the updating strategy
1846         for a submodule.  These variables are initially populated
1847         by 'git submodule init'; edit them to override the
1848         URL and other values found in the `.gitmodules` file.  See
1849         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1851 submodule.<name>.fetchRecurseSubmodules::
1852         This option can be used to control recursive fetching of this
1853         submodule. It can be overridden by using the --[no-]recurse-submodules
1854         command line option to "git fetch" and "git pull".
1855         This setting will override that from in the linkgit:gitmodules[5]
1856         file.
1858 submodule.<name>.ignore::
1859         Defines under what circumstances "git status" and the diff family show
1860         a submodule as modified. When set to "all", it will never be considered
1861         modified, "dirty" will ignore all changes to the submodules work tree and
1862         takes only differences between the HEAD of the submodule and the commit
1863         recorded in the superproject into account. "untracked" will additionally
1864         let submodules with modified tracked files in their work tree show up.
1865         Using "none" (the default when this option is not set) also shows
1866         submodules that have untracked files in their work tree as changed.
1867         This setting overrides any setting made in .gitmodules for this submodule,
1868         both settings can be overridden on the command line by using the
1869         "--ignore-submodules" option.
1871 tar.umask::
1872         This variable can be used to restrict the permission bits of
1873         tar archive entries.  The default is 0002, which turns off the
1874         world write bit.  The special value "user" indicates that the
1875         archiving user's umask will be used instead.  See umask(2) and
1876         linkgit:git-archive[1].
1878 transfer.fsckObjects::
1879         When `fetch.fsckObjects` or `receive.fsckObjects` are
1880         not set, the value of this variable is used instead.
1881         Defaults to false.
1883 transfer.unpackLimit::
1884         When `fetch.unpackLimit` or `receive.unpackLimit` are
1885         not set, the value of this variable is used instead.
1886         The default value is 100.
1888 url.<base>.insteadOf::
1889         Any URL that starts with this value will be rewritten to
1890         start, instead, with <base>. In cases where some site serves a
1891         large number of repositories, and serves them with multiple
1892         access methods, and some users need to use different access
1893         methods, this feature allows people to specify any of the
1894         equivalent URLs and have git automatically rewrite the URL to
1895         the best alternative for the particular user, even for a
1896         never-before-seen repository on the site.  When more than one
1897         insteadOf strings match a given URL, the longest match is used.
1899 url.<base>.pushInsteadOf::
1900         Any URL that starts with this value will not be pushed to;
1901         instead, it will be rewritten to start with <base>, and the
1902         resulting URL will be pushed to. In cases where some site serves
1903         a large number of repositories, and serves them with multiple
1904         access methods, some of which do not allow push, this feature
1905         allows people to specify a pull-only URL and have git
1906         automatically use an appropriate URL to push, even for a
1907         never-before-seen repository on the site.  When more than one
1908         pushInsteadOf strings match a given URL, the longest match is
1909         used.  If a remote has an explicit pushurl, git will ignore this
1910         setting for that remote.
1912 user.email::
1913         Your email address to be recorded in any newly created commits.
1914         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1915         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1917 user.name::
1918         Your full name to be recorded in any newly created commits.
1919         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1920         environment variables.  See linkgit:git-commit-tree[1].
1922 user.signingkey::
1923         If linkgit:git-tag[1] is not selecting the key you want it to
1924         automatically when creating a signed tag, you can override the
1925         default selection with this variable.  This option is passed
1926         unchanged to gpg's --local-user parameter, so you may specify a key
1927         using any method that gpg supports.
1929 web.browser::
1930         Specify a web browser that may be used by some commands.
1931         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1932         may use it.