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