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