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