Merge branch 'da/mergetool-meld'
[git.git] / Documentation / config.txt
blob400dcad21d627d7fc1dba9ec31d86f046bb49396
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).  Other char escape sequences (including octal
82 escape sequences) are invalid.
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.
136 Other git-related tools may and do use their own variables.  When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
142 advice.*::
143         These variables control various optional help messages designed to
144         aid new users. All 'advice.*' variables default to 'true', and you
145         can tell Git that you do not need help by setting these to 'false':
148         pushUpdateRejected::
149                 Set this variable to 'false' if you want to disable
150                 'pushNonFFCurrent',
151                 'pushNonFFMatching', 'pushAlreadyExists',
152                 'pushFetchFirst', and 'pushNeedsForce'
153                 simultaneously.
154         pushNonFFCurrent::
155                 Advice shown when linkgit:git-push[1] fails due to a
156                 non-fast-forward update to the current branch.
157         pushNonFFMatching::
158                 Advice shown when you ran linkgit:git-push[1] and pushed
159                 'matching refs' explicitly (i.e. you used ':', or
160                 specified a refspec that isn't your current branch) and
161                 it resulted in a non-fast-forward error.
162         pushAlreadyExists::
163                 Shown when linkgit:git-push[1] rejects an update that
164                 does not qualify for fast-forwarding (e.g., a tag.)
165         pushFetchFirst::
166                 Shown when linkgit:git-push[1] rejects an update that
167                 tries to overwrite a remote ref that points at an
168                 object we do not have.
169         pushNeedsForce::
170                 Shown when linkgit:git-push[1] rejects an update that
171                 tries to overwrite a remote ref that points at an
172                 object that is not a commit-ish, or make the remote
173                 ref point at an object that is not a commit-ish.
174         statusHints::
175                 Show directions on how to proceed from the current
176                 state in the output of linkgit:git-status[1], in
177                 the template shown when writing commit messages in
178                 linkgit:git-commit[1], and in the help message shown
179                 by linkgit:git-checkout[1] when switching branch.
180         statusUoption::
181                 Advise to consider using the `-u` option to linkgit:git-status[1]
182                 when the command takes more than 2 seconds to enumerate untracked
183                 files.
184         commitBeforeMerge::
185                 Advice shown when linkgit:git-merge[1] refuses to
186                 merge to avoid overwriting local changes.
187         resolveConflict::
188                 Advice shown by various commands when conflicts
189                 prevent the operation from being performed.
190         implicitIdentity::
191                 Advice on how to set your identity configuration when
192                 your information is guessed from the system username and
193                 domain name.
194         detachedHead::
195                 Advice shown when you used linkgit:git-checkout[1] to
196                 move to the detach HEAD state, to instruct how to create
197                 a local branch after the fact.
198         amWorkDir::
199                 Advice that shows the location of the patch file when
200                 linkgit:git-am[1] fails to apply it.
201         rmHints::
202                 In case of failure in the output of linkgit:git-rm[1],
203                 show directions on how to proceed from the current state.
206 core.fileMode::
207         If false, the executable bit differences between the index and
208         the working tree are ignored; useful on broken filesystems like FAT.
209         See linkgit:git-update-index[1].
211 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212 will probe and set core.fileMode false if appropriate when the
213 repository is created.
215 core.ignorecase::
216         If true, this option enables various workarounds to enable
217         Git to work better on filesystems that are not case sensitive,
218         like FAT. For example, if a directory listing finds
219         "makefile" when Git expects "Makefile", Git will assume
220         it is really the same file, and continue to remember it as
221         "Makefile".
223 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224 will probe and set core.ignorecase true if appropriate when the repository
225 is created.
227 core.precomposeunicode::
228         This option is only used by Mac OS implementation of Git.
229         When core.precomposeunicode=true, Git reverts the unicode decomposition
230         of filenames done by Mac OS. This is useful when sharing a repository
231         between Mac OS and Linux or Windows.
232         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233         When false, file names are handled fully transparent by Git,
234         which is backward compatible with older versions of Git.
236 core.trustctime::
237         If false, the ctime differences between the index and the
238         working tree are ignored; useful when the inode change time
239         is regularly modified by something outside Git (file system
240         crawlers and some backup systems).
241         See linkgit:git-update-index[1]. True by default.
243 core.checkstat::
244         Determines which stat fields to match between the index
245         and work tree. The user can set this to 'default' or
246         'minimal'. Default (or explicitly 'default'), is to check
247         all fields, including the sub-second part of mtime and ctime.
249 core.quotepath::
250         The commands that output paths (e.g. 'ls-files',
251         'diff'), when not given the `-z` option, will quote
252         "unusual" characters in the pathname by enclosing the
253         pathname in a double-quote pair and with backslashes the
254         same way strings in C source code are quoted.  If this
255         variable is set to false, the bytes higher than 0x80 are
256         not quoted but output as verbatim.  Note that double
257         quote, backslash and control characters are always
258         quoted without `-z` regardless of the setting of this
259         variable.
261 core.eol::
262         Sets the line ending type to use in the working directory for
263         files that have the `text` property set.  Alternatives are
264         'lf', 'crlf' and 'native', which uses the platform's native
265         line ending.  The default value is `native`.  See
266         linkgit:gitattributes[5] for more information on end-of-line
267         conversion.
269 core.safecrlf::
270         If true, makes Git check if converting `CRLF` is reversible when
271         end-of-line conversion is active.  Git will verify if a command
272         modifies a file in the work tree either directly or indirectly.
273         For example, committing a file followed by checking out the
274         same file should yield the original file in the work tree.  If
275         this is not the case for the current setting of
276         `core.autocrlf`, Git will reject the file.  The variable can
277         be set to "warn", in which case Git will only warn about an
278         irreversible conversion but continue the operation.
280 CRLF conversion bears a slight chance of corrupting data.
281 When it is enabled, Git will convert CRLF to LF during commit and LF to
282 CRLF during checkout.  A file that contains a mixture of LF and
283 CRLF before the commit cannot be recreated by Git.  For text
284 files this is the right thing to do: it corrects line endings
285 such that we have only LF line endings in the repository.
286 But for binary files that are accidentally classified as text the
287 conversion can corrupt data.
289 If you recognize such corruption early you can easily fix it by
290 setting the conversion type explicitly in .gitattributes.  Right
291 after committing you still have the original file in your work
292 tree and this file is not yet corrupted.  You can explicitly tell
293 Git that this file is binary and Git will handle the file
294 appropriately.
296 Unfortunately, the desired effect of cleaning up text files with
297 mixed line endings and the undesired effect of corrupting binary
298 files cannot be distinguished.  In both cases CRLFs are removed
299 in an irreversible way.  For text files this is the right thing
300 to do because CRLFs are line endings, while for binary files
301 converting CRLFs corrupts data.
303 Note, this safety check does not mean that a checkout will generate a
304 file identical to the original file for a different setting of
305 `core.eol` and `core.autocrlf`, but only for the current one.  For
306 example, a text file with `LF` would be accepted with `core.eol=lf`
307 and could later be checked out with `core.eol=crlf`, in which case the
308 resulting file would contain `CRLF`, although the original file
309 contained `LF`.  However, in both work trees the line endings would be
310 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
311 file with mixed line endings would be reported by the `core.safecrlf`
312 mechanism.
314 core.autocrlf::
315         Setting this variable to "true" is almost the same as setting
316         the `text` attribute to "auto" on all files except that text
317         files are not guaranteed to be normalized: files that contain
318         `CRLF` in the repository will not be touched.  Use this
319         setting if you want to have `CRLF` line endings in your
320         working directory even though the repository does not have
321         normalized line endings.  This variable can be set to 'input',
322         in which case no output conversion is performed.
324 core.symlinks::
325         If false, symbolic links are checked out as small plain files that
326         contain the link text. linkgit:git-update-index[1] and
327         linkgit:git-add[1] will not change the recorded type to regular
328         file. Useful on filesystems like FAT that do not support
329         symbolic links.
331 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
332 will probe and set core.symlinks false if appropriate when the repository
333 is created.
335 core.gitProxy::
336         A "proxy command" to execute (as 'command host port') instead
337         of establishing direct connection to the remote server when
338         using the Git protocol for fetching. If the variable value is
339         in the "COMMAND for DOMAIN" format, the command is applied only
340         on hostnames ending with the specified domain string. This variable
341         may be set multiple times and is matched in the given order;
342         the first match wins.
344 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
345 (which always applies universally, without the special "for"
346 handling).
348 The special string `none` can be used as the proxy command to
349 specify that no proxy be used for a given domain pattern.
350 This is useful for excluding servers inside a firewall from
351 proxy use, while defaulting to a common proxy for external domains.
353 core.ignoreStat::
354         If true, commands which modify both the working tree and the index
355         will mark the updated paths with the "assume unchanged" bit in the
356         index. These marked files are then assumed to stay unchanged in the
357         working tree, until you mark them otherwise manually - Git will not
358         detect the file changes by lstat() calls. This is useful on systems
359         where those are very slow, such as Microsoft Windows.
360         See linkgit:git-update-index[1].
361         False by default.
363 core.preferSymlinkRefs::
364         Instead of the default "symref" format for HEAD
365         and other symbolic reference files, use symbolic links.
366         This is sometimes needed to work with old scripts that
367         expect HEAD to be a symbolic link.
369 core.bare::
370         If true this repository is assumed to be 'bare' and has no
371         working directory associated with it.  If this is the case a
372         number of commands that require a working directory will be
373         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
375 This setting is automatically guessed by linkgit:git-clone[1] or
376 linkgit:git-init[1] when the repository was created.  By default a
377 repository that ends in "/.git" is assumed to be not bare (bare =
378 false), while all other repositories are assumed to be bare (bare
379 = true).
381 core.worktree::
382         Set the path to the root of the working tree.
383         This can be overridden by the GIT_WORK_TREE environment
384         variable and the '--work-tree' command-line option.
385         The value can be an absolute path or relative to the path to
386         the .git directory, which is either specified by --git-dir
387         or GIT_DIR, or automatically discovered.
388         If --git-dir or GIT_DIR is specified but none of
389         --work-tree, GIT_WORK_TREE and core.worktree is specified,
390         the current working directory is regarded as the top level
391         of your working tree.
393 Note that this variable is honored even when set in a configuration
394 file in a ".git" subdirectory of a directory and its value differs
395 from the latter directory (e.g. "/path/to/.git/config" has
396 core.worktree set to "/different/path"), which is most likely a
397 misconfiguration.  Running Git commands in the "/path/to" directory will
398 still use "/different/path" as the root of the work tree and can cause
399 confusion unless you know what you are doing (e.g. you are creating a
400 read-only snapshot of the same index to a location different from the
401 repository's usual working tree).
403 core.logAllRefUpdates::
404         Enable the reflog. Updates to a ref <ref> is logged to the file
405         "$GIT_DIR/logs/<ref>", by appending the new and old
406         SHA-1, the date/time and the reason of the update, but
407         only when the file exists.  If this configuration
408         variable is set to true, missing "$GIT_DIR/logs/<ref>"
409         file is automatically created for branch heads (i.e. under
410         refs/heads/), remote refs (i.e. under refs/remotes/),
411         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
413 This information can be used to determine what commit
414 was the tip of a branch "2 days ago".
416 This value is true by default in a repository that has
417 a working directory associated with it, and false by
418 default in a bare repository.
420 core.repositoryFormatVersion::
421         Internal variable identifying the repository format and layout
422         version.
424 core.sharedRepository::
425         When 'group' (or 'true'), the repository is made shareable between
426         several users in a group (making sure all the files and objects are
427         group-writable). When 'all' (or 'world' or 'everybody'), the
428         repository will be readable by all users, additionally to being
429         group-shareable. When 'umask' (or 'false'), Git will use permissions
430         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
431         files in the repository will have this mode value. '0xxx' will override
432         user's umask value (whereas the other options will only override
433         requested parts of the user's umask value). Examples: '0660' will make
434         the repo read/write-able for the owner and group, but inaccessible to
435         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
436         repository that is group-readable but not group-writable.
437         See linkgit:git-init[1]. False by default.
439 core.warnAmbiguousRefs::
440         If true, Git will warn you if the ref name you passed it is ambiguous
441         and might match multiple refs in the repository. True by default.
443 core.compression::
444         An integer -1..9, indicating a default compression level.
445         -1 is the zlib default. 0 means no compression,
446         and 1..9 are various speed/size tradeoffs, 9 being slowest.
447         If set, this provides a default to other compression variables,
448         such as 'core.loosecompression' and 'pack.compression'.
450 core.loosecompression::
451         An integer -1..9, indicating the compression level for objects that
452         are not in a pack file. -1 is the zlib default. 0 means no
453         compression, and 1..9 are various speed/size tradeoffs, 9 being
454         slowest.  If not set,  defaults to core.compression.  If that is
455         not set,  defaults to 1 (best speed).
457 core.packedGitWindowSize::
458         Number of bytes of a pack file to map into memory in a
459         single mapping operation.  Larger window sizes may allow
460         your system to process a smaller number of large pack files
461         more quickly.  Smaller window sizes will negatively affect
462         performance due to increased calls to the operating system's
463         memory manager, but may improve performance when accessing
464         a large number of large pack files.
466 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
467 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
468 be reasonable for all users/operating systems.  You probably do
469 not need to adjust this value.
471 Common unit suffixes of 'k', 'm', or 'g' are supported.
473 core.packedGitLimit::
474         Maximum number of bytes to map simultaneously into memory
475         from pack files.  If Git needs to access more than this many
476         bytes at once to complete an operation it will unmap existing
477         regions to reclaim virtual address space within the process.
479 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
480 This should be reasonable for all users/operating systems, except on
481 the largest projects.  You probably do not need to adjust this value.
483 Common unit suffixes of 'k', 'm', or 'g' are supported.
485 core.deltaBaseCacheLimit::
486         Maximum number of bytes to reserve for caching base objects
487         that may be referenced by multiple deltified objects.  By storing the
488         entire decompressed base objects in a cache Git is able
489         to avoid unpacking and decompressing frequently used base
490         objects multiple times.
492 Default is 96 MiB on all platforms.  This should be reasonable
493 for all users/operating systems, except on the largest projects.
494 You probably do not need to adjust this value.
496 Common unit suffixes of 'k', 'm', or 'g' are supported.
498 core.bigFileThreshold::
499         Files larger than this size are stored deflated, without
500         attempting delta compression.  Storing large files without
501         delta compression avoids excessive memory usage, at the
502         slight expense of increased disk usage. Additionally files
503         larger than this size are always treated as binary.
505 Default is 512 MiB on all platforms.  This should be reasonable
506 for most projects as source code and other text files can still
507 be delta compressed, but larger binary media files won't be.
509 Common unit suffixes of 'k', 'm', or 'g' are supported.
511 core.excludesfile::
512         In addition to '.gitignore' (per-directory) and
513         '.git/info/exclude', Git looks into this file for patterns
514         of files which are not meant to be tracked.  "`~/`" is expanded
515         to the value of `$HOME` and "`~user/`" to the specified user's
516         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
517         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
518         is used instead. See linkgit:gitignore[5].
520 core.askpass::
521         Some commands (e.g. svn and http interfaces) that interactively
522         ask for a password can be told to use an external program given
523         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
524         environment variable. If not set, fall back to the value of the
525         'SSH_ASKPASS' environment variable or, failing that, a simple password
526         prompt. The external program shall be given a suitable prompt as
527         command-line argument and write the password on its STDOUT.
529 core.attributesfile::
530         In addition to '.gitattributes' (per-directory) and
531         '.git/info/attributes', Git looks into this file for attributes
532         (see linkgit:gitattributes[5]). Path expansions are made the same
533         way as for `core.excludesfile`. Its default value is
534         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
535         set or empty, $HOME/.config/git/attributes is used instead.
537 core.editor::
538         Commands such as `commit` and `tag` that lets you edit
539         messages by launching an editor uses the value of this
540         variable when it is set, and the environment variable
541         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
543 core.commentchar::
544         Commands such as `commit` and `tag` that lets you edit
545         messages consider a line that begins with this character
546         commented, and removes them after the editor returns
547         (default '#').
549 If set to "auto", `git-commit` would select a character that is not
550 the beginning character of any line in existing commit messages.
552 sequence.editor::
553         Text editor used by `git rebase -i` for editing the rebase instruction file.
554         The value is meant to be interpreted by the shell when it is used.
555         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
556         When not configured the default commit message editor is used instead.
558 core.pager::
559         Text viewer for use by Git commands (e.g., 'less').  The value
560         is meant to be interpreted by the shell.  The order of preference
561         is the `$GIT_PAGER` environment variable, then `core.pager`
562         configuration, then `$PAGER`, and then the default chosen at
563         compile time (usually 'less').
565 When the `LESS` environment variable is unset, Git sets it to `FRX`
566 (if `LESS` environment variable is set, Git does not change it at
567 all).  If you want to selectively override Git's default setting
568 for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
569 be passed to the shell by Git, which will translate the final
570 command to `LESS=FRX less -S`. The environment does not set the
571 `S` option but the command line does, instructing less to truncate
572 long lines. Similarly, setting `core.pager` to `less -+F` will
573 deactivate the `F` option specified by the environment from the
574 command-line, deactivating the "quit if one screen" behavior of
575 `less`.  One can specifically activate some flags for particular
576 commands: for example, setting `pager.blame` to `less -S` enables
577 line truncation only for `git blame`.
579 Likewise, when the `LV` environment variable is unset, Git sets it
580 to `-c`.  You can override this setting by exporting `LV` with
581 another value or setting `core.pager` to `lv +c`.
583 core.whitespace::
584         A comma separated list of common whitespace problems to
585         notice.  'git diff' will use `color.diff.whitespace` to
586         highlight them, and 'git apply --whitespace=error' will
587         consider them as errors.  You can prefix `-` to disable
588         any of them (e.g. `-trailing-space`):
590 * `blank-at-eol` treats trailing whitespaces at the end of the line
591   as an error (enabled by default).
592 * `space-before-tab` treats a space character that appears immediately
593   before a tab character in the initial indent part of the line as an
594   error (enabled by default).
595 * `indent-with-non-tab` treats a line that is indented with space
596   characters instead of the equivalent tabs as an error (not enabled by
597   default).
598 * `tab-in-indent` treats a tab character in the initial indent part of
599   the line as an error (not enabled by default).
600 * `blank-at-eof` treats blank lines added at the end of file as an error
601   (enabled by default).
602 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
603   `blank-at-eof`.
604 * `cr-at-eol` treats a carriage-return at the end of line as
605   part of the line terminator, i.e. with it, `trailing-space`
606   does not trigger if the character before such a carriage-return
607   is not a whitespace (not enabled by default).
608 * `tabwidth=<n>` tells how many character positions a tab occupies; this
609   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
610   errors. The default tab width is 8. Allowed values are 1 to 63.
612 core.fsyncobjectfiles::
613         This boolean will enable 'fsync()' when writing object files.
615 This is a total waste of time and effort on a filesystem that orders
616 data writes properly, but can be useful for filesystems that do not use
617 journalling (traditional UNIX filesystems) or that only journal metadata
618 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
620 core.preloadindex::
621         Enable parallel index preload for operations like 'git diff'
623 This can speed up operations like 'git diff' and 'git status' especially
624 on filesystems like NFS that have weak caching semantics and thus
625 relatively high IO latencies.  When enabled, Git will do the
626 index comparison to the filesystem data in parallel, allowing
627 overlapping IO's.  Defaults to true.
629 core.createObject::
630         You can set this to 'link', in which case a hardlink followed by
631         a delete of the source are used to make sure that object creation
632         will not overwrite existing objects.
634 On some file system/operating system combinations, this is unreliable.
635 Set this config setting to 'rename' there; However, This will remove the
636 check that makes sure that existing object files will not get overwritten.
638 core.notesRef::
639         When showing commit messages, also show notes which are stored in
640         the given ref.  The ref must be fully qualified.  If the given
641         ref does not exist, it is not an error but means that no
642         notes should be printed.
644 This setting defaults to "refs/notes/commits", and it can be overridden by
645 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
647 core.sparseCheckout::
648         Enable "sparse checkout" feature. See section "Sparse checkout" in
649         linkgit:git-read-tree[1] for more information.
651 core.abbrev::
652         Set the length object names are abbreviated to.  If unspecified,
653         many commands abbreviate to 7 hexdigits, which may not be enough
654         for abbreviated object names to stay unique for sufficiently long
655         time.
657 add.ignore-errors::
658 add.ignoreErrors::
659         Tells 'git add' to continue adding files when some files cannot be
660         added due to indexing errors. Equivalent to the '--ignore-errors'
661         option of linkgit:git-add[1].  Older versions of Git accept only
662         `add.ignore-errors`, which does not follow the usual naming
663         convention for configuration variables.  Newer versions of Git
664         honor `add.ignoreErrors` as well.
666 alias.*::
667         Command aliases for the linkgit:git[1] command wrapper - e.g.
668         after defining "alias.last = cat-file commit HEAD", the invocation
669         "git last" is equivalent to "git cat-file commit HEAD". To avoid
670         confusion and troubles with script usage, aliases that
671         hide existing Git commands are ignored. Arguments are split by
672         spaces, the usual shell quoting and escaping is supported.
673         quote pair and a backslash can be used to quote them.
675 If the alias expansion is prefixed with an exclamation point,
676 it will be treated as a shell command.  For example, defining
677 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
678 "git new" is equivalent to running the shell command
679 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
680 executed from the top-level directory of a repository, which may
681 not necessarily be the current directory.
682 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
683 from the original current directory. See linkgit:git-rev-parse[1].
685 am.keepcr::
686         If true, git-am will call git-mailsplit for patches in mbox format
687         with parameter '--keep-cr'. In this case git-mailsplit will
688         not remove `\r` from lines ending with `\r\n`. Can be overridden
689         by giving '--no-keep-cr' from the command line.
690         See linkgit:git-am[1], linkgit:git-mailsplit[1].
692 apply.ignorewhitespace::
693         When set to 'change', tells 'git apply' to ignore changes in
694         whitespace, in the same way as the '--ignore-space-change'
695         option.
696         When set to one of: no, none, never, false tells 'git apply' to
697         respect all whitespace differences.
698         See linkgit:git-apply[1].
700 apply.whitespace::
701         Tells 'git apply' how to handle whitespaces, in the same way
702         as the '--whitespace' option. See linkgit:git-apply[1].
704 branch.autosetupmerge::
705         Tells 'git branch' and 'git checkout' to set up new branches
706         so that linkgit:git-pull[1] will appropriately merge from the
707         starting point branch. Note that even if this option is not set,
708         this behavior can be chosen per-branch using the `--track`
709         and `--no-track` options. The valid settings are: `false` -- no
710         automatic setup is done; `true` -- automatic setup is done when the
711         starting point is a remote-tracking branch; `always` --
712         automatic setup is done when the starting point is either a
713         local branch or remote-tracking
714         branch. This option defaults to true.
716 branch.autosetuprebase::
717         When a new branch is created with 'git branch' or 'git checkout'
718         that tracks another branch, this variable tells Git to set
719         up pull to rebase instead of merge (see "branch.<name>.rebase").
720         When `never`, rebase is never automatically set to true.
721         When `local`, rebase is set to true for tracked branches of
722         other local branches.
723         When `remote`, rebase is set to true for tracked branches of
724         remote-tracking branches.
725         When `always`, rebase will be set to true for all tracking
726         branches.
727         See "branch.autosetupmerge" for details on how to set up a
728         branch to track another branch.
729         This option defaults to never.
731 branch.<name>.remote::
732         When on branch <name>, it tells 'git fetch' and 'git push'
733         which remote to fetch from/push to.  The remote to push to
734         may be overridden with `remote.pushdefault` (for all branches).
735         The remote to push to, for the current branch, may be further
736         overridden by `branch.<name>.pushremote`.  If no remote is
737         configured, or if you are not on any branch, it defaults to
738         `origin` for fetching and `remote.pushdefault` for pushing.
739         Additionally, `.` (a period) is the current local repository
740         (a dot-repository), see `branch.<name>.merge`'s final note below.
742 branch.<name>.pushremote::
743         When on branch <name>, it overrides `branch.<name>.remote` for
744         pushing.  It also overrides `remote.pushdefault` for pushing
745         from branch <name>.  When you pull from one place (e.g. your
746         upstream) and push to another place (e.g. your own publishing
747         repository), you would want to set `remote.pushdefault` to
748         specify the remote to push to for all branches, and use this
749         option to override it for a specific branch.
751 branch.<name>.merge::
752         Defines, together with branch.<name>.remote, the upstream branch
753         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
754         branch to merge and can also affect 'git push' (see push.default).
755         When in branch <name>, it tells 'git fetch' the default
756         refspec to be marked for merging in FETCH_HEAD. The value is
757         handled like the remote part of a refspec, and must match a
758         ref which is fetched from the remote given by
759         "branch.<name>.remote".
760         The merge information is used by 'git pull' (which at first calls
761         'git fetch') to lookup the default branch for merging. Without
762         this option, 'git pull' defaults to merge the first refspec fetched.
763         Specify multiple values to get an octopus merge.
764         If you wish to setup 'git pull' so that it merges into <name> from
765         another branch in the local repository, you can point
766         branch.<name>.merge to the desired branch, and use the relative path
767         setting `.` (a period) for branch.<name>.remote.
769 branch.<name>.mergeoptions::
770         Sets default options for merging into branch <name>. The syntax and
771         supported options are the same as those of linkgit:git-merge[1], but
772         option values containing whitespace characters are currently not
773         supported.
775 branch.<name>.rebase::
776         When true, rebase the branch <name> on top of the fetched branch,
777         instead of merging the default branch from the default remote when
778         "git pull" is run. See "pull.rebase" for doing this in a non
779         branch-specific manner.
781         When preserve, also pass `--preserve-merges` along to 'git rebase'
782         so that locally committed merge commits will not be flattened
783         by running 'git pull'.
785 *NOTE*: this is a possibly dangerous operation; do *not* use
786 it unless you understand the implications (see linkgit:git-rebase[1]
787 for details).
789 branch.<name>.description::
790         Branch description, can be edited with
791         `git branch --edit-description`. Branch description is
792         automatically added in the format-patch cover letter or
793         request-pull summary.
795 browser.<tool>.cmd::
796         Specify the command to invoke the specified browser. The
797         specified command is evaluated in shell with the URLs passed
798         as arguments. (See linkgit:git-web{litdd}browse[1].)
800 browser.<tool>.path::
801         Override the path for the given tool that may be used to
802         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
803         working repository in gitweb (see linkgit:git-instaweb[1]).
805 clean.requireForce::
806         A boolean to make git-clean do nothing unless given -f,
807         -i or -n.   Defaults to true.
809 color.branch::
810         A boolean to enable/disable color in the output of
811         linkgit:git-branch[1]. May be set to `always`,
812         `false` (or `never`) or `auto` (or `true`), in which case colors are used
813         only when the output is to a terminal. Defaults to false.
815 color.branch.<slot>::
816         Use customized color for branch coloration. `<slot>` is one of
817         `current` (the current branch), `local` (a local branch),
818         `remote` (a remote-tracking branch in refs/remotes/),
819         `upstream` (upstream tracking branch), `plain` (other
820         refs).
822 The value for these configuration variables is a list of colors (at most
823 two) and attributes (at most one), separated by spaces.  The colors
824 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
825 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
826 `blink` and `reverse`.  The first color given is the foreground; the
827 second is the background.  The position of the attribute, if any,
828 doesn't matter.
830 color.diff::
831         Whether to use ANSI escape sequences to add color to patches.
832         If this is set to `always`, linkgit:git-diff[1],
833         linkgit:git-log[1], and linkgit:git-show[1] will use color
834         for all patches.  If it is set to `true` or `auto`, those
835         commands will only use color when output is to the terminal.
836         Defaults to false.
838 This does not affect linkgit:git-format-patch[1] or the
839 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
840 command line with the `--color[=<when>]` option.
842 color.diff.<slot>::
843         Use customized color for diff colorization.  `<slot>` specifies
844         which part of the patch to use the specified color, and is one
845         of `plain` (context text), `meta` (metainformation), `frag`
846         (hunk header), 'func' (function in hunk header), `old` (removed lines),
847         `new` (added lines), `commit` (commit headers), or `whitespace`
848         (highlighting whitespace errors). The values of these variables may be
849         specified as in color.branch.<slot>.
851 color.decorate.<slot>::
852         Use customized color for 'git log --decorate' output.  `<slot>` is one
853         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
854         branches, remote-tracking branches, tags, stash and HEAD, respectively.
856 color.grep::
857         When set to `always`, always highlight matches.  When `false` (or
858         `never`), never.  When set to `true` or `auto`, use color only
859         when the output is written to the terminal.  Defaults to `false`.
861 color.grep.<slot>::
862         Use customized color for grep colorization.  `<slot>` specifies which
863         part of the line to use the specified color, and is one of
866 `context`;;
867         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
868 `filename`;;
869         filename prefix (when not using `-h`)
870 `function`;;
871         function name lines (when using `-p`)
872 `linenumber`;;
873         line number prefix (when using `-n`)
874 `match`;;
875         matching text
876 `selected`;;
877         non-matching text in selected lines
878 `separator`;;
879         separators between fields on a line (`:`, `-`, and `=`)
880         and between hunks (`--`)
883 The values of these variables may be specified as in color.branch.<slot>.
885 color.interactive::
886         When set to `always`, always use colors for interactive prompts
887         and displays (such as those used by "git-add --interactive" and
888         "git-clean --interactive"). When false (or `never`), never.
889         When set to `true` or `auto`, use colors only when the output is
890         to the terminal. Defaults to false.
892 color.interactive.<slot>::
893         Use customized color for 'git add --interactive' and 'git clean
894         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
895         or `error`, for four distinct types of normal output from
896         interactive commands.  The values of these variables may be
897         specified as in color.branch.<slot>.
899 color.pager::
900         A boolean to enable/disable colored output when the pager is in
901         use (default is true).
903 color.showbranch::
904         A boolean to enable/disable color in the output of
905         linkgit:git-show-branch[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::
910         A boolean to enable/disable color in the output of
911         linkgit:git-status[1]. May be set to `always`,
912         `false` (or `never`) or `auto` (or `true`), in which case colors are used
913         only when the output is to a terminal. Defaults to false.
915 color.status.<slot>::
916         Use customized color for status colorization. `<slot>` is
917         one of `header` (the header text of the status message),
918         `added` or `updated` (files which are added but not committed),
919         `changed` (files which are changed but not added in the index),
920         `untracked` (files which are not tracked by Git),
921         `branch` (the current branch), or
922         `nobranch` (the color the 'no branch' warning is shown in, defaulting
923         to red). The values of these variables may be specified as in
924         color.branch.<slot>.
926 color.ui::
927         This variable determines the default value for variables such
928         as `color.diff` and `color.grep` that control the use of color
929         per command family. Its scope will expand as more commands learn
930         configuration to set a default for the `--color` option.  Set it
931         to `false` or `never` if you prefer Git commands not to use
932         color unless enabled explicitly with some other configuration
933         or the `--color` option. Set it to `always` if you want all
934         output not intended for machine consumption to use color, to
935         `true` or `auto` (this is the default since Git 1.8.4) if you
936         want such output to use color when written to the terminal.
938 column.ui::
939         Specify whether supported commands should output in columns.
940         This variable consists of a list of tokens separated by spaces
941         or commas:
943 These options control when the feature should be enabled
944 (defaults to 'never'):
947 `always`;;
948         always show in columns
949 `never`;;
950         never show in columns
951 `auto`;;
952         show in columns if the output is to the terminal
955 These options control layout (defaults to 'column').  Setting any
956 of these implies 'always' if none of 'always', 'never', or 'auto' are
957 specified.
960 `column`;;
961         fill columns before rows
962 `row`;;
963         fill rows before columns
964 `plain`;;
965         show in one column
968 Finally, these options can be combined with a layout option (defaults
969 to 'nodense'):
972 `dense`;;
973         make unequal size columns to utilize more space
974 `nodense`;;
975         make equal size columns
978 column.branch::
979         Specify whether to output branch listing in `git branch` in columns.
980         See `column.ui` for details.
982 column.clean::
983         Specify the layout when list items in `git clean -i`, which always
984         shows files and directories in columns. See `column.ui` for details.
986 column.status::
987         Specify whether to output untracked files in `git status` in columns.
988         See `column.ui` for details.
990 column.tag::
991         Specify whether to output tag listing in `git tag` in columns.
992         See `column.ui` for details.
994 commit.cleanup::
995         This setting overrides the default of the `--cleanup` option in
996         `git commit`. See linkgit:git-commit[1] for details. Changing the
997         default can be useful when you always want to keep lines that begin
998         with comment character `#` in your log message, in which case you
999         would do `git config commit.cleanup whitespace` (note that you will
1000         have to remove the help lines that begin with `#` in the commit log
1001         template yourself, if you do this).
1003 commit.gpgsign::
1005         A boolean to specify whether all commits should be GPG signed.
1006         Use of this option when doing operations such as rebase can
1007         result in a large number of commits being signed. It may be
1008         convenient to use an agent to avoid typing your GPG passphrase
1009         several times.
1011 commit.status::
1012         A boolean to enable/disable inclusion of status information in the
1013         commit message template when using an editor to prepare the commit
1014         message.  Defaults to true.
1016 commit.template::
1017         Specify a file to use as the template for new commit messages.
1018         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1019         specified user's home directory.
1021 credential.helper::
1022         Specify an external helper to be called when a username or
1023         password credential is needed; the helper may consult external
1024         storage to avoid prompting the user for the credentials. See
1025         linkgit:gitcredentials[7] for details.
1027 credential.useHttpPath::
1028         When acquiring credentials, consider the "path" component of an http
1029         or https URL to be important. Defaults to false. See
1030         linkgit:gitcredentials[7] for more information.
1032 credential.username::
1033         If no username is set for a network authentication, use this username
1034         by default. See credential.<context>.* below, and
1035         linkgit:gitcredentials[7].
1037 credential.<url>.*::
1038         Any of the credential.* options above can be applied selectively to
1039         some credentials. For example "credential.https://example.com.username"
1040         would set the default username only for https connections to
1041         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1042         matched.
1044 include::diff-config.txt[]
1046 difftool.<tool>.path::
1047         Override the path for the given tool.  This is useful in case
1048         your tool is not in the PATH.
1050 difftool.<tool>.cmd::
1051         Specify the command to invoke the specified diff tool.
1052         The specified command is evaluated in shell with the following
1053         variables available:  'LOCAL' is set to the name of the temporary
1054         file containing the contents of the diff pre-image and 'REMOTE'
1055         is set to the name of the temporary file containing the contents
1056         of the diff post-image.
1058 difftool.prompt::
1059         Prompt before each invocation of the diff tool.
1061 fetch.recurseSubmodules::
1062         This option can be either set to a boolean value or to 'on-demand'.
1063         Setting it to a boolean changes the behavior of fetch and pull to
1064         unconditionally recurse into submodules when set to true or to not
1065         recurse at all when set to false. When set to 'on-demand' (the default
1066         value), fetch and pull will only recurse into a populated submodule
1067         when its superproject retrieves a commit that updates the submodule's
1068         reference.
1070 fetch.fsckObjects::
1071         If it is set to true, git-fetch-pack will check all fetched
1072         objects. It will abort in the case of a malformed object or a
1073         broken link. The result of an abort are only dangling objects.
1074         Defaults to false. If not set, the value of `transfer.fsckObjects`
1075         is used instead.
1077 fetch.unpackLimit::
1078         If the number of objects fetched over the Git native
1079         transfer is below this
1080         limit, then the objects will be unpacked into loose object
1081         files. However if the number of received objects equals or
1082         exceeds this limit then the received pack will be stored as
1083         a pack, after adding any missing delta bases.  Storing the
1084         pack from a push can make the push operation complete faster,
1085         especially on slow filesystems.  If not set, the value of
1086         `transfer.unpackLimit` is used instead.
1088 fetch.prune::
1089         If true, fetch will automatically behave as if the `--prune`
1090         option was given on the command line.  See also `remote.<name>.prune`.
1092 format.attach::
1093         Enable multipart/mixed attachments as the default for
1094         'format-patch'.  The value can also be a double quoted string
1095         which will enable attachments as the default and set the
1096         value as the boundary.  See the --attach option in
1097         linkgit:git-format-patch[1].
1099 format.numbered::
1100         A boolean which can enable or disable sequence numbers in patch
1101         subjects.  It defaults to "auto" which enables it only if there
1102         is more than one patch.  It can be enabled or disabled for all
1103         messages by setting it to "true" or "false".  See --numbered
1104         option in linkgit:git-format-patch[1].
1106 format.headers::
1107         Additional email headers to include in a patch to be submitted
1108         by mail.  See linkgit:git-format-patch[1].
1110 format.to::
1111 format.cc::
1112         Additional recipients to include in a patch to be submitted
1113         by mail.  See the --to and --cc options in
1114         linkgit:git-format-patch[1].
1116 format.subjectprefix::
1117         The default for format-patch is to output files with the '[PATCH]'
1118         subject prefix. Use this variable to change that prefix.
1120 format.signature::
1121         The default for format-patch is to output a signature containing
1122         the Git version number. Use this variable to change that default.
1123         Set this variable to the empty string ("") to suppress
1124         signature generation.
1126 format.signaturefile::
1127         Works just like format.signature except the contents of the
1128         file specified by this variable will be used as the signature.
1130 format.suffix::
1131         The default for format-patch is to output files with the suffix
1132         `.patch`. Use this variable to change that suffix (make sure to
1133         include the dot if you want it).
1135 format.pretty::
1136         The default pretty format for log/show/whatchanged command,
1137         See linkgit:git-log[1], linkgit:git-show[1],
1138         linkgit:git-whatchanged[1].
1140 format.thread::
1141         The default threading style for 'git format-patch'.  Can be
1142         a boolean value, or `shallow` or `deep`.  `shallow` threading
1143         makes every mail a reply to the head of the series,
1144         where the head is chosen from the cover letter, the
1145         `--in-reply-to`, and the first patch mail, in this order.
1146         `deep` threading makes every mail a reply to the previous one.
1147         A true boolean value is the same as `shallow`, and a false
1148         value disables threading.
1150 format.signoff::
1151         A boolean value which lets you enable the `-s/--signoff` option of
1152         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1153         patch should be a conscious act and means that you certify you have
1154         the rights to submit this work under the same open source license.
1155         Please see the 'SubmittingPatches' document for further discussion.
1157 format.coverLetter::
1158         A boolean that controls whether to generate a cover-letter when
1159         format-patch is invoked, but in addition can be set to "auto", to
1160         generate a cover-letter only when there's more than one patch.
1162 filter.<driver>.clean::
1163         The command which is used to convert the content of a worktree
1164         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1165         details.
1167 filter.<driver>.smudge::
1168         The command which is used to convert the content of a blob
1169         object to a worktree file upon checkout.  See
1170         linkgit:gitattributes[5] for details.
1172 gc.aggressiveDepth::
1173         The depth parameter used in the delta compression
1174         algorithm used by 'git gc --aggressive'.  This defaults
1175         to 250.
1177 gc.aggressiveWindow::
1178         The window size parameter used in the delta compression
1179         algorithm used by 'git gc --aggressive'.  This defaults
1180         to 250.
1182 gc.auto::
1183         When there are approximately more than this many loose
1184         objects in the repository, `git gc --auto` will pack them.
1185         Some Porcelain commands use this command to perform a
1186         light-weight garbage collection from time to time.  The
1187         default value is 6700.  Setting this to 0 disables it.
1189 gc.autopacklimit::
1190         When there are more than this many packs that are not
1191         marked with `*.keep` file in the repository, `git gc
1192         --auto` consolidates them into one larger pack.  The
1193         default value is 50.  Setting this to 0 disables it.
1195 gc.autodetach::
1196         Make `git gc --auto` return immediately andrun in background
1197         if the system supports it. Default is true.
1199 gc.packrefs::
1200         Running `git pack-refs` in a repository renders it
1201         unclonable by Git versions prior to 1.5.1.2 over dumb
1202         transports such as HTTP.  This variable determines whether
1203         'git gc' runs `git pack-refs`. This can be set to `notbare`
1204         to enable it within all non-bare repos or it can be set to a
1205         boolean value.  The default is `true`.
1207 gc.pruneexpire::
1208         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1209         Override the grace period with this config variable.  The value
1210         "now" may be used to disable this  grace period and always prune
1211         unreachable objects immediately.
1213 gc.reflogexpire::
1214 gc.<pattern>.reflogexpire::
1215         'git reflog expire' removes reflog entries older than
1216         this time; defaults to 90 days.  With "<pattern>" (e.g.
1217         "refs/stash") in the middle the setting applies only to
1218         the refs that match the <pattern>.
1220 gc.reflogexpireunreachable::
1221 gc.<ref>.reflogexpireunreachable::
1222         'git reflog expire' removes reflog entries older than
1223         this time and are not reachable from the current tip;
1224         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1225         in the middle, the setting applies only to the refs that
1226         match the <pattern>.
1228 gc.rerereresolved::
1229         Records of conflicted merge you resolved earlier are
1230         kept for this many days when 'git rerere gc' is run.
1231         The default is 60 days.  See linkgit:git-rerere[1].
1233 gc.rerereunresolved::
1234         Records of conflicted merge you have not resolved are
1235         kept for this many days when 'git rerere gc' is run.
1236         The default is 15 days.  See linkgit:git-rerere[1].
1238 gitcvs.commitmsgannotation::
1239         Append this string to each commit message. Set to empty string
1240         to disable this feature. Defaults to "via git-CVS emulator".
1242 gitcvs.enabled::
1243         Whether the CVS server interface is enabled for this repository.
1244         See linkgit:git-cvsserver[1].
1246 gitcvs.logfile::
1247         Path to a log file where the CVS server interface well... logs
1248         various stuff. See linkgit:git-cvsserver[1].
1250 gitcvs.usecrlfattr::
1251         If true, the server will look up the end-of-line conversion
1252         attributes for files to determine the '-k' modes to use. If
1253         the attributes force Git to treat a file as text,
1254         the '-k' mode will be left blank so CVS clients will
1255         treat it as text. If they suppress text conversion, the file
1256         will be set with '-kb' mode, which suppresses any newline munging
1257         the client might otherwise do. If the attributes do not allow
1258         the file type to be determined, then 'gitcvs.allbinary' is
1259         used. See linkgit:gitattributes[5].
1261 gitcvs.allbinary::
1262         This is used if 'gitcvs.usecrlfattr' does not resolve
1263         the correct '-kb' mode to use. If true, all
1264         unresolved files are sent to the client in
1265         mode '-kb'. This causes the client to treat them
1266         as binary files, which suppresses any newline munging it
1267         otherwise might do. Alternatively, if it is set to "guess",
1268         then the contents of the file are examined to decide if
1269         it is binary, similar to 'core.autocrlf'.
1271 gitcvs.dbname::
1272         Database used by git-cvsserver to cache revision information
1273         derived from the Git repository. The exact meaning depends on the
1274         used database driver, for SQLite (which is the default driver) this
1275         is a filename. Supports variable substitution (see
1276         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1277         Default: '%Ggitcvs.%m.sqlite'
1279 gitcvs.dbdriver::
1280         Used Perl DBI driver. You can specify any available driver
1281         for this here, but it might not work. git-cvsserver is tested
1282         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1283         reported *not* to work with 'DBD::mysql'. Experimental feature.
1284         May not contain double colons (`:`). Default: 'SQLite'.
1285         See linkgit:git-cvsserver[1].
1287 gitcvs.dbuser, gitcvs.dbpass::
1288         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1289         since SQLite has no concept of database users and/or passwords.
1290         'gitcvs.dbuser' supports variable substitution (see
1291         linkgit:git-cvsserver[1] for details).
1293 gitcvs.dbTableNamePrefix::
1294         Database table name prefix.  Prepended to the names of any
1295         database tables used, allowing a single database to be used
1296         for several repositories.  Supports variable substitution (see
1297         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1298         characters will be replaced with underscores.
1300 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1301 'gitcvs.allbinary' can also be specified as
1302 'gitcvs.<access_method>.<varname>' (where 'access_method'
1303 is one of "ext" and "pserver") to make them apply only for the given
1304 access method.
1306 gitweb.category::
1307 gitweb.description::
1308 gitweb.owner::
1309 gitweb.url::
1310         See linkgit:gitweb[1] for description.
1312 gitweb.avatar::
1313 gitweb.blame::
1314 gitweb.grep::
1315 gitweb.highlight::
1316 gitweb.patches::
1317 gitweb.pickaxe::
1318 gitweb.remote_heads::
1319 gitweb.showsizes::
1320 gitweb.snapshot::
1321         See linkgit:gitweb.conf[5] for description.
1323 grep.lineNumber::
1324         If set to true, enable '-n' option by default.
1326 grep.patternType::
1327         Set the default matching behavior. Using a value of 'basic', 'extended',
1328         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1329         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1330         value 'default' will return to the default matching behavior.
1332 grep.extendedRegexp::
1333         If set to true, enable '--extended-regexp' option by default. This
1334         option is ignored when the 'grep.patternType' option is set to a value
1335         other than 'default'.
1337 gpg.program::
1338         Use this custom program instead of "gpg" found on $PATH when
1339         making or verifying a PGP signature. The program must support the
1340         same command-line interface as GPG, namely, to verify a detached
1341         signature, "gpg --verify $file - <$signature" is run, and the
1342         program is expected to signal a good signature by exiting with
1343         code 0, and to generate an ascii-armored detached signature, the
1344         standard input of "gpg -bsau $key" is fed with the contents to be
1345         signed, and the program is expected to send the result to its
1346         standard output.
1348 gui.commitmsgwidth::
1349         Defines how wide the commit message window is in the
1350         linkgit:git-gui[1]. "75" is the default.
1352 gui.diffcontext::
1353         Specifies how many context lines should be used in calls to diff
1354         made by the linkgit:git-gui[1]. The default is "5".
1356 gui.displayuntracked::
1357         Determines if linkgit::git-gui[1] shows untracked files
1358         in the file list. The default is "true".
1360 gui.encoding::
1361         Specifies the default encoding to use for displaying of
1362         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1363         It can be overridden by setting the 'encoding' attribute
1364         for relevant files (see linkgit:gitattributes[5]).
1365         If this option is not set, the tools default to the
1366         locale encoding.
1368 gui.matchtrackingbranch::
1369         Determines if new branches created with linkgit:git-gui[1] should
1370         default to tracking remote branches with matching names or
1371         not. Default: "false".
1373 gui.newbranchtemplate::
1374         Is used as suggested name when creating new branches using the
1375         linkgit:git-gui[1].
1377 gui.pruneduringfetch::
1378         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1379         performing a fetch. The default value is "false".
1381 gui.trustmtime::
1382         Determines if linkgit:git-gui[1] should trust the file modification
1383         timestamp or not. By default the timestamps are not trusted.
1385 gui.spellingdictionary::
1386         Specifies the dictionary used for spell checking commit messages in
1387         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1388         off.
1390 gui.fastcopyblame::
1391         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1392         location detection. It makes blame significantly faster on huge
1393         repositories at the expense of less thorough copy detection.
1395 gui.copyblamethreshold::
1396         Specifies the threshold to use in 'git gui blame' original location
1397         detection, measured in alphanumeric characters. See the
1398         linkgit:git-blame[1] manual for more information on copy detection.
1400 gui.blamehistoryctx::
1401         Specifies the radius of history context in days to show in
1402         linkgit:gitk[1] for the selected commit, when the `Show History
1403         Context` menu item is invoked from 'git gui blame'. If this
1404         variable is set to zero, the whole history is shown.
1406 guitool.<name>.cmd::
1407         Specifies the shell command line to execute when the corresponding item
1408         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1409         mandatory for every tool. The command is executed from the root of
1410         the working directory, and in the environment it receives the name of
1411         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1412         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1413         the head is detached, 'CUR_BRANCH' is empty).
1415 guitool.<name>.needsfile::
1416         Run the tool only if a diff is selected in the GUI. It guarantees
1417         that 'FILENAME' is not empty.
1419 guitool.<name>.noconsole::
1420         Run the command silently, without creating a window to display its
1421         output.
1423 guitool.<name>.norescan::
1424         Don't rescan the working directory for changes after the tool
1425         finishes execution.
1427 guitool.<name>.confirm::
1428         Show a confirmation dialog before actually running the tool.
1430 guitool.<name>.argprompt::
1431         Request a string argument from the user, and pass it to the tool
1432         through the 'ARGS' environment variable. Since requesting an
1433         argument implies confirmation, the 'confirm' option has no effect
1434         if this is enabled. If the option is set to 'true', 'yes', or '1',
1435         the dialog uses a built-in generic prompt; otherwise the exact
1436         value of the variable is used.
1438 guitool.<name>.revprompt::
1439         Request a single valid revision from the user, and set the
1440         'REVISION' environment variable. In other aspects this option
1441         is similar to 'argprompt', and can be used together with it.
1443 guitool.<name>.revunmerged::
1444         Show only unmerged branches in the 'revprompt' subdialog.
1445         This is useful for tools similar to merge or rebase, but not
1446         for things like checkout or reset.
1448 guitool.<name>.title::
1449         Specifies the title to use for the prompt dialog. The default
1450         is the tool name.
1452 guitool.<name>.prompt::
1453         Specifies the general prompt string to display at the top of
1454         the dialog, before subsections for 'argprompt' and 'revprompt'.
1455         The default value includes the actual command.
1457 help.browser::
1458         Specify the browser that will be used to display help in the
1459         'web' format. See linkgit:git-help[1].
1461 help.format::
1462         Override the default help format used by linkgit:git-help[1].
1463         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1464         the default. 'web' and 'html' are the same.
1466 help.autocorrect::
1467         Automatically correct and execute mistyped commands after
1468         waiting for the given number of deciseconds (0.1 sec). If more
1469         than one command can be deduced from the entered text, nothing
1470         will be executed.  If the value of this option is negative,
1471         the corrected command will be executed immediately. If the
1472         value is 0 - the command will be just shown but not executed.
1473         This is the default.
1475 help.htmlpath::
1476         Specify the path where the HTML documentation resides. File system paths
1477         and URLs are supported. HTML pages will be prefixed with this path when
1478         help is displayed in the 'web' format. This defaults to the documentation
1479         path of your Git installation.
1481 http.proxy::
1482         Override the HTTP proxy, normally configured using the 'http_proxy',
1483         'https_proxy', and 'all_proxy' environment variables (see
1484         `curl(1)`).  This can be overridden on a per-remote basis; see
1485         remote.<name>.proxy
1487 http.cookiefile::
1488         File containing previously stored cookie lines which should be used
1489         in the Git http session, if they match the server. The file format
1490         of the file to read cookies from should be plain HTTP headers or
1491         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1492         NOTE that the file specified with http.cookiefile is only used as
1493         input unless http.saveCookies is set.
1495 http.savecookies::
1496         If set, store cookies received during requests to the file specified by
1497         http.cookiefile. Has no effect if http.cookiefile is unset.
1499 http.sslVerify::
1500         Whether to verify the SSL certificate when fetching or pushing
1501         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1502         variable.
1504 http.sslCert::
1505         File containing the SSL certificate when fetching or pushing
1506         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1507         variable.
1509 http.sslKey::
1510         File containing the SSL private key when fetching or pushing
1511         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1512         variable.
1514 http.sslCertPasswordProtected::
1515         Enable Git's password prompt for the SSL certificate.  Otherwise
1516         OpenSSL will prompt the user, possibly many times, if the
1517         certificate or private key is encrypted.  Can be overridden by the
1518         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1520 http.sslCAInfo::
1521         File containing the certificates to verify the peer with when
1522         fetching or pushing over HTTPS. Can be overridden by the
1523         'GIT_SSL_CAINFO' environment variable.
1525 http.sslCAPath::
1526         Path containing files with the CA certificates to verify the peer
1527         with when fetching or pushing over HTTPS. Can be overridden
1528         by the 'GIT_SSL_CAPATH' environment variable.
1530 http.sslTry::
1531         Attempt to use AUTH SSL/TLS and encrypted data transfers
1532         when connecting via regular FTP protocol. This might be needed
1533         if the FTP server requires it for security reasons or you wish
1534         to connect securely whenever remote FTP server supports it.
1535         Default is false since it might trigger certificate verification
1536         errors on misconfigured servers.
1538 http.maxRequests::
1539         How many HTTP requests to launch in parallel. Can be overridden
1540         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1542 http.minSessions::
1543         The number of curl sessions (counted across slots) to be kept across
1544         requests. They will not be ended with curl_easy_cleanup() until
1545         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1546         value will be capped at 1. Defaults to 1.
1548 http.postBuffer::
1549         Maximum size in bytes of the buffer used by smart HTTP
1550         transports when POSTing data to the remote system.
1551         For requests larger than this buffer size, HTTP/1.1 and
1552         Transfer-Encoding: chunked is used to avoid creating a
1553         massive pack file locally.  Default is 1 MiB, which is
1554         sufficient for most requests.
1556 http.lowSpeedLimit, http.lowSpeedTime::
1557         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1558         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1559         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1560         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1562 http.noEPSV::
1563         A boolean which disables using of EPSV ftp command by curl.
1564         This can helpful with some "poor" ftp servers which don't
1565         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1566         environment variable. Default is false (curl will use EPSV).
1568 http.useragent::
1569         The HTTP USER_AGENT string presented to an HTTP server.  The default
1570         value represents the version of the client Git such as git/1.7.1.
1571         This option allows you to override this value to a more common value
1572         such as Mozilla/4.0.  This may be necessary, for instance, if
1573         connecting through a firewall that restricts HTTP connections to a set
1574         of common USER_AGENT strings (but not including those like git/1.7.1).
1575         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1577 http.<url>.*::
1578         Any of the http.* options above can be applied selectively to some urls.
1579         For a config key to match a URL, each element of the config key is
1580         compared to that of the URL, in the following order:
1583 . Scheme (e.g., `https` in `https://example.com/`). This field
1584   must match exactly between the config key and the URL.
1586 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1587   This field must match exactly between the config key and the URL.
1589 . Port number (e.g., `8080` in `http://example.com:8080/`).
1590   This field must match exactly between the config key and the URL.
1591   Omitted port numbers are automatically converted to the correct
1592   default for the scheme before matching.
1594 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1595   path field of the config key must match the path field of the URL
1596   either exactly or as a prefix of slash-delimited path elements.  This means
1597   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1598   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1599   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1600   key with just path `foo/`).
1602 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1603   the config key has a user name it must match the user name in the
1604   URL exactly. If the config key does not have a user name, that
1605   config key will match a URL with any user name (including none),
1606   but at a lower precedence than a config key with a user name.
1609 The list above is ordered by decreasing precedence; a URL that matches
1610 a config key's path is preferred to one that matches its user name. For example,
1611 if the URL is `https://user@example.com/foo/bar` a config key match of
1612 `https://example.com/foo` will be preferred over a config key match of
1613 `https://user@example.com`.
1615 All URLs are normalized before attempting any matching (the password part,
1616 if embedded in the URL, is always ignored for matching purposes) so that
1617 equivalent urls that are simply spelled differently will match properly.
1618 Environment variable settings always override any matches.  The urls that are
1619 matched against are those given directly to Git commands.  This means any URLs
1620 visited as a result of a redirection do not participate in matching.
1622 i18n.commitEncoding::
1623         Character encoding the commit messages are stored in; Git itself
1624         does not care per se, but this information is necessary e.g. when
1625         importing commits from emails or in the gitk graphical history
1626         browser (and possibly at other places in the future or in other
1627         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1629 i18n.logOutputEncoding::
1630         Character encoding the commit messages are converted to when
1631         running 'git log' and friends.
1633 imap::
1634         The configuration variables in the 'imap' section are described
1635         in linkgit:git-imap-send[1].
1637 index.version::
1638         Specify the version with which new index files should be
1639         initialized.  This does not affect existing repositories.
1641 init.templatedir::
1642         Specify the directory from which templates will be copied.
1643         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1645 instaweb.browser::
1646         Specify the program that will be used to browse your working
1647         repository in gitweb. See linkgit:git-instaweb[1].
1649 instaweb.httpd::
1650         The HTTP daemon command-line to start gitweb on your working
1651         repository. See linkgit:git-instaweb[1].
1653 instaweb.local::
1654         If true the web server started by linkgit:git-instaweb[1] will
1655         be bound to the local IP (127.0.0.1).
1657 instaweb.modulepath::
1658         The default module path for linkgit:git-instaweb[1] to use
1659         instead of /usr/lib/apache2/modules.  Only used if httpd
1660         is Apache.
1662 instaweb.port::
1663         The port number to bind the gitweb httpd to. See
1664         linkgit:git-instaweb[1].
1666 interactive.singlekey::
1667         In interactive commands, allow the user to provide one-letter
1668         input with a single key (i.e., without hitting enter).
1669         Currently this is used by the `--patch` mode of
1670         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1671         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1672         setting is silently ignored if portable keystroke input
1673         is not available; requires the Perl module Term::ReadKey.
1675 log.abbrevCommit::
1676         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1677         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1678         override this option with `--no-abbrev-commit`.
1680 log.date::
1681         Set the default date-time mode for the 'log' command.
1682         Setting a value for log.date is similar to using 'git log''s
1683         `--date` option.  Possible values are `relative`, `local`,
1684         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1685         for details.
1687 log.decorate::
1688         Print out the ref names of any commits that are shown by the log
1689         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1690         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1691         specified, the full ref name (including prefix) will be printed.
1692         This is the same as the log commands '--decorate' option.
1694 log.showroot::
1695         If true, the initial commit will be shown as a big creation event.
1696         This is equivalent to a diff against an empty tree.
1697         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1698         normally hide the root commit will now show it. True by default.
1700 log.mailmap::
1701         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1702         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1704 mailmap.file::
1705         The location of an augmenting mailmap file. The default
1706         mailmap, located in the root of the repository, is loaded
1707         first, then the mailmap file pointed to by this variable.
1708         The location of the mailmap file may be in a repository
1709         subdirectory, or somewhere outside of the repository itself.
1710         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1712 mailmap.blob::
1713         Like `mailmap.file`, but consider the value as a reference to a
1714         blob in the repository. If both `mailmap.file` and
1715         `mailmap.blob` are given, both are parsed, with entries from
1716         `mailmap.file` taking precedence. In a bare repository, this
1717         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1718         defaults to empty.
1720 man.viewer::
1721         Specify the programs that may be used to display help in the
1722         'man' format. See linkgit:git-help[1].
1724 man.<tool>.cmd::
1725         Specify the command to invoke the specified man viewer. The
1726         specified command is evaluated in shell with the man page
1727         passed as argument. (See linkgit:git-help[1].)
1729 man.<tool>.path::
1730         Override the path for the given tool that may be used to
1731         display help in the 'man' format. See linkgit:git-help[1].
1733 include::merge-config.txt[]
1735 mergetool.<tool>.path::
1736         Override the path for the given tool.  This is useful in case
1737         your tool is not in the PATH.
1739 mergetool.<tool>.cmd::
1740         Specify the command to invoke the specified merge tool.  The
1741         specified command is evaluated in shell with the following
1742         variables available: 'BASE' is the name of a temporary file
1743         containing the common base of the files to be merged, if available;
1744         'LOCAL' is the name of a temporary file containing the contents of
1745         the file on the current branch; 'REMOTE' is the name of a temporary
1746         file containing the contents of the file from the branch being
1747         merged; 'MERGED' contains the name of the file to which the merge
1748         tool should write the results of a successful merge.
1750 mergetool.<tool>.trustExitCode::
1751         For a custom merge command, specify whether the exit code of
1752         the merge command can be used to determine whether the merge was
1753         successful.  If this is not set to true then the merge target file
1754         timestamp is checked and the merge assumed to have been successful
1755         if the file has been updated, otherwise the user is prompted to
1756         indicate the success of the merge.
1758 mergetool.meld.hasOutput::
1759         Older versions of `meld` do not support the `--output` option.
1760         Git will attempt to detect whether `meld` supports `--output`
1761         by inspecting the output of `meld --help`.  Configuring
1762         `mergetool.meld.hasOutput` will make Git skip these checks and
1763         use the configured value instead.  Setting `mergetool.meld.hasOutput`
1764         to `true` tells Git to unconditionally use the `--output` option,
1765         and `false` avoids using `--output`.
1767 mergetool.keepBackup::
1768         After performing a merge, the original file with conflict markers
1769         can be saved as a file with a `.orig` extension.  If this variable
1770         is set to `false` then this file is not preserved.  Defaults to
1771         `true` (i.e. keep the backup files).
1773 mergetool.keepTemporaries::
1774         When invoking a custom merge tool, Git uses a set of temporary
1775         files to pass to the tool. If the tool returns an error and this
1776         variable is set to `true`, then these temporary files will be
1777         preserved, otherwise they will be removed after the tool has
1778         exited. Defaults to `false`.
1780 mergetool.writeToTemp::
1781         Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1782         conflicting files in the worktree by default.  Git will attempt
1783         to use a temporary directory for these files when set `true`.
1784         Defaults to `false`.
1786 mergetool.prompt::
1787         Prompt before each invocation of the merge resolution program.
1789 notes.displayRef::
1790         The (fully qualified) refname from which to show notes when
1791         showing commit messages.  The value of this variable can be set
1792         to a glob, in which case notes from all matching refs will be
1793         shown.  You may also specify this configuration variable
1794         several times.  A warning will be issued for refs that do not
1795         exist, but a glob that does not match any refs is silently
1796         ignored.
1798 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1799 environment variable, which must be a colon separated list of refs or
1800 globs.
1802 The effective value of "core.notesRef" (possibly overridden by
1803 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1804 displayed.
1806 notes.rewrite.<command>::
1807         When rewriting commits with <command> (currently `amend` or
1808         `rebase`) and this variable is set to `true`, Git
1809         automatically copies your notes from the original to the
1810         rewritten commit.  Defaults to `true`, but see
1811         "notes.rewriteRef" below.
1813 notes.rewriteMode::
1814         When copying notes during a rewrite (see the
1815         "notes.rewrite.<command>" option), determines what to do if
1816         the target commit already has a note.  Must be one of
1817         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1818         `concatenate`.
1820 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1821 environment variable.
1823 notes.rewriteRef::
1824         When copying notes during a rewrite, specifies the (fully
1825         qualified) ref whose notes should be copied.  The ref may be a
1826         glob, in which case notes in all matching refs will be copied.
1827         You may also specify this configuration several times.
1829 Does not have a default value; you must configure this variable to
1830 enable note rewriting.  Set it to `refs/notes/commits` to enable
1831 rewriting for the default commit notes.
1833 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1834 environment variable, which must be a colon separated list of refs or
1835 globs.
1837 pack.window::
1838         The size of the window used by linkgit:git-pack-objects[1] when no
1839         window size is given on the command line. Defaults to 10.
1841 pack.depth::
1842         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1843         maximum depth is given on the command line. Defaults to 50.
1845 pack.windowMemory::
1846         The window memory size limit used by linkgit:git-pack-objects[1]
1847         when no limit is given on the command line.  The value can be
1848         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1849         limit.
1851 pack.compression::
1852         An integer -1..9, indicating the compression level for objects
1853         in a pack file. -1 is the zlib default. 0 means no
1854         compression, and 1..9 are various speed/size tradeoffs, 9 being
1855         slowest.  If not set,  defaults to core.compression.  If that is
1856         not set,  defaults to -1, the zlib default, which is "a default
1857         compromise between speed and compression (currently equivalent
1858         to level 6)."
1860 Note that changing the compression level will not automatically recompress
1861 all existing objects. You can force recompression by passing the -F option
1862 to linkgit:git-repack[1].
1864 pack.deltaCacheSize::
1865         The maximum memory in bytes used for caching deltas in
1866         linkgit:git-pack-objects[1] before writing them out to a pack.
1867         This cache is used to speed up the writing object phase by not
1868         having to recompute the final delta result once the best match
1869         for all objects is found.  Repacking large repositories on machines
1870         which are tight with memory might be badly impacted by this though,
1871         especially if this cache pushes the system into swapping.
1872         A value of 0 means no limit. The smallest size of 1 byte may be
1873         used to virtually disable this cache. Defaults to 256 MiB.
1875 pack.deltaCacheLimit::
1876         The maximum size of a delta, that is cached in
1877         linkgit:git-pack-objects[1]. This cache is used to speed up the
1878         writing object phase by not having to recompute the final delta
1879         result once the best match for all objects is found. Defaults to 1000.
1881 pack.threads::
1882         Specifies the number of threads to spawn when searching for best
1883         delta matches.  This requires that linkgit:git-pack-objects[1]
1884         be compiled with pthreads otherwise this option is ignored with a
1885         warning. This is meant to reduce packing time on multiprocessor
1886         machines. The required amount of memory for the delta search window
1887         is however multiplied by the number of threads.
1888         Specifying 0 will cause Git to auto-detect the number of CPU's
1889         and set the number of threads accordingly.
1891 pack.indexVersion::
1892         Specify the default pack index version.  Valid values are 1 for
1893         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1894         the new pack index with capabilities for packs larger than 4 GB
1895         as well as proper protection against the repacking of corrupted
1896         packs.  Version 2 is the default.  Note that version 2 is enforced
1897         and this config option ignored whenever the corresponding pack is
1898         larger than 2 GB.
1900 If you have an old Git that does not understand the version 2 `*.idx` file,
1901 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1902 that will copy both `*.pack` file and corresponding `*.idx` file from the
1903 other side may give you a repository that cannot be accessed with your
1904 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1905 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1906 the `*.idx` file.
1908 pack.packSizeLimit::
1909         The maximum size of a pack.  This setting only affects
1910         packing to a file when repacking, i.e. the git:// protocol
1911         is unaffected.  It can be overridden by the `--max-pack-size`
1912         option of linkgit:git-repack[1]. The minimum size allowed is
1913         limited to 1 MiB. The default is unlimited.
1914         Common unit suffixes of 'k', 'm', or 'g' are
1915         supported.
1917 pack.useBitmaps::
1918         When true, git will use pack bitmaps (if available) when packing
1919         to stdout (e.g., during the server side of a fetch). Defaults to
1920         true. You should not generally need to turn this off unless
1921         you are debugging pack bitmaps.
1923 pack.writebitmaps::
1924         This is a deprecated synonym for `repack.writeBitmaps`.
1926 pack.writeBitmapHashCache::
1927         When true, git will include a "hash cache" section in the bitmap
1928         index (if one is written). This cache can be used to feed git's
1929         delta heuristics, potentially leading to better deltas between
1930         bitmapped and non-bitmapped objects (e.g., when serving a fetch
1931         between an older, bitmapped pack and objects that have been
1932         pushed since the last gc). The downside is that it consumes 4
1933         bytes per object of disk space, and that JGit's bitmap
1934         implementation does not understand it, causing it to complain if
1935         Git and JGit are used on the same repository. Defaults to false.
1937 pager.<cmd>::
1938         If the value is boolean, turns on or off pagination of the
1939         output of a particular Git subcommand when writing to a tty.
1940         Otherwise, turns on pagination for the subcommand using the
1941         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1942         or `--no-pager` is specified on the command line, it takes
1943         precedence over this option.  To disable pagination for all
1944         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1946 pretty.<name>::
1947         Alias for a --pretty= format string, as specified in
1948         linkgit:git-log[1]. Any aliases defined here can be used just
1949         as the built-in pretty formats could. For example,
1950         running `git config pretty.changelog "format:* %H %s"`
1951         would cause the invocation `git log --pretty=changelog`
1952         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1953         Note that an alias with the same name as a built-in format
1954         will be silently ignored.
1956 pull.ff::
1957         By default, Git does not create an extra merge commit when merging
1958         a commit that is a descendant of the current commit. Instead, the
1959         tip of the current branch is fast-forwarded. When set to `false`,
1960         this variable tells Git to create an extra merge commit in such
1961         a case (equivalent to giving the `--no-ff` option from the command
1962         line). When set to `only`, only such fast-forward merges are
1963         allowed (equivalent to giving the `--ff-only` option from the
1964         command line).
1966 pull.rebase::
1967         When true, rebase branches on top of the fetched branch, instead
1968         of merging the default branch from the default remote when "git
1969         pull" is run. See "branch.<name>.rebase" for setting this on a
1970         per-branch basis.
1972         When preserve, also pass `--preserve-merges` along to 'git rebase'
1973         so that locally committed merge commits will not be flattened
1974         by running 'git pull'.
1976 *NOTE*: this is a possibly dangerous operation; do *not* use
1977 it unless you understand the implications (see linkgit:git-rebase[1]
1978 for details).
1980 pull.octopus::
1981         The default merge strategy to use when pulling multiple branches
1982         at once.
1984 pull.twohead::
1985         The default merge strategy to use when pulling a single branch.
1987 push.default::
1988         Defines the action `git push` should take if no refspec is
1989         explicitly given.  Different values are well-suited for
1990         specific workflows; for instance, in a purely central workflow
1991         (i.e. the fetch source is equal to the push destination),
1992         `upstream` is probably what you want.  Possible values are:
1996 * `nothing` - do not push anything (error out) unless a refspec is
1997   explicitly given. This is primarily meant for people who want to
1998   avoid mistakes by always being explicit.
2000 * `current` - push the current branch to update a branch with the same
2001   name on the receiving end.  Works in both central and non-central
2002   workflows.
2004 * `upstream` - push the current branch back to the branch whose
2005   changes are usually integrated into the current branch (which is
2006   called `@{upstream}`).  This mode only makes sense if you are
2007   pushing to the same repository you would normally pull from
2008   (i.e. central workflow).
2010 * `simple` - in centralized workflow, work like `upstream` with an
2011   added safety to refuse to push if the upstream branch's name is
2012   different from the local one.
2014 When pushing to a remote that is different from the remote you normally
2015 pull from, work as `current`.  This is the safest option and is suited
2016 for beginners.
2018 This mode has become the default in Git 2.0.
2020 * `matching` - push all branches having the same name on both ends.
2021   This makes the repository you are pushing to remember the set of
2022   branches that will be pushed out (e.g. if you always push 'maint'
2023   and 'master' there and no other branches, the repository you push
2024   to will have these two branches, and your local 'maint' and
2025   'master' will be pushed there).
2027 To use this mode effectively, you have to make sure _all_ the
2028 branches you would push out are ready to be pushed out before
2029 running 'git push', as the whole point of this mode is to allow you
2030 to push all of the branches in one go.  If you usually finish work
2031 on only one branch and push out the result, while other branches are
2032 unfinished, this mode is not for you.  Also this mode is not
2033 suitable for pushing into a shared central repository, as other
2034 people may add new branches there, or update the tip of existing
2035 branches outside your control.
2037 This used to be the default, but not since Git 2.0 (`simple` is the
2038 new default).
2042 rebase.stat::
2043         Whether to show a diffstat of what changed upstream since the last
2044         rebase. False by default.
2046 rebase.autosquash::
2047         If set to true enable '--autosquash' option by default.
2049 rebase.autostash::
2050         When set to true, automatically create a temporary stash
2051         before the operation begins, and apply it after the operation
2052         ends.  This means that you can run rebase on a dirty worktree.
2053         However, use with care: the final stash application after a
2054         successful rebase might result in non-trivial conflicts.
2055         Defaults to false.
2057 receive.autogc::
2058         By default, git-receive-pack will run "git-gc --auto" after
2059         receiving data from git-push and updating refs.  You can stop
2060         it by setting this variable to false.
2062 receive.certnonceseed::
2063         By setting this variable to a string, `git receive-pack`
2064         will accept a `git push --signed` and verifies it by using
2065         a "nonce" protected by HMAC using this string as a secret
2066         key.
2068 receive.certnonceslop::
2069         When a `git push --signed` sent a push certificate with a
2070         "nonce" that was issued by a receive-pack serving the same
2071         repository within this many seconds, export the "nonce"
2072         found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2073         hooks (instead of what the receive-pack asked the sending
2074         side to include).  This may allow writing checks in
2075         `pre-receive` and `post-receive` a bit easier.  Instead of
2076         checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2077         that records by how many seconds the nonce is stale to
2078         decide if they want to accept the certificate, they only
2079         can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2081 receive.fsckObjects::
2082         If it is set to true, git-receive-pack will check all received
2083         objects. It will abort in the case of a malformed object or a
2084         broken link. The result of an abort are only dangling objects.
2085         Defaults to false. If not set, the value of `transfer.fsckObjects`
2086         is used instead.
2088 receive.unpackLimit::
2089         If the number of objects received in a push is below this
2090         limit then the objects will be unpacked into loose object
2091         files. However if the number of received objects equals or
2092         exceeds this limit then the received pack will be stored as
2093         a pack, after adding any missing delta bases.  Storing the
2094         pack from a push can make the push operation complete faster,
2095         especially on slow filesystems.  If not set, the value of
2096         `transfer.unpackLimit` is used instead.
2098 receive.denyDeletes::
2099         If set to true, git-receive-pack will deny a ref update that deletes
2100         the ref. Use this to prevent such a ref deletion via a push.
2102 receive.denyDeleteCurrent::
2103         If set to true, git-receive-pack will deny a ref update that
2104         deletes the currently checked out branch of a non-bare repository.
2106 receive.denyCurrentBranch::
2107         If set to true or "refuse", git-receive-pack will deny a ref update
2108         to the currently checked out branch of a non-bare repository.
2109         Such a push is potentially dangerous because it brings the HEAD
2110         out of sync with the index and working tree. If set to "warn",
2111         print a warning of such a push to stderr, but allow the push to
2112         proceed. If set to false or "ignore", allow such pushes with no
2113         message. Defaults to "refuse".
2115 receive.denyNonFastForwards::
2116         If set to true, git-receive-pack will deny a ref update which is
2117         not a fast-forward. Use this to prevent such an update via a push,
2118         even if that push is forced. This configuration variable is
2119         set when initializing a shared repository.
2121 receive.hiderefs::
2122         String(s) `receive-pack` uses to decide which refs to omit
2123         from its initial advertisement.  Use more than one
2124         definitions to specify multiple prefix strings. A ref that
2125         are under the hierarchies listed on the value of this
2126         variable is excluded, and is hidden when responding to `git
2127         push`, and an attempt to update or delete a hidden ref by
2128         `git push` is rejected.
2130 receive.updateserverinfo::
2131         If set to true, git-receive-pack will run git-update-server-info
2132         after receiving data from git-push and updating refs.
2134 receive.shallowupdate::
2135         If set to true, .git/shallow can be updated when new refs
2136         require new shallow roots. Otherwise those refs are rejected.
2138 remote.pushdefault::
2139         The remote to push to by default.  Overrides
2140         `branch.<name>.remote` for all branches, and is overridden by
2141         `branch.<name>.pushremote` for specific branches.
2143 remote.<name>.url::
2144         The URL of a remote repository.  See linkgit:git-fetch[1] or
2145         linkgit:git-push[1].
2147 remote.<name>.pushurl::
2148         The push URL of a remote repository.  See linkgit:git-push[1].
2150 remote.<name>.proxy::
2151         For remotes that require curl (http, https and ftp), the URL to
2152         the proxy to use for that remote.  Set to the empty string to
2153         disable proxying for that remote.
2155 remote.<name>.fetch::
2156         The default set of "refspec" for linkgit:git-fetch[1]. See
2157         linkgit:git-fetch[1].
2159 remote.<name>.push::
2160         The default set of "refspec" for linkgit:git-push[1]. See
2161         linkgit:git-push[1].
2163 remote.<name>.mirror::
2164         If true, pushing to this remote will automatically behave
2165         as if the `--mirror` option was given on the command line.
2167 remote.<name>.skipDefaultUpdate::
2168         If true, this remote will be skipped by default when updating
2169         using linkgit:git-fetch[1] or the `update` subcommand of
2170         linkgit:git-remote[1].
2172 remote.<name>.skipFetchAll::
2173         If true, this remote will be skipped by default when updating
2174         using linkgit:git-fetch[1] or the `update` subcommand of
2175         linkgit:git-remote[1].
2177 remote.<name>.receivepack::
2178         The default program to execute on the remote side when pushing.  See
2179         option \--receive-pack of linkgit:git-push[1].
2181 remote.<name>.uploadpack::
2182         The default program to execute on the remote side when fetching.  See
2183         option \--upload-pack of linkgit:git-fetch-pack[1].
2185 remote.<name>.tagopt::
2186         Setting this value to \--no-tags disables automatic tag following when
2187         fetching from remote <name>. Setting it to \--tags will fetch every
2188         tag from remote <name>, even if they are not reachable from remote
2189         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2190         override this setting. See options \--tags and \--no-tags of
2191         linkgit:git-fetch[1].
2193 remote.<name>.vcs::
2194         Setting this to a value <vcs> will cause Git to interact with
2195         the remote with the git-remote-<vcs> helper.
2197 remote.<name>.prune::
2198         When set to true, fetching from this remote by default will also
2199         remove any remote-tracking references that no longer exist on the
2200         remote (as if the `--prune` option was given on the command line).
2201         Overrides `fetch.prune` settings, if any.
2203 remotes.<group>::
2204         The list of remotes which are fetched by "git remote update
2205         <group>".  See linkgit:git-remote[1].
2207 repack.usedeltabaseoffset::
2208         By default, linkgit:git-repack[1] creates packs that use
2209         delta-base offset. If you need to share your repository with
2210         Git older than version 1.4.4, either directly or via a dumb
2211         protocol such as http, then you need to set this option to
2212         "false" and repack. Access from old Git versions over the
2213         native protocol are unaffected by this option.
2215 repack.packKeptObjects::
2216         If set to true, makes `git repack` act as if
2217         `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2218         details. Defaults to `false` normally, but `true` if a bitmap
2219         index is being written (either via `--write-bitmap-index` or
2220         `repack.writeBitmaps`).
2222 repack.writeBitmaps::
2223         When true, git will write a bitmap index when packing all
2224         objects to disk (e.g., when `git repack -a` is run).  This
2225         index can speed up the "counting objects" phase of subsequent
2226         packs created for clones and fetches, at the cost of some disk
2227         space and extra time spent on the initial repack.  Defaults to
2228         false.
2230 rerere.autoupdate::
2231         When set to true, `git-rerere` updates the index with the
2232         resulting contents after it cleanly resolves conflicts using
2233         previously recorded resolution.  Defaults to false.
2235 rerere.enabled::
2236         Activate recording of resolved conflicts, so that identical
2237         conflict hunks can be resolved automatically, should they be
2238         encountered again.  By default, linkgit:git-rerere[1] is
2239         enabled if there is an `rr-cache` directory under the
2240         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2241         repository.
2243 sendemail.identity::
2244         A configuration identity. When given, causes values in the
2245         'sendemail.<identity>' subsection to take precedence over
2246         values in the 'sendemail' section. The default identity is
2247         the value of 'sendemail.identity'.
2249 sendemail.smtpencryption::
2250         See linkgit:git-send-email[1] for description.  Note that this
2251         setting is not subject to the 'identity' mechanism.
2253 sendemail.smtpssl::
2254         Deprecated alias for 'sendemail.smtpencryption = ssl'.
2256 sendemail.smtpsslcertpath::
2257         Path to ca-certificates (either a directory or a single file).
2258         Set it to an empty string to disable certificate verification.
2260 sendemail.<identity>.*::
2261         Identity-specific versions of the 'sendemail.*' parameters
2262         found below, taking precedence over those when the this
2263         identity is selected, through command-line or
2264         'sendemail.identity'.
2266 sendemail.aliasesfile::
2267 sendemail.aliasfiletype::
2268 sendemail.annotate::
2269 sendemail.bcc::
2270 sendemail.cc::
2271 sendemail.cccmd::
2272 sendemail.chainreplyto::
2273 sendemail.confirm::
2274 sendemail.envelopesender::
2275 sendemail.from::
2276 sendemail.multiedit::
2277 sendemail.signedoffbycc::
2278 sendemail.smtppass::
2279 sendemail.suppresscc::
2280 sendemail.suppressfrom::
2281 sendemail.to::
2282 sendemail.smtpdomain::
2283 sendemail.smtpserver::
2284 sendemail.smtpserverport::
2285 sendemail.smtpserveroption::
2286 sendemail.smtpuser::
2287 sendemail.thread::
2288 sendemail.validate::
2289         See linkgit:git-send-email[1] for description.
2291 sendemail.signedoffcc::
2292         Deprecated alias for 'sendemail.signedoffbycc'.
2294 showbranch.default::
2295         The default set of branches for linkgit:git-show-branch[1].
2296         See linkgit:git-show-branch[1].
2298 status.relativePaths::
2299         By default, linkgit:git-status[1] shows paths relative to the
2300         current directory. Setting this variable to `false` shows paths
2301         relative to the repository root (this was the default for Git
2302         prior to v1.5.4).
2304 status.short::
2305         Set to true to enable --short by default in linkgit:git-status[1].
2306         The option --no-short takes precedence over this variable.
2308 status.branch::
2309         Set to true to enable --branch by default in linkgit:git-status[1].
2310         The option --no-branch takes precedence over this variable.
2312 status.displayCommentPrefix::
2313         If set to true, linkgit:git-status[1] will insert a comment
2314         prefix before each output line (starting with
2315         `core.commentChar`, i.e. `#` by default). This was the
2316         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2317         Defaults to false.
2319 status.showUntrackedFiles::
2320         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2321         files which are not currently tracked by Git. Directories which
2322         contain only untracked files, are shown with the directory name
2323         only. Showing untracked files means that Git needs to lstat() all
2324         all the files in the whole repository, which might be slow on some
2325         systems. So, this variable controls how the commands displays
2326         the untracked files. Possible values are:
2329 * `no` - Show no untracked files.
2330 * `normal` - Show untracked files and directories.
2331 * `all` - Show also individual files in untracked directories.
2334 If this variable is not specified, it defaults to 'normal'.
2335 This variable can be overridden with the -u|--untracked-files option
2336 of linkgit:git-status[1] and linkgit:git-commit[1].
2338 status.submodulesummary::
2339         Defaults to false.
2340         If this is set to a non zero number or true (identical to -1 or an
2341         unlimited number), the submodule summary will be enabled and a
2342         summary of commits for modified submodules will be shown (see
2343         --summary-limit option of linkgit:git-submodule[1]). Please note
2344         that the summary output command will be suppressed for all
2345         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2346         for those submodules where `submodule.<name>.ignore=all`. The only
2347         exception to that rule is that status and commit will show staged
2348         submodule changes. To
2349         also view the summary for ignored submodules you can either use
2350         the --ignore-submodules=dirty command-line option or the 'git
2351         submodule summary' command, which shows a similar output but does
2352         not honor these settings.
2354 submodule.<name>.path::
2355 submodule.<name>.url::
2356 submodule.<name>.update::
2357         The path within this project, URL, and the updating strategy
2358         for a submodule.  These variables are initially populated
2359         by 'git submodule init'; edit them to override the
2360         URL and other values found in the `.gitmodules` file.  See
2361         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2363 submodule.<name>.branch::
2364         The remote branch name for a submodule, used by `git submodule
2365         update --remote`.  Set this option to override the value found in
2366         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2367         linkgit:gitmodules[5] for details.
2369 submodule.<name>.fetchRecurseSubmodules::
2370         This option can be used to control recursive fetching of this
2371         submodule. It can be overridden by using the --[no-]recurse-submodules
2372         command-line option to "git fetch" and "git pull".
2373         This setting will override that from in the linkgit:gitmodules[5]
2374         file.
2376 submodule.<name>.ignore::
2377         Defines under what circumstances "git status" and the diff family show
2378         a submodule as modified. When set to "all", it will never be considered
2379         modified (but it will nonetheless show up in the output of status and
2380         commit when it has been staged), "dirty" will ignore all changes
2381         to the submodules work tree and
2382         takes only differences between the HEAD of the submodule and the commit
2383         recorded in the superproject into account. "untracked" will additionally
2384         let submodules with modified tracked files in their work tree show up.
2385         Using "none" (the default when this option is not set) also shows
2386         submodules that have untracked files in their work tree as changed.
2387         This setting overrides any setting made in .gitmodules for this submodule,
2388         both settings can be overridden on the command line by using the
2389         "--ignore-submodules" option. The 'git submodule' commands are not
2390         affected by this setting.
2392 tag.sort::
2393         This variable controls the sort ordering of tags when displayed by
2394         linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2395         value of this variable will be used as the default.
2397 tar.umask::
2398         This variable can be used to restrict the permission bits of
2399         tar archive entries.  The default is 0002, which turns off the
2400         world write bit.  The special value "user" indicates that the
2401         archiving user's umask will be used instead.  See umask(2) and
2402         linkgit:git-archive[1].
2404 transfer.fsckObjects::
2405         When `fetch.fsckObjects` or `receive.fsckObjects` are
2406         not set, the value of this variable is used instead.
2407         Defaults to false.
2409 transfer.hiderefs::
2410         This variable can be used to set both `receive.hiderefs`
2411         and `uploadpack.hiderefs` at the same time to the same
2412         values.  See entries for these other variables.
2414 transfer.unpackLimit::
2415         When `fetch.unpackLimit` or `receive.unpackLimit` are
2416         not set, the value of this variable is used instead.
2417         The default value is 100.
2419 uploadarchive.allowUnreachable::
2420         If true, allow clients to use `git archive --remote` to request
2421         any tree, whether reachable from the ref tips or not. See the
2422         discussion in the `SECURITY` section of
2423         linkgit:git-upload-archive[1] for more details. Defaults to
2424         `false`.
2426 uploadpack.hiderefs::
2427         String(s) `upload-pack` uses to decide which refs to omit
2428         from its initial advertisement.  Use more than one
2429         definitions to specify multiple prefix strings. A ref that
2430         are under the hierarchies listed on the value of this
2431         variable is excluded, and is hidden from `git ls-remote`,
2432         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2433         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2435 uploadpack.allowtipsha1inwant::
2436         When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2437         to accept a fetch request that asks for an object at the tip
2438         of a hidden ref (by default, such a request is rejected).
2439         see also `uploadpack.hiderefs`.
2441 uploadpack.keepalive::
2442         When `upload-pack` has started `pack-objects`, there may be a
2443         quiet period while `pack-objects` prepares the pack. Normally
2444         it would output progress information, but if `--quiet` was used
2445         for the fetch, `pack-objects` will output nothing at all until
2446         the pack data begins. Some clients and networks may consider
2447         the server to be hung and give up. Setting this option instructs
2448         `upload-pack` to send an empty keepalive packet every
2449         `uploadpack.keepalive` seconds. Setting this option to 0
2450         disables keepalive packets entirely. The default is 5 seconds.
2452 url.<base>.insteadOf::
2453         Any URL that starts with this value will be rewritten to
2454         start, instead, with <base>. In cases where some site serves a
2455         large number of repositories, and serves them with multiple
2456         access methods, and some users need to use different access
2457         methods, this feature allows people to specify any of the
2458         equivalent URLs and have Git automatically rewrite the URL to
2459         the best alternative for the particular user, even for a
2460         never-before-seen repository on the site.  When more than one
2461         insteadOf strings match a given URL, the longest match is used.
2463 url.<base>.pushInsteadOf::
2464         Any URL that starts with this value will not be pushed to;
2465         instead, it will be rewritten to start with <base>, and the
2466         resulting URL will be pushed to. In cases where some site serves
2467         a large number of repositories, and serves them with multiple
2468         access methods, some of which do not allow push, this feature
2469         allows people to specify a pull-only URL and have Git
2470         automatically use an appropriate URL to push, even for a
2471         never-before-seen repository on the site.  When more than one
2472         pushInsteadOf strings match a given URL, the longest match is
2473         used.  If a remote has an explicit pushurl, Git will ignore this
2474         setting for that remote.
2476 user.email::
2477         Your email address to be recorded in any newly created commits.
2478         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2479         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2481 user.name::
2482         Your full name to be recorded in any newly created commits.
2483         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2484         environment variables.  See linkgit:git-commit-tree[1].
2486 user.signingkey::
2487         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2488         key you want it to automatically when creating a signed tag or
2489         commit, you can override the default selection with this variable.
2490         This option is passed unchanged to gpg's --local-user parameter,
2491         so you may specify a key using any method that gpg supports.
2493 web.browser::
2494         Specify a web browser that may be used by some commands.
2495         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2496         may use it.