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