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