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