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