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