Merge branch 'js/asciidoctor-tweaks' into next
[git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
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.
10
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; we say then that the variable is
18 multivalued.
19
20 Syntax
21 ~~~~~~
22
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored.  The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
26
27 The file consists of sections and variables.  A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins.  Section names are case-insensitive.  Only alphanumeric
30 characters, `-` and `.` are allowed in section names.  Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
33
34 Sections can be further divided into subsections.  To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
37
38 --------
39         [section "subsection"]
40
41 --------
42
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively).  Section headers cannot span multiple
46 lines.  Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
48 don't need to.
49
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
54
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
61
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped.  Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes.  Internal whitespaces within the value are retained
68 verbatim.
69
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
72
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS).  Other char escape sequences (including octal
76 escape sequences) are invalid.
77
78
79 Includes
80 ~~~~~~~~
81
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 variable takes a pathname as its value, and is subject to tilde
85 expansion.
86
87 The
88 included file is expanded immediately, as if its contents had been
89 found at the location of the include directive. If the value of the
90 `include.path` variable is a relative path, the path is considered to be
91 relative to the configuration file in which the include directive was
92 found.  See below for examples.
93
94
95 Example
96 ~~~~~~~
97
98         # Core variables
99         [core]
100                 ; Don't trust file modes
101                 filemode = false
102
103         # Our diff algorithm
104         [diff]
105                 external = /usr/local/bin/diff-wrapper
106                 renames = true
107
108         [branch "devel"]
109                 remote = origin
110                 merge = refs/heads/devel
111
112         # Proxy settings
113         [core]
114                 gitProxy="ssh" for "kernel.org"
115                 gitProxy=default-proxy ; for the rest
116
117         [include]
118                 path = /path/to/foo.inc ; include by absolute path
119                 path = foo ; expand "foo" relative to the current file
120                 path = ~/foo ; expand "foo" in your `$HOME` directory
121
122
123 Values
124 ~~~~~~
125
126 Values of many variables are treated as a simple string, but there
127 are variables that take values of specific types and there are rules
128 as to how to spell them.
129
130 boolean::
131
132        When a variable is said to take a boolean value, many
133        synonyms are accepted for 'true' and 'false'; these are all
134        case-insensitive.
135
136        true;; Boolean true can be spelled as `yes`, `on`, `true`,
137                 or `1`.  Also, a variable defined without `= <value>`
138                 is taken as true.
139
140        false;; Boolean false can be spelled as `no`, `off`,
141                 `false`, or `0`.
142 +
143 When converting value to the canonical form using `--bool` type
144 specifier; 'git config' will ensure that the output is "true" or
145 "false" (spelled in lowercase).
146
147 integer::
148        The value for many variables that specify various sizes can
149        be suffixed with `k`, `M`,... to mean "scale the number by
150        1024", "by 1024x1024", etc.
151
152 color::
153        The value for a variable that takes a color is a list of
154        colors (at most two, one for foreground and one for background)
155        and attributes (as many as you want), separated by spaces.
156 +
157 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
158 `blue`, `magenta`, `cyan` and `white`.  The first color given is the
159 foreground; the second is the background.
160 +
161 Colors may also be given as numbers between 0 and 255; these use ANSI
162 256-color mode (but note that not all terminals may support this).  If
163 your terminal supports it, you may also specify 24-bit RGB values as
164 hex, like `#ff0ab3`.
165 +
166 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
167 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
168 The position of any attributes with respect to the colors
169 (before, after, or in between), doesn't matter. Specific attributes may
170 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
171 `no-ul`, etc).
172 +
173 For git's pre-defined color slots, the attributes are meant to be reset
174 at the beginning of each item in the colored output. So setting
175 `color.decorate.branch` to `black` will paint that branch name in a
176 plain `black`, even if the previous thing on the same output line (e.g.
177 opening parenthesis before the list of branch names in `log --decorate`
178 output) is set to be painted with `bold` or some other attribute.
179 However, custom log formats may do more complicated and layered
180 coloring, and the negated forms may be useful there.
181
182 pathname::
183         A variable that takes a pathname value can be given a
184         string that begins with "`~/`" or "`~user/`", and the usual
185         tilde expansion happens to such a string: `~/`
186         is expanded to the value of `$HOME`, and `~user/` to the
187         specified user's home directory.
188
189
190 Variables
191 ~~~~~~~~~
192
193 Note that this list is non-comprehensive and not necessarily complete.
194 For command-specific variables, you will find a more detailed description
195 in the appropriate manual page.
196
197 Other git-related tools may and do use their own variables.  When
198 inventing new variables for use in your own tool, make sure their
199 names do not conflict with those that are used by Git itself and
200 other popular tools, and describe them in your documentation.
201
202
203 advice.*::
204         These variables control various optional help messages designed to
205         aid new users. All 'advice.*' variables default to 'true', and you
206         can tell Git that you do not need help by setting these to 'false':
207 +
208 --
209         pushUpdateRejected::
210                 Set this variable to 'false' if you want to disable
211                 'pushNonFFCurrent',
212                 'pushNonFFMatching', 'pushAlreadyExists',
213                 'pushFetchFirst', and 'pushNeedsForce'
214                 simultaneously.
215         pushNonFFCurrent::
216                 Advice shown when linkgit:git-push[1] fails due to a
217                 non-fast-forward update to the current branch.
218         pushNonFFMatching::
219                 Advice shown when you ran linkgit:git-push[1] and pushed
220                 'matching refs' explicitly (i.e. you used ':', or
221                 specified a refspec that isn't your current branch) and
222                 it resulted in a non-fast-forward error.
223         pushAlreadyExists::
224                 Shown when linkgit:git-push[1] rejects an update that
225                 does not qualify for fast-forwarding (e.g., a tag.)
226         pushFetchFirst::
227                 Shown when linkgit:git-push[1] rejects an update that
228                 tries to overwrite a remote ref that points at an
229                 object we do not have.
230         pushNeedsForce::
231                 Shown when linkgit:git-push[1] rejects an update that
232                 tries to overwrite a remote ref that points at an
233                 object that is not a commit-ish, or make the remote
234                 ref point at an object that is not a commit-ish.
235         statusHints::
236                 Show directions on how to proceed from the current
237                 state in the output of linkgit:git-status[1], in
238                 the template shown when writing commit messages in
239                 linkgit:git-commit[1], and in the help message shown
240                 by linkgit:git-checkout[1] when switching branch.
241         statusUoption::
242                 Advise to consider using the `-u` option to linkgit:git-status[1]
243                 when the command takes more than 2 seconds to enumerate untracked
244                 files.
245         commitBeforeMerge::
246                 Advice shown when linkgit:git-merge[1] refuses to
247                 merge to avoid overwriting local changes.
248         resolveConflict::
249                 Advice shown by various commands when conflicts
250                 prevent the operation from being performed.
251         implicitIdentity::
252                 Advice on how to set your identity configuration when
253                 your information is guessed from the system username and
254                 domain name.
255         detachedHead::
256                 Advice shown when you used linkgit:git-checkout[1] to
257                 move to the detach HEAD state, to instruct how to create
258                 a local branch after the fact.
259         amWorkDir::
260                 Advice that shows the location of the patch file when
261                 linkgit:git-am[1] fails to apply it.
262         rmHints::
263                 In case of failure in the output of linkgit:git-rm[1],
264                 show directions on how to proceed from the current state.
265 --
266
267 core.fileMode::
268         Tells Git if the executable bit of files in the working tree
269         is to be honored.
270 +
271 Some filesystems lose the executable bit when a file that is
272 marked as executable is checked out, or checks out an
273 non-executable file with executable bit on.
274 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
275 to see if it handles the executable bit correctly
276 and this variable is automatically set as necessary.
277 +
278 A repository, however, may be on a filesystem that handles
279 the filemode correctly, and this variable is set to 'true'
280 when created, but later may be made accessible from another
281 environment that loses the filemode (e.g. exporting ext4 via
282 CIFS mount, visiting a Cygwin created repository with
283 Git for Windows or Eclipse).
284 In such a case it may be necessary to set this variable to 'false'.
285 See linkgit:git-update-index[1].
286 +
287 The default is true (when core.filemode is not specified in the config file).
288
289 core.hideDotFiles::
290         (Windows-only) If true, mark newly-created directories and files whose
291         name starts with a dot as hidden.  If 'dotGitOnly', only the `.git/`
292         directory is hidden, but no other files starting with a dot.  The
293         default mode is 'dotGitOnly'.
294
295 core.ignoreCase::
296         If true, this option enables various workarounds to enable
297         Git to work better on filesystems that are not case sensitive,
298         like FAT. For example, if a directory listing finds
299         "makefile" when Git expects "Makefile", Git will assume
300         it is really the same file, and continue to remember it as
301         "Makefile".
302 +
303 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
304 will probe and set core.ignoreCase true if appropriate when the repository
305 is created.
306
307 core.precomposeUnicode::
308         This option is only used by Mac OS implementation of Git.
309         When core.precomposeUnicode=true, Git reverts the unicode decomposition
310         of filenames done by Mac OS. This is useful when sharing a repository
311         between Mac OS and Linux or Windows.
312         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
313         When false, file names are handled fully transparent by Git,
314         which is backward compatible with older versions of Git.
315
316 core.protectHFS::
317         If set to true, do not allow checkout of paths that would
318         be considered equivalent to `.git` on an HFS+ filesystem.
319         Defaults to `true` on Mac OS, and `false` elsewhere.
320
321 core.protectNTFS::
322         If set to true, do not allow checkout of paths that would
323         cause problems with the NTFS filesystem, e.g. conflict with
324         8.3 "short" names.
325         Defaults to `true` on Windows, and `false` elsewhere.
326
327 core.trustctime::
328         If false, the ctime differences between the index and the
329         working tree are ignored; useful when the inode change time
330         is regularly modified by something outside Git (file system
331         crawlers and some backup systems).
332         See linkgit:git-update-index[1]. True by default.
333
334 core.untrackedCache::
335         Determines what to do about the untracked cache feature of the
336         index. It will be kept, if this variable is unset or set to
337         `keep`. It will automatically be added if set to `true`. And
338         it will automatically be removed, if set to `false`. Before
339         setting it to `true`, you should check that mtime is working
340         properly on your system.
341         See linkgit:git-update-index[1]. `keep` by default.
342
343 core.checkStat::
344         Determines which stat fields to match between the index
345         and work tree. The user can set this to 'default' or
346         'minimal'. Default (or explicitly 'default'), is to check
347         all fields, including the sub-second part of mtime and ctime.
348
349 core.quotePath::
350         The commands that output paths (e.g. 'ls-files',
351         'diff'), when not given the `-z` option, will quote
352         "unusual" characters in the pathname by enclosing the
353         pathname in a double-quote pair and with backslashes the
354         same way strings in C source code are quoted.  If this
355         variable is set to false, the bytes higher than 0x80 are
356         not quoted but output as verbatim.  Note that double
357         quote, backslash and control characters are always
358         quoted without `-z` regardless of the setting of this
359         variable.
360
361 core.eol::
362         Sets the line ending type to use in the working directory for
363         files that have the `text` property set when core.autocrlf is false.
364         Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
365         native line ending.  The default value is `native`.  See
366         linkgit:gitattributes[5] for more information on end-of-line
367         conversion.
368
369 core.safecrlf::
370         If true, makes Git check if converting `CRLF` is reversible when
371         end-of-line conversion is active.  Git will verify if a command
372         modifies a file in the work tree either directly or indirectly.
373         For example, committing a file followed by checking out the
374         same file should yield the original file in the work tree.  If
375         this is not the case for the current setting of
376         `core.autocrlf`, Git will reject the file.  The variable can
377         be set to "warn", in which case Git will only warn about an
378         irreversible conversion but continue the operation.
379 +
380 CRLF conversion bears a slight chance of corrupting data.
381 When it is enabled, Git will convert CRLF to LF during commit and LF to
382 CRLF during checkout.  A file that contains a mixture of LF and
383 CRLF before the commit cannot be recreated by Git.  For text
384 files this is the right thing to do: it corrects line endings
385 such that we have only LF line endings in the repository.
386 But for binary files that are accidentally classified as text the
387 conversion can corrupt data.
388 +
389 If you recognize such corruption early you can easily fix it by
390 setting the conversion type explicitly in .gitattributes.  Right
391 after committing you still have the original file in your work
392 tree and this file is not yet corrupted.  You can explicitly tell
393 Git that this file is binary and Git will handle the file
394 appropriately.
395 +
396 Unfortunately, the desired effect of cleaning up text files with
397 mixed line endings and the undesired effect of corrupting binary
398 files cannot be distinguished.  In both cases CRLFs are removed
399 in an irreversible way.  For text files this is the right thing
400 to do because CRLFs are line endings, while for binary files
401 converting CRLFs corrupts data.
402 +
403 Note, this safety check does not mean that a checkout will generate a
404 file identical to the original file for a different setting of
405 `core.eol` and `core.autocrlf`, but only for the current one.  For
406 example, a text file with `LF` would be accepted with `core.eol=lf`
407 and could later be checked out with `core.eol=crlf`, in which case the
408 resulting file would contain `CRLF`, although the original file
409 contained `LF`.  However, in both work trees the line endings would be
410 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
411 file with mixed line endings would be reported by the `core.safecrlf`
412 mechanism.
413
414 core.autocrlf::
415         Setting this variable to "true" is the same as setting
416         the `text` attribute to "auto" on all files and core.eol to "crlf".
417         Set to true if you want to have `CRLF` line endings in your
418         working directory and the repository has LF line endings.
419         This variable can be set to 'input',
420         in which case no output conversion is performed.
421
422 core.symlinks::
423         If false, symbolic links are checked out as small plain files that
424         contain the link text. linkgit:git-update-index[1] and
425         linkgit:git-add[1] will not change the recorded type to regular
426         file. Useful on filesystems like FAT that do not support
427         symbolic links.
428 +
429 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
430 will probe and set core.symlinks false if appropriate when the repository
431 is created.
432
433 core.gitProxy::
434         A "proxy command" to execute (as 'command host port') instead
435         of establishing direct connection to the remote server when
436         using the Git protocol for fetching. If the variable value is
437         in the "COMMAND for DOMAIN" format, the command is applied only
438         on hostnames ending with the specified domain string. This variable
439         may be set multiple times and is matched in the given order;
440         the first match wins.
441 +
442 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
443 (which always applies universally, without the special "for"
444 handling).
445 +
446 The special string `none` can be used as the proxy command to
447 specify that no proxy be used for a given domain pattern.
448 This is useful for excluding servers inside a firewall from
449 proxy use, while defaulting to a common proxy for external domains.
450
451 core.sshCommand::
452         If this variable is set, `git fetch` and `git push` will
453         use the specified command instead of `ssh` when they need to
454         connect to a remote system. The command is in the same form as
455         the `GIT_SSH_COMMAND` environment variable and is overridden
456         when the environment variable is set.
457
458 core.ignoreStat::
459         If true, Git will avoid using lstat() calls to detect if files have
460         changed by setting the "assume-unchanged" bit for those tracked files
461         which it has updated identically in both the index and working tree.
462 +
463 When files are modified outside of Git, the user will need to stage
464 the modified files explicitly (e.g. see 'Examples' section in
465 linkgit:git-update-index[1]).
466 Git will not normally detect changes to those files.
467 +
468 This is useful on systems where lstat() calls are very slow, such as
469 CIFS/Microsoft Windows.
470 +
471 False by default.
472
473 core.preferSymlinkRefs::
474         Instead of the default "symref" format for HEAD
475         and other symbolic reference files, use symbolic links.
476         This is sometimes needed to work with old scripts that
477         expect HEAD to be a symbolic link.
478
479 core.bare::
480         If true this repository is assumed to be 'bare' and has no
481         working directory associated with it.  If this is the case a
482         number of commands that require a working directory will be
483         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
484 +
485 This setting is automatically guessed by linkgit:git-clone[1] or
486 linkgit:git-init[1] when the repository was created.  By default a
487 repository that ends in "/.git" is assumed to be not bare (bare =
488 false), while all other repositories are assumed to be bare (bare
489 = true).
490
491 core.worktree::
492         Set the path to the root of the working tree.
493         If `GIT_COMMON_DIR` environment variable is set, core.worktree
494         is ignored and not used for determining the root of working tree.
495         This can be overridden by the `GIT_WORK_TREE` environment
496         variable and the `--work-tree` command-line option.
497         The value can be an absolute path or relative to the path to
498         the .git directory, which is either specified by --git-dir
499         or GIT_DIR, or automatically discovered.
500         If --git-dir or GIT_DIR is specified but none of
501         --work-tree, GIT_WORK_TREE and core.worktree is specified,
502         the current working directory is regarded as the top level
503         of your working tree.
504 +
505 Note that this variable is honored even when set in a configuration
506 file in a ".git" subdirectory of a directory and its value differs
507 from the latter directory (e.g. "/path/to/.git/config" has
508 core.worktree set to "/different/path"), which is most likely a
509 misconfiguration.  Running Git commands in the "/path/to" directory will
510 still use "/different/path" as the root of the work tree and can cause
511 confusion unless you know what you are doing (e.g. you are creating a
512 read-only snapshot of the same index to a location different from the
513 repository's usual working tree).
514
515 core.logAllRefUpdates::
516         Enable the reflog. Updates to a ref <ref> is logged to the file
517         "`$GIT_DIR/logs/<ref>`", by appending the new and old
518         SHA-1, the date/time and the reason of the update, but
519         only when the file exists.  If this configuration
520         variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
521         file is automatically created for branch heads (i.e. under
522         refs/heads/), remote refs (i.e. under refs/remotes/),
523         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
524 +
525 This information can be used to determine what commit
526 was the tip of a branch "2 days ago".
527 +
528 This value is true by default in a repository that has
529 a working directory associated with it, and false by
530 default in a bare repository.
531
532 core.repositoryFormatVersion::
533         Internal variable identifying the repository format and layout
534         version.
535
536 core.sharedRepository::
537         When 'group' (or 'true'), the repository is made shareable between
538         several users in a group (making sure all the files and objects are
539         group-writable). When 'all' (or 'world' or 'everybody'), the
540         repository will be readable by all users, additionally to being
541         group-shareable. When 'umask' (or 'false'), Git will use permissions
542         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
543         files in the repository will have this mode value. '0xxx' will override
544         user's umask value (whereas the other options will only override
545         requested parts of the user's umask value). Examples: '0660' will make
546         the repo read/write-able for the owner and group, but inaccessible to
547         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
548         repository that is group-readable but not group-writable.
549         See linkgit:git-init[1]. False by default.
550
551 core.warnAmbiguousRefs::
552         If true, Git will warn you if the ref name you passed it is ambiguous
553         and might match multiple refs in the repository. True by default.
554
555 core.compression::
556         An integer -1..9, indicating a default compression level.
557         -1 is the zlib default. 0 means no compression,
558         and 1..9 are various speed/size tradeoffs, 9 being slowest.
559         If set, this provides a default to other compression variables,
560         such as `core.looseCompression` and `pack.compression`.
561
562 core.looseCompression::
563         An integer -1..9, indicating the compression level for objects that
564         are not in a pack file. -1 is the zlib default. 0 means no
565         compression, and 1..9 are various speed/size tradeoffs, 9 being
566         slowest.  If not set,  defaults to core.compression.  If that is
567         not set,  defaults to 1 (best speed).
568
569 core.packedGitWindowSize::
570         Number of bytes of a pack file to map into memory in a
571         single mapping operation.  Larger window sizes may allow
572         your system to process a smaller number of large pack files
573         more quickly.  Smaller window sizes will negatively affect
574         performance due to increased calls to the operating system's
575         memory manager, but may improve performance when accessing
576         a large number of large pack files.
577 +
578 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
579 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
580 be reasonable for all users/operating systems.  You probably do
581 not need to adjust this value.
582 +
583 Common unit suffixes of 'k', 'm', or 'g' are supported.
584
585 core.packedGitLimit::
586         Maximum number of bytes to map simultaneously into memory
587         from pack files.  If Git needs to access more than this many
588         bytes at once to complete an operation it will unmap existing
589         regions to reclaim virtual address space within the process.
590 +
591 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
592 This should be reasonable for all users/operating systems, except on
593 the largest projects.  You probably do not need to adjust this value.
594 +
595 Common unit suffixes of 'k', 'm', or 'g' are supported.
596
597 core.deltaBaseCacheLimit::
598         Maximum number of bytes to reserve for caching base objects
599         that may be referenced by multiple deltified objects.  By storing the
600         entire decompressed base objects in a cache Git is able
601         to avoid unpacking and decompressing frequently used base
602         objects multiple times.
603 +
604 Default is 96 MiB on all platforms.  This should be reasonable
605 for all users/operating systems, except on the largest projects.
606 You probably do not need to adjust this value.
607 +
608 Common unit suffixes of 'k', 'm', or 'g' are supported.
609
610 core.bigFileThreshold::
611         Files larger than this size are stored deflated, without
612         attempting delta compression.  Storing large files without
613         delta compression avoids excessive memory usage, at the
614         slight expense of increased disk usage. Additionally files
615         larger than this size are always treated as binary.
616 +
617 Default is 512 MiB on all platforms.  This should be reasonable
618 for most projects as source code and other text files can still
619 be delta compressed, but larger binary media files won't be.
620 +
621 Common unit suffixes of 'k', 'm', or 'g' are supported.
622
623 core.excludesFile::
624         Specifies the pathname to the file that contains patterns to
625         describe paths that are not meant to be tracked, in addition
626         to '.gitignore' (per-directory) and '.git/info/exclude'.
627         Defaults to `$XDG_CONFIG_HOME/git/ignore`.
628         If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
629         is used instead. See linkgit:gitignore[5].
630
631 core.askPass::
632         Some commands (e.g. svn and http interfaces) that interactively
633         ask for a password can be told to use an external program given
634         via the value of this variable. Can be overridden by the `GIT_ASKPASS`
635         environment variable. If not set, fall back to the value of the
636         `SSH_ASKPASS` environment variable or, failing that, a simple password
637         prompt. The external program shall be given a suitable prompt as
638         command-line argument and write the password on its STDOUT.
639
640 core.attributesFile::
641         In addition to '.gitattributes' (per-directory) and
642         '.git/info/attributes', Git looks into this file for attributes
643         (see linkgit:gitattributes[5]). Path expansions are made the same
644         way as for `core.excludesFile`. Its default value is
645         `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
646         set or empty, `$HOME/.config/git/attributes` is used instead.
647
648 core.hooksPath::
649         By default Git will look for your hooks in the
650         '$GIT_DIR/hooks' directory. Set this to different path,
651         e.g. '/etc/git/hooks', and Git will try to find your hooks in
652         that directory, e.g. '/etc/git/hooks/pre-receive' instead of
653         in '$GIT_DIR/hooks/pre-receive'.
654 +
655 The path can be either absolute or relative. A relative path is
656 taken as relative to the directory where the hooks are run (see
657 the "DESCRIPTION" section of linkgit:githooks[5]).
658 +
659 This configuration variable is useful in cases where you'd like to
660 centrally configure your Git hooks instead of configuring them on a
661 per-repository basis, or as a more flexible and centralized
662 alternative to having an `init.templateDir` where you've changed
663 default hooks.
664
665 core.editor::
666         Commands such as `commit` and `tag` that lets you edit
667         messages by launching an editor uses the value of this
668         variable when it is set, and the environment variable
669         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
670
671 core.commentChar::
672         Commands such as `commit` and `tag` that lets you edit
673         messages consider a line that begins with this character
674         commented, and removes them after the editor returns
675         (default '#').
676 +
677 If set to "auto", `git-commit` would select a character that is not
678 the beginning character of any line in existing commit messages.
679
680 core.packedRefsTimeout::
681         The length of time, in milliseconds, to retry when trying to
682         lock the `packed-refs` file. Value 0 means not to retry at
683         all; -1 means to try indefinitely. Default is 1000 (i.e.,
684         retry for 1 second).
685
686 sequence.editor::
687         Text editor used by `git rebase -i` for editing the rebase instruction file.
688         The value is meant to be interpreted by the shell when it is used.
689         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
690         When not configured the default commit message editor is used instead.
691
692 core.pager::
693         Text viewer for use by Git commands (e.g., 'less').  The value
694         is meant to be interpreted by the shell.  The order of preference
695         is the `$GIT_PAGER` environment variable, then `core.pager`
696         configuration, then `$PAGER`, and then the default chosen at
697         compile time (usually 'less').
698 +
699 When the `LESS` environment variable is unset, Git sets it to `FRX`
700 (if `LESS` environment variable is set, Git does not change it at
701 all).  If you want to selectively override Git's default setting
702 for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
703 be passed to the shell by Git, which will translate the final
704 command to `LESS=FRX less -S`. The environment does not set the
705 `S` option but the command line does, instructing less to truncate
706 long lines. Similarly, setting `core.pager` to `less -+F` will
707 deactivate the `F` option specified by the environment from the
708 command-line, deactivating the "quit if one screen" behavior of
709 `less`.  One can specifically activate some flags for particular
710 commands: for example, setting `pager.blame` to `less -S` enables
711 line truncation only for `git blame`.
712 +
713 Likewise, when the `LV` environment variable is unset, Git sets it
714 to `-c`.  You can override this setting by exporting `LV` with
715 another value or setting `core.pager` to `lv +c`.
716
717 core.whitespace::
718         A comma separated list of common whitespace problems to
719         notice.  'git diff' will use `color.diff.whitespace` to
720         highlight them, and 'git apply --whitespace=error' will
721         consider them as errors.  You can prefix `-` to disable
722         any of them (e.g. `-trailing-space`):
723 +
724 * `blank-at-eol` treats trailing whitespaces at the end of the line
725   as an error (enabled by default).
726 * `space-before-tab` treats a space character that appears immediately
727   before a tab character in the initial indent part of the line as an
728   error (enabled by default).
729 * `indent-with-non-tab` treats a line that is indented with space
730   characters instead of the equivalent tabs as an error (not enabled by
731   default).
732 * `tab-in-indent` treats a tab character in the initial indent part of
733   the line as an error (not enabled by default).
734 * `blank-at-eof` treats blank lines added at the end of file as an error
735   (enabled by default).
736 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
737   `blank-at-eof`.
738 * `cr-at-eol` treats a carriage-return at the end of line as
739   part of the line terminator, i.e. with it, `trailing-space`
740   does not trigger if the character before such a carriage-return
741   is not a whitespace (not enabled by default).
742 * `tabwidth=<n>` tells how many character positions a tab occupies; this
743   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
744   errors. The default tab width is 8. Allowed values are 1 to 63.
745
746 core.fsyncObjectFiles::
747         This boolean will enable 'fsync()' when writing object files.
748 +
749 This is a total waste of time and effort on a filesystem that orders
750 data writes properly, but can be useful for filesystems that do not use
751 journalling (traditional UNIX filesystems) or that only journal metadata
752 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
753
754 core.preloadIndex::
755         Enable parallel index preload for operations like 'git diff'
756 +
757 This can speed up operations like 'git diff' and 'git status' especially
758 on filesystems like NFS that have weak caching semantics and thus
759 relatively high IO latencies.  When enabled, Git will do the
760 index comparison to the filesystem data in parallel, allowing
761 overlapping IO's.  Defaults to true.
762
763 core.createObject::
764         You can set this to 'link', in which case a hardlink followed by
765         a delete of the source are used to make sure that object creation
766         will not overwrite existing objects.
767 +
768 On some file system/operating system combinations, this is unreliable.
769 Set this config setting to 'rename' there; However, This will remove the
770 check that makes sure that existing object files will not get overwritten.
771
772 core.notesRef::
773         When showing commit messages, also show notes which are stored in
774         the given ref.  The ref must be fully qualified.  If the given
775         ref does not exist, it is not an error but means that no
776         notes should be printed.
777 +
778 This setting defaults to "refs/notes/commits", and it can be overridden by
779 the `GIT_NOTES_REF` environment variable.  See linkgit:git-notes[1].
780
781 core.sparseCheckout::
782         Enable "sparse checkout" feature. See section "Sparse checkout" in
783         linkgit:git-read-tree[1] for more information.
784
785 core.abbrev::
786         Set the length object names are abbreviated to.  If
787         unspecified or set to "auto", an appropriate value is
788         computed based on the approximate number of packed objects
789         in your repository, which hopefully is enough for
790         abbreviated object names to stay unique for some time.
791
792 add.ignoreErrors::
793 add.ignore-errors (deprecated)::
794         Tells 'git add' to continue adding files when some files cannot be
795         added due to indexing errors. Equivalent to the `--ignore-errors`
796         option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
797         as it does not follow the usual naming convention for configuration
798         variables.
799
800 alias.*::
801         Command aliases for the linkgit:git[1] command wrapper - e.g.
802         after defining "alias.last = cat-file commit HEAD", the invocation
803         "git last" is equivalent to "git cat-file commit HEAD". To avoid
804         confusion and troubles with script usage, aliases that
805         hide existing Git commands are ignored. Arguments are split by
806         spaces, the usual shell quoting and escaping is supported.
807         A quote pair or a backslash can be used to quote them.
808 +
809 If the alias expansion is prefixed with an exclamation point,
810 it will be treated as a shell command.  For example, defining
811 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
812 "git new" is equivalent to running the shell command
813 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
814 executed from the top-level directory of a repository, which may
815 not necessarily be the current directory.
816 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
817 from the original current directory. See linkgit:git-rev-parse[1].
818
819 am.keepcr::
820         If true, git-am will call git-mailsplit for patches in mbox format
821         with parameter `--keep-cr`. In this case git-mailsplit will
822         not remove `\r` from lines ending with `\r\n`. Can be overridden
823         by giving `--no-keep-cr` from the command line.
824         See linkgit:git-am[1], linkgit:git-mailsplit[1].
825
826 am.threeWay::
827         By default, `git am` will fail if the patch does not apply cleanly. When
828         set to true, this setting tells `git am` to fall back on 3-way merge if
829         the patch records the identity of blobs it is supposed to apply to and
830         we have those blobs available locally (equivalent to giving the `--3way`
831         option from the command line). Defaults to `false`.
832         See linkgit:git-am[1].
833
834 apply.ignoreWhitespace::
835         When set to 'change', tells 'git apply' to ignore changes in
836         whitespace, in the same way as the `--ignore-space-change`
837         option.
838         When set to one of: no, none, never, false tells 'git apply' to
839         respect all whitespace differences.
840         See linkgit:git-apply[1].
841
842 apply.whitespace::
843         Tells 'git apply' how to handle whitespaces, in the same way
844         as the `--whitespace` option. See linkgit:git-apply[1].
845
846 branch.autoSetupMerge::
847         Tells 'git branch' and 'git checkout' to set up new branches
848         so that linkgit:git-pull[1] will appropriately merge from the
849         starting point branch. Note that even if this option is not set,
850         this behavior can be chosen per-branch using the `--track`
851         and `--no-track` options. The valid settings are: `false` -- no
852         automatic setup is done; `true` -- automatic setup is done when the
853         starting point is a remote-tracking branch; `always` --
854         automatic setup is done when the starting point is either a
855         local branch or remote-tracking
856         branch. This option defaults to true.
857
858 branch.autoSetupRebase::
859         When a new branch is created with 'git branch' or 'git checkout'
860         that tracks another branch, this variable tells Git to set
861         up pull to rebase instead of merge (see "branch.<name>.rebase").
862         When `never`, rebase is never automatically set to true.
863         When `local`, rebase is set to true for tracked branches of
864         other local branches.
865         When `remote`, rebase is set to true for tracked branches of
866         remote-tracking branches.
867         When `always`, rebase will be set to true for all tracking
868         branches.
869         See "branch.autoSetupMerge" for details on how to set up a
870         branch to track another branch.
871         This option defaults to never.
872
873 branch.<name>.remote::
874         When on branch <name>, it tells 'git fetch' and 'git push'
875         which remote to fetch from/push to.  The remote to push to
876         may be overridden with `remote.pushDefault` (for all branches).
877         The remote to push to, for the current branch, may be further
878         overridden by `branch.<name>.pushRemote`.  If no remote is
879         configured, or if you are not on any branch, it defaults to
880         `origin` for fetching and `remote.pushDefault` for pushing.
881         Additionally, `.` (a period) is the current local repository
882         (a dot-repository), see `branch.<name>.merge`'s final note below.
883
884 branch.<name>.pushRemote::
885         When on branch <name>, it overrides `branch.<name>.remote` for
886         pushing.  It also overrides `remote.pushDefault` for pushing
887         from branch <name>.  When you pull from one place (e.g. your
888         upstream) and push to another place (e.g. your own publishing
889         repository), you would want to set `remote.pushDefault` to
890         specify the remote to push to for all branches, and use this
891         option to override it for a specific branch.
892
893 branch.<name>.merge::
894         Defines, together with branch.<name>.remote, the upstream branch
895         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
896         branch to merge and can also affect 'git push' (see push.default).
897         When in branch <name>, it tells 'git fetch' the default
898         refspec to be marked for merging in FETCH_HEAD. The value is
899         handled like the remote part of a refspec, and must match a
900         ref which is fetched from the remote given by
901         "branch.<name>.remote".
902         The merge information is used by 'git pull' (which at first calls
903         'git fetch') to lookup the default branch for merging. Without
904         this option, 'git pull' defaults to merge the first refspec fetched.
905         Specify multiple values to get an octopus merge.
906         If you wish to setup 'git pull' so that it merges into <name> from
907         another branch in the local repository, you can point
908         branch.<name>.merge to the desired branch, and use the relative path
909         setting `.` (a period) for branch.<name>.remote.
910
911 branch.<name>.mergeOptions::
912         Sets default options for merging into branch <name>. The syntax and
913         supported options are the same as those of linkgit:git-merge[1], but
914         option values containing whitespace characters are currently not
915         supported.
916
917 branch.<name>.rebase::
918         When true, rebase the branch <name> on top of the fetched branch,
919         instead of merging the default branch from the default remote when
920         "git pull" is run. See "pull.rebase" for doing this in a non
921         branch-specific manner.
922 +
923 When preserve, also pass `--preserve-merges` along to 'git rebase'
924 so that locally committed merge commits will not be flattened
925 by running 'git pull'.
926 +
927 When the value is `interactive`, the rebase is run in interactive mode.
928 +
929 *NOTE*: this is a possibly dangerous operation; do *not* use
930 it unless you understand the implications (see linkgit:git-rebase[1]
931 for details).
932
933 branch.<name>.description::
934         Branch description, can be edited with
935         `git branch --edit-description`. Branch description is
936         automatically added in the format-patch cover letter or
937         request-pull summary.
938
939 browser.<tool>.cmd::
940         Specify the command to invoke the specified browser. The
941         specified command is evaluated in shell with the URLs passed
942         as arguments. (See linkgit:git-web{litdd}browse[1].)
943
944 browser.<tool>.path::
945         Override the path for the given tool that may be used to
946         browse HTML help (see `-w` option in linkgit:git-help[1]) or a
947         working repository in gitweb (see linkgit:git-instaweb[1]).
948
949 clean.requireForce::
950         A boolean to make git-clean do nothing unless given -f,
951         -i or -n.   Defaults to true.
952
953 color.branch::
954         A boolean to enable/disable color in the output of
955         linkgit:git-branch[1]. May be set to `always`,
956         `false` (or `never`) or `auto` (or `true`), in which case colors are used
957         only when the output is to a terminal. If unset, then the
958         value of `color.ui` is used (`auto` by default).
959
960 color.branch.<slot>::
961         Use customized color for branch coloration. `<slot>` is one of
962         `current` (the current branch), `local` (a local branch),
963         `remote` (a remote-tracking branch in refs/remotes/),
964         `upstream` (upstream tracking branch), `plain` (other
965         refs).
966
967 color.diff::
968         Whether to use ANSI escape sequences to add color to patches.
969         If this is set to `always`, linkgit:git-diff[1],
970         linkgit:git-log[1], and linkgit:git-show[1] will use color
971         for all patches.  If it is set to `true` or `auto`, those
972         commands will only use color when output is to the terminal.
973         If unset, then the value of `color.ui` is used (`auto` by
974         default).
975 +
976 This does not affect linkgit:git-format-patch[1] or the
977 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
978 command line with the `--color[=<when>]` option.
979
980 color.diff.<slot>::
981         Use customized color for diff colorization.  `<slot>` specifies
982         which part of the patch to use the specified color, and is one
983         of `context` (context text - `plain` is a historical synonym),
984         `meta` (metainformation), `frag`
985         (hunk header), 'func' (function in hunk header), `old` (removed lines),
986         `new` (added lines), `commit` (commit headers), or `whitespace`
987         (highlighting whitespace errors).
988
989 color.decorate.<slot>::
990         Use customized color for 'git log --decorate' output.  `<slot>` is one
991         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
992         branches, remote-tracking branches, tags, stash and HEAD, respectively.
993
994 color.grep::
995         When set to `always`, always highlight matches.  When `false` (or
996         `never`), never.  When set to `true` or `auto`, use color only
997         when the output is written to the terminal.  If unset, then the
998         value of `color.ui` is used (`auto` by default).
999
1000 color.grep.<slot>::
1001         Use customized color for grep colorization.  `<slot>` specifies which
1002         part of the line to use the specified color, and is one of
1003 +
1004 --
1005 `context`;;
1006         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1007 `filename`;;
1008         filename prefix (when not using `-h`)
1009 `function`;;
1010         function name lines (when using `-p`)
1011 `linenumber`;;
1012         line number prefix (when using `-n`)
1013 `match`;;
1014         matching text (same as setting `matchContext` and `matchSelected`)
1015 `matchContext`;;
1016         matching text in context lines
1017 `matchSelected`;;
1018         matching text in selected lines
1019 `selected`;;
1020         non-matching text in selected lines
1021 `separator`;;
1022         separators between fields on a line (`:`, `-`, and `=`)
1023         and between hunks (`--`)
1024 --
1025
1026 color.interactive::
1027         When set to `always`, always use colors for interactive prompts
1028         and displays (such as those used by "git-add --interactive" and
1029         "git-clean --interactive"). When false (or `never`), never.
1030         When set to `true` or `auto`, use colors only when the output is
1031         to the terminal. If unset, then the value of `color.ui` is
1032         used (`auto` by default).
1033
1034 color.interactive.<slot>::
1035         Use customized color for 'git add --interactive' and 'git clean
1036         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1037         or `error`, for four distinct types of normal output from
1038         interactive commands.
1039
1040 color.pager::
1041         A boolean to enable/disable colored output when the pager is in
1042         use (default is true).
1043
1044 color.showBranch::
1045         A boolean to enable/disable color in the output of
1046         linkgit:git-show-branch[1]. May be set to `always`,
1047         `false` (or `never`) or `auto` (or `true`), in which case colors are used
1048         only when the output is to a terminal. If unset, then the
1049         value of `color.ui` is used (`auto` by default).
1050
1051 color.status::
1052         A boolean to enable/disable color in the output of
1053         linkgit:git-status[1]. May be set to `always`,
1054         `false` (or `never`) or `auto` (or `true`), in which case colors are used
1055         only when the output is to a terminal. If unset, then the
1056         value of `color.ui` is used (`auto` by default).
1057
1058 color.status.<slot>::
1059         Use customized color for status colorization. `<slot>` is
1060         one of `header` (the header text of the status message),
1061         `added` or `updated` (files which are added but not committed),
1062         `changed` (files which are changed but not added in the index),
1063         `untracked` (files which are not tracked by Git),
1064         `branch` (the current branch),
1065         `nobranch` (the color the 'no branch' warning is shown in, defaulting
1066         to red), or
1067         `unmerged` (files which have unmerged changes).
1068
1069 color.ui::
1070         This variable determines the default value for variables such
1071         as `color.diff` and `color.grep` that control the use of color
1072         per command family. Its scope will expand as more commands learn
1073         configuration to set a default for the `--color` option.  Set it
1074         to `false` or `never` if you prefer Git commands not to use
1075         color unless enabled explicitly with some other configuration
1076         or the `--color` option. Set it to `always` if you want all
1077         output not intended for machine consumption to use color, to
1078         `true` or `auto` (this is the default since Git 1.8.4) if you
1079         want such output to use color when written to the terminal.
1080
1081 column.ui::
1082         Specify whether supported commands should output in columns.
1083         This variable consists of a list of tokens separated by spaces
1084         or commas:
1085 +
1086 These options control when the feature should be enabled
1087 (defaults to 'never'):
1088 +
1089 --
1090 `always`;;
1091         always show in columns
1092 `never`;;
1093         never show in columns
1094 `auto`;;
1095         show in columns if the output is to the terminal
1096 --
1097 +
1098 These options control layout (defaults to 'column').  Setting any
1099 of these implies 'always' if none of 'always', 'never', or 'auto' are
1100 specified.
1101 +
1102 --
1103 `column`;;
1104         fill columns before rows
1105 `row`;;
1106         fill rows before columns
1107 `plain`;;
1108         show in one column
1109 --
1110 +
1111 Finally, these options can be combined with a layout option (defaults
1112 to 'nodense'):
1113 +
1114 --
1115 `dense`;;
1116         make unequal size columns to utilize more space
1117 `nodense`;;
1118         make equal size columns
1119 --
1120
1121 column.branch::
1122         Specify whether to output branch listing in `git branch` in columns.
1123         See `column.ui` for details.
1124
1125 column.clean::
1126         Specify the layout when list items in `git clean -i`, which always
1127         shows files and directories in columns. See `column.ui` for details.
1128
1129 column.status::
1130         Specify whether to output untracked files in `git status` in columns.
1131         See `column.ui` for details.
1132
1133 column.tag::
1134         Specify whether to output tag listing in `git tag` in columns.
1135         See `column.ui` for details.
1136
1137 commit.cleanup::
1138         This setting overrides the default of the `--cleanup` option in
1139         `git commit`. See linkgit:git-commit[1] for details. Changing the
1140         default can be useful when you always want to keep lines that begin
1141         with comment character `#` in your log message, in which case you
1142         would do `git config commit.cleanup whitespace` (note that you will
1143         have to remove the help lines that begin with `#` in the commit log
1144         template yourself, if you do this).
1145
1146 commit.gpgSign::
1147
1148         A boolean to specify whether all commits should be GPG signed.
1149         Use of this option when doing operations such as rebase can
1150         result in a large number of commits being signed. It may be
1151         convenient to use an agent to avoid typing your GPG passphrase
1152         several times.
1153
1154 commit.status::
1155         A boolean to enable/disable inclusion of status information in the
1156         commit message template when using an editor to prepare the commit
1157         message.  Defaults to true.
1158
1159 commit.template::
1160         Specify the pathname of a file to use as the template for
1161         new commit messages.
1162
1163 commit.verbose::
1164         A boolean or int to specify the level of verbose with `git commit`.
1165         See linkgit:git-commit[1].
1166
1167 credential.helper::
1168         Specify an external helper to be called when a username or
1169         password credential is needed; the helper may consult external
1170         storage to avoid prompting the user for the credentials. Note
1171         that multiple helpers may be defined. See linkgit:gitcredentials[7]
1172         for details.
1173
1174 credential.useHttpPath::
1175         When acquiring credentials, consider the "path" component of an http
1176         or https URL to be important. Defaults to false. See
1177         linkgit:gitcredentials[7] for more information.
1178
1179 credential.username::
1180         If no username is set for a network authentication, use this username
1181         by default. See credential.<context>.* below, and
1182         linkgit:gitcredentials[7].
1183
1184 credential.<url>.*::
1185         Any of the credential.* options above can be applied selectively to
1186         some credentials. For example "credential.https://example.com.username"
1187         would set the default username only for https connections to
1188         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1189         matched.
1190
1191 credentialCache.ignoreSIGHUP::
1192         Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1193
1194 include::diff-config.txt[]
1195
1196 difftool.<tool>.path::
1197         Override the path for the given tool.  This is useful in case
1198         your tool is not in the PATH.
1199
1200 difftool.<tool>.cmd::
1201         Specify the command to invoke the specified diff tool.
1202         The specified command is evaluated in shell with the following
1203         variables available:  'LOCAL' is set to the name of the temporary
1204         file containing the contents of the diff pre-image and 'REMOTE'
1205         is set to the name of the temporary file containing the contents
1206         of the diff post-image.
1207
1208 difftool.prompt::
1209         Prompt before each invocation of the diff tool.
1210
1211 fastimport.unpackLimit::
1212         If the number of objects imported by linkgit:git-fast-import[1]
1213         is below this limit, then the objects will be unpacked into
1214         loose object files.  However if the number of imported objects
1215         equals or exceeds this limit then the pack will be stored as a
1216         pack.  Storing the pack from a fast-import can make the import
1217         operation complete faster, especially on slow filesystems.  If
1218         not set, the value of `transfer.unpackLimit` is used instead.
1219
1220 fetch.recurseSubmodules::
1221         This option can be either set to a boolean value or to 'on-demand'.
1222         Setting it to a boolean changes the behavior of fetch and pull to
1223         unconditionally recurse into submodules when set to true or to not
1224         recurse at all when set to false. When set to 'on-demand' (the default
1225         value), fetch and pull will only recurse into a populated submodule
1226         when its superproject retrieves a commit that updates the submodule's
1227         reference.
1228
1229 fetch.fsckObjects::
1230         If it is set to true, git-fetch-pack will check all fetched
1231         objects. It will abort in the case of a malformed object or a
1232         broken link. The result of an abort are only dangling objects.
1233         Defaults to false. If not set, the value of `transfer.fsckObjects`
1234         is used instead.
1235
1236 fetch.unpackLimit::
1237         If the number of objects fetched over the Git native
1238         transfer is below this
1239         limit, then the objects will be unpacked into loose object
1240         files. However if the number of received objects equals or
1241         exceeds this limit then the received pack will be stored as
1242         a pack, after adding any missing delta bases.  Storing the
1243         pack from a push can make the push operation complete faster,
1244         especially on slow filesystems.  If not set, the value of
1245         `transfer.unpackLimit` is used instead.
1246
1247 fetch.prune::
1248         If true, fetch will automatically behave as if the `--prune`
1249         option was given on the command line.  See also `remote.<name>.prune`.
1250
1251 fetch.output::
1252         Control how ref update status is printed. Valid values are
1253         `full` and `compact`. Default value is `full`. See section
1254         OUTPUT in linkgit:git-fetch[1] for detail.
1255
1256 format.attach::
1257         Enable multipart/mixed attachments as the default for
1258         'format-patch'.  The value can also be a double quoted string
1259         which will enable attachments as the default and set the
1260         value as the boundary.  See the --attach option in
1261         linkgit:git-format-patch[1].
1262
1263 format.from::
1264         Provides the default value for the `--from` option to format-patch.
1265         Accepts a boolean value, or a name and email address.  If false,
1266         format-patch defaults to `--no-from`, using commit authors directly in
1267         the "From:" field of patch mails.  If true, format-patch defaults to
1268         `--from`, using your committer identity in the "From:" field of patch
1269         mails and including a "From:" field in the body of the patch mail if
1270         different.  If set to a non-boolean value, format-patch uses that
1271         value instead of your committer identity.  Defaults to false.
1272
1273 format.numbered::
1274         A boolean which can enable or disable sequence numbers in patch
1275         subjects.  It defaults to "auto" which enables it only if there
1276         is more than one patch.  It can be enabled or disabled for all
1277         messages by setting it to "true" or "false".  See --numbered
1278         option in linkgit:git-format-patch[1].
1279
1280 format.headers::
1281         Additional email headers to include in a patch to be submitted
1282         by mail.  See linkgit:git-format-patch[1].
1283
1284 format.to::
1285 format.cc::
1286         Additional recipients to include in a patch to be submitted
1287         by mail.  See the --to and --cc options in
1288         linkgit:git-format-patch[1].
1289
1290 format.subjectPrefix::
1291         The default for format-patch is to output files with the '[PATCH]'
1292         subject prefix. Use this variable to change that prefix.
1293
1294 format.signature::
1295         The default for format-patch is to output a signature containing
1296         the Git version number. Use this variable to change that default.
1297         Set this variable to the empty string ("") to suppress
1298         signature generation.
1299
1300 format.signatureFile::
1301         Works just like format.signature except the contents of the
1302         file specified by this variable will be used as the signature.
1303
1304 format.suffix::
1305         The default for format-patch is to output files with the suffix
1306         `.patch`. Use this variable to change that suffix (make sure to
1307         include the dot if you want it).
1308
1309 format.pretty::
1310         The default pretty format for log/show/whatchanged command,
1311         See linkgit:git-log[1], linkgit:git-show[1],
1312         linkgit:git-whatchanged[1].
1313
1314 format.thread::
1315         The default threading style for 'git format-patch'.  Can be
1316         a boolean value, or `shallow` or `deep`.  `shallow` threading
1317         makes every mail a reply to the head of the series,
1318         where the head is chosen from the cover letter, the
1319         `--in-reply-to`, and the first patch mail, in this order.
1320         `deep` threading makes every mail a reply to the previous one.
1321         A true boolean value is the same as `shallow`, and a false
1322         value disables threading.
1323
1324 format.signOff::
1325         A boolean value which lets you enable the `-s/--signoff` option of
1326         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1327         patch should be a conscious act and means that you certify you have
1328         the rights to submit this work under the same open source license.
1329         Please see the 'SubmittingPatches' document for further discussion.
1330
1331 format.coverLetter::
1332         A boolean that controls whether to generate a cover-letter when
1333         format-patch is invoked, but in addition can be set to "auto", to
1334         generate a cover-letter only when there's more than one patch.
1335
1336 format.outputDirectory::
1337         Set a custom directory to store the resulting files instead of the
1338         current working directory.
1339
1340 format.useAutoBase::
1341         A boolean value which lets you enable the `--base=auto` option of
1342         format-patch by default.
1343
1344 filter.<driver>.clean::
1345         The command which is used to convert the content of a worktree
1346         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1347         details.
1348
1349 filter.<driver>.smudge::
1350         The command which is used to convert the content of a blob
1351         object to a worktree file upon checkout.  See
1352         linkgit:gitattributes[5] for details.
1353
1354 fsck.<msg-id>::
1355         Allows overriding the message type (error, warn or ignore) of a
1356         specific message ID such as `missingEmail`.
1357 +
1358 For convenience, fsck prefixes the error/warning with the message ID,
1359 e.g.  "missingEmail: invalid author/committer line - missing email" means
1360 that setting `fsck.missingEmail = ignore` will hide that issue.
1361 +
1362 This feature is intended to support working with legacy repositories
1363 which cannot be repaired without disruptive changes.
1364
1365 fsck.skipList::
1366         The path to a sorted list of object names (i.e. one SHA-1 per
1367         line) that are known to be broken in a non-fatal way and should
1368         be ignored. This feature is useful when an established project
1369         should be accepted despite early commits containing errors that
1370         can be safely ignored such as invalid committer email addresses.
1371         Note: corrupt objects cannot be skipped with this setting.
1372
1373 gc.aggressiveDepth::
1374         The depth parameter used in the delta compression
1375         algorithm used by 'git gc --aggressive'.  This defaults
1376         to 50.
1377
1378 gc.aggressiveWindow::
1379         The window size parameter used in the delta compression
1380         algorithm used by 'git gc --aggressive'.  This defaults
1381         to 250.
1382
1383 gc.auto::
1384         When there are approximately more than this many loose
1385         objects in the repository, `git gc --auto` will pack them.
1386         Some Porcelain commands use this command to perform a
1387         light-weight garbage collection from time to time.  The
1388         default value is 6700.  Setting this to 0 disables it.
1389
1390 gc.autoPackLimit::
1391         When there are more than this many packs that are not
1392         marked with `*.keep` file in the repository, `git gc
1393         --auto` consolidates them into one larger pack.  The
1394         default value is 50.  Setting this to 0 disables it.
1395
1396 gc.autoDetach::
1397         Make `git gc --auto` return immediately and run in background
1398         if the system supports it. Default is true.
1399
1400 gc.packRefs::
1401         Running `git pack-refs` in a repository renders it
1402         unclonable by Git versions prior to 1.5.1.2 over dumb
1403         transports such as HTTP.  This variable determines whether
1404         'git gc' runs `git pack-refs`. This can be set to `notbare`
1405         to enable it within all non-bare repos or it can be set to a
1406         boolean value.  The default is `true`.
1407
1408 gc.pruneExpire::
1409         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1410         Override the grace period with this config variable.  The value
1411         "now" may be used to disable this grace period and always prune
1412         unreachable objects immediately, or "never" may be used to
1413         suppress pruning.  This feature helps prevent corruption when
1414         'git gc' runs concurrently with another process writing to the
1415         repository; see the "NOTES" section of linkgit:git-gc[1].
1416
1417 gc.worktreePruneExpire::
1418         When 'git gc' is run, it calls
1419         'git worktree prune --expire 3.months.ago'.
1420         This config variable can be used to set a different grace
1421         period. The value "now" may be used to disable the grace
1422         period and prune `$GIT_DIR/worktrees` immediately, or "never"
1423         may be used to suppress pruning.
1424
1425 gc.reflogExpire::
1426 gc.<pattern>.reflogExpire::
1427         'git reflog expire' removes reflog entries older than
1428         this time; defaults to 90 days. The value "now" expires all
1429         entries immediately, and "never" suppresses expiration
1430         altogether. With "<pattern>" (e.g.
1431         "refs/stash") in the middle the setting applies only to
1432         the refs that match the <pattern>.
1433
1434 gc.reflogExpireUnreachable::
1435 gc.<pattern>.reflogExpireUnreachable::
1436         'git reflog expire' removes reflog entries older than
1437         this time and are not reachable from the current tip;
1438         defaults to 30 days. The value "now" expires all entries
1439         immediately, and "never" suppresses expiration altogether.
1440         With "<pattern>" (e.g. "refs/stash")
1441         in the middle, the setting applies only to the refs that
1442         match the <pattern>.
1443
1444 gc.rerereResolved::
1445         Records of conflicted merge you resolved earlier are
1446         kept for this many days when 'git rerere gc' is run.
1447         The default is 60 days.  See linkgit:git-rerere[1].
1448
1449 gc.rerereUnresolved::
1450         Records of conflicted merge you have not resolved are
1451         kept for this many days when 'git rerere gc' is run.
1452         The default is 15 days.  See linkgit:git-rerere[1].
1453
1454 gitcvs.commitMsgAnnotation::
1455         Append this string to each commit message. Set to empty string
1456         to disable this feature. Defaults to "via git-CVS emulator".
1457
1458 gitcvs.enabled::
1459         Whether the CVS server interface is enabled for this repository.
1460         See linkgit:git-cvsserver[1].
1461
1462 gitcvs.logFile::
1463         Path to a log file where the CVS server interface well... logs
1464         various stuff. See linkgit:git-cvsserver[1].
1465
1466 gitcvs.usecrlfattr::
1467         If true, the server will look up the end-of-line conversion
1468         attributes for files to determine the `-k` modes to use. If
1469         the attributes force Git to treat a file as text,
1470         the `-k` mode will be left blank so CVS clients will
1471         treat it as text. If they suppress text conversion, the file
1472         will be set with '-kb' mode, which suppresses any newline munging
1473         the client might otherwise do. If the attributes do not allow
1474         the file type to be determined, then `gitcvs.allBinary` is
1475         used. See linkgit:gitattributes[5].
1476
1477 gitcvs.allBinary::
1478         This is used if `gitcvs.usecrlfattr` does not resolve
1479         the correct '-kb' mode to use. If true, all
1480         unresolved files are sent to the client in
1481         mode '-kb'. This causes the client to treat them
1482         as binary files, which suppresses any newline munging it
1483         otherwise might do. Alternatively, if it is set to "guess",
1484         then the contents of the file are examined to decide if
1485         it is binary, similar to `core.autocrlf`.
1486
1487 gitcvs.dbName::
1488         Database used by git-cvsserver to cache revision information
1489         derived from the Git repository. The exact meaning depends on the
1490         used database driver, for SQLite (which is the default driver) this
1491         is a filename. Supports variable substitution (see
1492         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1493         Default: '%Ggitcvs.%m.sqlite'
1494
1495 gitcvs.dbDriver::
1496         Used Perl DBI driver. You can specify any available driver
1497         for this here, but it might not work. git-cvsserver is tested
1498         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1499         reported *not* to work with 'DBD::mysql'. Experimental feature.
1500         May not contain double colons (`:`). Default: 'SQLite'.
1501         See linkgit:git-cvsserver[1].
1502
1503 gitcvs.dbUser, gitcvs.dbPass::
1504         Database user and password. Only useful if setting `gitcvs.dbDriver`,
1505         since SQLite has no concept of database users and/or passwords.
1506         'gitcvs.dbUser' supports variable substitution (see
1507         linkgit:git-cvsserver[1] for details).
1508
1509 gitcvs.dbTableNamePrefix::
1510         Database table name prefix.  Prepended to the names of any
1511         database tables used, allowing a single database to be used
1512         for several repositories.  Supports variable substitution (see
1513         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1514         characters will be replaced with underscores.
1515
1516 All gitcvs variables except for `gitcvs.usecrlfattr` and
1517 `gitcvs.allBinary` can also be specified as
1518 'gitcvs.<access_method>.<varname>' (where 'access_method'
1519 is one of "ext" and "pserver") to make them apply only for the given
1520 access method.
1521
1522 gitweb.category::
1523 gitweb.description::
1524 gitweb.owner::
1525 gitweb.url::
1526         See linkgit:gitweb[1] for description.
1527
1528 gitweb.avatar::
1529 gitweb.blame::
1530 gitweb.grep::
1531 gitweb.highlight::
1532 gitweb.patches::
1533 gitweb.pickaxe::
1534 gitweb.remote_heads::
1535 gitweb.showSizes::
1536 gitweb.snapshot::
1537         See linkgit:gitweb.conf[5] for description.
1538
1539 grep.lineNumber::
1540         If set to true, enable `-n` option by default.
1541
1542 grep.patternType::
1543         Set the default matching behavior. Using a value of 'basic', 'extended',
1544         'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1545         `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1546         value 'default' will return to the default matching behavior.
1547
1548 grep.extendedRegexp::
1549         If set to true, enable `--extended-regexp` option by default. This
1550         option is ignored when the `grep.patternType` option is set to a value
1551         other than 'default'.
1552
1553 grep.threads::
1554         Number of grep worker threads to use.
1555         See `grep.threads` in linkgit:git-grep[1] for more information.
1556
1557 grep.fallbackToNoIndex::
1558         If set to true, fall back to git grep --no-index if git grep
1559         is executed outside of a git repository.  Defaults to false.
1560
1561 gpg.program::
1562         Use this custom program instead of "`gpg`" found on `$PATH` when
1563         making or verifying a PGP signature. The program must support the
1564         same command-line interface as GPG, namely, to verify a detached
1565         signature, "`gpg --verify $file - <$signature`" is run, and the
1566         program is expected to signal a good signature by exiting with
1567         code 0, and to generate an ASCII-armored detached signature, the
1568         standard input of "`gpg -bsau $key`" is fed with the contents to be
1569         signed, and the program is expected to send the result to its
1570         standard output.
1571
1572 gui.commitMsgWidth::
1573         Defines how wide the commit message window is in the
1574         linkgit:git-gui[1]. "75" is the default.
1575
1576 gui.diffContext::
1577         Specifies how many context lines should be used in calls to diff
1578         made by the linkgit:git-gui[1]. The default is "5".
1579
1580 gui.displayUntracked::
1581         Determines if linkgit:git-gui[1] shows untracked files
1582         in the file list. The default is "true".
1583
1584 gui.encoding::
1585         Specifies the default encoding to use for displaying of
1586         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1587         It can be overridden by setting the 'encoding' attribute
1588         for relevant files (see linkgit:gitattributes[5]).
1589         If this option is not set, the tools default to the
1590         locale encoding.
1591
1592 gui.matchTrackingBranch::
1593         Determines if new branches created with linkgit:git-gui[1] should
1594         default to tracking remote branches with matching names or
1595         not. Default: "false".
1596
1597 gui.newBranchTemplate::
1598         Is used as suggested name when creating new branches using the
1599         linkgit:git-gui[1].
1600
1601 gui.pruneDuringFetch::
1602         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1603         performing a fetch. The default value is "false".
1604
1605 gui.trustmtime::
1606         Determines if linkgit:git-gui[1] should trust the file modification
1607         timestamp or not. By default the timestamps are not trusted.
1608
1609 gui.spellingDictionary::
1610         Specifies the dictionary used for spell checking commit messages in
1611         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1612         off.
1613
1614 gui.fastCopyBlame::
1615         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1616         location detection. It makes blame significantly faster on huge
1617         repositories at the expense of less thorough copy detection.
1618
1619 gui.copyBlameThreshold::
1620         Specifies the threshold to use in 'git gui blame' original location
1621         detection, measured in alphanumeric characters. See the
1622         linkgit:git-blame[1] manual for more information on copy detection.
1623
1624 gui.blamehistoryctx::
1625         Specifies the radius of history context in days to show in
1626         linkgit:gitk[1] for the selected commit, when the `Show History
1627         Context` menu item is invoked from 'git gui blame'. If this
1628         variable is set to zero, the whole history is shown.
1629
1630 guitool.<name>.cmd::
1631         Specifies the shell command line to execute when the corresponding item
1632         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1633         mandatory for every tool. The command is executed from the root of
1634         the working directory, and in the environment it receives the name of
1635         the tool as `GIT_GUITOOL`, the name of the currently selected file as
1636         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1637         the head is detached, 'CUR_BRANCH' is empty).
1638
1639 guitool.<name>.needsFile::
1640         Run the tool only if a diff is selected in the GUI. It guarantees
1641         that 'FILENAME' is not empty.
1642
1643 guitool.<name>.noConsole::
1644         Run the command silently, without creating a window to display its
1645         output.
1646
1647 guitool.<name>.noRescan::
1648         Don't rescan the working directory for changes after the tool
1649         finishes execution.
1650
1651 guitool.<name>.confirm::
1652         Show a confirmation dialog before actually running the tool.
1653
1654 guitool.<name>.argPrompt::
1655         Request a string argument from the user, and pass it to the tool
1656         through the `ARGS` environment variable. Since requesting an
1657         argument implies confirmation, the 'confirm' option has no effect
1658         if this is enabled. If the option is set to 'true', 'yes', or '1',
1659         the dialog uses a built-in generic prompt; otherwise the exact
1660         value of the variable is used.
1661
1662 guitool.<name>.revPrompt::
1663         Request a single valid revision from the user, and set the
1664         `REVISION` environment variable. In other aspects this option
1665         is similar to 'argPrompt', and can be used together with it.
1666
1667 guitool.<name>.revUnmerged::
1668         Show only unmerged branches in the 'revPrompt' subdialog.
1669         This is useful for tools similar to merge or rebase, but not
1670         for things like checkout or reset.
1671
1672 guitool.<name>.title::
1673         Specifies the title to use for the prompt dialog. The default
1674         is the tool name.
1675
1676 guitool.<name>.prompt::
1677         Specifies the general prompt string to display at the top of
1678         the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1679         The default value includes the actual command.
1680
1681 help.browser::
1682         Specify the browser that will be used to display help in the
1683         'web' format. See linkgit:git-help[1].
1684
1685 help.format::
1686         Override the default help format used by linkgit:git-help[1].
1687         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1688         the default. 'web' and 'html' are the same.
1689
1690 help.autoCorrect::
1691         Automatically correct and execute mistyped commands after
1692         waiting for the given number of deciseconds (0.1 sec). If more
1693         than one command can be deduced from the entered text, nothing
1694         will be executed.  If the value of this option is negative,
1695         the corrected command will be executed immediately. If the
1696         value is 0 - the command will be just shown but not executed.
1697         This is the default.
1698
1699 help.htmlPath::
1700         Specify the path where the HTML documentation resides. File system paths
1701         and URLs are supported. HTML pages will be prefixed with this path when
1702         help is displayed in the 'web' format. This defaults to the documentation
1703         path of your Git installation.
1704
1705 http.proxy::
1706         Override the HTTP proxy, normally configured using the 'http_proxy',
1707         'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1708         addition to the syntax understood by curl, it is possible to specify a
1709         proxy string with a user name but no password, in which case git will
1710         attempt to acquire one in the same way it does for other credentials. See
1711         linkgit:gitcredentials[7] for more information. The syntax thus is
1712         '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1713         on a per-remote basis; see remote.<name>.proxy
1714
1715 http.proxyAuthMethod::
1716         Set the method with which to authenticate against the HTTP proxy. This
1717         only takes effect if the configured proxy string contains a user name part
1718         (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1719         overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1720         Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1721         variable.  Possible values are:
1722 +
1723 --
1724 * `anyauth` - Automatically pick a suitable authentication method. It is
1725   assumed that the proxy answers an unauthenticated request with a 407
1726   status code and one or more Proxy-authenticate headers with supported
1727   authentication methods. This is the default.
1728 * `basic` - HTTP Basic authentication
1729 * `digest` - HTTP Digest authentication; this prevents the password from being
1730   transmitted to the proxy in clear text
1731 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1732   of `curl(1)`)
1733 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1734 --
1735
1736 http.emptyAuth::
1737         Attempt authentication without seeking a username or password.  This
1738         can be used to attempt GSS-Negotiate authentication without specifying
1739         a username in the URL, as libcurl normally requires a username for
1740         authentication.
1741
1742 http.delegation::
1743         Control GSSAPI credential delegation. The delegation is disabled
1744         by default in libcurl since version 7.21.7. Set parameter to tell
1745         the server what it is allowed to delegate when it comes to user
1746         credentials. Used with GSS/kerberos. Possible values are:
1747 +
1748 --
1749 * `none` - Don't allow any delegation.
1750 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1751   Kerberos service ticket, which is a matter of realm policy.
1752 * `always` - Unconditionally allow the server to delegate.
1753 --
1754
1755
1756 http.extraHeader::
1757         Pass an additional HTTP header when communicating with a server.  If
1758         more than one such entry exists, all of them are added as extra
1759         headers.  To allow overriding the settings inherited from the system
1760         config, an empty value will reset the extra headers to the empty list.
1761
1762 http.cookieFile::
1763         The pathname of a file containing previously stored cookie lines,
1764         which should be used
1765         in the Git http session, if they match the server. The file format
1766         of the file to read cookies from should be plain HTTP headers or
1767         the Netscape/Mozilla cookie file format (see `curl(1)`).
1768         NOTE that the file specified with http.cookieFile is used only as
1769         input unless http.saveCookies is set.
1770
1771 http.saveCookies::
1772         If set, store cookies received during requests to the file specified by
1773         http.cookieFile. Has no effect if http.cookieFile is unset.
1774
1775 http.sslVersion::
1776         The SSL version to use when negotiating an SSL connection, if you
1777         want to force the default.  The available and default version
1778         depend on whether libcurl was built against NSS or OpenSSL and the
1779         particular configuration of the crypto library in use. Internally
1780         this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1781         documentation for more details on the format of this option and
1782         for the ssl version supported. Actually the possible values of
1783         this option are:
1784
1785         - sslv2
1786         - sslv3
1787         - tlsv1
1788         - tlsv1.0
1789         - tlsv1.1
1790         - tlsv1.2
1791
1792 +
1793 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1794 To force git to use libcurl's default ssl version and ignore any
1795 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1796 empty string.
1797
1798 http.sslCipherList::
1799   A list of SSL ciphers to use when negotiating an SSL connection.
1800   The available ciphers depend on whether libcurl was built against
1801   NSS or OpenSSL and the particular configuration of the crypto
1802   library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1803   option; see the libcurl documentation for more details on the format
1804   of this list.
1805 +
1806 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1807 To force git to use libcurl's default cipher list and ignore any
1808 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1809 empty string.
1810
1811 http.sslVerify::
1812         Whether to verify the SSL certificate when fetching or pushing
1813         over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1814         variable.
1815
1816 http.sslCert::
1817         File containing the SSL certificate when fetching or pushing
1818         over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1819         variable.
1820
1821 http.sslKey::
1822         File containing the SSL private key when fetching or pushing
1823         over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1824         variable.
1825
1826 http.sslCertPasswordProtected::
1827         Enable Git's password prompt for the SSL certificate.  Otherwise
1828         OpenSSL will prompt the user, possibly many times, if the
1829         certificate or private key is encrypted.  Can be overridden by the
1830         `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1831
1832 http.sslCAInfo::
1833         File containing the certificates to verify the peer with when
1834         fetching or pushing over HTTPS. Can be overridden by the
1835         `GIT_SSL_CAINFO` environment variable.
1836
1837 http.sslCAPath::
1838         Path containing files with the CA certificates to verify the peer
1839         with when fetching or pushing over HTTPS. Can be overridden
1840         by the `GIT_SSL_CAPATH` environment variable.
1841
1842 http.pinnedpubkey::
1843         Public key of the https service. It may either be the filename of
1844         a PEM or DER encoded public key file or a string starting with
1845         'sha256//' followed by the base64 encoded sha256 hash of the
1846         public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1847         exit with an error if this option is set but not supported by
1848         cURL.
1849
1850 http.sslTry::
1851         Attempt to use AUTH SSL/TLS and encrypted data transfers
1852         when connecting via regular FTP protocol. This might be needed
1853         if the FTP server requires it for security reasons or you wish
1854         to connect securely whenever remote FTP server supports it.
1855         Default is false since it might trigger certificate verification
1856         errors on misconfigured servers.
1857
1858 http.maxRequests::
1859         How many HTTP requests to launch in parallel. Can be overridden
1860         by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1861
1862 http.minSessions::
1863         The number of curl sessions (counted across slots) to be kept across
1864         requests. They will not be ended with curl_easy_cleanup() until
1865         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1866         value will be capped at 1. Defaults to 1.
1867
1868 http.postBuffer::
1869         Maximum size in bytes of the buffer used by smart HTTP
1870         transports when POSTing data to the remote system.
1871         For requests larger than this buffer size, HTTP/1.1 and
1872         Transfer-Encoding: chunked is used to avoid creating a
1873         massive pack file locally.  Default is 1 MiB, which is
1874         sufficient for most requests.
1875
1876 http.lowSpeedLimit, http.lowSpeedTime::
1877         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1878         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1879         Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1880         `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1881
1882 http.noEPSV::
1883         A boolean which disables using of EPSV ftp command by curl.
1884         This can helpful with some "poor" ftp servers which don't
1885         support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1886         environment variable. Default is false (curl will use EPSV).
1887
1888 http.userAgent::
1889         The HTTP USER_AGENT string presented to an HTTP server.  The default
1890         value represents the version of the client Git such as git/1.7.1.
1891         This option allows you to override this value to a more common value
1892         such as Mozilla/4.0.  This may be necessary, for instance, if
1893         connecting through a firewall that restricts HTTP connections to a set
1894         of common USER_AGENT strings (but not including those like git/1.7.1).
1895         Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1896
1897 http.followRedirects::
1898         Whether git should follow HTTP redirects. If set to `true`, git
1899         will transparently follow any redirect issued by a server it
1900         encounters. If set to `false`, git will treat all redirects as
1901         errors. If set to `initial`, git will follow redirects only for
1902         the initial request to a remote, but not for subsequent
1903         follow-up HTTP requests. Since git uses the redirected URL as
1904         the base for the follow-up requests, this is generally
1905         sufficient. The default is `initial`.
1906
1907 http.<url>.*::
1908         Any of the http.* options above can be applied selectively to some URLs.
1909         For a config key to match a URL, each element of the config key is
1910         compared to that of the URL, in the following order:
1911 +
1912 --
1913 . Scheme (e.g., `https` in `https://example.com/`). This field
1914   must match exactly between the config key and the URL.
1915
1916 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1917   This field must match exactly between the config key and the URL.
1918
1919 . Port number (e.g., `8080` in `http://example.com:8080/`).
1920   This field must match exactly between the config key and the URL.
1921   Omitted port numbers are automatically converted to the correct
1922   default for the scheme before matching.
1923
1924 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1925   path field of the config key must match the path field of the URL
1926   either exactly or as a prefix of slash-delimited path elements.  This means
1927   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1928   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1929   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1930   key with just path `foo/`).
1931
1932 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1933   the config key has a user name it must match the user name in the
1934   URL exactly. If the config key does not have a user name, that
1935   config key will match a URL with any user name (including none),
1936   but at a lower precedence than a config key with a user name.
1937 --
1938 +
1939 The list above is ordered by decreasing precedence; a URL that matches
1940 a config key's path is preferred to one that matches its user name. For example,
1941 if the URL is `https://user@example.com/foo/bar` a config key match of
1942 `https://example.com/foo` will be preferred over a config key match of
1943 `https://user@example.com`.
1944 +
1945 All URLs are normalized before attempting any matching (the password part,
1946 if embedded in the URL, is always ignored for matching purposes) so that
1947 equivalent URLs that are simply spelled differently will match properly.
1948 Environment variable settings always override any matches.  The URLs that are
1949 matched against are those given directly to Git commands.  This means any URLs
1950 visited as a result of a redirection do not participate in matching.
1951
1952 i18n.commitEncoding::
1953         Character encoding the commit messages are stored in; Git itself
1954         does not care per se, but this information is necessary e.g. when
1955         importing commits from emails or in the gitk graphical history
1956         browser (and possibly at other places in the future or in other
1957         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1958
1959 i18n.logOutputEncoding::
1960         Character encoding the commit messages are converted to when
1961         running 'git log' and friends.
1962
1963 imap::
1964         The configuration variables in the 'imap' section are described
1965         in linkgit:git-imap-send[1].
1966
1967 index.version::
1968         Specify the version with which new index files should be
1969         initialized.  This does not affect existing repositories.
1970
1971 init.templateDir::
1972         Specify the directory from which templates will be copied.
1973         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1974
1975 instaweb.browser::
1976         Specify the program that will be used to browse your working
1977         repository in gitweb. See linkgit:git-instaweb[1].
1978
1979 instaweb.httpd::
1980         The HTTP daemon command-line to start gitweb on your working
1981         repository. See linkgit:git-instaweb[1].
1982
1983 instaweb.local::
1984         If true the web server started by linkgit:git-instaweb[1] will
1985         be bound to the local IP (127.0.0.1).
1986
1987 instaweb.modulePath::
1988         The default module path for linkgit:git-instaweb[1] to use
1989         instead of /usr/lib/apache2/modules.  Only used if httpd
1990         is Apache.
1991
1992 instaweb.port::
1993         The port number to bind the gitweb httpd to. See
1994         linkgit:git-instaweb[1].
1995
1996 interactive.singleKey::
1997         In interactive commands, allow the user to provide one-letter
1998         input with a single key (i.e., without hitting enter).
1999         Currently this is used by the `--patch` mode of
2000         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2001         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2002         setting is silently ignored if portable keystroke input
2003         is not available; requires the Perl module Term::ReadKey.
2004
2005 interactive.diffFilter::
2006         When an interactive command (such as `git add --patch`) shows
2007         a colorized diff, git will pipe the diff through the shell
2008         command defined by this configuration variable. The command may
2009         mark up the diff further for human consumption, provided that it
2010         retains a one-to-one correspondence with the lines in the
2011         original diff. Defaults to disabled (no filtering).
2012
2013 log.abbrevCommit::
2014         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2015         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2016         override this option with `--no-abbrev-commit`.
2017
2018 log.date::
2019         Set the default date-time mode for the 'log' command.
2020         Setting a value for log.date is similar to using 'git log''s
2021         `--date` option.  See linkgit:git-log[1] for details.
2022
2023 log.decorate::
2024         Print out the ref names of any commits that are shown by the log
2025         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2026         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2027         specified, the full ref name (including prefix) will be printed.
2028         If 'auto' is specified, then if the output is going to a terminal,
2029         the ref names are shown as if 'short' were given, otherwise no ref
2030         names are shown. This is the same as the `--decorate` option
2031         of the `git log`.
2032
2033 log.follow::
2034         If `true`, `git log` will act as if the `--follow` option was used when
2035         a single <path> is given.  This has the same limitations as `--follow`,
2036         i.e. it cannot be used to follow multiple files and does not work well
2037         on non-linear history.
2038
2039 log.showRoot::
2040         If true, the initial commit will be shown as a big creation event.
2041         This is equivalent to a diff against an empty tree.
2042         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2043         normally hide the root commit will now show it. True by default.
2044
2045 log.mailmap::
2046         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2047         linkgit:git-whatchanged[1] assume `--use-mailmap`.
2048
2049 mailinfo.scissors::
2050         If true, makes linkgit:git-mailinfo[1] (and therefore
2051         linkgit:git-am[1]) act by default as if the --scissors option
2052         was provided on the command-line. When active, this features
2053         removes everything from the message body before a scissors
2054         line (i.e. consisting mainly of ">8", "8<" and "-").
2055
2056 mailmap.file::
2057         The location of an augmenting mailmap file. The default
2058         mailmap, located in the root of the repository, is loaded
2059         first, then the mailmap file pointed to by this variable.
2060         The location of the mailmap file may be in a repository
2061         subdirectory, or somewhere outside of the repository itself.
2062         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2063
2064 mailmap.blob::
2065         Like `mailmap.file`, but consider the value as a reference to a
2066         blob in the repository. If both `mailmap.file` and
2067         `mailmap.blob` are given, both are parsed, with entries from
2068         `mailmap.file` taking precedence. In a bare repository, this
2069         defaults to `HEAD:.mailmap`. In a non-bare repository, it
2070         defaults to empty.
2071
2072 man.viewer::
2073         Specify the programs that may be used to display help in the
2074         'man' format. See linkgit:git-help[1].
2075
2076 man.<tool>.cmd::
2077         Specify the command to invoke the specified man viewer. The
2078         specified command is evaluated in shell with the man page
2079         passed as argument. (See linkgit:git-help[1].)
2080
2081 man.<tool>.path::
2082         Override the path for the given tool that may be used to
2083         display help in the 'man' format. See linkgit:git-help[1].
2084
2085 include::merge-config.txt[]
2086
2087 mergetool.<tool>.path::
2088         Override the path for the given tool.  This is useful in case
2089         your tool is not in the PATH.
2090
2091 mergetool.<tool>.cmd::
2092         Specify the command to invoke the specified merge tool.  The
2093         specified command is evaluated in shell with the following
2094         variables available: 'BASE' is the name of a temporary file
2095         containing the common base of the files to be merged, if available;
2096         'LOCAL' is the name of a temporary file containing the contents of
2097         the file on the current branch; 'REMOTE' is the name of a temporary
2098         file containing the contents of the file from the branch being
2099         merged; 'MERGED' contains the name of the file to which the merge
2100         tool should write the results of a successful merge.
2101
2102 mergetool.<tool>.trustExitCode::
2103         For a custom merge command, specify whether the exit code of
2104         the merge command can be used to determine whether the merge was
2105         successful.  If this is not set to true then the merge target file
2106         timestamp is checked and the merge assumed to have been successful
2107         if the file has been updated, otherwise the user is prompted to
2108         indicate the success of the merge.
2109
2110 mergetool.meld.hasOutput::
2111         Older versions of `meld` do not support the `--output` option.
2112         Git will attempt to detect whether `meld` supports `--output`
2113         by inspecting the output of `meld --help`.  Configuring
2114         `mergetool.meld.hasOutput` will make Git skip these checks and
2115         use the configured value instead.  Setting `mergetool.meld.hasOutput`
2116         to `true` tells Git to unconditionally use the `--output` option,
2117         and `false` avoids using `--output`.
2118
2119 mergetool.keepBackup::
2120         After performing a merge, the original file with conflict markers
2121         can be saved as a file with a `.orig` extension.  If this variable
2122         is set to `false` then this file is not preserved.  Defaults to
2123         `true` (i.e. keep the backup files).
2124
2125 mergetool.keepTemporaries::
2126         When invoking a custom merge tool, Git uses a set of temporary
2127         files to pass to the tool. If the tool returns an error and this
2128         variable is set to `true`, then these temporary files will be
2129         preserved, otherwise they will be removed after the tool has
2130         exited. Defaults to `false`.
2131
2132 mergetool.writeToTemp::
2133         Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2134         conflicting files in the worktree by default.  Git will attempt
2135         to use a temporary directory for these files when set `true`.
2136         Defaults to `false`.
2137
2138 mergetool.prompt::
2139         Prompt before each invocation of the merge resolution program.
2140
2141 notes.mergeStrategy::
2142         Which merge strategy to choose by default when resolving notes
2143         conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2144         `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2145         section of linkgit:git-notes[1] for more information on each strategy.
2146
2147 notes.<name>.mergeStrategy::
2148         Which merge strategy to choose when doing a notes merge into
2149         refs/notes/<name>.  This overrides the more general
2150         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2151         linkgit:git-notes[1] for more information on the available strategies.
2152
2153 notes.displayRef::
2154         The (fully qualified) refname from which to show notes when
2155         showing commit messages.  The value of this variable can be set
2156         to a glob, in which case notes from all matching refs will be
2157         shown.  You may also specify this configuration variable
2158         several times.  A warning will be issued for refs that do not
2159         exist, but a glob that does not match any refs is silently
2160         ignored.
2161 +
2162 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2163 environment variable, which must be a colon separated list of refs or
2164 globs.
2165 +
2166 The effective value of "core.notesRef" (possibly overridden by
2167 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2168 displayed.
2169
2170 notes.rewrite.<command>::
2171         When rewriting commits with <command> (currently `amend` or
2172         `rebase`) and this variable is set to `true`, Git
2173         automatically copies your notes from the original to the
2174         rewritten commit.  Defaults to `true`, but see
2175         "notes.rewriteRef" below.
2176
2177 notes.rewriteMode::
2178         When copying notes during a rewrite (see the
2179         "notes.rewrite.<command>" option), determines what to do if
2180         the target commit already has a note.  Must be one of
2181         `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2182         Defaults to `concatenate`.
2183 +
2184 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2185 environment variable.
2186
2187 notes.rewriteRef::
2188         When copying notes during a rewrite, specifies the (fully
2189         qualified) ref whose notes should be copied.  The ref may be a
2190         glob, in which case notes in all matching refs will be copied.
2191         You may also specify this configuration several times.
2192 +
2193 Does not have a default value; you must configure this variable to
2194 enable note rewriting.  Set it to `refs/notes/commits` to enable
2195 rewriting for the default commit notes.
2196 +
2197 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2198 environment variable, which must be a colon separated list of refs or
2199 globs.
2200
2201 pack.window::
2202         The size of the window used by linkgit:git-pack-objects[1] when no
2203         window size is given on the command line. Defaults to 10.
2204
2205 pack.depth::
2206         The maximum delta depth used by linkgit:git-pack-objects[1] when no
2207         maximum depth is given on the command line. Defaults to 50.
2208
2209 pack.windowMemory::
2210         The maximum size of memory that is consumed by each thread
2211         in linkgit:git-pack-objects[1] for pack window memory when
2212         no limit is given on the command line.  The value can be
2213         suffixed with "k", "m", or "g".  When left unconfigured (or
2214         set explicitly to 0), there will be no limit.
2215
2216 pack.compression::
2217         An integer -1..9, indicating the compression level for objects
2218         in a pack file. -1 is the zlib default. 0 means no
2219         compression, and 1..9 are various speed/size tradeoffs, 9 being
2220         slowest.  If not set,  defaults to core.compression.  If that is
2221         not set,  defaults to -1, the zlib default, which is "a default
2222         compromise between speed and compression (currently equivalent
2223         to level 6)."
2224 +
2225 Note that changing the compression level will not automatically recompress
2226 all existing objects. You can force recompression by passing the -F option
2227 to linkgit:git-repack[1].
2228
2229 pack.deltaCacheSize::
2230         The maximum memory in bytes used for caching deltas in
2231         linkgit:git-pack-objects[1] before writing them out to a pack.
2232         This cache is used to speed up the writing object phase by not
2233         having to recompute the final delta result once the best match
2234         for all objects is found.  Repacking large repositories on machines
2235         which are tight with memory might be badly impacted by this though,
2236         especially if this cache pushes the system into swapping.
2237         A value of 0 means no limit. The smallest size of 1 byte may be
2238         used to virtually disable this cache. Defaults to 256 MiB.
2239
2240 pack.deltaCacheLimit::
2241         The maximum size of a delta, that is cached in
2242         linkgit:git-pack-objects[1]. This cache is used to speed up the
2243         writing object phase by not having to recompute the final delta
2244         result once the best match for all objects is found. Defaults to 1000.
2245
2246 pack.threads::
2247         Specifies the number of threads to spawn when searching for best
2248         delta matches.  This requires that linkgit:git-pack-objects[1]
2249         be compiled with pthreads otherwise this option is ignored with a
2250         warning. This is meant to reduce packing time on multiprocessor
2251         machines. The required amount of memory for the delta search window
2252         is however multiplied by the number of threads.
2253         Specifying 0 will cause Git to auto-detect the number of CPU's
2254         and set the number of threads accordingly.
2255
2256 pack.indexVersion::
2257         Specify the default pack index version.  Valid values are 1 for
2258         legacy pack index used by Git versions prior to 1.5.2, and 2 for
2259         the new pack index with capabilities for packs larger than 4 GB
2260         as well as proper protection against the repacking of corrupted
2261         packs.  Version 2 is the default.  Note that version 2 is enforced
2262         and this config option ignored whenever the corresponding pack is
2263         larger than 2 GB.
2264 +
2265 If you have an old Git that does not understand the version 2 `*.idx` file,
2266 cloning or fetching over a non native protocol (e.g. "http")
2267 that will copy both `*.pack` file and corresponding `*.idx` file from the
2268 other side may give you a repository that cannot be accessed with your
2269 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2270 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2271 the `*.idx` file.
2272
2273 pack.packSizeLimit::
2274         The maximum size of a pack.  This setting only affects
2275         packing to a file when repacking, i.e. the git:// protocol
2276         is unaffected.  It can be overridden by the `--max-pack-size`
2277         option of linkgit:git-repack[1].  Reaching this limit results
2278         in the creation of multiple packfiles; which in turn prevents
2279         bitmaps from being created.
2280         The minimum size allowed is limited to 1 MiB.
2281         The default is unlimited.
2282         Common unit suffixes of 'k', 'm', or 'g' are
2283         supported.
2284
2285 pack.useBitmaps::
2286         When true, git will use pack bitmaps (if available) when packing
2287         to stdout (e.g., during the server side of a fetch). Defaults to
2288         true. You should not generally need to turn this off unless
2289         you are debugging pack bitmaps.
2290
2291 pack.writeBitmaps (deprecated)::
2292         This is a deprecated synonym for `repack.writeBitmaps`.
2293
2294 pack.writeBitmapHashCache::
2295         When true, git will include a "hash cache" section in the bitmap
2296         index (if one is written). This cache can be used to feed git's
2297         delta heuristics, potentially leading to better deltas between
2298         bitmapped and non-bitmapped objects (e.g., when serving a fetch
2299         between an older, bitmapped pack and objects that have been
2300         pushed since the last gc). The downside is that it consumes 4
2301         bytes per object of disk space, and that JGit's bitmap
2302         implementation does not understand it, causing it to complain if
2303         Git and JGit are used on the same repository. Defaults to false.
2304
2305 pager.<cmd>::
2306         If the value is boolean, turns on or off pagination of the
2307         output of a particular Git subcommand when writing to a tty.
2308         Otherwise, turns on pagination for the subcommand using the
2309         pager specified by the value of `pager.<cmd>`.  If `--paginate`
2310         or `--no-pager` is specified on the command line, it takes
2311         precedence over this option.  To disable pagination for all
2312         commands, set `core.pager` or `GIT_PAGER` to `cat`.
2313
2314 pretty.<name>::
2315         Alias for a --pretty= format string, as specified in
2316         linkgit:git-log[1]. Any aliases defined here can be used just
2317         as the built-in pretty formats could. For example,
2318         running `git config pretty.changelog "format:* %H %s"`
2319         would cause the invocation `git log --pretty=changelog`
2320         to be equivalent to running `git log "--pretty=format:* %H %s"`.
2321         Note that an alias with the same name as a built-in format
2322         will be silently ignored.
2323
2324 protocol.allow::
2325         If set, provide a user defined default policy for all protocols which
2326         don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2327         if unset, known-safe protocols (http, https, git, ssh, file) have a
2328         default policy of `always`, known-dangerous protocols (ext) have a
2329         default policy of `never`, and all other protocols have a default
2330         policy of `user`.  Supported policies:
2331 +
2332 --
2333
2334 * `always` - protocol is always able to be used.
2335
2336 * `never` - protocol is never able to be used.
2337
2338 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2339   either unset or has a value of 1.  This policy should be used when you want a
2340   protocol to be directly usable by the user but don't want it used by commands which
2341   execute clone/fetch/push commands without user input, e.g. recursive
2342   submodule initialization.
2343
2344 --
2345
2346 protocol.<name>.allow::
2347         Set a policy to be used by protocol `<name>` with clone/fetch/push
2348         commands. See `protocol.allow` above for the available policies.
2349 +
2350 The protocol names currently used by git are:
2351 +
2352 --
2353   - `file`: any local file-based path (including `file://` URLs,
2354     or local paths)
2355
2356   - `git`: the anonymous git protocol over a direct TCP
2357     connection (or proxy, if configured)
2358
2359   - `ssh`: git over ssh (including `host:path` syntax,
2360     `ssh://`, etc).
2361
2362   - `http`: git over http, both "smart http" and "dumb http".
2363     Note that this does _not_ include `https`; if you want to configure
2364     both, you must do so individually.
2365
2366   - any external helpers are named by their protocol (e.g., use
2367     `hg` to allow the `git-remote-hg` helper)
2368 --
2369
2370 pull.ff::
2371         By default, Git does not create an extra merge commit when merging
2372         a commit that is a descendant of the current commit. Instead, the
2373         tip of the current branch is fast-forwarded. When set to `false`,
2374         this variable tells Git to create an extra merge commit in such
2375         a case (equivalent to giving the `--no-ff` option from the command
2376         line). When set to `only`, only such fast-forward merges are
2377         allowed (equivalent to giving the `--ff-only` option from the
2378         command line). This setting overrides `merge.ff` when pulling.
2379
2380 pull.rebase::
2381         When true, rebase branches on top of the fetched branch, instead
2382         of merging the default branch from the default remote when "git
2383         pull" is run. See "branch.<name>.rebase" for setting this on a
2384         per-branch basis.
2385 +
2386 When preserve, also pass `--preserve-merges` along to 'git rebase'
2387 so that locally committed merge commits will not be flattened
2388 by running 'git pull'.
2389 +
2390 When the value is `interactive`, the rebase is run in interactive mode.
2391 +
2392 *NOTE*: this is a possibly dangerous operation; do *not* use
2393 it unless you understand the implications (see linkgit:git-rebase[1]
2394 for details).
2395
2396 pull.octopus::
2397         The default merge strategy to use when pulling multiple branches
2398         at once.
2399
2400 pull.twohead::
2401         The default merge strategy to use when pulling a single branch.
2402
2403 push.default::
2404         Defines the action `git push` should take if no refspec is
2405         explicitly given.  Different values are well-suited for
2406         specific workflows; for instance, in a purely central workflow
2407         (i.e. the fetch source is equal to the push destination),
2408         `upstream` is probably what you want.  Possible values are:
2409 +
2410 --
2411
2412 * `nothing` - do not push anything (error out) unless a refspec is
2413   explicitly given. This is primarily meant for people who want to
2414   avoid mistakes by always being explicit.
2415
2416 * `current` - push the current branch to update a branch with the same
2417   name on the receiving end.  Works in both central and non-central
2418   workflows.
2419
2420 * `upstream` - push the current branch back to the branch whose
2421   changes are usually integrated into the current branch (which is
2422   called `@{upstream}`).  This mode only makes sense if you are
2423   pushing to the same repository you would normally pull from
2424   (i.e. central workflow).
2425
2426 * `simple` - in centralized workflow, work like `upstream` with an
2427   added safety to refuse to push if the upstream branch's name is
2428   different from the local one.
2429 +
2430 When pushing to a remote that is different from the remote you normally
2431 pull from, work as `current`.  This is the safest option and is suited
2432 for beginners.
2433 +
2434 This mode has become the default in Git 2.0.
2435
2436 * `matching` - push all branches having the same name on both ends.
2437   This makes the repository you are pushing to remember the set of
2438   branches that will be pushed out (e.g. if you always push 'maint'
2439   and 'master' there and no other branches, the repository you push
2440   to will have these two branches, and your local 'maint' and
2441   'master' will be pushed there).
2442 +
2443 To use this mode effectively, you have to make sure _all_ the
2444 branches you would push out are ready to be pushed out before
2445 running 'git push', as the whole point of this mode is to allow you
2446 to push all of the branches in one go.  If you usually finish work
2447 on only one branch and push out the result, while other branches are
2448 unfinished, this mode is not for you.  Also this mode is not
2449 suitable for pushing into a shared central repository, as other
2450 people may add new branches there, or update the tip of existing
2451 branches outside your control.
2452 +
2453 This used to be the default, but not since Git 2.0 (`simple` is the
2454 new default).
2455
2456 --
2457
2458 push.followTags::
2459         If set to true enable `--follow-tags` option by default.  You
2460         may override this configuration at time of push by specifying
2461         `--no-follow-tags`.
2462
2463 push.gpgSign::
2464         May be set to a boolean value, or the string 'if-asked'. A true
2465         value causes all pushes to be GPG signed, as if `--signed` is
2466         passed to linkgit:git-push[1]. The string 'if-asked' causes
2467         pushes to be signed if the server supports it, as if
2468         `--signed=if-asked` is passed to 'git push'. A false value may
2469         override a value from a lower-priority config file. An explicit
2470         command-line flag always overrides this config option.
2471
2472 push.recurseSubmodules::
2473         Make sure all submodule commits used by the revisions to be pushed
2474         are available on a remote-tracking branch. If the value is 'check'
2475         then Git will verify that all submodule commits that changed in the
2476         revisions to be pushed are available on at least one remote of the
2477         submodule. If any commits are missing, the push will be aborted and
2478         exit with non-zero status. If the value is 'on-demand' then all
2479         submodules that changed in the revisions to be pushed will be
2480         pushed. If on-demand was not able to push all necessary revisions
2481         it will also be aborted and exit with non-zero status. If the value
2482         is 'no' then default behavior of ignoring submodules when pushing
2483         is retained. You may override this configuration at time of push by
2484         specifying '--recurse-submodules=check|on-demand|no'.
2485
2486 rebase.stat::
2487         Whether to show a diffstat of what changed upstream since the last
2488         rebase. False by default.
2489
2490 rebase.autoSquash::
2491         If set to true enable `--autosquash` option by default.
2492
2493 rebase.autoStash::
2494         When set to true, automatically create a temporary stash
2495         before the operation begins, and apply it after the operation
2496         ends.  This means that you can run rebase on a dirty worktree.
2497         However, use with care: the final stash application after a
2498         successful rebase might result in non-trivial conflicts.
2499         Defaults to false.
2500
2501 rebase.missingCommitsCheck::
2502         If set to "warn", git rebase -i will print a warning if some
2503         commits are removed (e.g. a line was deleted), however the
2504         rebase will still proceed. If set to "error", it will print
2505         the previous warning and stop the rebase, 'git rebase
2506         --edit-todo' can then be used to correct the error. If set to
2507         "ignore", no checking is done.
2508         To drop a commit without warning or error, use the `drop`
2509         command in the todo-list.
2510         Defaults to "ignore".
2511
2512 rebase.instructionFormat::
2513         A format string, as specified in linkgit:git-log[1], to be used for
2514         the instruction list during an interactive rebase.  The format will automatically
2515         have the long commit hash prepended to the format.
2516
2517 receive.advertiseAtomic::
2518         By default, git-receive-pack will advertise the atomic push
2519         capability to its clients. If you don't want to advertise this
2520         capability, set this variable to false.
2521
2522 receive.advertisePushOptions::
2523         By default, git-receive-pack will advertise the push options
2524         capability to its clients. If you don't want to advertise this
2525         capability, set this variable to false.
2526
2527 receive.autogc::
2528         By default, git-receive-pack will run "git-gc --auto" after
2529         receiving data from git-push and updating refs.  You can stop
2530         it by setting this variable to false.
2531
2532 receive.certNonceSeed::
2533         By setting this variable to a string, `git receive-pack`
2534         will accept a `git push --signed` and verifies it by using
2535         a "nonce" protected by HMAC using this string as a secret
2536         key.
2537
2538 receive.certNonceSlop::
2539         When a `git push --signed` sent a push certificate with a
2540         "nonce" that was issued by a receive-pack serving the same
2541         repository within this many seconds, export the "nonce"
2542         found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2543         hooks (instead of what the receive-pack asked the sending
2544         side to include).  This may allow writing checks in
2545         `pre-receive` and `post-receive` a bit easier.  Instead of
2546         checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2547         that records by how many seconds the nonce is stale to
2548         decide if they want to accept the certificate, they only
2549         can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2550
2551 receive.fsckObjects::
2552         If it is set to true, git-receive-pack will check all received
2553         objects. It will abort in the case of a malformed object or a
2554         broken link. The result of an abort are only dangling objects.
2555         Defaults to false. If not set, the value of `transfer.fsckObjects`
2556         is used instead.
2557
2558 receive.fsck.<msg-id>::
2559         When `receive.fsckObjects` is set to true, errors can be switched
2560         to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2561         setting where the `<msg-id>` is the fsck message ID and the value
2562         is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2563         the error/warning with the message ID, e.g. "missingEmail: invalid
2564         author/committer line - missing email" means that setting
2565         `receive.fsck.missingEmail = ignore` will hide that issue.
2566 +
2567 This feature is intended to support working with legacy repositories
2568 which would not pass pushing when `receive.fsckObjects = true`, allowing
2569 the host to accept repositories with certain known issues but still catch
2570 other issues.
2571
2572 receive.fsck.skipList::
2573         The path to a sorted list of object names (i.e. one SHA-1 per
2574         line) that are known to be broken in a non-fatal way and should
2575         be ignored. This feature is useful when an established project
2576         should be accepted despite early commits containing errors that
2577         can be safely ignored such as invalid committer email addresses.
2578         Note: corrupt objects cannot be skipped with this setting.
2579
2580 receive.keepAlive::
2581         After receiving the pack from the client, `receive-pack` may
2582         produce no output (if `--quiet` was specified) while processing
2583         the pack, causing some networks to drop the TCP connection.
2584         With this option set, if `receive-pack` does not transmit
2585         any data in this phase for `receive.keepAlive` seconds, it will
2586         send a short keepalive packet.  The default is 5 seconds; set
2587         to 0 to disable keepalives entirely.
2588
2589 receive.unpackLimit::
2590         If the number of objects received in a push is below this
2591         limit then the objects will be unpacked into loose object
2592         files. However if the number of received objects equals or
2593         exceeds this limit then the received pack will be stored as
2594         a pack, after adding any missing delta bases.  Storing the
2595         pack from a push can make the push operation complete faster,
2596         especially on slow filesystems.  If not set, the value of
2597         `transfer.unpackLimit` is used instead.
2598
2599 receive.maxInputSize::
2600         If the size of the incoming pack stream is larger than this
2601         limit, then git-receive-pack will error out, instead of
2602         accepting the pack file. If not set or set to 0, then the size
2603         is unlimited.
2604
2605 receive.denyDeletes::
2606         If set to true, git-receive-pack will deny a ref update that deletes
2607         the ref. Use this to prevent such a ref deletion via a push.
2608
2609 receive.denyDeleteCurrent::
2610         If set to true, git-receive-pack will deny a ref update that
2611         deletes the currently checked out branch of a non-bare repository.
2612
2613 receive.denyCurrentBranch::
2614         If set to true or "refuse", git-receive-pack will deny a ref update
2615         to the currently checked out branch of a non-bare repository.
2616         Such a push is potentially dangerous because it brings the HEAD
2617         out of sync with the index and working tree. If set to "warn",
2618         print a warning of such a push to stderr, but allow the push to
2619         proceed. If set to false or "ignore", allow such pushes with no
2620         message. Defaults to "refuse".
2621 +
2622 Another option is "updateInstead" which will update the working
2623 tree if pushing into the current branch.  This option is
2624 intended for synchronizing working directories when one side is not easily
2625 accessible via interactive ssh (e.g. a live web site, hence the requirement
2626 that the working directory be clean). This mode also comes in handy when
2627 developing inside a VM to test and fix code on different Operating Systems.
2628 +
2629 By default, "updateInstead" will refuse the push if the working tree or
2630 the index have any difference from the HEAD, but the `push-to-checkout`
2631 hook can be used to customize this.  See linkgit:githooks[5].
2632
2633 receive.denyNonFastForwards::
2634         If set to true, git-receive-pack will deny a ref update which is
2635         not a fast-forward. Use this to prevent such an update via a push,
2636         even if that push is forced. This configuration variable is
2637         set when initializing a shared repository.
2638
2639 receive.hideRefs::
2640         This variable is the same as `transfer.hideRefs`, but applies
2641         only to `receive-pack` (and so affects pushes, but not fetches).
2642         An attempt to update or delete a hidden ref by `git push` is
2643         rejected.
2644
2645 receive.updateServerInfo::
2646         If set to true, git-receive-pack will run git-update-server-info
2647         after receiving data from git-push and updating refs.
2648
2649 receive.shallowUpdate::
2650         If set to true, .git/shallow can be updated when new refs
2651         require new shallow roots. Otherwise those refs are rejected.
2652
2653 remote.pushDefault::
2654         The remote to push to by default.  Overrides
2655         `branch.<name>.remote` for all branches, and is overridden by
2656         `branch.<name>.pushRemote` for specific branches.
2657
2658 remote.<name>.url::
2659         The URL of a remote repository.  See linkgit:git-fetch[1] or
2660         linkgit:git-push[1].
2661
2662 remote.<name>.pushurl::
2663         The push URL of a remote repository.  See linkgit:git-push[1].
2664
2665 remote.<name>.proxy::
2666         For remotes that require curl (http, https and ftp), the URL to
2667         the proxy to use for that remote.  Set to the empty string to
2668         disable proxying for that remote.
2669
2670 remote.<name>.proxyAuthMethod::
2671         For remotes that require curl (http, https and ftp), the method to use for
2672         authenticating against the proxy in use (probably set in
2673         `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2674
2675 remote.<name>.fetch::
2676         The default set of "refspec" for linkgit:git-fetch[1]. See
2677         linkgit:git-fetch[1].
2678
2679 remote.<name>.push::
2680         The default set of "refspec" for linkgit:git-push[1]. See
2681         linkgit:git-push[1].
2682
2683 remote.<name>.mirror::
2684         If true, pushing to this remote will automatically behave
2685         as if the `--mirror` option was given on the command line.
2686
2687 remote.<name>.skipDefaultUpdate::
2688         If true, this remote will be skipped by default when updating
2689         using linkgit:git-fetch[1] or the `update` subcommand of
2690         linkgit:git-remote[1].
2691
2692 remote.<name>.skipFetchAll::
2693         If true, this remote will be skipped by default when updating
2694         using linkgit:git-fetch[1] or the `update` subcommand of
2695         linkgit:git-remote[1].
2696
2697 remote.<name>.receivepack::
2698         The default program to execute on the remote side when pushing.  See
2699         option --receive-pack of linkgit:git-push[1].
2700
2701 remote.<name>.uploadpack::
2702         The default program to execute on the remote side when fetching.  See
2703         option --upload-pack of linkgit:git-fetch-pack[1].
2704
2705 remote.<name>.tagOpt::
2706         Setting this value to --no-tags disables automatic tag following when
2707         fetching from remote <name>. Setting it to --tags will fetch every
2708         tag from remote <name>, even if they are not reachable from remote
2709         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2710         override this setting. See options --tags and --no-tags of
2711         linkgit:git-fetch[1].
2712
2713 remote.<name>.vcs::
2714         Setting this to a value <vcs> will cause Git to interact with
2715         the remote with the git-remote-<vcs> helper.
2716
2717 remote.<name>.prune::
2718         When set to true, fetching from this remote by default will also
2719         remove any remote-tracking references that no longer exist on the
2720         remote (as if the `--prune` option was given on the command line).
2721         Overrides `fetch.prune` settings, if any.
2722
2723 remotes.<group>::
2724         The list of remotes which are fetched by "git remote update
2725         <group>".  See linkgit:git-remote[1].
2726
2727 repack.useDeltaBaseOffset::
2728         By default, linkgit:git-repack[1] creates packs that use
2729         delta-base offset. If you need to share your repository with
2730         Git older than version 1.4.4, either directly or via a dumb
2731         protocol such as http, then you need to set this option to
2732         "false" and repack. Access from old Git versions over the
2733         native protocol are unaffected by this option.
2734
2735 repack.packKeptObjects::
2736         If set to true, makes `git repack` act as if
2737         `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2738         details. Defaults to `false` normally, but `true` if a bitmap
2739         index is being written (either via `--write-bitmap-index` or
2740         `repack.writeBitmaps`).
2741
2742 repack.writeBitmaps::
2743         When true, git will write a bitmap index when packing all
2744         objects to disk (e.g., when `git repack -a` is run).  This
2745         index can speed up the "counting objects" phase of subsequent
2746         packs created for clones and fetches, at the cost of some disk
2747         space and extra time spent on the initial repack.  This has
2748         no effect if multiple packfiles are created.
2749         Defaults to false.
2750
2751 rerere.autoUpdate::
2752         When set to true, `git-rerere` updates the index with the
2753         resulting contents after it cleanly resolves conflicts using
2754         previously recorded resolution.  Defaults to false.
2755
2756 rerere.enabled::
2757         Activate recording of resolved conflicts, so that identical
2758         conflict hunks can be resolved automatically, should they be
2759         encountered again.  By default, linkgit:git-rerere[1] is
2760         enabled if there is an `rr-cache` directory under the
2761         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2762         repository.
2763
2764 sendemail.identity::
2765         A configuration identity. When given, causes values in the
2766         'sendemail.<identity>' subsection to take precedence over
2767         values in the 'sendemail' section. The default identity is
2768         the value of `sendemail.identity`.
2769
2770 sendemail.smtpEncryption::
2771         See linkgit:git-send-email[1] for description.  Note that this
2772         setting is not subject to the 'identity' mechanism.
2773
2774 sendemail.smtpssl (deprecated)::
2775         Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2776
2777 sendemail.smtpsslcertpath::
2778         Path to ca-certificates (either a directory or a single file).
2779         Set it to an empty string to disable certificate verification.
2780
2781 sendemail.<identity>.*::
2782         Identity-specific versions of the 'sendemail.*' parameters
2783         found below, taking precedence over those when the this
2784         identity is selected, through command-line or
2785         `sendemail.identity`.
2786
2787 sendemail.aliasesFile::
2788 sendemail.aliasFileType::
2789 sendemail.annotate::
2790 sendemail.bcc::
2791 sendemail.cc::
2792 sendemail.ccCmd::
2793 sendemail.chainReplyTo::
2794 sendemail.confirm::
2795 sendemail.envelopeSender::
2796 sendemail.from::
2797 sendemail.multiEdit::
2798 sendemail.signedoffbycc::
2799 sendemail.smtpPass::
2800 sendemail.suppresscc::
2801 sendemail.suppressFrom::
2802 sendemail.to::
2803 sendemail.smtpDomain::
2804 sendemail.smtpServer::
2805 sendemail.smtpServerPort::
2806 sendemail.smtpServerOption::
2807 sendemail.smtpUser::
2808 sendemail.thread::
2809 sendemail.transferEncoding::
2810 sendemail.validate::
2811 sendemail.xmailer::
2812         See linkgit:git-send-email[1] for description.
2813
2814 sendemail.signedoffcc (deprecated)::
2815         Deprecated alias for `sendemail.signedoffbycc`.
2816
2817 showbranch.default::
2818         The default set of branches for linkgit:git-show-branch[1].
2819         See linkgit:git-show-branch[1].
2820
2821 status.relativePaths::
2822         By default, linkgit:git-status[1] shows paths relative to the
2823         current directory. Setting this variable to `false` shows paths
2824         relative to the repository root (this was the default for Git
2825         prior to v1.5.4).
2826
2827 status.short::
2828         Set to true to enable --short by default in linkgit:git-status[1].
2829         The option --no-short takes precedence over this variable.
2830
2831 status.branch::
2832         Set to true to enable --branch by default in linkgit:git-status[1].
2833         The option --no-branch takes precedence over this variable.
2834
2835 status.displayCommentPrefix::
2836         If set to true, linkgit:git-status[1] will insert a comment
2837         prefix before each output line (starting with
2838         `core.commentChar`, i.e. `#` by default). This was the
2839         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2840         Defaults to false.
2841
2842 status.showUntrackedFiles::
2843         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2844         files which are not currently tracked by Git. Directories which
2845         contain only untracked files, are shown with the directory name
2846         only. Showing untracked files means that Git needs to lstat() all
2847         the files in the whole repository, which might be slow on some
2848         systems. So, this variable controls how the commands displays
2849         the untracked files. Possible values are:
2850 +
2851 --
2852 * `no` - Show no untracked files.
2853 * `normal` - Show untracked files and directories.
2854 * `all` - Show also individual files in untracked directories.
2855 --
2856 +
2857 If this variable is not specified, it defaults to 'normal'.
2858 This variable can be overridden with the -u|--untracked-files option
2859 of linkgit:git-status[1] and linkgit:git-commit[1].
2860
2861 status.submoduleSummary::
2862         Defaults to false.
2863         If this is set to a non zero number or true (identical to -1 or an
2864         unlimited number), the submodule summary will be enabled and a
2865         summary of commits for modified submodules will be shown (see
2866         --summary-limit option of linkgit:git-submodule[1]). Please note
2867         that the summary output command will be suppressed for all
2868         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2869         for those submodules where `submodule.<name>.ignore=all`. The only
2870         exception to that rule is that status and commit will show staged
2871         submodule changes. To
2872         also view the summary for ignored submodules you can either use
2873         the --ignore-submodules=dirty command-line option or the 'git
2874         submodule summary' command, which shows a similar output but does
2875         not honor these settings.
2876
2877 stash.showPatch::
2878         If this is set to true, the `git stash show` command without an
2879         option will show the stash in patch form.  Defaults to false.
2880         See description of 'show' command in linkgit:git-stash[1].
2881
2882 stash.showStat::
2883         If this is set to true, the `git stash show` command without an
2884         option will show diffstat of the stash.  Defaults to true.
2885         See description of 'show' command in linkgit:git-stash[1].
2886
2887 submodule.<name>.url::
2888         The URL for a submodule. This variable is copied from the .gitmodules
2889         file to the git config via 'git submodule init'. The user can change
2890         the configured URL before obtaining the submodule via 'git submodule
2891         update'. After obtaining the submodule, the presence of this variable
2892         is used as a sign whether the submodule is of interest to git commands.
2893         See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2894
2895 submodule.<name>.update::
2896         The default update procedure for a submodule. This variable
2897         is populated by `git submodule init` from the
2898         linkgit:gitmodules[5] file. See description of 'update'
2899         command in linkgit:git-submodule[1].
2900
2901 submodule.<name>.branch::
2902         The remote branch name for a submodule, used by `git submodule
2903         update --remote`.  Set this option to override the value found in
2904         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2905         linkgit:gitmodules[5] for details.
2906
2907 submodule.<name>.fetchRecurseSubmodules::
2908         This option can be used to control recursive fetching of this
2909         submodule. It can be overridden by using the --[no-]recurse-submodules
2910         command-line option to "git fetch" and "git pull".
2911         This setting will override that from in the linkgit:gitmodules[5]
2912         file.
2913
2914 submodule.<name>.ignore::
2915         Defines under what circumstances "git status" and the diff family show
2916         a submodule as modified. When set to "all", it will never be considered
2917         modified (but it will nonetheless show up in the output of status and
2918         commit when it has been staged), "dirty" will ignore all changes
2919         to the submodules work tree and
2920         takes only differences between the HEAD of the submodule and the commit
2921         recorded in the superproject into account. "untracked" will additionally
2922         let submodules with modified tracked files in their work tree show up.
2923         Using "none" (the default when this option is not set) also shows
2924         submodules that have untracked files in their work tree as changed.
2925         This setting overrides any setting made in .gitmodules for this submodule,
2926         both settings can be overridden on the command line by using the
2927         "--ignore-submodules" option. The 'git submodule' commands are not
2928         affected by this setting.
2929
2930 submodule.fetchJobs::
2931         Specifies how many submodules are fetched/cloned at the same time.
2932         A positive integer allows up to that number of submodules fetched
2933         in parallel. A value of 0 will give some reasonable default.
2934         If unset, it defaults to 1.
2935
2936 submodule.alternateLocation::
2937         Specifies how the submodules obtain alternates when submodules are
2938         cloned. Possible values are `no`, `superproject`.
2939         By default `no` is assumed, which doesn't add references. When the
2940         value is set to `superproject` the submodule to be cloned computes
2941         its alternates location relative to the superprojects alternate.
2942
2943 submodule.alternateErrorStrategy
2944         Specifies how to treat errors with the alternates for a submodule
2945         as computed via `submodule.alternateLocation`. Possible values are
2946         `ignore`, `info`, `die`. Default is `die`.
2947
2948 tag.forceSignAnnotated::
2949         A boolean to specify whether annotated tags created should be GPG signed.
2950         If `--annotate` is specified on the command line, it takes
2951         precedence over this option.
2952
2953 tag.sort::
2954         This variable controls the sort ordering of tags when displayed by
2955         linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2956         value of this variable will be used as the default.
2957
2958 tar.umask::
2959         This variable can be used to restrict the permission bits of
2960         tar archive entries.  The default is 0002, which turns off the
2961         world write bit.  The special value "user" indicates that the
2962         archiving user's umask will be used instead.  See umask(2) and
2963         linkgit:git-archive[1].
2964
2965 transfer.fsckObjects::
2966         When `fetch.fsckObjects` or `receive.fsckObjects` are
2967         not set, the value of this variable is used instead.
2968         Defaults to false.
2969
2970 transfer.hideRefs::
2971         String(s) `receive-pack` and `upload-pack` use to decide which
2972         refs to omit from their initial advertisements.  Use more than
2973         one definition to specify multiple prefix strings. A ref that is
2974         under the hierarchies listed in the value of this variable is
2975         excluded, and is hidden when responding to `git push` or `git
2976         fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
2977         program-specific versions of this config.
2978 +
2979 You may also include a `!` in front of the ref name to negate the entry,
2980 explicitly exposing it, even if an earlier entry marked it as hidden.
2981 If you have multiple hideRefs values, later entries override earlier ones
2982 (and entries in more-specific config files override less-specific ones).
2983 +
2984 If a namespace is in use, the namespace prefix is stripped from each
2985 reference before it is matched against `transfer.hiderefs` patterns.
2986 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2987 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2988 is omitted from the advertisements but `refs/heads/master` and
2989 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2990 "have" lines. In order to match refs before stripping, add a `^` in front of
2991 the ref name. If you combine `!` and `^`, `!` must be specified first.
2992 +
2993 Even if you hide refs, a client may still be able to steal the target
2994 objects via the techniques described in the "SECURITY" section of the
2995 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
2996 separate repository.
2997
2998 transfer.unpackLimit::
2999         When `fetch.unpackLimit` or `receive.unpackLimit` are
3000         not set, the value of this variable is used instead.
3001         The default value is 100.
3002
3003 uploadarchive.allowUnreachable::
3004         If true, allow clients to use `git archive --remote` to request
3005         any tree, whether reachable from the ref tips or not. See the
3006         discussion in the "SECURITY" section of
3007         linkgit:git-upload-archive[1] for more details. Defaults to
3008         `false`.
3009
3010 uploadpack.hideRefs::
3011         This variable is the same as `transfer.hideRefs`, but applies
3012         only to `upload-pack` (and so affects only fetches, not pushes).
3013         An attempt to fetch a hidden ref by `git fetch` will fail.  See
3014         also `uploadpack.allowTipSHA1InWant`.
3015
3016 uploadpack.allowTipSHA1InWant::
3017         When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3018         to accept a fetch request that asks for an object at the tip
3019         of a hidden ref (by default, such a request is rejected).
3020         See also `uploadpack.hideRefs`.  Even if this is false, a client
3021         may be able to steal objects via the techniques described in the
3022         "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3023         best to keep private data in a separate repository.
3024
3025 uploadpack.allowReachableSHA1InWant::
3026         Allow `upload-pack` to accept a fetch request that asks for an
3027         object that is reachable from any ref tip. However, note that
3028         calculating object reachability is computationally expensive.
3029         Defaults to `false`.  Even if this is false, a client may be able
3030         to steal objects via the techniques described in the "SECURITY"
3031         section of the linkgit:gitnamespaces[7] man page; it's best to
3032         keep private data in a separate repository.
3033
3034 uploadpack.allowAnySHA1InWant::
3035         Allow `upload-pack` to accept a fetch request that asks for any
3036         object at all.
3037         Defaults to `false`.
3038
3039 uploadpack.keepAlive::
3040         When `upload-pack` has started `pack-objects`, there may be a
3041         quiet period while `pack-objects` prepares the pack. Normally
3042         it would output progress information, but if `--quiet` was used
3043         for the fetch, `pack-objects` will output nothing at all until
3044         the pack data begins. Some clients and networks may consider
3045         the server to be hung and give up. Setting this option instructs
3046         `upload-pack` to send an empty keepalive packet every
3047         `uploadpack.keepAlive` seconds. Setting this option to 0
3048         disables keepalive packets entirely. The default is 5 seconds.
3049
3050 uploadpack.packObjectsHook::
3051         If this option is set, when `upload-pack` would run
3052         `git pack-objects` to create a packfile for a client, it will
3053         run this shell command instead.  The `pack-objects` command and
3054         arguments it _would_ have run (including the `git pack-objects`
3055         at the beginning) are appended to the shell command. The stdin
3056         and stdout of the hook are treated as if `pack-objects` itself
3057         was run. I.e., `upload-pack` will feed input intended for
3058         `pack-objects` to the hook, and expects a completed packfile on
3059         stdout.
3060 +
3061 Note that this configuration variable is ignored if it is seen in the
3062 repository-level config (this is a safety measure against fetching from
3063 untrusted repositories).
3064
3065 url.<base>.insteadOf::
3066         Any URL that starts with this value will be rewritten to
3067         start, instead, with <base>. In cases where some site serves a
3068         large number of repositories, and serves them with multiple
3069         access methods, and some users need to use different access
3070         methods, this feature allows people to specify any of the
3071         equivalent URLs and have Git automatically rewrite the URL to
3072         the best alternative for the particular user, even for a
3073         never-before-seen repository on the site.  When more than one
3074         insteadOf strings match a given URL, the longest match is used.
3075
3076 url.<base>.pushInsteadOf::
3077         Any URL that starts with this value will not be pushed to;
3078         instead, it will be rewritten to start with <base>, and the
3079         resulting URL will be pushed to. In cases where some site serves
3080         a large number of repositories, and serves them with multiple
3081         access methods, some of which do not allow push, this feature
3082         allows people to specify a pull-only URL and have Git
3083         automatically use an appropriate URL to push, even for a
3084         never-before-seen repository on the site.  When more than one
3085         pushInsteadOf strings match a given URL, the longest match is
3086         used.  If a remote has an explicit pushurl, Git will ignore this
3087         setting for that remote.
3088
3089 user.email::
3090         Your email address to be recorded in any newly created commits.
3091         Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3092         `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3093
3094 user.name::
3095         Your full name to be recorded in any newly created commits.
3096         Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3097         environment variables.  See linkgit:git-commit-tree[1].
3098
3099 user.useConfigOnly::
3100         Instruct Git to avoid trying to guess defaults for `user.email`
3101         and `user.name`, and instead retrieve the values only from the
3102         configuration. For example, if you have multiple email addresses
3103         and would like to use a different one for each repository, then
3104         with this configuration option set to `true` in the global config
3105         along with a name, Git will prompt you to set up an email before
3106         making new commits in a newly cloned repository.
3107         Defaults to `false`.
3108
3109 user.signingKey::
3110         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3111         key you want it to automatically when creating a signed tag or
3112         commit, you can override the default selection with this variable.
3113         This option is passed unchanged to gpg's --local-user parameter,
3114         so you may specify a key using any method that gpg supports.
3115
3116 versionsort.prereleaseSuffix::
3117         When version sort is used in linkgit:git-tag[1], prerelease
3118         tags (e.g. "1.0-rc1") may appear after the main release
3119         "1.0". By specifying the suffix "-rc" in this variable,
3120         "1.0-rc1" will appear before "1.0".
3121 +
3122 This variable can be specified multiple times, once per suffix. The
3123 order of suffixes in the config file determines the sorting order
3124 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
3125 is sorted before 1.0-rcXX). The sorting order between different
3126 suffixes is undefined if they are in multiple config files.
3127
3128 web.browser::
3129         Specify a web browser that may be used by some commands.
3130         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3131         may use it.