Merge branch 'ct/prompt-untracked-fix'
[git/git-svn.git] / Documentation / config.txt
blob2e5ceaf71974b1e5404de79103648da1829eaf42
1 CONFIGURATION FILE
2 ------------------
4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character.  Some
17 variables may appear multiple times; we say then that the variable is
18 multivalued.
20 Syntax
21 ~~~~~~
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.
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.
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:
38 --------
39         [section "subsection"]
41 --------
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.
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.
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.
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.
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
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.
79 Includes
80 ~~~~~~~~
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.
92 Example
93 ~~~~~~~
95         # Core variables
96         [core]
97                 ; Don't trust file modes
98                 filemode = false
100         # Our diff algorithm
101         [diff]
102                 external = /usr/local/bin/diff-wrapper
103                 renames = true
105         [branch "devel"]
106                 remote = origin
107                 merge = refs/heads/devel
109         # Proxy settings
110         [core]
111                 gitProxy="ssh" for "kernel.org"
112                 gitProxy=default-proxy ; for the rest
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
120 Values
121 ~~~~~~
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.
127 boolean::
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.
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.
137        false;; Boolean false can be spelled as `no`, `off`,
138                 `false`, or `0`.
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).
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.
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).
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`.
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.
173 Variables
174 ~~~~~~~~~
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.
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.
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':
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.
250 core.fileMode::
251         Tells Git if the executable bit of files in the working tree
252         is to be honored.
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.
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].
270 The default is true (when core.filemode is not specified in the config file).
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".
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
412 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
413 (which always applies universally, without the special "for"
414 handling).
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.
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.
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.
431 This is useful on systems where lstat() calls are very slow, such as
432 CIFS/Microsoft Windows.
434 False by default.
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.
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].
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).
454 core.worktree::
455         Set the path to the root of the working tree.
456         This can be overridden by the GIT_WORK_TREE environment
457         variable and the '--work-tree' command-line option.
458         The value can be an absolute path or relative to the path to
459         the .git directory, which is either specified by --git-dir
460         or GIT_DIR, or automatically discovered.
461         If --git-dir or GIT_DIR is specified but none of
462         --work-tree, GIT_WORK_TREE and core.worktree is specified,
463         the current working directory is regarded as the top level
464         of your working tree.
466 Note that this variable is honored even when set in a configuration
467 file in a ".git" subdirectory of a directory and its value differs
468 from the latter directory (e.g. "/path/to/.git/config" has
469 core.worktree set to "/different/path"), which is most likely a
470 misconfiguration.  Running Git commands in the "/path/to" directory will
471 still use "/different/path" as the root of the work tree and can cause
472 confusion unless you know what you are doing (e.g. you are creating a
473 read-only snapshot of the same index to a location different from the
474 repository's usual working tree).
476 core.logAllRefUpdates::
477         Enable the reflog. Updates to a ref <ref> is logged to the file
478         "$GIT_DIR/logs/<ref>", by appending the new and old
479         SHA-1, the date/time and the reason of the update, but
480         only when the file exists.  If this configuration
481         variable is set to true, missing "$GIT_DIR/logs/<ref>"
482         file is automatically created for branch heads (i.e. under
483         refs/heads/), remote refs (i.e. under refs/remotes/),
484         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
486 This information can be used to determine what commit
487 was the tip of a branch "2 days ago".
489 This value is true by default in a repository that has
490 a working directory associated with it, and false by
491 default in a bare repository.
493 core.repositoryFormatVersion::
494         Internal variable identifying the repository format and layout
495         version.
497 core.sharedRepository::
498         When 'group' (or 'true'), the repository is made shareable between
499         several users in a group (making sure all the files and objects are
500         group-writable). When 'all' (or 'world' or 'everybody'), the
501         repository will be readable by all users, additionally to being
502         group-shareable. When 'umask' (or 'false'), Git will use permissions
503         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
504         files in the repository will have this mode value. '0xxx' will override
505         user's umask value (whereas the other options will only override
506         requested parts of the user's umask value). Examples: '0660' will make
507         the repo read/write-able for the owner and group, but inaccessible to
508         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
509         repository that is group-readable but not group-writable.
510         See linkgit:git-init[1]. False by default.
512 core.warnAmbiguousRefs::
513         If true, Git will warn you if the ref name you passed it is ambiguous
514         and might match multiple refs in the repository. True by default.
516 core.compression::
517         An integer -1..9, indicating a default compression level.
518         -1 is the zlib default. 0 means no compression,
519         and 1..9 are various speed/size tradeoffs, 9 being slowest.
520         If set, this provides a default to other compression variables,
521         such as 'core.looseCompression' and 'pack.compression'.
523 core.looseCompression::
524         An integer -1..9, indicating the compression level for objects that
525         are not in a pack file. -1 is the zlib default. 0 means no
526         compression, and 1..9 are various speed/size tradeoffs, 9 being
527         slowest.  If not set,  defaults to core.compression.  If that is
528         not set,  defaults to 1 (best speed).
530 core.packedGitWindowSize::
531         Number of bytes of a pack file to map into memory in a
532         single mapping operation.  Larger window sizes may allow
533         your system to process a smaller number of large pack files
534         more quickly.  Smaller window sizes will negatively affect
535         performance due to increased calls to the operating system's
536         memory manager, but may improve performance when accessing
537         a large number of large pack files.
539 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
540 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
541 be reasonable for all users/operating systems.  You probably do
542 not need to adjust this value.
544 Common unit suffixes of 'k', 'm', or 'g' are supported.
546 core.packedGitLimit::
547         Maximum number of bytes to map simultaneously into memory
548         from pack files.  If Git needs to access more than this many
549         bytes at once to complete an operation it will unmap existing
550         regions to reclaim virtual address space within the process.
552 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
553 This should be reasonable for all users/operating systems, except on
554 the largest projects.  You probably do not need to adjust this value.
556 Common unit suffixes of 'k', 'm', or 'g' are supported.
558 core.deltaBaseCacheLimit::
559         Maximum number of bytes to reserve for caching base objects
560         that may be referenced by multiple deltified objects.  By storing the
561         entire decompressed base objects in a cache Git is able
562         to avoid unpacking and decompressing frequently used base
563         objects multiple times.
565 Default is 96 MiB on all platforms.  This should be reasonable
566 for all users/operating systems, except on the largest projects.
567 You probably do not need to adjust this value.
569 Common unit suffixes of 'k', 'm', or 'g' are supported.
571 core.bigFileThreshold::
572         Files larger than this size are stored deflated, without
573         attempting delta compression.  Storing large files without
574         delta compression avoids excessive memory usage, at the
575         slight expense of increased disk usage. Additionally files
576         larger than this size are always treated as binary.
578 Default is 512 MiB on all platforms.  This should be reasonable
579 for most projects as source code and other text files can still
580 be delta compressed, but larger binary media files won't be.
582 Common unit suffixes of 'k', 'm', or 'g' are supported.
584 core.excludesFile::
585         In addition to '.gitignore' (per-directory) and
586         '.git/info/exclude', Git looks into this file for patterns
587         of files which are not meant to be tracked.  "`~/`" is expanded
588         to the value of `$HOME` and "`~user/`" to the specified user's
589         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
590         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
591         is used instead. See linkgit:gitignore[5].
593 core.askPass::
594         Some commands (e.g. svn and http interfaces) that interactively
595         ask for a password can be told to use an external program given
596         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
597         environment variable. If not set, fall back to the value of the
598         'SSH_ASKPASS' environment variable or, failing that, a simple password
599         prompt. The external program shall be given a suitable prompt as
600         command-line argument and write the password on its STDOUT.
602 core.attributesFile::
603         In addition to '.gitattributes' (per-directory) and
604         '.git/info/attributes', Git looks into this file for attributes
605         (see linkgit:gitattributes[5]). Path expansions are made the same
606         way as for `core.excludesFile`. Its default value is
607         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
608         set or empty, $HOME/.config/git/attributes is used instead.
610 core.editor::
611         Commands such as `commit` and `tag` that lets you edit
612         messages by launching an editor uses the value of this
613         variable when it is set, and the environment variable
614         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
616 core.commentChar::
617         Commands such as `commit` and `tag` that lets you edit
618         messages consider a line that begins with this character
619         commented, and removes them after the editor returns
620         (default '#').
622 If set to "auto", `git-commit` would select a character that is not
623 the beginning character of any line in existing commit messages.
625 sequence.editor::
626         Text editor used by `git rebase -i` for editing the rebase instruction file.
627         The value is meant to be interpreted by the shell when it is used.
628         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
629         When not configured the default commit message editor is used instead.
631 core.pager::
632         Text viewer for use by Git commands (e.g., 'less').  The value
633         is meant to be interpreted by the shell.  The order of preference
634         is the `$GIT_PAGER` environment variable, then `core.pager`
635         configuration, then `$PAGER`, and then the default chosen at
636         compile time (usually 'less').
638 When the `LESS` environment variable is unset, Git sets it to `FRX`
639 (if `LESS` environment variable is set, Git does not change it at
640 all).  If you want to selectively override Git's default setting
641 for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
642 be passed to the shell by Git, which will translate the final
643 command to `LESS=FRX less -S`. The environment does not set the
644 `S` option but the command line does, instructing less to truncate
645 long lines. Similarly, setting `core.pager` to `less -+F` will
646 deactivate the `F` option specified by the environment from the
647 command-line, deactivating the "quit if one screen" behavior of
648 `less`.  One can specifically activate some flags for particular
649 commands: for example, setting `pager.blame` to `less -S` enables
650 line truncation only for `git blame`.
652 Likewise, when the `LV` environment variable is unset, Git sets it
653 to `-c`.  You can override this setting by exporting `LV` with
654 another value or setting `core.pager` to `lv +c`.
656 core.whitespace::
657         A comma separated list of common whitespace problems to
658         notice.  'git diff' will use `color.diff.whitespace` to
659         highlight them, and 'git apply --whitespace=error' will
660         consider them as errors.  You can prefix `-` to disable
661         any of them (e.g. `-trailing-space`):
663 * `blank-at-eol` treats trailing whitespaces at the end of the line
664   as an error (enabled by default).
665 * `space-before-tab` treats a space character that appears immediately
666   before a tab character in the initial indent part of the line as an
667   error (enabled by default).
668 * `indent-with-non-tab` treats a line that is indented with space
669   characters instead of the equivalent tabs as an error (not enabled by
670   default).
671 * `tab-in-indent` treats a tab character in the initial indent part of
672   the line as an error (not enabled by default).
673 * `blank-at-eof` treats blank lines added at the end of file as an error
674   (enabled by default).
675 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
676   `blank-at-eof`.
677 * `cr-at-eol` treats a carriage-return at the end of line as
678   part of the line terminator, i.e. with it, `trailing-space`
679   does not trigger if the character before such a carriage-return
680   is not a whitespace (not enabled by default).
681 * `tabwidth=<n>` tells how many character positions a tab occupies; this
682   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
683   errors. The default tab width is 8. Allowed values are 1 to 63.
685 core.fsyncObjectFiles::
686         This boolean will enable 'fsync()' when writing object files.
688 This is a total waste of time and effort on a filesystem that orders
689 data writes properly, but can be useful for filesystems that do not use
690 journalling (traditional UNIX filesystems) or that only journal metadata
691 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
693 core.preloadIndex::
694         Enable parallel index preload for operations like 'git diff'
696 This can speed up operations like 'git diff' and 'git status' especially
697 on filesystems like NFS that have weak caching semantics and thus
698 relatively high IO latencies.  When enabled, Git will do the
699 index comparison to the filesystem data in parallel, allowing
700 overlapping IO's.  Defaults to true.
702 core.createObject::
703         You can set this to 'link', in which case a hardlink followed by
704         a delete of the source are used to make sure that object creation
705         will not overwrite existing objects.
707 On some file system/operating system combinations, this is unreliable.
708 Set this config setting to 'rename' there; However, This will remove the
709 check that makes sure that existing object files will not get overwritten.
711 core.notesRef::
712         When showing commit messages, also show notes which are stored in
713         the given ref.  The ref must be fully qualified.  If the given
714         ref does not exist, it is not an error but means that no
715         notes should be printed.
717 This setting defaults to "refs/notes/commits", and it can be overridden by
718 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
720 core.sparseCheckout::
721         Enable "sparse checkout" feature. See section "Sparse checkout" in
722         linkgit:git-read-tree[1] for more information.
724 core.abbrev::
725         Set the length object names are abbreviated to.  If unspecified,
726         many commands abbreviate to 7 hexdigits, which may not be enough
727         for abbreviated object names to stay unique for sufficiently long
728         time.
730 add.ignoreErrors::
731 add.ignore-errors (deprecated)::
732         Tells 'git add' to continue adding files when some files cannot be
733         added due to indexing errors. Equivalent to the '--ignore-errors'
734         option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
735         as it does not follow the usual naming convention for configuration
736         variables.
738 alias.*::
739         Command aliases for the linkgit:git[1] command wrapper - e.g.
740         after defining "alias.last = cat-file commit HEAD", the invocation
741         "git last" is equivalent to "git cat-file commit HEAD". To avoid
742         confusion and troubles with script usage, aliases that
743         hide existing Git commands are ignored. Arguments are split by
744         spaces, the usual shell quoting and escaping is supported.
745         A quote pair or a backslash can be used to quote them.
747 If the alias expansion is prefixed with an exclamation point,
748 it will be treated as a shell command.  For example, defining
749 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
750 "git new" is equivalent to running the shell command
751 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
752 executed from the top-level directory of a repository, which may
753 not necessarily be the current directory.
754 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
755 from the original current directory. See linkgit:git-rev-parse[1].
757 am.keepcr::
758         If true, git-am will call git-mailsplit for patches in mbox format
759         with parameter '--keep-cr'. In this case git-mailsplit will
760         not remove `\r` from lines ending with `\r\n`. Can be overridden
761         by giving '--no-keep-cr' from the command line.
762         See linkgit:git-am[1], linkgit:git-mailsplit[1].
764 apply.ignoreWhitespace::
765         When set to 'change', tells 'git apply' to ignore changes in
766         whitespace, in the same way as the '--ignore-space-change'
767         option.
768         When set to one of: no, none, never, false tells 'git apply' to
769         respect all whitespace differences.
770         See linkgit:git-apply[1].
772 apply.whitespace::
773         Tells 'git apply' how to handle whitespaces, in the same way
774         as the '--whitespace' option. See linkgit:git-apply[1].
776 branch.autoSetupMerge::
777         Tells 'git branch' and 'git checkout' to set up new branches
778         so that linkgit:git-pull[1] will appropriately merge from the
779         starting point branch. Note that even if this option is not set,
780         this behavior can be chosen per-branch using the `--track`
781         and `--no-track` options. The valid settings are: `false` -- no
782         automatic setup is done; `true` -- automatic setup is done when the
783         starting point is a remote-tracking branch; `always` --
784         automatic setup is done when the starting point is either a
785         local branch or remote-tracking
786         branch. This option defaults to true.
788 branch.autoSetupRebase::
789         When a new branch is created with 'git branch' or 'git checkout'
790         that tracks another branch, this variable tells Git to set
791         up pull to rebase instead of merge (see "branch.<name>.rebase").
792         When `never`, rebase is never automatically set to true.
793         When `local`, rebase is set to true for tracked branches of
794         other local branches.
795         When `remote`, rebase is set to true for tracked branches of
796         remote-tracking branches.
797         When `always`, rebase will be set to true for all tracking
798         branches.
799         See "branch.autoSetupMerge" for details on how to set up a
800         branch to track another branch.
801         This option defaults to never.
803 branch.<name>.remote::
804         When on branch <name>, it tells 'git fetch' and 'git push'
805         which remote to fetch from/push to.  The remote to push to
806         may be overridden with `remote.pushDefault` (for all branches).
807         The remote to push to, for the current branch, may be further
808         overridden by `branch.<name>.pushRemote`.  If no remote is
809         configured, or if you are not on any branch, it defaults to
810         `origin` for fetching and `remote.pushDefault` for pushing.
811         Additionally, `.` (a period) is the current local repository
812         (a dot-repository), see `branch.<name>.merge`'s final note below.
814 branch.<name>.pushRemote::
815         When on branch <name>, it overrides `branch.<name>.remote` for
816         pushing.  It also overrides `remote.pushDefault` for pushing
817         from branch <name>.  When you pull from one place (e.g. your
818         upstream) and push to another place (e.g. your own publishing
819         repository), you would want to set `remote.pushDefault` to
820         specify the remote to push to for all branches, and use this
821         option to override it for a specific branch.
823 branch.<name>.merge::
824         Defines, together with branch.<name>.remote, the upstream branch
825         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
826         branch to merge and can also affect 'git push' (see push.default).
827         When in branch <name>, it tells 'git fetch' the default
828         refspec to be marked for merging in FETCH_HEAD. The value is
829         handled like the remote part of a refspec, and must match a
830         ref which is fetched from the remote given by
831         "branch.<name>.remote".
832         The merge information is used by 'git pull' (which at first calls
833         'git fetch') to lookup the default branch for merging. Without
834         this option, 'git pull' defaults to merge the first refspec fetched.
835         Specify multiple values to get an octopus merge.
836         If you wish to setup 'git pull' so that it merges into <name> from
837         another branch in the local repository, you can point
838         branch.<name>.merge to the desired branch, and use the relative path
839         setting `.` (a period) for branch.<name>.remote.
841 branch.<name>.mergeOptions::
842         Sets default options for merging into branch <name>. The syntax and
843         supported options are the same as those of linkgit:git-merge[1], but
844         option values containing whitespace characters are currently not
845         supported.
847 branch.<name>.rebase::
848         When true, rebase the branch <name> on top of the fetched branch,
849         instead of merging the default branch from the default remote when
850         "git pull" is run. See "pull.rebase" for doing this in a non
851         branch-specific manner.
853         When preserve, also pass `--preserve-merges` along to 'git rebase'
854         so that locally committed merge commits will not be flattened
855         by running 'git pull'.
857 *NOTE*: this is a possibly dangerous operation; do *not* use
858 it unless you understand the implications (see linkgit:git-rebase[1]
859 for details).
861 branch.<name>.description::
862         Branch description, can be edited with
863         `git branch --edit-description`. Branch description is
864         automatically added in the format-patch cover letter or
865         request-pull summary.
867 browser.<tool>.cmd::
868         Specify the command to invoke the specified browser. The
869         specified command is evaluated in shell with the URLs passed
870         as arguments. (See linkgit:git-web{litdd}browse[1].)
872 browser.<tool>.path::
873         Override the path for the given tool that may be used to
874         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
875         working repository in gitweb (see linkgit:git-instaweb[1]).
877 clean.requireForce::
878         A boolean to make git-clean do nothing unless given -f,
879         -i or -n.   Defaults to true.
881 color.branch::
882         A boolean to enable/disable color in the output of
883         linkgit:git-branch[1]. May be set to `always`,
884         `false` (or `never`) or `auto` (or `true`), in which case colors are used
885         only when the output is to a terminal. Defaults to false.
887 color.branch.<slot>::
888         Use customized color for branch coloration. `<slot>` is one of
889         `current` (the current branch), `local` (a local branch),
890         `remote` (a remote-tracking branch in refs/remotes/),
891         `upstream` (upstream tracking branch), `plain` (other
892         refs).
894 color.diff::
895         Whether to use ANSI escape sequences to add color to patches.
896         If this is set to `always`, linkgit:git-diff[1],
897         linkgit:git-log[1], and linkgit:git-show[1] will use color
898         for all patches.  If it is set to `true` or `auto`, those
899         commands will only use color when output is to the terminal.
900         Defaults to false.
902 This does not affect linkgit:git-format-patch[1] or the
903 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
904 command line with the `--color[=<when>]` option.
906 color.diff.<slot>::
907         Use customized color for diff colorization.  `<slot>` specifies
908         which part of the patch to use the specified color, and is one
909         of `plain` (context text), `meta` (metainformation), `frag`
910         (hunk header), 'func' (function in hunk header), `old` (removed lines),
911         `new` (added lines), `commit` (commit headers), or `whitespace`
912         (highlighting whitespace errors).
914 color.decorate.<slot>::
915         Use customized color for 'git log --decorate' output.  `<slot>` is one
916         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
917         branches, remote-tracking branches, tags, stash and HEAD, respectively.
919 color.grep::
920         When set to `always`, always highlight matches.  When `false` (or
921         `never`), never.  When set to `true` or `auto`, use color only
922         when the output is written to the terminal.  Defaults to `false`.
924 color.grep.<slot>::
925         Use customized color for grep colorization.  `<slot>` specifies which
926         part of the line to use the specified color, and is one of
929 `context`;;
930         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
931 `filename`;;
932         filename prefix (when not using `-h`)
933 `function`;;
934         function name lines (when using `-p`)
935 `linenumber`;;
936         line number prefix (when using `-n`)
937 `match`;;
938         matching text (same as setting `matchContext` and `matchSelected`)
939 `matchContext`;;
940         matching text in context lines
941 `matchSelected`;;
942         matching text in selected lines
943 `selected`;;
944         non-matching text in selected lines
945 `separator`;;
946         separators between fields on a line (`:`, `-`, and `=`)
947         and between hunks (`--`)
950 color.interactive::
951         When set to `always`, always use colors for interactive prompts
952         and displays (such as those used by "git-add --interactive" and
953         "git-clean --interactive"). When false (or `never`), never.
954         When set to `true` or `auto`, use colors only when the output is
955         to the terminal. Defaults to false.
957 color.interactive.<slot>::
958         Use customized color for 'git add --interactive' and 'git clean
959         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
960         or `error`, for four distinct types of normal output from
961         interactive commands.
963 color.pager::
964         A boolean to enable/disable colored output when the pager is in
965         use (default is true).
967 color.showBranch::
968         A boolean to enable/disable color in the output of
969         linkgit:git-show-branch[1]. May be set to `always`,
970         `false` (or `never`) or `auto` (or `true`), in which case colors are used
971         only when the output is to a terminal. Defaults to false.
973 color.status::
974         A boolean to enable/disable color in the output of
975         linkgit:git-status[1]. May be set to `always`,
976         `false` (or `never`) or `auto` (or `true`), in which case colors are used
977         only when the output is to a terminal. Defaults to false.
979 color.status.<slot>::
980         Use customized color for status colorization. `<slot>` is
981         one of `header` (the header text of the status message),
982         `added` or `updated` (files which are added but not committed),
983         `changed` (files which are changed but not added in the index),
984         `untracked` (files which are not tracked by Git),
985         `branch` (the current branch),
986         `nobranch` (the color the 'no branch' warning is shown in, defaulting
987         to red), or
988         `unmerged` (files which have unmerged changes).
990 color.ui::
991         This variable determines the default value for variables such
992         as `color.diff` and `color.grep` that control the use of color
993         per command family. Its scope will expand as more commands learn
994         configuration to set a default for the `--color` option.  Set it
995         to `false` or `never` if you prefer Git commands not to use
996         color unless enabled explicitly with some other configuration
997         or the `--color` option. Set it to `always` if you want all
998         output not intended for machine consumption to use color, to
999         `true` or `auto` (this is the default since Git 1.8.4) if you
1000         want such output to use color when written to the terminal.
1002 column.ui::
1003         Specify whether supported commands should output in columns.
1004         This variable consists of a list of tokens separated by spaces
1005         or commas:
1007 These options control when the feature should be enabled
1008 (defaults to 'never'):
1011 `always`;;
1012         always show in columns
1013 `never`;;
1014         never show in columns
1015 `auto`;;
1016         show in columns if the output is to the terminal
1019 These options control layout (defaults to 'column').  Setting any
1020 of these implies 'always' if none of 'always', 'never', or 'auto' are
1021 specified.
1024 `column`;;
1025         fill columns before rows
1026 `row`;;
1027         fill rows before columns
1028 `plain`;;
1029         show in one column
1032 Finally, these options can be combined with a layout option (defaults
1033 to 'nodense'):
1036 `dense`;;
1037         make unequal size columns to utilize more space
1038 `nodense`;;
1039         make equal size columns
1042 column.branch::
1043         Specify whether to output branch listing in `git branch` in columns.
1044         See `column.ui` for details.
1046 column.clean::
1047         Specify the layout when list items in `git clean -i`, which always
1048         shows files and directories in columns. See `column.ui` for details.
1050 column.status::
1051         Specify whether to output untracked files in `git status` in columns.
1052         See `column.ui` for details.
1054 column.tag::
1055         Specify whether to output tag listing in `git tag` in columns.
1056         See `column.ui` for details.
1058 commit.cleanup::
1059         This setting overrides the default of the `--cleanup` option in
1060         `git commit`. See linkgit:git-commit[1] for details. Changing the
1061         default can be useful when you always want to keep lines that begin
1062         with comment character `#` in your log message, in which case you
1063         would do `git config commit.cleanup whitespace` (note that you will
1064         have to remove the help lines that begin with `#` in the commit log
1065         template yourself, if you do this).
1067 commit.gpgSign::
1069         A boolean to specify whether all commits should be GPG signed.
1070         Use of this option when doing operations such as rebase can
1071         result in a large number of commits being signed. It may be
1072         convenient to use an agent to avoid typing your GPG passphrase
1073         several times.
1075 commit.status::
1076         A boolean to enable/disable inclusion of status information in the
1077         commit message template when using an editor to prepare the commit
1078         message.  Defaults to true.
1080 commit.template::
1081         Specify a file to use as the template for new commit messages.
1082         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1083         specified user's home directory.
1085 credential.helper::
1086         Specify an external helper to be called when a username or
1087         password credential is needed; the helper may consult external
1088         storage to avoid prompting the user for the credentials. See
1089         linkgit:gitcredentials[7] for details.
1091 credential.useHttpPath::
1092         When acquiring credentials, consider the "path" component of an http
1093         or https URL to be important. Defaults to false. See
1094         linkgit:gitcredentials[7] for more information.
1096 credential.username::
1097         If no username is set for a network authentication, use this username
1098         by default. See credential.<context>.* below, and
1099         linkgit:gitcredentials[7].
1101 credential.<url>.*::
1102         Any of the credential.* options above can be applied selectively to
1103         some credentials. For example "credential.https://example.com.username"
1104         would set the default username only for https connections to
1105         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1106         matched.
1108 include::diff-config.txt[]
1110 difftool.<tool>.path::
1111         Override the path for the given tool.  This is useful in case
1112         your tool is not in the PATH.
1114 difftool.<tool>.cmd::
1115         Specify the command to invoke the specified diff tool.
1116         The specified command is evaluated in shell with the following
1117         variables available:  'LOCAL' is set to the name of the temporary
1118         file containing the contents of the diff pre-image and 'REMOTE'
1119         is set to the name of the temporary file containing the contents
1120         of the diff post-image.
1122 difftool.prompt::
1123         Prompt before each invocation of the diff tool.
1125 fetch.recurseSubmodules::
1126         This option can be either set to a boolean value or to 'on-demand'.
1127         Setting it to a boolean changes the behavior of fetch and pull to
1128         unconditionally recurse into submodules when set to true or to not
1129         recurse at all when set to false. When set to 'on-demand' (the default
1130         value), fetch and pull will only recurse into a populated submodule
1131         when its superproject retrieves a commit that updates the submodule's
1132         reference.
1134 fetch.fsckObjects::
1135         If it is set to true, git-fetch-pack will check all fetched
1136         objects. It will abort in the case of a malformed object or a
1137         broken link. The result of an abort are only dangling objects.
1138         Defaults to false. If not set, the value of `transfer.fsckObjects`
1139         is used instead.
1141 fetch.unpackLimit::
1142         If the number of objects fetched over the Git native
1143         transfer is below this
1144         limit, then the objects will be unpacked into loose object
1145         files. However if the number of received objects equals or
1146         exceeds this limit then the received pack will be stored as
1147         a pack, after adding any missing delta bases.  Storing the
1148         pack from a push can make the push operation complete faster,
1149         especially on slow filesystems.  If not set, the value of
1150         `transfer.unpackLimit` is used instead.
1152 fetch.prune::
1153         If true, fetch will automatically behave as if the `--prune`
1154         option was given on the command line.  See also `remote.<name>.prune`.
1156 format.attach::
1157         Enable multipart/mixed attachments as the default for
1158         'format-patch'.  The value can also be a double quoted string
1159         which will enable attachments as the default and set the
1160         value as the boundary.  See the --attach option in
1161         linkgit:git-format-patch[1].
1163 format.numbered::
1164         A boolean which can enable or disable sequence numbers in patch
1165         subjects.  It defaults to "auto" which enables it only if there
1166         is more than one patch.  It can be enabled or disabled for all
1167         messages by setting it to "true" or "false".  See --numbered
1168         option in linkgit:git-format-patch[1].
1170 format.headers::
1171         Additional email headers to include in a patch to be submitted
1172         by mail.  See linkgit:git-format-patch[1].
1174 format.to::
1175 format.cc::
1176         Additional recipients to include in a patch to be submitted
1177         by mail.  See the --to and --cc options in
1178         linkgit:git-format-patch[1].
1180 format.subjectPrefix::
1181         The default for format-patch is to output files with the '[PATCH]'
1182         subject prefix. Use this variable to change that prefix.
1184 format.signature::
1185         The default for format-patch is to output a signature containing
1186         the Git version number. Use this variable to change that default.
1187         Set this variable to the empty string ("") to suppress
1188         signature generation.
1190 format.signatureFile::
1191         Works just like format.signature except the contents of the
1192         file specified by this variable will be used as the signature.
1194 format.suffix::
1195         The default for format-patch is to output files with the suffix
1196         `.patch`. Use this variable to change that suffix (make sure to
1197         include the dot if you want it).
1199 format.pretty::
1200         The default pretty format for log/show/whatchanged command,
1201         See linkgit:git-log[1], linkgit:git-show[1],
1202         linkgit:git-whatchanged[1].
1204 format.thread::
1205         The default threading style for 'git format-patch'.  Can be
1206         a boolean value, or `shallow` or `deep`.  `shallow` threading
1207         makes every mail a reply to the head of the series,
1208         where the head is chosen from the cover letter, the
1209         `--in-reply-to`, and the first patch mail, in this order.
1210         `deep` threading makes every mail a reply to the previous one.
1211         A true boolean value is the same as `shallow`, and a false
1212         value disables threading.
1214 format.signOff::
1215         A boolean value which lets you enable the `-s/--signoff` option of
1216         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1217         patch should be a conscious act and means that you certify you have
1218         the rights to submit this work under the same open source license.
1219         Please see the 'SubmittingPatches' document for further discussion.
1221 format.coverLetter::
1222         A boolean that controls whether to generate a cover-letter when
1223         format-patch is invoked, but in addition can be set to "auto", to
1224         generate a cover-letter only when there's more than one patch.
1226 filter.<driver>.clean::
1227         The command which is used to convert the content of a worktree
1228         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1229         details.
1231 filter.<driver>.smudge::
1232         The command which is used to convert the content of a blob
1233         object to a worktree file upon checkout.  See
1234         linkgit:gitattributes[5] for details.
1236 gc.aggressiveDepth::
1237         The depth parameter used in the delta compression
1238         algorithm used by 'git gc --aggressive'.  This defaults
1239         to 250.
1241 gc.aggressiveWindow::
1242         The window size parameter used in the delta compression
1243         algorithm used by 'git gc --aggressive'.  This defaults
1244         to 250.
1246 gc.auto::
1247         When there are approximately more than this many loose
1248         objects in the repository, `git gc --auto` will pack them.
1249         Some Porcelain commands use this command to perform a
1250         light-weight garbage collection from time to time.  The
1251         default value is 6700.  Setting this to 0 disables it.
1253 gc.autoPackLimit::
1254         When there are more than this many packs that are not
1255         marked with `*.keep` file in the repository, `git gc
1256         --auto` consolidates them into one larger pack.  The
1257         default value is 50.  Setting this to 0 disables it.
1259 gc.autoDetach::
1260         Make `git gc --auto` return immediately and run in background
1261         if the system supports it. Default is true.
1263 gc.packRefs::
1264         Running `git pack-refs` in a repository renders it
1265         unclonable by Git versions prior to 1.5.1.2 over dumb
1266         transports such as HTTP.  This variable determines whether
1267         'git gc' runs `git pack-refs`. This can be set to `notbare`
1268         to enable it within all non-bare repos or it can be set to a
1269         boolean value.  The default is `true`.
1271 gc.pruneExpire::
1272         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1273         Override the grace period with this config variable.  The value
1274         "now" may be used to disable this  grace period and always prune
1275         unreachable objects immediately.
1277 gc.reflogExpire::
1278 gc.<pattern>.reflogExpire::
1279         'git reflog expire' removes reflog entries older than
1280         this time; defaults to 90 days.  With "<pattern>" (e.g.
1281         "refs/stash") in the middle the setting applies only to
1282         the refs that match the <pattern>.
1284 gc.reflogExpireUnreachable::
1285 gc.<ref>.reflogExpireUnreachable::
1286         'git reflog expire' removes reflog entries older than
1287         this time and are not reachable from the current tip;
1288         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1289         in the middle, the setting applies only to the refs that
1290         match the <pattern>.
1292 gc.rerereResolved::
1293         Records of conflicted merge you resolved earlier are
1294         kept for this many days when 'git rerere gc' is run.
1295         The default is 60 days.  See linkgit:git-rerere[1].
1297 gc.rerereUnresolved::
1298         Records of conflicted merge you have not resolved are
1299         kept for this many days when 'git rerere gc' is run.
1300         The default is 15 days.  See linkgit:git-rerere[1].
1302 gitcvs.commitMsgAnnotation::
1303         Append this string to each commit message. Set to empty string
1304         to disable this feature. Defaults to "via git-CVS emulator".
1306 gitcvs.enabled::
1307         Whether the CVS server interface is enabled for this repository.
1308         See linkgit:git-cvsserver[1].
1310 gitcvs.logFile::
1311         Path to a log file where the CVS server interface well... logs
1312         various stuff. See linkgit:git-cvsserver[1].
1314 gitcvs.usecrlfattr::
1315         If true, the server will look up the end-of-line conversion
1316         attributes for files to determine the '-k' modes to use. If
1317         the attributes force Git to treat a file as text,
1318         the '-k' mode will be left blank so CVS clients will
1319         treat it as text. If they suppress text conversion, the file
1320         will be set with '-kb' mode, which suppresses any newline munging
1321         the client might otherwise do. If the attributes do not allow
1322         the file type to be determined, then 'gitcvs.allBinary' is
1323         used. See linkgit:gitattributes[5].
1325 gitcvs.allBinary::
1326         This is used if 'gitcvs.usecrlfattr' does not resolve
1327         the correct '-kb' mode to use. If true, all
1328         unresolved files are sent to the client in
1329         mode '-kb'. This causes the client to treat them
1330         as binary files, which suppresses any newline munging it
1331         otherwise might do. Alternatively, if it is set to "guess",
1332         then the contents of the file are examined to decide if
1333         it is binary, similar to 'core.autocrlf'.
1335 gitcvs.dbName::
1336         Database used by git-cvsserver to cache revision information
1337         derived from the Git repository. The exact meaning depends on the
1338         used database driver, for SQLite (which is the default driver) this
1339         is a filename. Supports variable substitution (see
1340         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1341         Default: '%Ggitcvs.%m.sqlite'
1343 gitcvs.dbDriver::
1344         Used Perl DBI driver. You can specify any available driver
1345         for this here, but it might not work. git-cvsserver is tested
1346         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1347         reported *not* to work with 'DBD::mysql'. Experimental feature.
1348         May not contain double colons (`:`). Default: 'SQLite'.
1349         See linkgit:git-cvsserver[1].
1351 gitcvs.dbUser, gitcvs.dbPass::
1352         Database user and password. Only useful if setting 'gitcvs.dbDriver',
1353         since SQLite has no concept of database users and/or passwords.
1354         'gitcvs.dbUser' supports variable substitution (see
1355         linkgit:git-cvsserver[1] for details).
1357 gitcvs.dbTableNamePrefix::
1358         Database table name prefix.  Prepended to the names of any
1359         database tables used, allowing a single database to be used
1360         for several repositories.  Supports variable substitution (see
1361         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1362         characters will be replaced with underscores.
1364 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1365 'gitcvs.allBinary' can also be specified as
1366 'gitcvs.<access_method>.<varname>' (where 'access_method'
1367 is one of "ext" and "pserver") to make them apply only for the given
1368 access method.
1370 gitweb.category::
1371 gitweb.description::
1372 gitweb.owner::
1373 gitweb.url::
1374         See linkgit:gitweb[1] for description.
1376 gitweb.avatar::
1377 gitweb.blame::
1378 gitweb.grep::
1379 gitweb.highlight::
1380 gitweb.patches::
1381 gitweb.pickaxe::
1382 gitweb.remote_heads::
1383 gitweb.showSizes::
1384 gitweb.snapshot::
1385         See linkgit:gitweb.conf[5] for description.
1387 grep.lineNumber::
1388         If set to true, enable '-n' option by default.
1390 grep.patternType::
1391         Set the default matching behavior. Using a value of 'basic', 'extended',
1392         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1393         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1394         value 'default' will return to the default matching behavior.
1396 grep.extendedRegexp::
1397         If set to true, enable '--extended-regexp' option by default. This
1398         option is ignored when the 'grep.patternType' option is set to a value
1399         other than 'default'.
1401 gpg.program::
1402         Use this custom program instead of "gpg" found on $PATH when
1403         making or verifying a PGP signature. The program must support the
1404         same command-line interface as GPG, namely, to verify a detached
1405         signature, "gpg --verify $file - <$signature" is run, and the
1406         program is expected to signal a good signature by exiting with
1407         code 0, and to generate an ASCII-armored detached signature, the
1408         standard input of "gpg -bsau $key" is fed with the contents to be
1409         signed, and the program is expected to send the result to its
1410         standard output.
1412 gui.commitMsgWidth::
1413         Defines how wide the commit message window is in the
1414         linkgit:git-gui[1]. "75" is the default.
1416 gui.diffContext::
1417         Specifies how many context lines should be used in calls to diff
1418         made by the linkgit:git-gui[1]. The default is "5".
1420 gui.displayUntracked::
1421         Determines if linkgit::git-gui[1] shows untracked files
1422         in the file list. The default is "true".
1424 gui.encoding::
1425         Specifies the default encoding to use for displaying of
1426         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1427         It can be overridden by setting the 'encoding' attribute
1428         for relevant files (see linkgit:gitattributes[5]).
1429         If this option is not set, the tools default to the
1430         locale encoding.
1432 gui.matchTrackingBranch::
1433         Determines if new branches created with linkgit:git-gui[1] should
1434         default to tracking remote branches with matching names or
1435         not. Default: "false".
1437 gui.newBranchTemplate::
1438         Is used as suggested name when creating new branches using the
1439         linkgit:git-gui[1].
1441 gui.pruneDuringFetch::
1442         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1443         performing a fetch. The default value is "false".
1445 gui.trustmtime::
1446         Determines if linkgit:git-gui[1] should trust the file modification
1447         timestamp or not. By default the timestamps are not trusted.
1449 gui.spellingDictionary::
1450         Specifies the dictionary used for spell checking commit messages in
1451         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1452         off.
1454 gui.fastCopyBlame::
1455         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1456         location detection. It makes blame significantly faster on huge
1457         repositories at the expense of less thorough copy detection.
1459 gui.copyBlameThreshold::
1460         Specifies the threshold to use in 'git gui blame' original location
1461         detection, measured in alphanumeric characters. See the
1462         linkgit:git-blame[1] manual for more information on copy detection.
1464 gui.blamehistoryctx::
1465         Specifies the radius of history context in days to show in
1466         linkgit:gitk[1] for the selected commit, when the `Show History
1467         Context` menu item is invoked from 'git gui blame'. If this
1468         variable is set to zero, the whole history is shown.
1470 guitool.<name>.cmd::
1471         Specifies the shell command line to execute when the corresponding item
1472         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1473         mandatory for every tool. The command is executed from the root of
1474         the working directory, and in the environment it receives the name of
1475         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1476         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1477         the head is detached, 'CUR_BRANCH' is empty).
1479 guitool.<name>.needsFile::
1480         Run the tool only if a diff is selected in the GUI. It guarantees
1481         that 'FILENAME' is not empty.
1483 guitool.<name>.noConsole::
1484         Run the command silently, without creating a window to display its
1485         output.
1487 guitool.<name>.noRescan::
1488         Don't rescan the working directory for changes after the tool
1489         finishes execution.
1491 guitool.<name>.confirm::
1492         Show a confirmation dialog before actually running the tool.
1494 guitool.<name>.argPrompt::
1495         Request a string argument from the user, and pass it to the tool
1496         through the 'ARGS' environment variable. Since requesting an
1497         argument implies confirmation, the 'confirm' option has no effect
1498         if this is enabled. If the option is set to 'true', 'yes', or '1',
1499         the dialog uses a built-in generic prompt; otherwise the exact
1500         value of the variable is used.
1502 guitool.<name>.revPrompt::
1503         Request a single valid revision from the user, and set the
1504         'REVISION' environment variable. In other aspects this option
1505         is similar to 'argPrompt', and can be used together with it.
1507 guitool.<name>.revUnmerged::
1508         Show only unmerged branches in the 'revPrompt' subdialog.
1509         This is useful for tools similar to merge or rebase, but not
1510         for things like checkout or reset.
1512 guitool.<name>.title::
1513         Specifies the title to use for the prompt dialog. The default
1514         is the tool name.
1516 guitool.<name>.prompt::
1517         Specifies the general prompt string to display at the top of
1518         the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1519         The default value includes the actual command.
1521 help.browser::
1522         Specify the browser that will be used to display help in the
1523         'web' format. See linkgit:git-help[1].
1525 help.format::
1526         Override the default help format used by linkgit:git-help[1].
1527         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1528         the default. 'web' and 'html' are the same.
1530 help.autoCorrect::
1531         Automatically correct and execute mistyped commands after
1532         waiting for the given number of deciseconds (0.1 sec). If more
1533         than one command can be deduced from the entered text, nothing
1534         will be executed.  If the value of this option is negative,
1535         the corrected command will be executed immediately. If the
1536         value is 0 - the command will be just shown but not executed.
1537         This is the default.
1539 help.htmlPath::
1540         Specify the path where the HTML documentation resides. File system paths
1541         and URLs are supported. HTML pages will be prefixed with this path when
1542         help is displayed in the 'web' format. This defaults to the documentation
1543         path of your Git installation.
1545 http.proxy::
1546         Override the HTTP proxy, normally configured using the 'http_proxy',
1547         'https_proxy', and 'all_proxy' environment variables (see
1548         `curl(1)`).  This can be overridden on a per-remote basis; see
1549         remote.<name>.proxy
1551 http.cookieFile::
1552         File containing previously stored cookie lines which should be used
1553         in the Git http session, if they match the server. The file format
1554         of the file to read cookies from should be plain HTTP headers or
1555         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1556         NOTE that the file specified with http.cookieFile is only used as
1557         input unless http.saveCookies is set.
1559 http.saveCookies::
1560         If set, store cookies received during requests to the file specified by
1561         http.cookieFile. Has no effect if http.cookieFile is unset.
1563 http.sslVerify::
1564         Whether to verify the SSL certificate when fetching or pushing
1565         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1566         variable.
1568 http.sslCert::
1569         File containing the SSL certificate when fetching or pushing
1570         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1571         variable.
1573 http.sslKey::
1574         File containing the SSL private key when fetching or pushing
1575         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1576         variable.
1578 http.sslCertPasswordProtected::
1579         Enable Git's password prompt for the SSL certificate.  Otherwise
1580         OpenSSL will prompt the user, possibly many times, if the
1581         certificate or private key is encrypted.  Can be overridden by the
1582         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1584 http.sslCAInfo::
1585         File containing the certificates to verify the peer with when
1586         fetching or pushing over HTTPS. Can be overridden by the
1587         'GIT_SSL_CAINFO' environment variable.
1589 http.sslCAPath::
1590         Path containing files with the CA certificates to verify the peer
1591         with when fetching or pushing over HTTPS. Can be overridden
1592         by the 'GIT_SSL_CAPATH' environment variable.
1594 http.sslTry::
1595         Attempt to use AUTH SSL/TLS and encrypted data transfers
1596         when connecting via regular FTP protocol. This might be needed
1597         if the FTP server requires it for security reasons or you wish
1598         to connect securely whenever remote FTP server supports it.
1599         Default is false since it might trigger certificate verification
1600         errors on misconfigured servers.
1602 http.maxRequests::
1603         How many HTTP requests to launch in parallel. Can be overridden
1604         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1606 http.minSessions::
1607         The number of curl sessions (counted across slots) to be kept across
1608         requests. They will not be ended with curl_easy_cleanup() until
1609         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1610         value will be capped at 1. Defaults to 1.
1612 http.postBuffer::
1613         Maximum size in bytes of the buffer used by smart HTTP
1614         transports when POSTing data to the remote system.
1615         For requests larger than this buffer size, HTTP/1.1 and
1616         Transfer-Encoding: chunked is used to avoid creating a
1617         massive pack file locally.  Default is 1 MiB, which is
1618         sufficient for most requests.
1620 http.lowSpeedLimit, http.lowSpeedTime::
1621         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1622         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1623         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1624         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1626 http.noEPSV::
1627         A boolean which disables using of EPSV ftp command by curl.
1628         This can helpful with some "poor" ftp servers which don't
1629         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1630         environment variable. Default is false (curl will use EPSV).
1632 http.userAgent::
1633         The HTTP USER_AGENT string presented to an HTTP server.  The default
1634         value represents the version of the client Git such as git/1.7.1.
1635         This option allows you to override this value to a more common value
1636         such as Mozilla/4.0.  This may be necessary, for instance, if
1637         connecting through a firewall that restricts HTTP connections to a set
1638         of common USER_AGENT strings (but not including those like git/1.7.1).
1639         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1641 http.<url>.*::
1642         Any of the http.* options above can be applied selectively to some URLs.
1643         For a config key to match a URL, each element of the config key is
1644         compared to that of the URL, in the following order:
1647 . Scheme (e.g., `https` in `https://example.com/`). This field
1648   must match exactly between the config key and the URL.
1650 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1651   This field must match exactly between the config key and the URL.
1653 . Port number (e.g., `8080` in `http://example.com:8080/`).
1654   This field must match exactly between the config key and the URL.
1655   Omitted port numbers are automatically converted to the correct
1656   default for the scheme before matching.
1658 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1659   path field of the config key must match the path field of the URL
1660   either exactly or as a prefix of slash-delimited path elements.  This means
1661   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1662   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1663   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1664   key with just path `foo/`).
1666 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1667   the config key has a user name it must match the user name in the
1668   URL exactly. If the config key does not have a user name, that
1669   config key will match a URL with any user name (including none),
1670   but at a lower precedence than a config key with a user name.
1673 The list above is ordered by decreasing precedence; a URL that matches
1674 a config key's path is preferred to one that matches its user name. For example,
1675 if the URL is `https://user@example.com/foo/bar` a config key match of
1676 `https://example.com/foo` will be preferred over a config key match of
1677 `https://user@example.com`.
1679 All URLs are normalized before attempting any matching (the password part,
1680 if embedded in the URL, is always ignored for matching purposes) so that
1681 equivalent URLs that are simply spelled differently will match properly.
1682 Environment variable settings always override any matches.  The URLs that are
1683 matched against are those given directly to Git commands.  This means any URLs
1684 visited as a result of a redirection do not participate in matching.
1686 i18n.commitEncoding::
1687         Character encoding the commit messages are stored in; Git itself
1688         does not care per se, but this information is necessary e.g. when
1689         importing commits from emails or in the gitk graphical history
1690         browser (and possibly at other places in the future or in other
1691         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1693 i18n.logOutputEncoding::
1694         Character encoding the commit messages are converted to when
1695         running 'git log' and friends.
1697 imap::
1698         The configuration variables in the 'imap' section are described
1699         in linkgit:git-imap-send[1].
1701 index.version::
1702         Specify the version with which new index files should be
1703         initialized.  This does not affect existing repositories.
1705 init.templateDir::
1706         Specify the directory from which templates will be copied.
1707         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1709 instaweb.browser::
1710         Specify the program that will be used to browse your working
1711         repository in gitweb. See linkgit:git-instaweb[1].
1713 instaweb.httpd::
1714         The HTTP daemon command-line to start gitweb on your working
1715         repository. See linkgit:git-instaweb[1].
1717 instaweb.local::
1718         If true the web server started by linkgit:git-instaweb[1] will
1719         be bound to the local IP (127.0.0.1).
1721 instaweb.modulePath::
1722         The default module path for linkgit:git-instaweb[1] to use
1723         instead of /usr/lib/apache2/modules.  Only used if httpd
1724         is Apache.
1726 instaweb.port::
1727         The port number to bind the gitweb httpd to. See
1728         linkgit:git-instaweb[1].
1730 interactive.singleKey::
1731         In interactive commands, allow the user to provide one-letter
1732         input with a single key (i.e., without hitting enter).
1733         Currently this is used by the `--patch` mode of
1734         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1735         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1736         setting is silently ignored if portable keystroke input
1737         is not available; requires the Perl module Term::ReadKey.
1739 log.abbrevCommit::
1740         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1741         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1742         override this option with `--no-abbrev-commit`.
1744 log.date::
1745         Set the default date-time mode for the 'log' command.
1746         Setting a value for log.date is similar to using 'git log''s
1747         `--date` option.  Possible values are `relative`, `local`,
1748         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1749         for details.
1751 log.decorate::
1752         Print out the ref names of any commits that are shown by the log
1753         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1754         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1755         specified, the full ref name (including prefix) will be printed.
1756         This is the same as the log commands '--decorate' option.
1758 log.showRoot::
1759         If true, the initial commit will be shown as a big creation event.
1760         This is equivalent to a diff against an empty tree.
1761         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1762         normally hide the root commit will now show it. True by default.
1764 log.mailmap::
1765         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1766         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1768 mailinfo.scissors::
1769         If true, makes linkgit:git-mailinfo[1] (and therefore
1770         linkgit:git-am[1]) act by default as if the --scissors option
1771         was provided on the command-line. When active, this features
1772         removes everything from the message body before a scissors
1773         line (i.e. consisting mainly of ">8", "8<" and "-").
1775 mailmap.file::
1776         The location of an augmenting mailmap file. The default
1777         mailmap, located in the root of the repository, is loaded
1778         first, then the mailmap file pointed to by this variable.
1779         The location of the mailmap file may be in a repository
1780         subdirectory, or somewhere outside of the repository itself.
1781         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1783 mailmap.blob::
1784         Like `mailmap.file`, but consider the value as a reference to a
1785         blob in the repository. If both `mailmap.file` and
1786         `mailmap.blob` are given, both are parsed, with entries from
1787         `mailmap.file` taking precedence. In a bare repository, this
1788         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1789         defaults to empty.
1791 man.viewer::
1792         Specify the programs that may be used to display help in the
1793         'man' format. See linkgit:git-help[1].
1795 man.<tool>.cmd::
1796         Specify the command to invoke the specified man viewer. The
1797         specified command is evaluated in shell with the man page
1798         passed as argument. (See linkgit:git-help[1].)
1800 man.<tool>.path::
1801         Override the path for the given tool that may be used to
1802         display help in the 'man' format. See linkgit:git-help[1].
1804 include::merge-config.txt[]
1806 mergetool.<tool>.path::
1807         Override the path for the given tool.  This is useful in case
1808         your tool is not in the PATH.
1810 mergetool.<tool>.cmd::
1811         Specify the command to invoke the specified merge tool.  The
1812         specified command is evaluated in shell with the following
1813         variables available: 'BASE' is the name of a temporary file
1814         containing the common base of the files to be merged, if available;
1815         'LOCAL' is the name of a temporary file containing the contents of
1816         the file on the current branch; 'REMOTE' is the name of a temporary
1817         file containing the contents of the file from the branch being
1818         merged; 'MERGED' contains the name of the file to which the merge
1819         tool should write the results of a successful merge.
1821 mergetool.<tool>.trustExitCode::
1822         For a custom merge command, specify whether the exit code of
1823         the merge command can be used to determine whether the merge was
1824         successful.  If this is not set to true then the merge target file
1825         timestamp is checked and the merge assumed to have been successful
1826         if the file has been updated, otherwise the user is prompted to
1827         indicate the success of the merge.
1829 mergetool.meld.hasOutput::
1830         Older versions of `meld` do not support the `--output` option.
1831         Git will attempt to detect whether `meld` supports `--output`
1832         by inspecting the output of `meld --help`.  Configuring
1833         `mergetool.meld.hasOutput` will make Git skip these checks and
1834         use the configured value instead.  Setting `mergetool.meld.hasOutput`
1835         to `true` tells Git to unconditionally use the `--output` option,
1836         and `false` avoids using `--output`.
1838 mergetool.keepBackup::
1839         After performing a merge, the original file with conflict markers
1840         can be saved as a file with a `.orig` extension.  If this variable
1841         is set to `false` then this file is not preserved.  Defaults to
1842         `true` (i.e. keep the backup files).
1844 mergetool.keepTemporaries::
1845         When invoking a custom merge tool, Git uses a set of temporary
1846         files to pass to the tool. If the tool returns an error and this
1847         variable is set to `true`, then these temporary files will be
1848         preserved, otherwise they will be removed after the tool has
1849         exited. Defaults to `false`.
1851 mergetool.writeToTemp::
1852         Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1853         conflicting files in the worktree by default.  Git will attempt
1854         to use a temporary directory for these files when set `true`.
1855         Defaults to `false`.
1857 mergetool.prompt::
1858         Prompt before each invocation of the merge resolution program.
1860 notes.displayRef::
1861         The (fully qualified) refname from which to show notes when
1862         showing commit messages.  The value of this variable can be set
1863         to a glob, in which case notes from all matching refs will be
1864         shown.  You may also specify this configuration variable
1865         several times.  A warning will be issued for refs that do not
1866         exist, but a glob that does not match any refs is silently
1867         ignored.
1869 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1870 environment variable, which must be a colon separated list of refs or
1871 globs.
1873 The effective value of "core.notesRef" (possibly overridden by
1874 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1875 displayed.
1877 notes.rewrite.<command>::
1878         When rewriting commits with <command> (currently `amend` or
1879         `rebase`) and this variable is set to `true`, Git
1880         automatically copies your notes from the original to the
1881         rewritten commit.  Defaults to `true`, but see
1882         "notes.rewriteRef" below.
1884 notes.rewriteMode::
1885         When copying notes during a rewrite (see the
1886         "notes.rewrite.<command>" option), determines what to do if
1887         the target commit already has a note.  Must be one of
1888         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1889         `concatenate`.
1891 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1892 environment variable.
1894 notes.rewriteRef::
1895         When copying notes during a rewrite, specifies the (fully
1896         qualified) ref whose notes should be copied.  The ref may be a
1897         glob, in which case notes in all matching refs will be copied.
1898         You may also specify this configuration several times.
1900 Does not have a default value; you must configure this variable to
1901 enable note rewriting.  Set it to `refs/notes/commits` to enable
1902 rewriting for the default commit notes.
1904 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1905 environment variable, which must be a colon separated list of refs or
1906 globs.
1908 pack.window::
1909         The size of the window used by linkgit:git-pack-objects[1] when no
1910         window size is given on the command line. Defaults to 10.
1912 pack.depth::
1913         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1914         maximum depth is given on the command line. Defaults to 50.
1916 pack.windowMemory::
1917         The maximum size of memory that is consumed by each thread
1918         in linkgit:git-pack-objects[1] for pack window memory when
1919         no limit is given on the command line.  The value can be
1920         suffixed with "k", "m", or "g".  When left unconfigured (or
1921         set explicitly to 0), there will be no limit.
1923 pack.compression::
1924         An integer -1..9, indicating the compression level for objects
1925         in a pack file. -1 is the zlib default. 0 means no
1926         compression, and 1..9 are various speed/size tradeoffs, 9 being
1927         slowest.  If not set,  defaults to core.compression.  If that is
1928         not set,  defaults to -1, the zlib default, which is "a default
1929         compromise between speed and compression (currently equivalent
1930         to level 6)."
1932 Note that changing the compression level will not automatically recompress
1933 all existing objects. You can force recompression by passing the -F option
1934 to linkgit:git-repack[1].
1936 pack.deltaCacheSize::
1937         The maximum memory in bytes used for caching deltas in
1938         linkgit:git-pack-objects[1] before writing them out to a pack.
1939         This cache is used to speed up the writing object phase by not
1940         having to recompute the final delta result once the best match
1941         for all objects is found.  Repacking large repositories on machines
1942         which are tight with memory might be badly impacted by this though,
1943         especially if this cache pushes the system into swapping.
1944         A value of 0 means no limit. The smallest size of 1 byte may be
1945         used to virtually disable this cache. Defaults to 256 MiB.
1947 pack.deltaCacheLimit::
1948         The maximum size of a delta, that is cached in
1949         linkgit:git-pack-objects[1]. This cache is used to speed up the
1950         writing object phase by not having to recompute the final delta
1951         result once the best match for all objects is found. Defaults to 1000.
1953 pack.threads::
1954         Specifies the number of threads to spawn when searching for best
1955         delta matches.  This requires that linkgit:git-pack-objects[1]
1956         be compiled with pthreads otherwise this option is ignored with a
1957         warning. This is meant to reduce packing time on multiprocessor
1958         machines. The required amount of memory for the delta search window
1959         is however multiplied by the number of threads.
1960         Specifying 0 will cause Git to auto-detect the number of CPU's
1961         and set the number of threads accordingly.
1963 pack.indexVersion::
1964         Specify the default pack index version.  Valid values are 1 for
1965         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1966         the new pack index with capabilities for packs larger than 4 GB
1967         as well as proper protection against the repacking of corrupted
1968         packs.  Version 2 is the default.  Note that version 2 is enforced
1969         and this config option ignored whenever the corresponding pack is
1970         larger than 2 GB.
1972 If you have an old Git that does not understand the version 2 `*.idx` file,
1973 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1974 that will copy both `*.pack` file and corresponding `*.idx` file from the
1975 other side may give you a repository that cannot be accessed with your
1976 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1977 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1978 the `*.idx` file.
1980 pack.packSizeLimit::
1981         The maximum size of a pack.  This setting only affects
1982         packing to a file when repacking, i.e. the git:// protocol
1983         is unaffected.  It can be overridden by the `--max-pack-size`
1984         option of linkgit:git-repack[1]. The minimum size allowed is
1985         limited to 1 MiB. The default is unlimited.
1986         Common unit suffixes of 'k', 'm', or 'g' are
1987         supported.
1989 pack.useBitmaps::
1990         When true, git will use pack bitmaps (if available) when packing
1991         to stdout (e.g., during the server side of a fetch). Defaults to
1992         true. You should not generally need to turn this off unless
1993         you are debugging pack bitmaps.
1995 pack.writeBitmaps (deprecated)::
1996         This is a deprecated synonym for `repack.writeBitmaps`.
1998 pack.writeBitmapHashCache::
1999         When true, git will include a "hash cache" section in the bitmap
2000         index (if one is written). This cache can be used to feed git's
2001         delta heuristics, potentially leading to better deltas between
2002         bitmapped and non-bitmapped objects (e.g., when serving a fetch
2003         between an older, bitmapped pack and objects that have been
2004         pushed since the last gc). The downside is that it consumes 4
2005         bytes per object of disk space, and that JGit's bitmap
2006         implementation does not understand it, causing it to complain if
2007         Git and JGit are used on the same repository. Defaults to false.
2009 pager.<cmd>::
2010         If the value is boolean, turns on or off pagination of the
2011         output of a particular Git subcommand when writing to a tty.
2012         Otherwise, turns on pagination for the subcommand using the
2013         pager specified by the value of `pager.<cmd>`.  If `--paginate`
2014         or `--no-pager` is specified on the command line, it takes
2015         precedence over this option.  To disable pagination for all
2016         commands, set `core.pager` or `GIT_PAGER` to `cat`.
2018 pretty.<name>::
2019         Alias for a --pretty= format string, as specified in
2020         linkgit:git-log[1]. Any aliases defined here can be used just
2021         as the built-in pretty formats could. For example,
2022         running `git config pretty.changelog "format:* %H %s"`
2023         would cause the invocation `git log --pretty=changelog`
2024         to be equivalent to running `git log "--pretty=format:* %H %s"`.
2025         Note that an alias with the same name as a built-in format
2026         will be silently ignored.
2028 pull.ff::
2029         By default, Git does not create an extra merge commit when merging
2030         a commit that is a descendant of the current commit. Instead, the
2031         tip of the current branch is fast-forwarded. When set to `false`,
2032         this variable tells Git to create an extra merge commit in such
2033         a case (equivalent to giving the `--no-ff` option from the command
2034         line). When set to `only`, only such fast-forward merges are
2035         allowed (equivalent to giving the `--ff-only` option from the
2036         command line).
2038 pull.rebase::
2039         When true, rebase branches on top of the fetched branch, instead
2040         of merging the default branch from the default remote when "git
2041         pull" is run. See "branch.<name>.rebase" for setting this on a
2042         per-branch basis.
2044         When preserve, also pass `--preserve-merges` along to 'git rebase'
2045         so that locally committed merge commits will not be flattened
2046         by running 'git pull'.
2048 *NOTE*: this is a possibly dangerous operation; do *not* use
2049 it unless you understand the implications (see linkgit:git-rebase[1]
2050 for details).
2052 pull.octopus::
2053         The default merge strategy to use when pulling multiple branches
2054         at once.
2056 pull.twohead::
2057         The default merge strategy to use when pulling a single branch.
2059 push.default::
2060         Defines the action `git push` should take if no refspec is
2061         explicitly given.  Different values are well-suited for
2062         specific workflows; for instance, in a purely central workflow
2063         (i.e. the fetch source is equal to the push destination),
2064         `upstream` is probably what you want.  Possible values are:
2068 * `nothing` - do not push anything (error out) unless a refspec is
2069   explicitly given. This is primarily meant for people who want to
2070   avoid mistakes by always being explicit.
2072 * `current` - push the current branch to update a branch with the same
2073   name on the receiving end.  Works in both central and non-central
2074   workflows.
2076 * `upstream` - push the current branch back to the branch whose
2077   changes are usually integrated into the current branch (which is
2078   called `@{upstream}`).  This mode only makes sense if you are
2079   pushing to the same repository you would normally pull from
2080   (i.e. central workflow).
2082 * `simple` - in centralized workflow, work like `upstream` with an
2083   added safety to refuse to push if the upstream branch's name is
2084   different from the local one.
2086 When pushing to a remote that is different from the remote you normally
2087 pull from, work as `current`.  This is the safest option and is suited
2088 for beginners.
2090 This mode has become the default in Git 2.0.
2092 * `matching` - push all branches having the same name on both ends.
2093   This makes the repository you are pushing to remember the set of
2094   branches that will be pushed out (e.g. if you always push 'maint'
2095   and 'master' there and no other branches, the repository you push
2096   to will have these two branches, and your local 'maint' and
2097   'master' will be pushed there).
2099 To use this mode effectively, you have to make sure _all_ the
2100 branches you would push out are ready to be pushed out before
2101 running 'git push', as the whole point of this mode is to allow you
2102 to push all of the branches in one go.  If you usually finish work
2103 on only one branch and push out the result, while other branches are
2104 unfinished, this mode is not for you.  Also this mode is not
2105 suitable for pushing into a shared central repository, as other
2106 people may add new branches there, or update the tip of existing
2107 branches outside your control.
2109 This used to be the default, but not since Git 2.0 (`simple` is the
2110 new default).
2114 push.followTags::
2115         If set to true enable '--follow-tags' option by default.  You
2116         may override this configuration at time of push by specifying
2117         '--no-follow-tags'.
2120 rebase.stat::
2121         Whether to show a diffstat of what changed upstream since the last
2122         rebase. False by default.
2124 rebase.autoSquash::
2125         If set to true enable '--autosquash' option by default.
2127 rebase.autoStash::
2128         When set to true, automatically create a temporary stash
2129         before the operation begins, and apply it after the operation
2130         ends.  This means that you can run rebase on a dirty worktree.
2131         However, use with care: the final stash application after a
2132         successful rebase might result in non-trivial conflicts.
2133         Defaults to false.
2135 receive.advertiseAtomic::
2136         By default, git-receive-pack will advertise the atomic push
2137         capability to its clients. If you don't want to this capability
2138         to be advertised, set this variable to false.
2140 receive.autogc::
2141         By default, git-receive-pack will run "git-gc --auto" after
2142         receiving data from git-push and updating refs.  You can stop
2143         it by setting this variable to false.
2145 receive.certNonceSeed::
2146         By setting this variable to a string, `git receive-pack`
2147         will accept a `git push --signed` and verifies it by using
2148         a "nonce" protected by HMAC using this string as a secret
2149         key.
2151 receive.certNonceSlop::
2152         When a `git push --signed` sent a push certificate with a
2153         "nonce" that was issued by a receive-pack serving the same
2154         repository within this many seconds, export the "nonce"
2155         found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2156         hooks (instead of what the receive-pack asked the sending
2157         side to include).  This may allow writing checks in
2158         `pre-receive` and `post-receive` a bit easier.  Instead of
2159         checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2160         that records by how many seconds the nonce is stale to
2161         decide if they want to accept the certificate, they only
2162         can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2164 receive.fsckObjects::
2165         If it is set to true, git-receive-pack will check all received
2166         objects. It will abort in the case of a malformed object or a
2167         broken link. The result of an abort are only dangling objects.
2168         Defaults to false. If not set, the value of `transfer.fsckObjects`
2169         is used instead.
2171 receive.unpackLimit::
2172         If the number of objects received in a push is below this
2173         limit then the objects will be unpacked into loose object
2174         files. However if the number of received objects equals or
2175         exceeds this limit then the received pack will be stored as
2176         a pack, after adding any missing delta bases.  Storing the
2177         pack from a push can make the push operation complete faster,
2178         especially on slow filesystems.  If not set, the value of
2179         `transfer.unpackLimit` is used instead.
2181 receive.denyDeletes::
2182         If set to true, git-receive-pack will deny a ref update that deletes
2183         the ref. Use this to prevent such a ref deletion via a push.
2185 receive.denyDeleteCurrent::
2186         If set to true, git-receive-pack will deny a ref update that
2187         deletes the currently checked out branch of a non-bare repository.
2189 receive.denyCurrentBranch::
2190         If set to true or "refuse", git-receive-pack will deny a ref update
2191         to the currently checked out branch of a non-bare repository.
2192         Such a push is potentially dangerous because it brings the HEAD
2193         out of sync with the index and working tree. If set to "warn",
2194         print a warning of such a push to stderr, but allow the push to
2195         proceed. If set to false or "ignore", allow such pushes with no
2196         message. Defaults to "refuse".
2198 Another option is "updateInstead" which will update the working
2199 tree if pushing into the current branch.  This option is
2200 intended for synchronizing working directories when one side is not easily
2201 accessible via interactive ssh (e.g. a live web site, hence the requirement
2202 that the working directory be clean). This mode also comes in handy when
2203 developing inside a VM to test and fix code on different Operating Systems.
2205 By default, "updateInstead" will refuse the push if the working tree or
2206 the index have any difference from the HEAD, but the `push-to-checkout`
2207 hook can be used to customize this.  See linkgit:githooks[5].
2209 receive.denyNonFastForwards::
2210         If set to true, git-receive-pack will deny a ref update which is
2211         not a fast-forward. Use this to prevent such an update via a push,
2212         even if that push is forced. This configuration variable is
2213         set when initializing a shared repository.
2215 receive.hideRefs::
2216         String(s) `receive-pack` uses to decide which refs to omit
2217         from its initial advertisement.  Use more than one
2218         definitions to specify multiple prefix strings. A ref that
2219         are under the hierarchies listed on the value of this
2220         variable is excluded, and is hidden when responding to `git
2221         push`, and an attempt to update or delete a hidden ref by
2222         `git push` is rejected.
2224 receive.updateServerInfo::
2225         If set to true, git-receive-pack will run git-update-server-info
2226         after receiving data from git-push and updating refs.
2228 receive.shallowUpdate::
2229         If set to true, .git/shallow can be updated when new refs
2230         require new shallow roots. Otherwise those refs are rejected.
2232 remote.pushDefault::
2233         The remote to push to by default.  Overrides
2234         `branch.<name>.remote` for all branches, and is overridden by
2235         `branch.<name>.pushRemote` for specific branches.
2237 remote.<name>.url::
2238         The URL of a remote repository.  See linkgit:git-fetch[1] or
2239         linkgit:git-push[1].
2241 remote.<name>.pushurl::
2242         The push URL of a remote repository.  See linkgit:git-push[1].
2244 remote.<name>.proxy::
2245         For remotes that require curl (http, https and ftp), the URL to
2246         the proxy to use for that remote.  Set to the empty string to
2247         disable proxying for that remote.
2249 remote.<name>.fetch::
2250         The default set of "refspec" for linkgit:git-fetch[1]. See
2251         linkgit:git-fetch[1].
2253 remote.<name>.push::
2254         The default set of "refspec" for linkgit:git-push[1]. See
2255         linkgit:git-push[1].
2257 remote.<name>.mirror::
2258         If true, pushing to this remote will automatically behave
2259         as if the `--mirror` option was given on the command line.
2261 remote.<name>.skipDefaultUpdate::
2262         If true, this remote will be skipped by default when updating
2263         using linkgit:git-fetch[1] or the `update` subcommand of
2264         linkgit:git-remote[1].
2266 remote.<name>.skipFetchAll::
2267         If true, this remote will be skipped by default when updating
2268         using linkgit:git-fetch[1] or the `update` subcommand of
2269         linkgit:git-remote[1].
2271 remote.<name>.receivepack::
2272         The default program to execute on the remote side when pushing.  See
2273         option \--receive-pack of linkgit:git-push[1].
2275 remote.<name>.uploadpack::
2276         The default program to execute on the remote side when fetching.  See
2277         option \--upload-pack of linkgit:git-fetch-pack[1].
2279 remote.<name>.tagOpt::
2280         Setting this value to \--no-tags disables automatic tag following when
2281         fetching from remote <name>. Setting it to \--tags will fetch every
2282         tag from remote <name>, even if they are not reachable from remote
2283         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2284         override this setting. See options \--tags and \--no-tags of
2285         linkgit:git-fetch[1].
2287 remote.<name>.vcs::
2288         Setting this to a value <vcs> will cause Git to interact with
2289         the remote with the git-remote-<vcs> helper.
2291 remote.<name>.prune::
2292         When set to true, fetching from this remote by default will also
2293         remove any remote-tracking references that no longer exist on the
2294         remote (as if the `--prune` option was given on the command line).
2295         Overrides `fetch.prune` settings, if any.
2297 remotes.<group>::
2298         The list of remotes which are fetched by "git remote update
2299         <group>".  See linkgit:git-remote[1].
2301 repack.useDeltaBaseOffset::
2302         By default, linkgit:git-repack[1] creates packs that use
2303         delta-base offset. If you need to share your repository with
2304         Git older than version 1.4.4, either directly or via a dumb
2305         protocol such as http, then you need to set this option to
2306         "false" and repack. Access from old Git versions over the
2307         native protocol are unaffected by this option.
2309 repack.packKeptObjects::
2310         If set to true, makes `git repack` act as if
2311         `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2312         details. Defaults to `false` normally, but `true` if a bitmap
2313         index is being written (either via `--write-bitmap-index` or
2314         `repack.writeBitmaps`).
2316 repack.writeBitmaps::
2317         When true, git will write a bitmap index when packing all
2318         objects to disk (e.g., when `git repack -a` is run).  This
2319         index can speed up the "counting objects" phase of subsequent
2320         packs created for clones and fetches, at the cost of some disk
2321         space and extra time spent on the initial repack.  Defaults to
2322         false.
2324 rerere.autoUpdate::
2325         When set to true, `git-rerere` updates the index with the
2326         resulting contents after it cleanly resolves conflicts using
2327         previously recorded resolution.  Defaults to false.
2329 rerere.enabled::
2330         Activate recording of resolved conflicts, so that identical
2331         conflict hunks can be resolved automatically, should they be
2332         encountered again.  By default, linkgit:git-rerere[1] is
2333         enabled if there is an `rr-cache` directory under the
2334         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2335         repository.
2337 sendemail.identity::
2338         A configuration identity. When given, causes values in the
2339         'sendemail.<identity>' subsection to take precedence over
2340         values in the 'sendemail' section. The default identity is
2341         the value of 'sendemail.identity'.
2343 sendemail.smtpEncryption::
2344         See linkgit:git-send-email[1] for description.  Note that this
2345         setting is not subject to the 'identity' mechanism.
2347 sendemail.smtpssl (deprecated)::
2348         Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2350 sendemail.smtpsslcertpath::
2351         Path to ca-certificates (either a directory or a single file).
2352         Set it to an empty string to disable certificate verification.
2354 sendemail.<identity>.*::
2355         Identity-specific versions of the 'sendemail.*' parameters
2356         found below, taking precedence over those when the this
2357         identity is selected, through command-line or
2358         'sendemail.identity'.
2360 sendemail.aliasesFile::
2361 sendemail.aliasFileType::
2362 sendemail.annotate::
2363 sendemail.bcc::
2364 sendemail.cc::
2365 sendemail.ccCmd::
2366 sendemail.chainReplyTo::
2367 sendemail.confirm::
2368 sendemail.envelopeSender::
2369 sendemail.from::
2370 sendemail.multiEdit::
2371 sendemail.signedoffbycc::
2372 sendemail.smtpPass::
2373 sendemail.suppresscc::
2374 sendemail.suppressFrom::
2375 sendemail.to::
2376 sendemail.smtpDomain::
2377 sendemail.smtpServer::
2378 sendemail.smtpServerPort::
2379 sendemail.smtpServerOption::
2380 sendemail.smtpUser::
2381 sendemail.thread::
2382 sendemail.transferEncoding::
2383 sendemail.validate::
2384 sendemail.xmailer::
2385         See linkgit:git-send-email[1] for description.
2387 sendemail.signedoffcc (deprecated)::
2388         Deprecated alias for 'sendemail.signedoffbycc'.
2390 showbranch.default::
2391         The default set of branches for linkgit:git-show-branch[1].
2392         See linkgit:git-show-branch[1].
2394 status.relativePaths::
2395         By default, linkgit:git-status[1] shows paths relative to the
2396         current directory. Setting this variable to `false` shows paths
2397         relative to the repository root (this was the default for Git
2398         prior to v1.5.4).
2400 status.short::
2401         Set to true to enable --short by default in linkgit:git-status[1].
2402         The option --no-short takes precedence over this variable.
2404 status.branch::
2405         Set to true to enable --branch by default in linkgit:git-status[1].
2406         The option --no-branch takes precedence over this variable.
2408 status.displayCommentPrefix::
2409         If set to true, linkgit:git-status[1] will insert a comment
2410         prefix before each output line (starting with
2411         `core.commentChar`, i.e. `#` by default). This was the
2412         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2413         Defaults to false.
2415 status.showUntrackedFiles::
2416         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2417         files which are not currently tracked by Git. Directories which
2418         contain only untracked files, are shown with the directory name
2419         only. Showing untracked files means that Git needs to lstat() all
2420         the files in the whole repository, which might be slow on some
2421         systems. So, this variable controls how the commands displays
2422         the untracked files. Possible values are:
2425 * `no` - Show no untracked files.
2426 * `normal` - Show untracked files and directories.
2427 * `all` - Show also individual files in untracked directories.
2430 If this variable is not specified, it defaults to 'normal'.
2431 This variable can be overridden with the -u|--untracked-files option
2432 of linkgit:git-status[1] and linkgit:git-commit[1].
2434 status.submoduleSummary::
2435         Defaults to false.
2436         If this is set to a non zero number or true (identical to -1 or an
2437         unlimited number), the submodule summary will be enabled and a
2438         summary of commits for modified submodules will be shown (see
2439         --summary-limit option of linkgit:git-submodule[1]). Please note
2440         that the summary output command will be suppressed for all
2441         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2442         for those submodules where `submodule.<name>.ignore=all`. The only
2443         exception to that rule is that status and commit will show staged
2444         submodule changes. To
2445         also view the summary for ignored submodules you can either use
2446         the --ignore-submodules=dirty command-line option or the 'git
2447         submodule summary' command, which shows a similar output but does
2448         not honor these settings.
2450 submodule.<name>.path::
2451 submodule.<name>.url::
2452         The path within this project and URL for a submodule. These
2453         variables are initially populated by 'git submodule init'. See
2454         linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2455         details.
2457 submodule.<name>.update::
2458         The default update procedure for a submodule. This variable
2459         is populated by `git submodule init` from the
2460         linkgit:gitmodules[5] file. See description of 'update'
2461         command in linkgit:git-submodule[1].
2463 submodule.<name>.branch::
2464         The remote branch name for a submodule, used by `git submodule
2465         update --remote`.  Set this option to override the value found in
2466         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2467         linkgit:gitmodules[5] for details.
2469 submodule.<name>.fetchRecurseSubmodules::
2470         This option can be used to control recursive fetching of this
2471         submodule. It can be overridden by using the --[no-]recurse-submodules
2472         command-line option to "git fetch" and "git pull".
2473         This setting will override that from in the linkgit:gitmodules[5]
2474         file.
2476 submodule.<name>.ignore::
2477         Defines under what circumstances "git status" and the diff family show
2478         a submodule as modified. When set to "all", it will never be considered
2479         modified (but it will nonetheless show up in the output of status and
2480         commit when it has been staged), "dirty" will ignore all changes
2481         to the submodules work tree and
2482         takes only differences between the HEAD of the submodule and the commit
2483         recorded in the superproject into account. "untracked" will additionally
2484         let submodules with modified tracked files in their work tree show up.
2485         Using "none" (the default when this option is not set) also shows
2486         submodules that have untracked files in their work tree as changed.
2487         This setting overrides any setting made in .gitmodules for this submodule,
2488         both settings can be overridden on the command line by using the
2489         "--ignore-submodules" option. The 'git submodule' commands are not
2490         affected by this setting.
2492 tag.sort::
2493         This variable controls the sort ordering of tags when displayed by
2494         linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2495         value of this variable will be used as the default.
2497 tar.umask::
2498         This variable can be used to restrict the permission bits of
2499         tar archive entries.  The default is 0002, which turns off the
2500         world write bit.  The special value "user" indicates that the
2501         archiving user's umask will be used instead.  See umask(2) and
2502         linkgit:git-archive[1].
2504 transfer.fsckObjects::
2505         When `fetch.fsckObjects` or `receive.fsckObjects` are
2506         not set, the value of this variable is used instead.
2507         Defaults to false.
2509 transfer.hideRefs::
2510         This variable can be used to set both `receive.hideRefs`
2511         and `uploadpack.hideRefs` at the same time to the same
2512         values.  See entries for these other variables.
2514 transfer.unpackLimit::
2515         When `fetch.unpackLimit` or `receive.unpackLimit` are
2516         not set, the value of this variable is used instead.
2517         The default value is 100.
2519 uploadarchive.allowUnreachable::
2520         If true, allow clients to use `git archive --remote` to request
2521         any tree, whether reachable from the ref tips or not. See the
2522         discussion in the `SECURITY` section of
2523         linkgit:git-upload-archive[1] for more details. Defaults to
2524         `false`.
2526 uploadpack.hideRefs::
2527         String(s) `upload-pack` uses to decide which refs to omit
2528         from its initial advertisement.  Use more than one
2529         definitions to specify multiple prefix strings. A ref that
2530         are under the hierarchies listed on the value of this
2531         variable is excluded, and is hidden from `git ls-remote`,
2532         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2533         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2535 uploadpack.allowtipsha1inwant::
2536         When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2537         to accept a fetch request that asks for an object at the tip
2538         of a hidden ref (by default, such a request is rejected).
2539         see also `uploadpack.hideRefs`.
2541 uploadpack.keepAlive::
2542         When `upload-pack` has started `pack-objects`, there may be a
2543         quiet period while `pack-objects` prepares the pack. Normally
2544         it would output progress information, but if `--quiet` was used
2545         for the fetch, `pack-objects` will output nothing at all until
2546         the pack data begins. Some clients and networks may consider
2547         the server to be hung and give up. Setting this option instructs
2548         `upload-pack` to send an empty keepalive packet every
2549         `uploadpack.keepAlive` seconds. Setting this option to 0
2550         disables keepalive packets entirely. The default is 5 seconds.
2552 url.<base>.insteadOf::
2553         Any URL that starts with this value will be rewritten to
2554         start, instead, with <base>. In cases where some site serves a
2555         large number of repositories, and serves them with multiple
2556         access methods, and some users need to use different access
2557         methods, this feature allows people to specify any of the
2558         equivalent URLs and have Git automatically rewrite the URL to
2559         the best alternative for the particular user, even for a
2560         never-before-seen repository on the site.  When more than one
2561         insteadOf strings match a given URL, the longest match is used.
2563 url.<base>.pushInsteadOf::
2564         Any URL that starts with this value will not be pushed to;
2565         instead, it will be rewritten to start with <base>, and the
2566         resulting URL will be pushed to. In cases where some site serves
2567         a large number of repositories, and serves them with multiple
2568         access methods, some of which do not allow push, this feature
2569         allows people to specify a pull-only URL and have Git
2570         automatically use an appropriate URL to push, even for a
2571         never-before-seen repository on the site.  When more than one
2572         pushInsteadOf strings match a given URL, the longest match is
2573         used.  If a remote has an explicit pushurl, Git will ignore this
2574         setting for that remote.
2576 user.email::
2577         Your email address to be recorded in any newly created commits.
2578         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2579         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2581 user.name::
2582         Your full name to be recorded in any newly created commits.
2583         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2584         environment variables.  See linkgit:git-commit-tree[1].
2586 user.signingKey::
2587         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2588         key you want it to automatically when creating a signed tag or
2589         commit, you can override the default selection with this variable.
2590         This option is passed unchanged to gpg's --local-user parameter,
2591         so you may specify a key using any method that gpg supports.
2593 versionsort.prereleaseSuffix::
2594         When version sort is used in linkgit:git-tag[1], prerelease
2595         tags (e.g. "1.0-rc1") may appear after the main release
2596         "1.0". By specifying the suffix "-rc" in this variable,
2597         "1.0-rc1" will appear before "1.0".
2599 This variable can be specified multiple times, once per suffix. The
2600 order of suffixes in the config file determines the sorting order
2601 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2602 is sorted before 1.0-rcXX). The sorting order between different
2603 suffixes is undefined if they are in multiple config files.
2605 web.browser::
2606         Specify a web browser that may be used by some commands.
2607         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2608         may use it.