Documentation / config.txton commit config.txt: move help.* to a separate file (d3df427)
   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
 290include::config/advice.txt[]
 291
 292include::config/core.txt[]
 293
 294include::config/add.txt[]
 295
 296include::config/alias.txt[]
 297
 298include::config/am.txt[]
 299
 300include::config/apply.txt[]
 301
 302include::config/blame.txt[]
 303
 304include::config/branch.txt[]
 305
 306include::config/browser.txt[]
 307
 308include::config/checkout.txt[]
 309
 310include::config/clean.txt[]
 311
 312include::config/color.txt[]
 313
 314include::config/column.txt[]
 315
 316include::config/commit.txt[]
 317
 318include::config/credential.txt[]
 319
 320include::config/completion.txt[]
 321
 322include::config/diff.txt[]
 323
 324include::config/difftool.txt[]
 325
 326include::config/fastimport.txt[]
 327
 328include::config/fetch.txt[]
 329
 330include::config/format.txt[]
 331
 332include::config/filter.txt[]
 333
 334include::config/fsck.txt[]
 335
 336include::config/gc.txt[]
 337
 338include::config/gitcvs.txt[]
 339
 340include::config/gitweb.txt[]
 341
 342include::config/grep.txt[]
 343
 344include::config/gpg.txt[]
 345
 346include::config/gui.txt[]
 347
 348include::config/guitool.txt[]
 349
 350include::config/help.txt[]
 351
 352http.proxy::
 353        Override the HTTP proxy, normally configured using the 'http_proxy',
 354        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
 355        addition to the syntax understood by curl, it is possible to specify a
 356        proxy string with a user name but no password, in which case git will
 357        attempt to acquire one in the same way it does for other credentials. See
 358        linkgit:gitcredentials[7] for more information. The syntax thus is
 359        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
 360        on a per-remote basis; see remote.<name>.proxy
 361
 362http.proxyAuthMethod::
 363        Set the method with which to authenticate against the HTTP proxy. This
 364        only takes effect if the configured proxy string contains a user name part
 365        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
 366        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
 367        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
 368        variable.  Possible values are:
 369+
 370--
 371* `anyauth` - Automatically pick a suitable authentication method. It is
 372  assumed that the proxy answers an unauthenticated request with a 407
 373  status code and one or more Proxy-authenticate headers with supported
 374  authentication methods. This is the default.
 375* `basic` - HTTP Basic authentication
 376* `digest` - HTTP Digest authentication; this prevents the password from being
 377  transmitted to the proxy in clear text
 378* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
 379  of `curl(1)`)
 380* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
 381--
 382
 383http.emptyAuth::
 384        Attempt authentication without seeking a username or password.  This
 385        can be used to attempt GSS-Negotiate authentication without specifying
 386        a username in the URL, as libcurl normally requires a username for
 387        authentication.
 388
 389http.delegation::
 390        Control GSSAPI credential delegation. The delegation is disabled
 391        by default in libcurl since version 7.21.7. Set parameter to tell
 392        the server what it is allowed to delegate when it comes to user
 393        credentials. Used with GSS/kerberos. Possible values are:
 394+
 395--
 396* `none` - Don't allow any delegation.
 397* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
 398  Kerberos service ticket, which is a matter of realm policy.
 399* `always` - Unconditionally allow the server to delegate.
 400--
 401
 402
 403http.extraHeader::
 404        Pass an additional HTTP header when communicating with a server.  If
 405        more than one such entry exists, all of them are added as extra
 406        headers.  To allow overriding the settings inherited from the system
 407        config, an empty value will reset the extra headers to the empty list.
 408
 409http.cookieFile::
 410        The pathname of a file containing previously stored cookie lines,
 411        which should be used
 412        in the Git http session, if they match the server. The file format
 413        of the file to read cookies from should be plain HTTP headers or
 414        the Netscape/Mozilla cookie file format (see `curl(1)`).
 415        NOTE that the file specified with http.cookieFile is used only as
 416        input unless http.saveCookies is set.
 417
 418http.saveCookies::
 419        If set, store cookies received during requests to the file specified by
 420        http.cookieFile. Has no effect if http.cookieFile is unset.
 421
 422http.sslVersion::
 423        The SSL version to use when negotiating an SSL connection, if you
 424        want to force the default.  The available and default version
 425        depend on whether libcurl was built against NSS or OpenSSL and the
 426        particular configuration of the crypto library in use. Internally
 427        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
 428        documentation for more details on the format of this option and
 429        for the ssl version supported. Actually the possible values of
 430        this option are:
 431
 432        - sslv2
 433        - sslv3
 434        - tlsv1
 435        - tlsv1.0
 436        - tlsv1.1
 437        - tlsv1.2
 438        - tlsv1.3
 439
 440+
 441Can be overridden by the `GIT_SSL_VERSION` environment variable.
 442To force git to use libcurl's default ssl version and ignore any
 443explicit http.sslversion option, set `GIT_SSL_VERSION` to the
 444empty string.
 445
 446http.sslCipherList::
 447  A list of SSL ciphers to use when negotiating an SSL connection.
 448  The available ciphers depend on whether libcurl was built against
 449  NSS or OpenSSL and the particular configuration of the crypto
 450  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
 451  option; see the libcurl documentation for more details on the format
 452  of this list.
 453+
 454Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
 455To force git to use libcurl's default cipher list and ignore any
 456explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
 457empty string.
 458
 459http.sslVerify::
 460        Whether to verify the SSL certificate when fetching or pushing
 461        over HTTPS. Defaults to true. Can be overridden by the
 462        `GIT_SSL_NO_VERIFY` environment variable.
 463
 464http.sslCert::
 465        File containing the SSL certificate when fetching or pushing
 466        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
 467        variable.
 468
 469http.sslKey::
 470        File containing the SSL private key when fetching or pushing
 471        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
 472        variable.
 473
 474http.sslCertPasswordProtected::
 475        Enable Git's password prompt for the SSL certificate.  Otherwise
 476        OpenSSL will prompt the user, possibly many times, if the
 477        certificate or private key is encrypted.  Can be overridden by the
 478        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
 479
 480http.sslCAInfo::
 481        File containing the certificates to verify the peer with when
 482        fetching or pushing over HTTPS. Can be overridden by the
 483        `GIT_SSL_CAINFO` environment variable.
 484
 485http.sslCAPath::
 486        Path containing files with the CA certificates to verify the peer
 487        with when fetching or pushing over HTTPS. Can be overridden
 488        by the `GIT_SSL_CAPATH` environment variable.
 489
 490http.sslBackend::
 491        Name of the SSL backend to use (e.g. "openssl" or "schannel").
 492        This option is ignored if cURL lacks support for choosing the SSL
 493        backend at runtime.
 494
 495http.schannelCheckRevoke::
 496        Used to enforce or disable certificate revocation checks in cURL
 497        when http.sslBackend is set to "schannel". Defaults to `true` if
 498        unset. Only necessary to disable this if Git consistently errors
 499        and the message is about checking the revocation status of a
 500        certificate. This option is ignored if cURL lacks support for
 501        setting the relevant SSL option at runtime.
 502
 503http.schannelUseSSLCAInfo::
 504        As of cURL v7.60.0, the Secure Channel backend can use the
 505        certificate bundle provided via `http.sslCAInfo`, but that would
 506        override the Windows Certificate Store. Since this is not desirable
 507        by default, Git will tell cURL not to use that bundle by default
 508        when the `schannel` backend was configured via `http.sslBackend`,
 509        unless `http.schannelUseSSLCAInfo` overrides this behavior.
 510
 511http.pinnedpubkey::
 512        Public key of the https service. It may either be the filename of
 513        a PEM or DER encoded public key file or a string starting with
 514        'sha256//' followed by the base64 encoded sha256 hash of the
 515        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
 516        exit with an error if this option is set but not supported by
 517        cURL.
 518
 519http.sslTry::
 520        Attempt to use AUTH SSL/TLS and encrypted data transfers
 521        when connecting via regular FTP protocol. This might be needed
 522        if the FTP server requires it for security reasons or you wish
 523        to connect securely whenever remote FTP server supports it.
 524        Default is false since it might trigger certificate verification
 525        errors on misconfigured servers.
 526
 527http.maxRequests::
 528        How many HTTP requests to launch in parallel. Can be overridden
 529        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
 530
 531http.minSessions::
 532        The number of curl sessions (counted across slots) to be kept across
 533        requests. They will not be ended with curl_easy_cleanup() until
 534        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
 535        value will be capped at 1. Defaults to 1.
 536
 537http.postBuffer::
 538        Maximum size in bytes of the buffer used by smart HTTP
 539        transports when POSTing data to the remote system.
 540        For requests larger than this buffer size, HTTP/1.1 and
 541        Transfer-Encoding: chunked is used to avoid creating a
 542        massive pack file locally.  Default is 1 MiB, which is
 543        sufficient for most requests.
 544
 545http.lowSpeedLimit, http.lowSpeedTime::
 546        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 547        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 548        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
 549        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
 550
 551http.noEPSV::
 552        A boolean which disables using of EPSV ftp command by curl.
 553        This can helpful with some "poor" ftp servers which don't
 554        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
 555        environment variable. Default is false (curl will use EPSV).
 556
 557http.userAgent::
 558        The HTTP USER_AGENT string presented to an HTTP server.  The default
 559        value represents the version of the client Git such as git/1.7.1.
 560        This option allows you to override this value to a more common value
 561        such as Mozilla/4.0.  This may be necessary, for instance, if
 562        connecting through a firewall that restricts HTTP connections to a set
 563        of common USER_AGENT strings (but not including those like git/1.7.1).
 564        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
 565
 566http.followRedirects::
 567        Whether git should follow HTTP redirects. If set to `true`, git
 568        will transparently follow any redirect issued by a server it
 569        encounters. If set to `false`, git will treat all redirects as
 570        errors. If set to `initial`, git will follow redirects only for
 571        the initial request to a remote, but not for subsequent
 572        follow-up HTTP requests. Since git uses the redirected URL as
 573        the base for the follow-up requests, this is generally
 574        sufficient. The default is `initial`.
 575
 576http.<url>.*::
 577        Any of the http.* options above can be applied selectively to some URLs.
 578        For a config key to match a URL, each element of the config key is
 579        compared to that of the URL, in the following order:
 580+
 581--
 582. Scheme (e.g., `https` in `https://example.com/`). This field
 583  must match exactly between the config key and the URL.
 584
 585. Host/domain name (e.g., `example.com` in `https://example.com/`).
 586  This field must match between the config key and the URL. It is
 587  possible to specify a `*` as part of the host name to match all subdomains
 588  at this level. `https://*.example.com/` for example would match
 589  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
 590
 591. Port number (e.g., `8080` in `http://example.com:8080/`).
 592  This field must match exactly between the config key and the URL.
 593  Omitted port numbers are automatically converted to the correct
 594  default for the scheme before matching.
 595
 596. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
 597  path field of the config key must match the path field of the URL
 598  either exactly or as a prefix of slash-delimited path elements.  This means
 599  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
 600  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
 601  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
 602  key with just path `foo/`).
 603
 604. User name (e.g., `user` in `https://user@example.com/repo.git`). If
 605  the config key has a user name it must match the user name in the
 606  URL exactly. If the config key does not have a user name, that
 607  config key will match a URL with any user name (including none),
 608  but at a lower precedence than a config key with a user name.
 609--
 610+
 611The list above is ordered by decreasing precedence; a URL that matches
 612a config key's path is preferred to one that matches its user name. For example,
 613if the URL is `https://user@example.com/foo/bar` a config key match of
 614`https://example.com/foo` will be preferred over a config key match of
 615`https://user@example.com`.
 616+
 617All URLs are normalized before attempting any matching (the password part,
 618if embedded in the URL, is always ignored for matching purposes) so that
 619equivalent URLs that are simply spelled differently will match properly.
 620Environment variable settings always override any matches.  The URLs that are
 621matched against are those given directly to Git commands.  This means any URLs
 622visited as a result of a redirection do not participate in matching.
 623
 624ssh.variant::
 625        By default, Git determines the command line arguments to use
 626        based on the basename of the configured SSH command (configured
 627        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
 628        the config setting `core.sshCommand`). If the basename is
 629        unrecognized, Git will attempt to detect support of OpenSSH
 630        options by first invoking the configured SSH command with the
 631        `-G` (print configuration) option and will subsequently use
 632        OpenSSH options (if that is successful) or no options besides
 633        the host and remote command (if it fails).
 634+
 635The config variable `ssh.variant` can be set to override this detection.
 636Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
 637`tortoiseplink`, `simple` (no options except the host and remote command).
 638The default auto-detection can be explicitly requested using the value
 639`auto`.  Any other value is treated as `ssh`.  This setting can also be
 640overridden via the environment variable `GIT_SSH_VARIANT`.
 641+
 642The current command-line parameters used for each variant are as
 643follows:
 644+
 645--
 646
 647* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
 648
 649* `simple` - [username@]host command
 650
 651* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
 652
 653* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
 654
 655--
 656+
 657Except for the `simple` variant, command-line parameters are likely to
 658change as git gains new features.
 659
 660i18n.commitEncoding::
 661        Character encoding the commit messages are stored in; Git itself
 662        does not care per se, but this information is necessary e.g. when
 663        importing commits from emails or in the gitk graphical history
 664        browser (and possibly at other places in the future or in other
 665        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
 666
 667i18n.logOutputEncoding::
 668        Character encoding the commit messages are converted to when
 669        running 'git log' and friends.
 670
 671imap::
 672        The configuration variables in the 'imap' section are described
 673        in linkgit:git-imap-send[1].
 674
 675index.threads::
 676        Specifies the number of threads to spawn when loading the index.
 677        This is meant to reduce index load time on multiprocessor machines.
 678        Specifying 0 or 'true' will cause Git to auto-detect the number of
 679        CPU's and set the number of threads accordingly. Specifying 1 or
 680        'false' will disable multithreading. Defaults to 'true'.
 681
 682index.version::
 683        Specify the version with which new index files should be
 684        initialized.  This does not affect existing repositories.
 685
 686init.templateDir::
 687        Specify the directory from which templates will be copied.
 688        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
 689
 690instaweb.browser::
 691        Specify the program that will be used to browse your working
 692        repository in gitweb. See linkgit:git-instaweb[1].
 693
 694instaweb.httpd::
 695        The HTTP daemon command-line to start gitweb on your working
 696        repository. See linkgit:git-instaweb[1].
 697
 698instaweb.local::
 699        If true the web server started by linkgit:git-instaweb[1] will
 700        be bound to the local IP (127.0.0.1).
 701
 702instaweb.modulePath::
 703        The default module path for linkgit:git-instaweb[1] to use
 704        instead of /usr/lib/apache2/modules.  Only used if httpd
 705        is Apache.
 706
 707instaweb.port::
 708        The port number to bind the gitweb httpd to. See
 709        linkgit:git-instaweb[1].
 710
 711interactive.singleKey::
 712        In interactive commands, allow the user to provide one-letter
 713        input with a single key (i.e., without hitting enter).
 714        Currently this is used by the `--patch` mode of
 715        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
 716        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
 717        setting is silently ignored if portable keystroke input
 718        is not available; requires the Perl module Term::ReadKey.
 719
 720interactive.diffFilter::
 721        When an interactive command (such as `git add --patch`) shows
 722        a colorized diff, git will pipe the diff through the shell
 723        command defined by this configuration variable. The command may
 724        mark up the diff further for human consumption, provided that it
 725        retains a one-to-one correspondence with the lines in the
 726        original diff. Defaults to disabled (no filtering).
 727
 728log.abbrevCommit::
 729        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 730        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
 731        override this option with `--no-abbrev-commit`.
 732
 733log.date::
 734        Set the default date-time mode for the 'log' command.
 735        Setting a value for log.date is similar to using 'git log''s
 736        `--date` option.  See linkgit:git-log[1] for details.
 737
 738log.decorate::
 739        Print out the ref names of any commits that are shown by the log
 740        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
 741        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
 742        specified, the full ref name (including prefix) will be printed.
 743        If 'auto' is specified, then if the output is going to a terminal,
 744        the ref names are shown as if 'short' were given, otherwise no ref
 745        names are shown. This is the same as the `--decorate` option
 746        of the `git log`.
 747
 748log.follow::
 749        If `true`, `git log` will act as if the `--follow` option was used when
 750        a single <path> is given.  This has the same limitations as `--follow`,
 751        i.e. it cannot be used to follow multiple files and does not work well
 752        on non-linear history.
 753
 754log.graphColors::
 755        A list of colors, separated by commas, that can be used to draw
 756        history lines in `git log --graph`.
 757
 758log.showRoot::
 759        If true, the initial commit will be shown as a big creation event.
 760        This is equivalent to a diff against an empty tree.
 761        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
 762        normally hide the root commit will now show it. True by default.
 763
 764log.showSignature::
 765        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 766        linkgit:git-whatchanged[1] assume `--show-signature`.
 767
 768log.mailmap::
 769        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 770        linkgit:git-whatchanged[1] assume `--use-mailmap`.
 771
 772mailinfo.scissors::
 773        If true, makes linkgit:git-mailinfo[1] (and therefore
 774        linkgit:git-am[1]) act by default as if the --scissors option
 775        was provided on the command-line. When active, this features
 776        removes everything from the message body before a scissors
 777        line (i.e. consisting mainly of ">8", "8<" and "-").
 778
 779mailmap.file::
 780        The location of an augmenting mailmap file. The default
 781        mailmap, located in the root of the repository, is loaded
 782        first, then the mailmap file pointed to by this variable.
 783        The location of the mailmap file may be in a repository
 784        subdirectory, or somewhere outside of the repository itself.
 785        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
 786
 787mailmap.blob::
 788        Like `mailmap.file`, but consider the value as a reference to a
 789        blob in the repository. If both `mailmap.file` and
 790        `mailmap.blob` are given, both are parsed, with entries from
 791        `mailmap.file` taking precedence. In a bare repository, this
 792        defaults to `HEAD:.mailmap`. In a non-bare repository, it
 793        defaults to empty.
 794
 795man.viewer::
 796        Specify the programs that may be used to display help in the
 797        'man' format. See linkgit:git-help[1].
 798
 799man.<tool>.cmd::
 800        Specify the command to invoke the specified man viewer. The
 801        specified command is evaluated in shell with the man page
 802        passed as argument. (See linkgit:git-help[1].)
 803
 804man.<tool>.path::
 805        Override the path for the given tool that may be used to
 806        display help in the 'man' format. See linkgit:git-help[1].
 807
 808include::merge-config.txt[]
 809
 810mergetool.<tool>.path::
 811        Override the path for the given tool.  This is useful in case
 812        your tool is not in the PATH.
 813
 814mergetool.<tool>.cmd::
 815        Specify the command to invoke the specified merge tool.  The
 816        specified command is evaluated in shell with the following
 817        variables available: 'BASE' is the name of a temporary file
 818        containing the common base of the files to be merged, if available;
 819        'LOCAL' is the name of a temporary file containing the contents of
 820        the file on the current branch; 'REMOTE' is the name of a temporary
 821        file containing the contents of the file from the branch being
 822        merged; 'MERGED' contains the name of the file to which the merge
 823        tool should write the results of a successful merge.
 824
 825mergetool.<tool>.trustExitCode::
 826        For a custom merge command, specify whether the exit code of
 827        the merge command can be used to determine whether the merge was
 828        successful.  If this is not set to true then the merge target file
 829        timestamp is checked and the merge assumed to have been successful
 830        if the file has been updated, otherwise the user is prompted to
 831        indicate the success of the merge.
 832
 833mergetool.meld.hasOutput::
 834        Older versions of `meld` do not support the `--output` option.
 835        Git will attempt to detect whether `meld` supports `--output`
 836        by inspecting the output of `meld --help`.  Configuring
 837        `mergetool.meld.hasOutput` will make Git skip these checks and
 838        use the configured value instead.  Setting `mergetool.meld.hasOutput`
 839        to `true` tells Git to unconditionally use the `--output` option,
 840        and `false` avoids using `--output`.
 841
 842mergetool.keepBackup::
 843        After performing a merge, the original file with conflict markers
 844        can be saved as a file with a `.orig` extension.  If this variable
 845        is set to `false` then this file is not preserved.  Defaults to
 846        `true` (i.e. keep the backup files).
 847
 848mergetool.keepTemporaries::
 849        When invoking a custom merge tool, Git uses a set of temporary
 850        files to pass to the tool. If the tool returns an error and this
 851        variable is set to `true`, then these temporary files will be
 852        preserved, otherwise they will be removed after the tool has
 853        exited. Defaults to `false`.
 854
 855mergetool.writeToTemp::
 856        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
 857        conflicting files in the worktree by default.  Git will attempt
 858        to use a temporary directory for these files when set `true`.
 859        Defaults to `false`.
 860
 861mergetool.prompt::
 862        Prompt before each invocation of the merge resolution program.
 863
 864notes.mergeStrategy::
 865        Which merge strategy to choose by default when resolving notes
 866        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
 867        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
 868        section of linkgit:git-notes[1] for more information on each strategy.
 869
 870notes.<name>.mergeStrategy::
 871        Which merge strategy to choose when doing a notes merge into
 872        refs/notes/<name>.  This overrides the more general
 873        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
 874        linkgit:git-notes[1] for more information on the available strategies.
 875
 876notes.displayRef::
 877        The (fully qualified) refname from which to show notes when
 878        showing commit messages.  The value of this variable can be set
 879        to a glob, in which case notes from all matching refs will be
 880        shown.  You may also specify this configuration variable
 881        several times.  A warning will be issued for refs that do not
 882        exist, but a glob that does not match any refs is silently
 883        ignored.
 884+
 885This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
 886environment variable, which must be a colon separated list of refs or
 887globs.
 888+
 889The effective value of "core.notesRef" (possibly overridden by
 890GIT_NOTES_REF) is also implicitly added to the list of refs to be
 891displayed.
 892
 893notes.rewrite.<command>::
 894        When rewriting commits with <command> (currently `amend` or
 895        `rebase`) and this variable is set to `true`, Git
 896        automatically copies your notes from the original to the
 897        rewritten commit.  Defaults to `true`, but see
 898        "notes.rewriteRef" below.
 899
 900notes.rewriteMode::
 901        When copying notes during a rewrite (see the
 902        "notes.rewrite.<command>" option), determines what to do if
 903        the target commit already has a note.  Must be one of
 904        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
 905        Defaults to `concatenate`.
 906+
 907This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
 908environment variable.
 909
 910notes.rewriteRef::
 911        When copying notes during a rewrite, specifies the (fully
 912        qualified) ref whose notes should be copied.  The ref may be a
 913        glob, in which case notes in all matching refs will be copied.
 914        You may also specify this configuration several times.
 915+
 916Does not have a default value; you must configure this variable to
 917enable note rewriting.  Set it to `refs/notes/commits` to enable
 918rewriting for the default commit notes.
 919+
 920This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
 921environment variable, which must be a colon separated list of refs or
 922globs.
 923
 924pack.window::
 925        The size of the window used by linkgit:git-pack-objects[1] when no
 926        window size is given on the command line. Defaults to 10.
 927
 928pack.depth::
 929        The maximum delta depth used by linkgit:git-pack-objects[1] when no
 930        maximum depth is given on the command line. Defaults to 50.
 931        Maximum value is 4095.
 932
 933pack.windowMemory::
 934        The maximum size of memory that is consumed by each thread
 935        in linkgit:git-pack-objects[1] for pack window memory when
 936        no limit is given on the command line.  The value can be
 937        suffixed with "k", "m", or "g".  When left unconfigured (or
 938        set explicitly to 0), there will be no limit.
 939
 940pack.compression::
 941        An integer -1..9, indicating the compression level for objects
 942        in a pack file. -1 is the zlib default. 0 means no
 943        compression, and 1..9 are various speed/size tradeoffs, 9 being
 944        slowest.  If not set,  defaults to core.compression.  If that is
 945        not set,  defaults to -1, the zlib default, which is "a default
 946        compromise between speed and compression (currently equivalent
 947        to level 6)."
 948+
 949Note that changing the compression level will not automatically recompress
 950all existing objects. You can force recompression by passing the -F option
 951to linkgit:git-repack[1].
 952
 953pack.island::
 954        An extended regular expression configuring a set of delta
 955        islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
 956        for details.
 957
 958pack.islandCore::
 959        Specify an island name which gets to have its objects be
 960        packed first. This creates a kind of pseudo-pack at the front
 961        of one pack, so that the objects from the specified island are
 962        hopefully faster to copy into any pack that should be served
 963        to a user requesting these objects. In practice this means
 964        that the island specified should likely correspond to what is
 965        the most commonly cloned in the repo. See also "DELTA ISLANDS"
 966        in linkgit:git-pack-objects[1].
 967
 968pack.deltaCacheSize::
 969        The maximum memory in bytes used for caching deltas in
 970        linkgit:git-pack-objects[1] before writing them out to a pack.
 971        This cache is used to speed up the writing object phase by not
 972        having to recompute the final delta result once the best match
 973        for all objects is found.  Repacking large repositories on machines
 974        which are tight with memory might be badly impacted by this though,
 975        especially if this cache pushes the system into swapping.
 976        A value of 0 means no limit. The smallest size of 1 byte may be
 977        used to virtually disable this cache. Defaults to 256 MiB.
 978
 979pack.deltaCacheLimit::
 980        The maximum size of a delta, that is cached in
 981        linkgit:git-pack-objects[1]. This cache is used to speed up the
 982        writing object phase by not having to recompute the final delta
 983        result once the best match for all objects is found.
 984        Defaults to 1000. Maximum value is 65535.
 985
 986pack.threads::
 987        Specifies the number of threads to spawn when searching for best
 988        delta matches.  This requires that linkgit:git-pack-objects[1]
 989        be compiled with pthreads otherwise this option is ignored with a
 990        warning. This is meant to reduce packing time on multiprocessor
 991        machines. The required amount of memory for the delta search window
 992        is however multiplied by the number of threads.
 993        Specifying 0 will cause Git to auto-detect the number of CPU's
 994        and set the number of threads accordingly.
 995
 996pack.indexVersion::
 997        Specify the default pack index version.  Valid values are 1 for
 998        legacy pack index used by Git versions prior to 1.5.2, and 2 for
 999        the new pack index with capabilities for packs larger than 4 GB
1000        as well as proper protection against the repacking of corrupted
1001        packs.  Version 2 is the default.  Note that version 2 is enforced
1002        and this config option ignored whenever the corresponding pack is
1003        larger than 2 GB.
1004+
1005If you have an old Git that does not understand the version 2 `*.idx` file,
1006cloning or fetching over a non native protocol (e.g. "http")
1007that will copy both `*.pack` file and corresponding `*.idx` file from the
1008other side may give you a repository that cannot be accessed with your
1009older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1010you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1011the `*.idx` file.
1012
1013pack.packSizeLimit::
1014        The maximum size of a pack.  This setting only affects
1015        packing to a file when repacking, i.e. the git:// protocol
1016        is unaffected.  It can be overridden by the `--max-pack-size`
1017        option of linkgit:git-repack[1].  Reaching this limit results
1018        in the creation of multiple packfiles; which in turn prevents
1019        bitmaps from being created.
1020        The minimum size allowed is limited to 1 MiB.
1021        The default is unlimited.
1022        Common unit suffixes of 'k', 'm', or 'g' are
1023        supported.
1024
1025pack.useBitmaps::
1026        When true, git will use pack bitmaps (if available) when packing
1027        to stdout (e.g., during the server side of a fetch). Defaults to
1028        true. You should not generally need to turn this off unless
1029        you are debugging pack bitmaps.
1030
1031pack.writeBitmaps (deprecated)::
1032        This is a deprecated synonym for `repack.writeBitmaps`.
1033
1034pack.writeBitmapHashCache::
1035        When true, git will include a "hash cache" section in the bitmap
1036        index (if one is written). This cache can be used to feed git's
1037        delta heuristics, potentially leading to better deltas between
1038        bitmapped and non-bitmapped objects (e.g., when serving a fetch
1039        between an older, bitmapped pack and objects that have been
1040        pushed since the last gc). The downside is that it consumes 4
1041        bytes per object of disk space, and that JGit's bitmap
1042        implementation does not understand it, causing it to complain if
1043        Git and JGit are used on the same repository. Defaults to false.
1044
1045pager.<cmd>::
1046        If the value is boolean, turns on or off pagination of the
1047        output of a particular Git subcommand when writing to a tty.
1048        Otherwise, turns on pagination for the subcommand using the
1049        pager specified by the value of `pager.<cmd>`.  If `--paginate`
1050        or `--no-pager` is specified on the command line, it takes
1051        precedence over this option.  To disable pagination for all
1052        commands, set `core.pager` or `GIT_PAGER` to `cat`.
1053
1054pretty.<name>::
1055        Alias for a --pretty= format string, as specified in
1056        linkgit:git-log[1]. Any aliases defined here can be used just
1057        as the built-in pretty formats could. For example,
1058        running `git config pretty.changelog "format:* %H %s"`
1059        would cause the invocation `git log --pretty=changelog`
1060        to be equivalent to running `git log "--pretty=format:* %H %s"`.
1061        Note that an alias with the same name as a built-in format
1062        will be silently ignored.
1063
1064protocol.allow::
1065        If set, provide a user defined default policy for all protocols which
1066        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
1067        if unset, known-safe protocols (http, https, git, ssh, file) have a
1068        default policy of `always`, known-dangerous protocols (ext) have a
1069        default policy of `never`, and all other protocols have a default
1070        policy of `user`.  Supported policies:
1071+
1072--
1073
1074* `always` - protocol is always able to be used.
1075
1076* `never` - protocol is never able to be used.
1077
1078* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
1079  either unset or has a value of 1.  This policy should be used when you want a
1080  protocol to be directly usable by the user but don't want it used by commands which
1081  execute clone/fetch/push commands without user input, e.g. recursive
1082  submodule initialization.
1083
1084--
1085
1086protocol.<name>.allow::
1087        Set a policy to be used by protocol `<name>` with clone/fetch/push
1088        commands. See `protocol.allow` above for the available policies.
1089+
1090The protocol names currently used by git are:
1091+
1092--
1093  - `file`: any local file-based path (including `file://` URLs,
1094    or local paths)
1095
1096  - `git`: the anonymous git protocol over a direct TCP
1097    connection (or proxy, if configured)
1098
1099  - `ssh`: git over ssh (including `host:path` syntax,
1100    `ssh://`, etc).
1101
1102  - `http`: git over http, both "smart http" and "dumb http".
1103    Note that this does _not_ include `https`; if you want to configure
1104    both, you must do so individually.
1105
1106  - any external helpers are named by their protocol (e.g., use
1107    `hg` to allow the `git-remote-hg` helper)
1108--
1109
1110protocol.version::
1111        Experimental. If set, clients will attempt to communicate with a
1112        server using the specified protocol version.  If unset, no
1113        attempt will be made by the client to communicate using a
1114        particular protocol version, this results in protocol version 0
1115        being used.
1116        Supported versions:
1117+
1118--
1119
1120* `0` - the original wire protocol.
1121
1122* `1` - the original wire protocol with the addition of a version string
1123  in the initial response from the server.
1124
1125* `2` - link:technical/protocol-v2.html[wire protocol version 2].
1126
1127--
1128
1129include::pull-config.txt[]
1130
1131include::push-config.txt[]
1132
1133include::rebase-config.txt[]
1134
1135include::receive-config.txt[]
1136
1137remote.pushDefault::
1138        The remote to push to by default.  Overrides
1139        `branch.<name>.remote` for all branches, and is overridden by
1140        `branch.<name>.pushRemote` for specific branches.
1141
1142remote.<name>.url::
1143        The URL of a remote repository.  See linkgit:git-fetch[1] or
1144        linkgit:git-push[1].
1145
1146remote.<name>.pushurl::
1147        The push URL of a remote repository.  See linkgit:git-push[1].
1148
1149remote.<name>.proxy::
1150        For remotes that require curl (http, https and ftp), the URL to
1151        the proxy to use for that remote.  Set to the empty string to
1152        disable proxying for that remote.
1153
1154remote.<name>.proxyAuthMethod::
1155        For remotes that require curl (http, https and ftp), the method to use for
1156        authenticating against the proxy in use (probably set in
1157        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
1158
1159remote.<name>.fetch::
1160        The default set of "refspec" for linkgit:git-fetch[1]. See
1161        linkgit:git-fetch[1].
1162
1163remote.<name>.push::
1164        The default set of "refspec" for linkgit:git-push[1]. See
1165        linkgit:git-push[1].
1166
1167remote.<name>.mirror::
1168        If true, pushing to this remote will automatically behave
1169        as if the `--mirror` option was given on the command line.
1170
1171remote.<name>.skipDefaultUpdate::
1172        If true, this remote will be skipped by default when updating
1173        using linkgit:git-fetch[1] or the `update` subcommand of
1174        linkgit:git-remote[1].
1175
1176remote.<name>.skipFetchAll::
1177        If true, this remote will be skipped by default when updating
1178        using linkgit:git-fetch[1] or the `update` subcommand of
1179        linkgit:git-remote[1].
1180
1181remote.<name>.receivepack::
1182        The default program to execute on the remote side when pushing.  See
1183        option --receive-pack of linkgit:git-push[1].
1184
1185remote.<name>.uploadpack::
1186        The default program to execute on the remote side when fetching.  See
1187        option --upload-pack of linkgit:git-fetch-pack[1].
1188
1189remote.<name>.tagOpt::
1190        Setting this value to --no-tags disables automatic tag following when
1191        fetching from remote <name>. Setting it to --tags will fetch every
1192        tag from remote <name>, even if they are not reachable from remote
1193        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1194        override this setting. See options --tags and --no-tags of
1195        linkgit:git-fetch[1].
1196
1197remote.<name>.vcs::
1198        Setting this to a value <vcs> will cause Git to interact with
1199        the remote with the git-remote-<vcs> helper.
1200
1201remote.<name>.prune::
1202        When set to true, fetching from this remote by default will also
1203        remove any remote-tracking references that no longer exist on the
1204        remote (as if the `--prune` option was given on the command line).
1205        Overrides `fetch.prune` settings, if any.
1206
1207remote.<name>.pruneTags::
1208        When set to true, fetching from this remote by default will also
1209        remove any local tags that no longer exist on the remote if pruning
1210        is activated in general via `remote.<name>.prune`, `fetch.prune` or
1211        `--prune`. Overrides `fetch.pruneTags` settings, if any.
1212+
1213See also `remote.<name>.prune` and the PRUNING section of
1214linkgit:git-fetch[1].
1215
1216remotes.<group>::
1217        The list of remotes which are fetched by "git remote update
1218        <group>".  See linkgit:git-remote[1].
1219
1220repack.useDeltaBaseOffset::
1221        By default, linkgit:git-repack[1] creates packs that use
1222        delta-base offset. If you need to share your repository with
1223        Git older than version 1.4.4, either directly or via a dumb
1224        protocol such as http, then you need to set this option to
1225        "false" and repack. Access from old Git versions over the
1226        native protocol are unaffected by this option.
1227
1228repack.packKeptObjects::
1229        If set to true, makes `git repack` act as if
1230        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
1231        details. Defaults to `false` normally, but `true` if a bitmap
1232        index is being written (either via `--write-bitmap-index` or
1233        `repack.writeBitmaps`).
1234
1235repack.useDeltaIslands::
1236        If set to true, makes `git repack` act as if `--delta-islands`
1237        was passed. Defaults to `false`.
1238
1239repack.writeBitmaps::
1240        When true, git will write a bitmap index when packing all
1241        objects to disk (e.g., when `git repack -a` is run).  This
1242        index can speed up the "counting objects" phase of subsequent
1243        packs created for clones and fetches, at the cost of some disk
1244        space and extra time spent on the initial repack.  This has
1245        no effect if multiple packfiles are created.
1246        Defaults to false.
1247
1248rerere.autoUpdate::
1249        When set to true, `git-rerere` updates the index with the
1250        resulting contents after it cleanly resolves conflicts using
1251        previously recorded resolution.  Defaults to false.
1252
1253rerere.enabled::
1254        Activate recording of resolved conflicts, so that identical
1255        conflict hunks can be resolved automatically, should they be
1256        encountered again.  By default, linkgit:git-rerere[1] is
1257        enabled if there is an `rr-cache` directory under the
1258        `$GIT_DIR`, e.g. if "rerere" was previously used in the
1259        repository.
1260
1261reset.quiet::
1262        When set to true, 'git reset' will default to the '--quiet' option.
1263
1264include::sendemail-config.txt[]
1265
1266sequence.editor::
1267        Text editor used by `git rebase -i` for editing the rebase instruction file.
1268        The value is meant to be interpreted by the shell when it is used.
1269        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
1270        When not configured the default commit message editor is used instead.
1271
1272showBranch.default::
1273        The default set of branches for linkgit:git-show-branch[1].
1274        See linkgit:git-show-branch[1].
1275
1276splitIndex.maxPercentChange::
1277        When the split index feature is used, this specifies the
1278        percent of entries the split index can contain compared to the
1279        total number of entries in both the split index and the shared
1280        index before a new shared index is written.
1281        The value should be between 0 and 100. If the value is 0 then
1282        a new shared index is always written, if it is 100 a new
1283        shared index is never written.
1284        By default the value is 20, so a new shared index is written
1285        if the number of entries in the split index would be greater
1286        than 20 percent of the total number of entries.
1287        See linkgit:git-update-index[1].
1288
1289splitIndex.sharedIndexExpire::
1290        When the split index feature is used, shared index files that
1291        were not modified since the time this variable specifies will
1292        be removed when a new shared index file is created. The value
1293        "now" expires all entries immediately, and "never" suppresses
1294        expiration altogether.
1295        The default value is "2.weeks.ago".
1296        Note that a shared index file is considered modified (for the
1297        purpose of expiration) each time a new split-index file is
1298        either created based on it or read from it.
1299        See linkgit:git-update-index[1].
1300
1301status.relativePaths::
1302        By default, linkgit:git-status[1] shows paths relative to the
1303        current directory. Setting this variable to `false` shows paths
1304        relative to the repository root (this was the default for Git
1305        prior to v1.5.4).
1306
1307status.short::
1308        Set to true to enable --short by default in linkgit:git-status[1].
1309        The option --no-short takes precedence over this variable.
1310
1311status.branch::
1312        Set to true to enable --branch by default in linkgit:git-status[1].
1313        The option --no-branch takes precedence over this variable.
1314
1315status.displayCommentPrefix::
1316        If set to true, linkgit:git-status[1] will insert a comment
1317        prefix before each output line (starting with
1318        `core.commentChar`, i.e. `#` by default). This was the
1319        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
1320        Defaults to false.
1321
1322status.renameLimit::
1323        The number of files to consider when performing rename detection
1324        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
1325        the value of diff.renameLimit.
1326
1327status.renames::
1328        Whether and how Git detects renames in linkgit:git-status[1] and
1329        linkgit:git-commit[1] .  If set to "false", rename detection is
1330        disabled. If set to "true", basic rename detection is enabled.
1331        If set to "copies" or "copy", Git will detect copies, as well.
1332        Defaults to the value of diff.renames.
1333
1334status.showStash::
1335        If set to true, linkgit:git-status[1] will display the number of
1336        entries currently stashed away.
1337        Defaults to false.
1338
1339status.showUntrackedFiles::
1340        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1341        files which are not currently tracked by Git. Directories which
1342        contain only untracked files, are shown with the directory name
1343        only. Showing untracked files means that Git needs to lstat() all
1344        the files in the whole repository, which might be slow on some
1345        systems. So, this variable controls how the commands displays
1346        the untracked files. Possible values are:
1347+
1348--
1349* `no` - Show no untracked files.
1350* `normal` - Show untracked files and directories.
1351* `all` - Show also individual files in untracked directories.
1352--
1353+
1354If this variable is not specified, it defaults to 'normal'.
1355This variable can be overridden with the -u|--untracked-files option
1356of linkgit:git-status[1] and linkgit:git-commit[1].
1357
1358status.submoduleSummary::
1359        Defaults to false.
1360        If this is set to a non zero number or true (identical to -1 or an
1361        unlimited number), the submodule summary will be enabled and a
1362        summary of commits for modified submodules will be shown (see
1363        --summary-limit option of linkgit:git-submodule[1]). Please note
1364        that the summary output command will be suppressed for all
1365        submodules when `diff.ignoreSubmodules` is set to 'all' or only
1366        for those submodules where `submodule.<name>.ignore=all`. The only
1367        exception to that rule is that status and commit will show staged
1368        submodule changes. To
1369        also view the summary for ignored submodules you can either use
1370        the --ignore-submodules=dirty command-line option or the 'git
1371        submodule summary' command, which shows a similar output but does
1372        not honor these settings.
1373
1374stash.showPatch::
1375        If this is set to true, the `git stash show` command without an
1376        option will show the stash entry in patch form.  Defaults to false.
1377        See description of 'show' command in linkgit:git-stash[1].
1378
1379stash.showStat::
1380        If this is set to true, the `git stash show` command without an
1381        option will show diffstat of the stash entry.  Defaults to true.
1382        See description of 'show' command in linkgit:git-stash[1].
1383
1384include::submodule-config.txt[]
1385
1386tag.forceSignAnnotated::
1387        A boolean to specify whether annotated tags created should be GPG signed.
1388        If `--annotate` is specified on the command line, it takes
1389        precedence over this option.
1390
1391tag.sort::
1392        This variable controls the sort ordering of tags when displayed by
1393        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
1394        value of this variable will be used as the default.
1395
1396tar.umask::
1397        This variable can be used to restrict the permission bits of
1398        tar archive entries.  The default is 0002, which turns off the
1399        world write bit.  The special value "user" indicates that the
1400        archiving user's umask will be used instead.  See umask(2) and
1401        linkgit:git-archive[1].
1402
1403transfer.fsckObjects::
1404        When `fetch.fsckObjects` or `receive.fsckObjects` are
1405        not set, the value of this variable is used instead.
1406        Defaults to false.
1407+
1408When set, the fetch or receive will abort in the case of a malformed
1409object or a link to a nonexistent object. In addition, various other
1410issues are checked for, including legacy issues (see `fsck.<msg-id>`),
1411and potential security issues like the existence of a `.GIT` directory
1412or a malicious `.gitmodules` file (see the release notes for v2.2.1
1413and v2.17.1 for details). Other sanity and security checks may be
1414added in future releases.
1415+
1416On the receiving side, failing fsckObjects will make those objects
1417unreachable, see "QUARANTINE ENVIRONMENT" in
1418linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
1419instead be left unreferenced in the repository.
1420+
1421Due to the non-quarantine nature of the `fetch.fsckObjects`
1422implementation it can not be relied upon to leave the object store
1423clean like `receive.fsckObjects` can.
1424+
1425As objects are unpacked they're written to the object store, so there
1426can be cases where malicious objects get introduced even though the
1427"fetch" failed, only to have a subsequent "fetch" succeed because only
1428new incoming objects are checked, not those that have already been
1429written to the object store. That difference in behavior should not be
1430relied upon. In the future, such objects may be quarantined for
1431"fetch" as well.
1432+
1433For now, the paranoid need to find some way to emulate the quarantine
1434environment if they'd like the same protection as "push". E.g. in the
1435case of an internal mirror do the mirroring in two steps, one to fetch
1436the untrusted objects, and then do a second "push" (which will use the
1437quarantine) to another internal repo, and have internal clients
1438consume this pushed-to repository, or embargo internal fetches and
1439only allow them once a full "fsck" has run (and no new fetches have
1440happened in the meantime).
1441
1442transfer.hideRefs::
1443        String(s) `receive-pack` and `upload-pack` use to decide which
1444        refs to omit from their initial advertisements.  Use more than
1445        one definition to specify multiple prefix strings. A ref that is
1446        under the hierarchies listed in the value of this variable is
1447        excluded, and is hidden when responding to `git push` or `git
1448        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
1449        program-specific versions of this config.
1450+
1451You may also include a `!` in front of the ref name to negate the entry,
1452explicitly exposing it, even if an earlier entry marked it as hidden.
1453If you have multiple hideRefs values, later entries override earlier ones
1454(and entries in more-specific config files override less-specific ones).
1455+
1456If a namespace is in use, the namespace prefix is stripped from each
1457reference before it is matched against `transfer.hiderefs` patterns.
1458For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
1459the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
1460is omitted from the advertisements but `refs/heads/master` and
1461`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
1462"have" lines. In order to match refs before stripping, add a `^` in front of
1463the ref name. If you combine `!` and `^`, `!` must be specified first.
1464+
1465Even if you hide refs, a client may still be able to steal the target
1466objects via the techniques described in the "SECURITY" section of the
1467linkgit:gitnamespaces[7] man page; it's best to keep private data in a
1468separate repository.
1469
1470transfer.unpackLimit::
1471        When `fetch.unpackLimit` or `receive.unpackLimit` are
1472        not set, the value of this variable is used instead.
1473        The default value is 100.
1474
1475uploadarchive.allowUnreachable::
1476        If true, allow clients to use `git archive --remote` to request
1477        any tree, whether reachable from the ref tips or not. See the
1478        discussion in the "SECURITY" section of
1479        linkgit:git-upload-archive[1] for more details. Defaults to
1480        `false`.
1481
1482uploadpack.hideRefs::
1483        This variable is the same as `transfer.hideRefs`, but applies
1484        only to `upload-pack` (and so affects only fetches, not pushes).
1485        An attempt to fetch a hidden ref by `git fetch` will fail.  See
1486        also `uploadpack.allowTipSHA1InWant`.
1487
1488uploadpack.allowTipSHA1InWant::
1489        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
1490        to accept a fetch request that asks for an object at the tip
1491        of a hidden ref (by default, such a request is rejected).
1492        See also `uploadpack.hideRefs`.  Even if this is false, a client
1493        may be able to steal objects via the techniques described in the
1494        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
1495        best to keep private data in a separate repository.
1496
1497uploadpack.allowReachableSHA1InWant::
1498        Allow `upload-pack` to accept a fetch request that asks for an
1499        object that is reachable from any ref tip. However, note that
1500        calculating object reachability is computationally expensive.
1501        Defaults to `false`.  Even if this is false, a client may be able
1502        to steal objects via the techniques described in the "SECURITY"
1503        section of the linkgit:gitnamespaces[7] man page; it's best to
1504        keep private data in a separate repository.
1505
1506uploadpack.allowAnySHA1InWant::
1507        Allow `upload-pack` to accept a fetch request that asks for any
1508        object at all.
1509        Defaults to `false`.
1510
1511uploadpack.keepAlive::
1512        When `upload-pack` has started `pack-objects`, there may be a
1513        quiet period while `pack-objects` prepares the pack. Normally
1514        it would output progress information, but if `--quiet` was used
1515        for the fetch, `pack-objects` will output nothing at all until
1516        the pack data begins. Some clients and networks may consider
1517        the server to be hung and give up. Setting this option instructs
1518        `upload-pack` to send an empty keepalive packet every
1519        `uploadpack.keepAlive` seconds. Setting this option to 0
1520        disables keepalive packets entirely. The default is 5 seconds.
1521
1522uploadpack.packObjectsHook::
1523        If this option is set, when `upload-pack` would run
1524        `git pack-objects` to create a packfile for a client, it will
1525        run this shell command instead.  The `pack-objects` command and
1526        arguments it _would_ have run (including the `git pack-objects`
1527        at the beginning) are appended to the shell command. The stdin
1528        and stdout of the hook are treated as if `pack-objects` itself
1529        was run. I.e., `upload-pack` will feed input intended for
1530        `pack-objects` to the hook, and expects a completed packfile on
1531        stdout.
1532+
1533Note that this configuration variable is ignored if it is seen in the
1534repository-level config (this is a safety measure against fetching from
1535untrusted repositories).
1536
1537uploadpack.allowFilter::
1538        If this option is set, `upload-pack` will support partial
1539        clone and partial fetch object filtering.
1540
1541uploadpack.allowRefInWant::
1542        If this option is set, `upload-pack` will support the `ref-in-want`
1543        feature of the protocol version 2 `fetch` command.  This feature
1544        is intended for the benefit of load-balanced servers which may
1545        not have the same view of what OIDs their refs point to due to
1546        replication delay.
1547
1548url.<base>.insteadOf::
1549        Any URL that starts with this value will be rewritten to
1550        start, instead, with <base>. In cases where some site serves a
1551        large number of repositories, and serves them with multiple
1552        access methods, and some users need to use different access
1553        methods, this feature allows people to specify any of the
1554        equivalent URLs and have Git automatically rewrite the URL to
1555        the best alternative for the particular user, even for a
1556        never-before-seen repository on the site.  When more than one
1557        insteadOf strings match a given URL, the longest match is used.
1558+
1559Note that any protocol restrictions will be applied to the rewritten
1560URL. If the rewrite changes the URL to use a custom protocol or remote
1561helper, you may need to adjust the `protocol.*.allow` config to permit
1562the request.  In particular, protocols you expect to use for submodules
1563must be set to `always` rather than the default of `user`. See the
1564description of `protocol.allow` above.
1565
1566url.<base>.pushInsteadOf::
1567        Any URL that starts with this value will not be pushed to;
1568        instead, it will be rewritten to start with <base>, and the
1569        resulting URL will be pushed to. In cases where some site serves
1570        a large number of repositories, and serves them with multiple
1571        access methods, some of which do not allow push, this feature
1572        allows people to specify a pull-only URL and have Git
1573        automatically use an appropriate URL to push, even for a
1574        never-before-seen repository on the site.  When more than one
1575        pushInsteadOf strings match a given URL, the longest match is
1576        used.  If a remote has an explicit pushurl, Git will ignore this
1577        setting for that remote.
1578
1579user.email::
1580        Your email address to be recorded in any newly created commits.
1581        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
1582        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
1583
1584user.name::
1585        Your full name to be recorded in any newly created commits.
1586        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
1587        environment variables.  See linkgit:git-commit-tree[1].
1588
1589user.useConfigOnly::
1590        Instruct Git to avoid trying to guess defaults for `user.email`
1591        and `user.name`, and instead retrieve the values only from the
1592        configuration. For example, if you have multiple email addresses
1593        and would like to use a different one for each repository, then
1594        with this configuration option set to `true` in the global config
1595        along with a name, Git will prompt you to set up an email before
1596        making new commits in a newly cloned repository.
1597        Defaults to `false`.
1598
1599user.signingKey::
1600        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
1601        key you want it to automatically when creating a signed tag or
1602        commit, you can override the default selection with this variable.
1603        This option is passed unchanged to gpg's --local-user parameter,
1604        so you may specify a key using any method that gpg supports.
1605
1606versionsort.prereleaseSuffix (deprecated)::
1607        Deprecated alias for `versionsort.suffix`.  Ignored if
1608        `versionsort.suffix` is set.
1609
1610versionsort.suffix::
1611        Even when version sort is used in linkgit:git-tag[1], tagnames
1612        with the same base version but different suffixes are still sorted
1613        lexicographically, resulting e.g. in prerelease tags appearing
1614        after the main release (e.g. "1.0-rc1" after "1.0").  This
1615        variable can be specified to determine the sorting order of tags
1616        with different suffixes.
1617+
1618By specifying a single suffix in this variable, any tagname containing
1619that suffix will appear before the corresponding main release.  E.g. if
1620the variable is set to "-rc", then all "1.0-rcX" tags will appear before
1621"1.0".  If specified multiple times, once per suffix, then the order of
1622suffixes in the configuration will determine the sorting order of tagnames
1623with those suffixes.  E.g. if "-pre" appears before "-rc" in the
1624configuration, then all "1.0-preX" tags will be listed before any
1625"1.0-rcX" tags.  The placement of the main release tag relative to tags
1626with various suffixes can be determined by specifying the empty suffix
1627among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
1628"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
1629are listed first, followed by "v4.8", then "v4.8-ckX" and finally
1630"v4.8-bfsX".
1631+
1632If more than one suffixes match the same tagname, then that tagname will
1633be sorted according to the suffix which starts at the earliest position in
1634the tagname.  If more than one different matching suffixes start at
1635that earliest position, then that tagname will be sorted according to the
1636longest of those suffixes.
1637The sorting order between different suffixes is undefined if they are
1638in multiple config files.
1639
1640web.browser::
1641        Specify a web browser that may be used by some commands.
1642        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1643        may use it.
1644
1645worktree.guessRemote::
1646        With `add`, if no branch argument, and neither of `-b` nor
1647        `-B` nor `--detach` are given, the command defaults to
1648        creating a new branch from HEAD.  If `worktree.guessRemote` is
1649        set to true, `worktree add` tries to find a remote-tracking
1650        branch whose name uniquely matches the new branch name.  If
1651        such a branch exists, it is checked out and set as "upstream"
1652        for the new branch.  If no such match can be found, it falls
1653        back to creating a new branch from the current HEAD.