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