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