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