Documentation / config.txton commit config.txt: move pager.* to a separate file (87e1b41)
   1CONFIGURATION FILE
   2------------------
   3
   4The Git configuration file contains a number of variables that affect
   5the Git commands' behavior. The `.git/config` file in each repository
   6is used to store the configuration for that repository, and
   7`$HOME/.gitconfig` is used to store a per-user configuration as
   8fallback values for the `.git/config` file. The file `/etc/gitconfig`
   9can be used to store a system-wide default configuration.
  10
  11The configuration variables are used by both the Git plumbing
  12and the porcelains. The variables are divided into sections, wherein
  13the fully qualified variable name of the variable itself is the last
  14dot-separated segment and the section name is everything before the last
  15dot. The variable names are case-insensitive, allow only alphanumeric
  16characters and `-`, and must start with an alphabetic character.  Some
  17variables may appear multiple times; we say then that the variable is
  18multivalued.
  19
  20Syntax
  21~~~~~~
  22
  23The syntax is fairly flexible and permissive; whitespaces are mostly
  24ignored.  The '#' and ';' characters begin comments to the end of line,
  25blank lines are ignored.
  26
  27The file consists of sections and variables.  A section begins with
  28the name of the section in square brackets and continues until the next
  29section begins.  Section names are case-insensitive.  Only alphanumeric
  30characters, `-` and `.` are allowed in section names.  Each variable
  31must belong to some section, which means that there must be a section
  32header before the first setting of a variable.
  33
  34Sections can be further divided into subsections.  To begin a subsection
  35put its name in double quotes, separated by space from the section name,
  36in the section header, like in the example below:
  37
  38--------
  39        [section "subsection"]
  40
  41--------
  42
  43Subsection names are case sensitive and can contain any characters except
  44newline and the null byte. Doublequote `"` and backslash can be included
  45by escaping them as `\"` and `\\`, respectively. Backslashes preceding
  46other characters are dropped when reading; for example, `\t` is read as
  47`t` and `\0` is read as `0` Section headers cannot span multiple lines.
  48Variables may belong directly to a section or to a given subsection. You
  49can have `[section]` if you have `[section "subsection"]`, but you don't
  50need to.
  51
  52There is also a deprecated `[section.subsection]` syntax. With this
  53syntax, the subsection name is converted to lower-case and is also
  54compared case sensitively. These subsection names follow the same
  55restrictions as section names.
  56
  57All the other lines (and the remainder of the line after the section
  58header) are recognized as setting variables, in the form
  59'name = value' (or just 'name', which is a short-hand to say that
  60the variable is the boolean "true").
  61The variable names are case-insensitive, allow only alphanumeric characters
  62and `-`, and must start with an alphabetic character.
  63
  64A line that defines a value can be continued to the next line by
  65ending it with a `\`; the backquote and the end-of-line are
  66stripped.  Leading whitespaces after 'name =', the remainder of the
  67line after the first comment character '#' or ';', and trailing
  68whitespaces of the line are discarded unless they are enclosed in
  69double quotes.  Internal whitespaces within the value are retained
  70verbatim.
  71
  72Inside double quotes, double quote `"` and backslash `\` characters
  73must be escaped: use `\"` for `"` and `\\` for `\`.
  74
  75The following escape sequences (beside `\"` and `\\`) are recognized:
  76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  77and `\b` for backspace (BS).  Other char escape sequences (including octal
  78escape sequences) are invalid.
  79
  80
  81Includes
  82~~~~~~~~
  83
  84The `include` and `includeIf` sections allow you to include config
  85directives from another source. These sections behave identically to
  86each other with the exception that `includeIf` sections may be ignored
  87if their condition does not evaluate to true; see "Conditional includes"
  88below.
  89
  90You can include a config file from another by setting the special
  91`include.path` (or `includeIf.*.path`) variable to the name of the file
  92to be included. The variable takes a pathname as its value, and is
  93subject to tilde expansion. These variables can be given multiple times.
  94
  95The contents of the included file are inserted immediately, as if they
  96had been found at the location of the include directive. If the value of the
  97variable is a relative path, the path is considered to
  98be relative to the configuration file in which the include directive
  99was found.  See below for examples.
 100
 101Conditional includes
 102~~~~~~~~~~~~~~~~~~~~
 103
 104You can include a config file from another conditionally by setting a
 105`includeIf.<condition>.path` variable to the name of the file to be
 106included.
 107
 108The condition starts with a keyword followed by a colon and some data
 109whose format and meaning depends on the keyword. Supported keywords
 110are:
 111
 112`gitdir`::
 113
 114        The data that follows the keyword `gitdir:` is used as a glob
 115        pattern. If the location of the .git directory matches the
 116        pattern, the include condition is met.
 117+
 118The .git location may be auto-discovered, or come from `$GIT_DIR`
 119environment variable. If the repository is auto discovered via a .git
 120file (e.g. from submodules, or a linked worktree), the .git location
 121would be the final location where the .git directory is, not where the
 122.git file is.
 123+
 124The pattern can contain standard globbing wildcards and two additional
 125ones, `**/` and `/**`, that can match multiple path components. Please
 126refer to linkgit:gitignore[5] for details. For convenience:
 127
 128 * If the pattern starts with `~/`, `~` will be substituted with the
 129   content of the environment variable `HOME`.
 130
 131 * If the pattern starts with `./`, it is replaced with the directory
 132   containing the current config file.
 133
 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
 135   will be automatically prepended. For example, the pattern `foo/bar`
 136   becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
 137
 138 * If the pattern ends with `/`, `**` will be automatically added. For
 139   example, the pattern `foo/` becomes `foo/**`. In other words, it
 140   matches "foo" and everything inside, recursively.
 141
 142`gitdir/i`::
 143        This is the same as `gitdir` except that matching is done
 144        case-insensitively (e.g. on case-insensitive file sytems)
 145
 146A few more notes on matching via `gitdir` and `gitdir/i`:
 147
 148 * Symlinks in `$GIT_DIR` are not resolved before matching.
 149
 150 * Both the symlink & realpath versions of paths will be matched
 151   outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
 152   /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
 153   will match.
 154+
 155This was not the case in the initial release of this feature in
 156v2.13.0, which only matched the realpath version. Configuration that
 157wants to be compatible with the initial release of this feature needs
 158to either specify only the realpath version, or both versions.
 159
 160 * Note that "../" is not special and will match literally, which is
 161   unlikely what you want.
 162
 163Example
 164~~~~~~~
 165
 166        # Core variables
 167        [core]
 168                ; Don't trust file modes
 169                filemode = false
 170
 171        # Our diff algorithm
 172        [diff]
 173                external = /usr/local/bin/diff-wrapper
 174                renames = true
 175
 176        [branch "devel"]
 177                remote = origin
 178                merge = refs/heads/devel
 179
 180        # Proxy settings
 181        [core]
 182                gitProxy="ssh" for "kernel.org"
 183                gitProxy=default-proxy ; for the rest
 184
 185        [include]
 186                path = /path/to/foo.inc ; include by absolute path
 187                path = foo.inc ; find "foo.inc" relative to the current file
 188                path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
 189
 190        ; include if $GIT_DIR is /path/to/foo/.git
 191        [includeIf "gitdir:/path/to/foo/.git"]
 192                path = /path/to/foo.inc
 193
 194        ; include for all repositories inside /path/to/group
 195        [includeIf "gitdir:/path/to/group/"]
 196                path = /path/to/foo.inc
 197
 198        ; include for all repositories inside $HOME/to/group
 199        [includeIf "gitdir:~/to/group/"]
 200                path = /path/to/foo.inc
 201
 202        ; relative paths are always relative to the including
 203        ; file (if the condition is true); their location is not
 204        ; affected by the condition
 205        [includeIf "gitdir:/path/to/group/"]
 206                path = foo.inc
 207
 208Values
 209~~~~~~
 210
 211Values of many variables are treated as a simple string, but there
 212are variables that take values of specific types and there are rules
 213as to how to spell them.
 214
 215boolean::
 216
 217       When a variable is said to take a boolean value, many
 218       synonyms are accepted for 'true' and 'false'; these are all
 219       case-insensitive.
 220
 221        true;; Boolean true literals are `yes`, `on`, `true`,
 222                and `1`.  Also, a variable defined without `= <value>`
 223                is taken as true.
 224
 225        false;; Boolean false literals are `no`, `off`, `false`,
 226                `0` and the empty string.
 227+
 228When converting a value to its canonical form using the `--type=bool` type
 229specifier, 'git config' will ensure that the output is "true" or
 230"false" (spelled in lowercase).
 231
 232integer::
 233       The value for many variables that specify various sizes can
 234       be suffixed with `k`, `M`,... to mean "scale the number by
 235       1024", "by 1024x1024", etc.
 236
 237color::
 238       The value for a variable that takes a color is a list of
 239       colors (at most two, one for foreground and one for background)
 240       and attributes (as many as you want), separated by spaces.
 241+
 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
 243`blue`, `magenta`, `cyan` and `white`.  The first color given is the
 244foreground; the second is the background.
 245+
 246Colors may also be given as numbers between 0 and 255; these use ANSI
 247256-color mode (but note that not all terminals may support this).  If
 248your terminal supports it, you may also specify 24-bit RGB values as
 249hex, like `#ff0ab3`.
 250+
 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
 252`italic`, and `strike` (for crossed-out or "strikethrough" letters).
 253The position of any attributes with respect to the colors
 254(before, after, or in between), doesn't matter. Specific attributes may
 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
 256`no-ul`, etc).
 257+
 258An empty color string produces no color effect at all. This can be used
 259to avoid coloring specific elements without disabling color entirely.
 260+
 261For git's pre-defined color slots, the attributes are meant to be reset
 262at the beginning of each item in the colored output. So setting
 263`color.decorate.branch` to `black` will paint that branch name in a
 264plain `black`, even if the previous thing on the same output line (e.g.
 265opening parenthesis before the list of branch names in `log --decorate`
 266output) is set to be painted with `bold` or some other attribute.
 267However, custom log formats may do more complicated and layered
 268coloring, and the negated forms may be useful there.
 269
 270pathname::
 271        A variable that takes a pathname value can be given a
 272        string that begins with "`~/`" or "`~user/`", and the usual
 273        tilde expansion happens to such a string: `~/`
 274        is expanded to the value of `$HOME`, and `~user/` to the
 275        specified user's home directory.
 276
 277
 278Variables
 279~~~~~~~~~
 280
 281Note that this list is non-comprehensive and not necessarily complete.
 282For command-specific variables, you will find a more detailed description
 283in the appropriate manual page.
 284
 285Other git-related tools may and do use their own variables.  When
 286inventing new variables for use in your own tool, make sure their
 287names do not conflict with those that are used by Git itself and
 288other popular tools, and describe them in your documentation.
 289
 290include::config/advice.txt[]
 291
 292include::config/core.txt[]
 293
 294include::config/add.txt[]
 295
 296include::config/alias.txt[]
 297
 298include::config/am.txt[]
 299
 300include::config/apply.txt[]
 301
 302include::config/blame.txt[]
 303
 304include::config/branch.txt[]
 305
 306include::config/browser.txt[]
 307
 308include::config/checkout.txt[]
 309
 310include::config/clean.txt[]
 311
 312include::config/color.txt[]
 313
 314include::config/column.txt[]
 315
 316include::config/commit.txt[]
 317
 318include::config/credential.txt[]
 319
 320include::config/completion.txt[]
 321
 322include::config/diff.txt[]
 323
 324include::config/difftool.txt[]
 325
 326include::config/fastimport.txt[]
 327
 328include::config/fetch.txt[]
 329
 330include::config/format.txt[]
 331
 332include::config/filter.txt[]
 333
 334include::config/fsck.txt[]
 335
 336include::config/gc.txt[]
 337
 338include::config/gitcvs.txt[]
 339
 340include::config/gitweb.txt[]
 341
 342include::config/grep.txt[]
 343
 344include::config/gpg.txt[]
 345
 346include::config/gui.txt[]
 347
 348include::config/guitool.txt[]
 349
 350include::config/help.txt[]
 351
 352include::config/http.txt[]
 353
 354include::config/i18n.txt[]
 355
 356include::config/imap.txt[]
 357
 358include::config/index.txt[]
 359
 360include::config/init.txt[]
 361
 362include::config/instaweb.txt[]
 363
 364include::config/interactive.txt[]
 365
 366include::config/log.txt[]
 367
 368include::config/mailinfo.txt[]
 369
 370include::config/mailmap.txt[]
 371
 372include::config/man.txt[]
 373
 374include::config/merge.txt[]
 375
 376include::config/mergetool.txt[]
 377
 378include::config/notes.txt[]
 379
 380include::config/pack.txt[]
 381
 382include::config/pager.txt[]
 383
 384pretty.<name>::
 385        Alias for a --pretty= format string, as specified in
 386        linkgit:git-log[1]. Any aliases defined here can be used just
 387        as the built-in pretty formats could. For example,
 388        running `git config pretty.changelog "format:* %H %s"`
 389        would cause the invocation `git log --pretty=changelog`
 390        to be equivalent to running `git log "--pretty=format:* %H %s"`.
 391        Note that an alias with the same name as a built-in format
 392        will be silently ignored.
 393
 394protocol.allow::
 395        If set, provide a user defined default policy for all protocols which
 396        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
 397        if unset, known-safe protocols (http, https, git, ssh, file) have a
 398        default policy of `always`, known-dangerous protocols (ext) have a
 399        default policy of `never`, and all other protocols have a default
 400        policy of `user`.  Supported policies:
 401+
 402--
 403
 404* `always` - protocol is always able to be used.
 405
 406* `never` - protocol is never able to be used.
 407
 408* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
 409  either unset or has a value of 1.  This policy should be used when you want a
 410  protocol to be directly usable by the user but don't want it used by commands which
 411  execute clone/fetch/push commands without user input, e.g. recursive
 412  submodule initialization.
 413
 414--
 415
 416protocol.<name>.allow::
 417        Set a policy to be used by protocol `<name>` with clone/fetch/push
 418        commands. See `protocol.allow` above for the available policies.
 419+
 420The protocol names currently used by git are:
 421+
 422--
 423  - `file`: any local file-based path (including `file://` URLs,
 424    or local paths)
 425
 426  - `git`: the anonymous git protocol over a direct TCP
 427    connection (or proxy, if configured)
 428
 429  - `ssh`: git over ssh (including `host:path` syntax,
 430    `ssh://`, etc).
 431
 432  - `http`: git over http, both "smart http" and "dumb http".
 433    Note that this does _not_ include `https`; if you want to configure
 434    both, you must do so individually.
 435
 436  - any external helpers are named by their protocol (e.g., use
 437    `hg` to allow the `git-remote-hg` helper)
 438--
 439
 440protocol.version::
 441        Experimental. If set, clients will attempt to communicate with a
 442        server using the specified protocol version.  If unset, no
 443        attempt will be made by the client to communicate using a
 444        particular protocol version, this results in protocol version 0
 445        being used.
 446        Supported versions:
 447+
 448--
 449
 450* `0` - the original wire protocol.
 451
 452* `1` - the original wire protocol with the addition of a version string
 453  in the initial response from the server.
 454
 455* `2` - link:technical/protocol-v2.html[wire protocol version 2].
 456
 457--
 458
 459include::pull-config.txt[]
 460
 461include::push-config.txt[]
 462
 463include::rebase-config.txt[]
 464
 465include::receive-config.txt[]
 466
 467remote.pushDefault::
 468        The remote to push to by default.  Overrides
 469        `branch.<name>.remote` for all branches, and is overridden by
 470        `branch.<name>.pushRemote` for specific branches.
 471
 472remote.<name>.url::
 473        The URL of a remote repository.  See linkgit:git-fetch[1] or
 474        linkgit:git-push[1].
 475
 476remote.<name>.pushurl::
 477        The push URL of a remote repository.  See linkgit:git-push[1].
 478
 479remote.<name>.proxy::
 480        For remotes that require curl (http, https and ftp), the URL to
 481        the proxy to use for that remote.  Set to the empty string to
 482        disable proxying for that remote.
 483
 484remote.<name>.proxyAuthMethod::
 485        For remotes that require curl (http, https and ftp), the method to use for
 486        authenticating against the proxy in use (probably set in
 487        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
 488
 489remote.<name>.fetch::
 490        The default set of "refspec" for linkgit:git-fetch[1]. See
 491        linkgit:git-fetch[1].
 492
 493remote.<name>.push::
 494        The default set of "refspec" for linkgit:git-push[1]. See
 495        linkgit:git-push[1].
 496
 497remote.<name>.mirror::
 498        If true, pushing to this remote will automatically behave
 499        as if the `--mirror` option was given on the command line.
 500
 501remote.<name>.skipDefaultUpdate::
 502        If true, this remote will be skipped by default when updating
 503        using linkgit:git-fetch[1] or the `update` subcommand of
 504        linkgit:git-remote[1].
 505
 506remote.<name>.skipFetchAll::
 507        If true, this remote will be skipped by default when updating
 508        using linkgit:git-fetch[1] or the `update` subcommand of
 509        linkgit:git-remote[1].
 510
 511remote.<name>.receivepack::
 512        The default program to execute on the remote side when pushing.  See
 513        option --receive-pack of linkgit:git-push[1].
 514
 515remote.<name>.uploadpack::
 516        The default program to execute on the remote side when fetching.  See
 517        option --upload-pack of linkgit:git-fetch-pack[1].
 518
 519remote.<name>.tagOpt::
 520        Setting this value to --no-tags disables automatic tag following when
 521        fetching from remote <name>. Setting it to --tags will fetch every
 522        tag from remote <name>, even if they are not reachable from remote
 523        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
 524        override this setting. See options --tags and --no-tags of
 525        linkgit:git-fetch[1].
 526
 527remote.<name>.vcs::
 528        Setting this to a value <vcs> will cause Git to interact with
 529        the remote with the git-remote-<vcs> helper.
 530
 531remote.<name>.prune::
 532        When set to true, fetching from this remote by default will also
 533        remove any remote-tracking references that no longer exist on the
 534        remote (as if the `--prune` option was given on the command line).
 535        Overrides `fetch.prune` settings, if any.
 536
 537remote.<name>.pruneTags::
 538        When set to true, fetching from this remote by default will also
 539        remove any local tags that no longer exist on the remote if pruning
 540        is activated in general via `remote.<name>.prune`, `fetch.prune` or
 541        `--prune`. Overrides `fetch.pruneTags` settings, if any.
 542+
 543See also `remote.<name>.prune` and the PRUNING section of
 544linkgit:git-fetch[1].
 545
 546remotes.<group>::
 547        The list of remotes which are fetched by "git remote update
 548        <group>".  See linkgit:git-remote[1].
 549
 550repack.useDeltaBaseOffset::
 551        By default, linkgit:git-repack[1] creates packs that use
 552        delta-base offset. If you need to share your repository with
 553        Git older than version 1.4.4, either directly or via a dumb
 554        protocol such as http, then you need to set this option to
 555        "false" and repack. Access from old Git versions over the
 556        native protocol are unaffected by this option.
 557
 558repack.packKeptObjects::
 559        If set to true, makes `git repack` act as if
 560        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
 561        details. Defaults to `false` normally, but `true` if a bitmap
 562        index is being written (either via `--write-bitmap-index` or
 563        `repack.writeBitmaps`).
 564
 565repack.useDeltaIslands::
 566        If set to true, makes `git repack` act as if `--delta-islands`
 567        was passed. Defaults to `false`.
 568
 569repack.writeBitmaps::
 570        When true, git will write a bitmap index when packing all
 571        objects to disk (e.g., when `git repack -a` is run).  This
 572        index can speed up the "counting objects" phase of subsequent
 573        packs created for clones and fetches, at the cost of some disk
 574        space and extra time spent on the initial repack.  This has
 575        no effect if multiple packfiles are created.
 576        Defaults to false.
 577
 578rerere.autoUpdate::
 579        When set to true, `git-rerere` updates the index with the
 580        resulting contents after it cleanly resolves conflicts using
 581        previously recorded resolution.  Defaults to false.
 582
 583rerere.enabled::
 584        Activate recording of resolved conflicts, so that identical
 585        conflict hunks can be resolved automatically, should they be
 586        encountered again.  By default, linkgit:git-rerere[1] is
 587        enabled if there is an `rr-cache` directory under the
 588        `$GIT_DIR`, e.g. if "rerere" was previously used in the
 589        repository.
 590
 591reset.quiet::
 592        When set to true, 'git reset' will default to the '--quiet' option.
 593
 594include::sendemail-config.txt[]
 595
 596sequence.editor::
 597        Text editor used by `git rebase -i` for editing the rebase instruction file.
 598        The value is meant to be interpreted by the shell when it is used.
 599        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 600        When not configured the default commit message editor is used instead.
 601
 602showBranch.default::
 603        The default set of branches for linkgit:git-show-branch[1].
 604        See linkgit:git-show-branch[1].
 605
 606splitIndex.maxPercentChange::
 607        When the split index feature is used, this specifies the
 608        percent of entries the split index can contain compared to the
 609        total number of entries in both the split index and the shared
 610        index before a new shared index is written.
 611        The value should be between 0 and 100. If the value is 0 then
 612        a new shared index is always written, if it is 100 a new
 613        shared index is never written.
 614        By default the value is 20, so a new shared index is written
 615        if the number of entries in the split index would be greater
 616        than 20 percent of the total number of entries.
 617        See linkgit:git-update-index[1].
 618
 619splitIndex.sharedIndexExpire::
 620        When the split index feature is used, shared index files that
 621        were not modified since the time this variable specifies will
 622        be removed when a new shared index file is created. The value
 623        "now" expires all entries immediately, and "never" suppresses
 624        expiration altogether.
 625        The default value is "2.weeks.ago".
 626        Note that a shared index file is considered modified (for the
 627        purpose of expiration) each time a new split-index file is
 628        either created based on it or read from it.
 629        See linkgit:git-update-index[1].
 630
 631include::config/ssh.txt[]
 632
 633status.relativePaths::
 634        By default, linkgit:git-status[1] shows paths relative to the
 635        current directory. Setting this variable to `false` shows paths
 636        relative to the repository root (this was the default for Git
 637        prior to v1.5.4).
 638
 639status.short::
 640        Set to true to enable --short by default in linkgit:git-status[1].
 641        The option --no-short takes precedence over this variable.
 642
 643status.branch::
 644        Set to true to enable --branch by default in linkgit:git-status[1].
 645        The option --no-branch takes precedence over this variable.
 646
 647status.displayCommentPrefix::
 648        If set to true, linkgit:git-status[1] will insert a comment
 649        prefix before each output line (starting with
 650        `core.commentChar`, i.e. `#` by default). This was the
 651        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
 652        Defaults to false.
 653
 654status.renameLimit::
 655        The number of files to consider when performing rename detection
 656        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
 657        the value of diff.renameLimit.
 658
 659status.renames::
 660        Whether and how Git detects renames in linkgit:git-status[1] and
 661        linkgit:git-commit[1] .  If set to "false", rename detection is
 662        disabled. If set to "true", basic rename detection is enabled.
 663        If set to "copies" or "copy", Git will detect copies, as well.
 664        Defaults to the value of diff.renames.
 665
 666status.showStash::
 667        If set to true, linkgit:git-status[1] will display the number of
 668        entries currently stashed away.
 669        Defaults to false.
 670
 671status.showUntrackedFiles::
 672        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
 673        files which are not currently tracked by Git. Directories which
 674        contain only untracked files, are shown with the directory name
 675        only. Showing untracked files means that Git needs to lstat() all
 676        the files in the whole repository, which might be slow on some
 677        systems. So, this variable controls how the commands displays
 678        the untracked files. Possible values are:
 679+
 680--
 681* `no` - Show no untracked files.
 682* `normal` - Show untracked files and directories.
 683* `all` - Show also individual files in untracked directories.
 684--
 685+
 686If this variable is not specified, it defaults to 'normal'.
 687This variable can be overridden with the -u|--untracked-files option
 688of linkgit:git-status[1] and linkgit:git-commit[1].
 689
 690status.submoduleSummary::
 691        Defaults to false.
 692        If this is set to a non zero number or true (identical to -1 or an
 693        unlimited number), the submodule summary will be enabled and a
 694        summary of commits for modified submodules will be shown (see
 695        --summary-limit option of linkgit:git-submodule[1]). Please note
 696        that the summary output command will be suppressed for all
 697        submodules when `diff.ignoreSubmodules` is set to 'all' or only
 698        for those submodules where `submodule.<name>.ignore=all`. The only
 699        exception to that rule is that status and commit will show staged
 700        submodule changes. To
 701        also view the summary for ignored submodules you can either use
 702        the --ignore-submodules=dirty command-line option or the 'git
 703        submodule summary' command, which shows a similar output but does
 704        not honor these settings.
 705
 706stash.showPatch::
 707        If this is set to true, the `git stash show` command without an
 708        option will show the stash entry in patch form.  Defaults to false.
 709        See description of 'show' command in linkgit:git-stash[1].
 710
 711stash.showStat::
 712        If this is set to true, the `git stash show` command without an
 713        option will show diffstat of the stash entry.  Defaults to true.
 714        See description of 'show' command in linkgit:git-stash[1].
 715
 716include::submodule-config.txt[]
 717
 718tag.forceSignAnnotated::
 719        A boolean to specify whether annotated tags created should be GPG signed.
 720        If `--annotate` is specified on the command line, it takes
 721        precedence over this option.
 722
 723tag.sort::
 724        This variable controls the sort ordering of tags when displayed by
 725        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
 726        value of this variable will be used as the default.
 727
 728tar.umask::
 729        This variable can be used to restrict the permission bits of
 730        tar archive entries.  The default is 0002, which turns off the
 731        world write bit.  The special value "user" indicates that the
 732        archiving user's umask will be used instead.  See umask(2) and
 733        linkgit:git-archive[1].
 734
 735transfer.fsckObjects::
 736        When `fetch.fsckObjects` or `receive.fsckObjects` are
 737        not set, the value of this variable is used instead.
 738        Defaults to false.
 739+
 740When set, the fetch or receive will abort in the case of a malformed
 741object or a link to a nonexistent object. In addition, various other
 742issues are checked for, including legacy issues (see `fsck.<msg-id>`),
 743and potential security issues like the existence of a `.GIT` directory
 744or a malicious `.gitmodules` file (see the release notes for v2.2.1
 745and v2.17.1 for details). Other sanity and security checks may be
 746added in future releases.
 747+
 748On the receiving side, failing fsckObjects will make those objects
 749unreachable, see "QUARANTINE ENVIRONMENT" in
 750linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
 751instead be left unreferenced in the repository.
 752+
 753Due to the non-quarantine nature of the `fetch.fsckObjects`
 754implementation it can not be relied upon to leave the object store
 755clean like `receive.fsckObjects` can.
 756+
 757As objects are unpacked they're written to the object store, so there
 758can be cases where malicious objects get introduced even though the
 759"fetch" failed, only to have a subsequent "fetch" succeed because only
 760new incoming objects are checked, not those that have already been
 761written to the object store. That difference in behavior should not be
 762relied upon. In the future, such objects may be quarantined for
 763"fetch" as well.
 764+
 765For now, the paranoid need to find some way to emulate the quarantine
 766environment if they'd like the same protection as "push". E.g. in the
 767case of an internal mirror do the mirroring in two steps, one to fetch
 768the untrusted objects, and then do a second "push" (which will use the
 769quarantine) to another internal repo, and have internal clients
 770consume this pushed-to repository, or embargo internal fetches and
 771only allow them once a full "fsck" has run (and no new fetches have
 772happened in the meantime).
 773
 774transfer.hideRefs::
 775        String(s) `receive-pack` and `upload-pack` use to decide which
 776        refs to omit from their initial advertisements.  Use more than
 777        one definition to specify multiple prefix strings. A ref that is
 778        under the hierarchies listed in the value of this variable is
 779        excluded, and is hidden when responding to `git push` or `git
 780        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
 781        program-specific versions of this config.
 782+
 783You may also include a `!` in front of the ref name to negate the entry,
 784explicitly exposing it, even if an earlier entry marked it as hidden.
 785If you have multiple hideRefs values, later entries override earlier ones
 786(and entries in more-specific config files override less-specific ones).
 787+
 788If a namespace is in use, the namespace prefix is stripped from each
 789reference before it is matched against `transfer.hiderefs` patterns.
 790For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
 791the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
 792is omitted from the advertisements but `refs/heads/master` and
 793`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
 794"have" lines. In order to match refs before stripping, add a `^` in front of
 795the ref name. If you combine `!` and `^`, `!` must be specified first.
 796+
 797Even if you hide refs, a client may still be able to steal the target
 798objects via the techniques described in the "SECURITY" section of the
 799linkgit:gitnamespaces[7] man page; it's best to keep private data in a
 800separate repository.
 801
 802transfer.unpackLimit::
 803        When `fetch.unpackLimit` or `receive.unpackLimit` are
 804        not set, the value of this variable is used instead.
 805        The default value is 100.
 806
 807uploadarchive.allowUnreachable::
 808        If true, allow clients to use `git archive --remote` to request
 809        any tree, whether reachable from the ref tips or not. See the
 810        discussion in the "SECURITY" section of
 811        linkgit:git-upload-archive[1] for more details. Defaults to
 812        `false`.
 813
 814uploadpack.hideRefs::
 815        This variable is the same as `transfer.hideRefs`, but applies
 816        only to `upload-pack` (and so affects only fetches, not pushes).
 817        An attempt to fetch a hidden ref by `git fetch` will fail.  See
 818        also `uploadpack.allowTipSHA1InWant`.
 819
 820uploadpack.allowTipSHA1InWant::
 821        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
 822        to accept a fetch request that asks for an object at the tip
 823        of a hidden ref (by default, such a request is rejected).
 824        See also `uploadpack.hideRefs`.  Even if this is false, a client
 825        may be able to steal objects via the techniques described in the
 826        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
 827        best to keep private data in a separate repository.
 828
 829uploadpack.allowReachableSHA1InWant::
 830        Allow `upload-pack` to accept a fetch request that asks for an
 831        object that is reachable from any ref tip. However, note that
 832        calculating object reachability is computationally expensive.
 833        Defaults to `false`.  Even if this is false, a client may be able
 834        to steal objects via the techniques described in the "SECURITY"
 835        section of the linkgit:gitnamespaces[7] man page; it's best to
 836        keep private data in a separate repository.
 837
 838uploadpack.allowAnySHA1InWant::
 839        Allow `upload-pack` to accept a fetch request that asks for any
 840        object at all.
 841        Defaults to `false`.
 842
 843uploadpack.keepAlive::
 844        When `upload-pack` has started `pack-objects`, there may be a
 845        quiet period while `pack-objects` prepares the pack. Normally
 846        it would output progress information, but if `--quiet` was used
 847        for the fetch, `pack-objects` will output nothing at all until
 848        the pack data begins. Some clients and networks may consider
 849        the server to be hung and give up. Setting this option instructs
 850        `upload-pack` to send an empty keepalive packet every
 851        `uploadpack.keepAlive` seconds. Setting this option to 0
 852        disables keepalive packets entirely. The default is 5 seconds.
 853
 854uploadpack.packObjectsHook::
 855        If this option is set, when `upload-pack` would run
 856        `git pack-objects` to create a packfile for a client, it will
 857        run this shell command instead.  The `pack-objects` command and
 858        arguments it _would_ have run (including the `git pack-objects`
 859        at the beginning) are appended to the shell command. The stdin
 860        and stdout of the hook are treated as if `pack-objects` itself
 861        was run. I.e., `upload-pack` will feed input intended for
 862        `pack-objects` to the hook, and expects a completed packfile on
 863        stdout.
 864+
 865Note that this configuration variable is ignored if it is seen in the
 866repository-level config (this is a safety measure against fetching from
 867untrusted repositories).
 868
 869uploadpack.allowFilter::
 870        If this option is set, `upload-pack` will support partial
 871        clone and partial fetch object filtering.
 872
 873uploadpack.allowRefInWant::
 874        If this option is set, `upload-pack` will support the `ref-in-want`
 875        feature of the protocol version 2 `fetch` command.  This feature
 876        is intended for the benefit of load-balanced servers which may
 877        not have the same view of what OIDs their refs point to due to
 878        replication delay.
 879
 880url.<base>.insteadOf::
 881        Any URL that starts with this value will be rewritten to
 882        start, instead, with <base>. In cases where some site serves a
 883        large number of repositories, and serves them with multiple
 884        access methods, and some users need to use different access
 885        methods, this feature allows people to specify any of the
 886        equivalent URLs and have Git automatically rewrite the URL to
 887        the best alternative for the particular user, even for a
 888        never-before-seen repository on the site.  When more than one
 889        insteadOf strings match a given URL, the longest match is used.
 890+
 891Note that any protocol restrictions will be applied to the rewritten
 892URL. If the rewrite changes the URL to use a custom protocol or remote
 893helper, you may need to adjust the `protocol.*.allow` config to permit
 894the request.  In particular, protocols you expect to use for submodules
 895must be set to `always` rather than the default of `user`. See the
 896description of `protocol.allow` above.
 897
 898url.<base>.pushInsteadOf::
 899        Any URL that starts with this value will not be pushed to;
 900        instead, it will be rewritten to start with <base>, and the
 901        resulting URL will be pushed to. In cases where some site serves
 902        a large number of repositories, and serves them with multiple
 903        access methods, some of which do not allow push, this feature
 904        allows people to specify a pull-only URL and have Git
 905        automatically use an appropriate URL to push, even for a
 906        never-before-seen repository on the site.  When more than one
 907        pushInsteadOf strings match a given URL, the longest match is
 908        used.  If a remote has an explicit pushurl, Git will ignore this
 909        setting for that remote.
 910
 911user.email::
 912        Your email address to be recorded in any newly created commits.
 913        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
 914        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
 915
 916user.name::
 917        Your full name to be recorded in any newly created commits.
 918        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
 919        environment variables.  See linkgit:git-commit-tree[1].
 920
 921user.useConfigOnly::
 922        Instruct Git to avoid trying to guess defaults for `user.email`
 923        and `user.name`, and instead retrieve the values only from the
 924        configuration. For example, if you have multiple email addresses
 925        and would like to use a different one for each repository, then
 926        with this configuration option set to `true` in the global config
 927        along with a name, Git will prompt you to set up an email before
 928        making new commits in a newly cloned repository.
 929        Defaults to `false`.
 930
 931user.signingKey::
 932        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
 933        key you want it to automatically when creating a signed tag or
 934        commit, you can override the default selection with this variable.
 935        This option is passed unchanged to gpg's --local-user parameter,
 936        so you may specify a key using any method that gpg supports.
 937
 938versionsort.prereleaseSuffix (deprecated)::
 939        Deprecated alias for `versionsort.suffix`.  Ignored if
 940        `versionsort.suffix` is set.
 941
 942versionsort.suffix::
 943        Even when version sort is used in linkgit:git-tag[1], tagnames
 944        with the same base version but different suffixes are still sorted
 945        lexicographically, resulting e.g. in prerelease tags appearing
 946        after the main release (e.g. "1.0-rc1" after "1.0").  This
 947        variable can be specified to determine the sorting order of tags
 948        with different suffixes.
 949+
 950By specifying a single suffix in this variable, any tagname containing
 951that suffix will appear before the corresponding main release.  E.g. if
 952the variable is set to "-rc", then all "1.0-rcX" tags will appear before
 953"1.0".  If specified multiple times, once per suffix, then the order of
 954suffixes in the configuration will determine the sorting order of tagnames
 955with those suffixes.  E.g. if "-pre" appears before "-rc" in the
 956configuration, then all "1.0-preX" tags will be listed before any
 957"1.0-rcX" tags.  The placement of the main release tag relative to tags
 958with various suffixes can be determined by specifying the empty suffix
 959among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
 960"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
 961are listed first, followed by "v4.8", then "v4.8-ckX" and finally
 962"v4.8-bfsX".
 963+
 964If more than one suffixes match the same tagname, then that tagname will
 965be sorted according to the suffix which starts at the earliest position in
 966the tagname.  If more than one different matching suffixes start at
 967that earliest position, then that tagname will be sorted according to the
 968longest of those suffixes.
 969The sorting order between different suffixes is undefined if they are
 970in multiple config files.
 971
 972web.browser::
 973        Specify a web browser that may be used by some commands.
 974        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
 975        may use it.
 976
 977worktree.guessRemote::
 978        With `add`, if no branch argument, and neither of `-b` nor
 979        `-B` nor `--detach` are given, the command defaults to
 980        creating a new branch from HEAD.  If `worktree.guessRemote` is
 981        set to true, `worktree add` tries to find a remote-tracking
 982        branch whose name uniquely matches the new branch name.  If
 983        such a branch exists, it is checked out and set as "upstream"
 984        for the new branch.  If no such match can be found, it falls
 985        back to creating a new branch from the current HEAD.