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