OSDN Git Service

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