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