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