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