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