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