fb7cc8aada3e982a2ff1f3c3a3f36e0f2f45a06f
   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 value to the canonical form using `--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
 290
 291advice.*::
 292        These variables control various optional help messages designed to
 293        aid new users. All 'advice.*' variables default to 'true', and you
 294        can tell Git that you do not need help by setting these to 'false':
 295+
 296--
 297        pushUpdateRejected::
 298                Set this variable to 'false' if you want to disable
 299                'pushNonFFCurrent',
 300                'pushNonFFMatching', 'pushAlreadyExists',
 301                'pushFetchFirst', and 'pushNeedsForce'
 302                simultaneously.
 303        pushNonFFCurrent::
 304                Advice shown when linkgit:git-push[1] fails due to a
 305                non-fast-forward update to the current branch.
 306        pushNonFFMatching::
 307                Advice shown when you ran linkgit:git-push[1] and pushed
 308                'matching refs' explicitly (i.e. you used ':', or
 309                specified a refspec that isn't your current branch) and
 310                it resulted in a non-fast-forward error.
 311        pushAlreadyExists::
 312                Shown when linkgit:git-push[1] rejects an update that
 313                does not qualify for fast-forwarding (e.g., a tag.)
 314        pushFetchFirst::
 315                Shown when linkgit:git-push[1] rejects an update that
 316                tries to overwrite a remote ref that points at an
 317                object we do not have.
 318        pushNeedsForce::
 319                Shown when linkgit:git-push[1] rejects an update that
 320                tries to overwrite a remote ref that points at an
 321                object that is not a commit-ish, or make the remote
 322                ref point at an object that is not a commit-ish.
 323        statusHints::
 324                Show directions on how to proceed from the current
 325                state in the output of linkgit:git-status[1], in
 326                the template shown when writing commit messages in
 327                linkgit:git-commit[1], and in the help message shown
 328                by linkgit:git-checkout[1] when switching branch.
 329        statusUoption::
 330                Advise to consider using the `-u` option to linkgit:git-status[1]
 331                when the command takes more than 2 seconds to enumerate untracked
 332                files.
 333        commitBeforeMerge::
 334                Advice shown when linkgit:git-merge[1] refuses to
 335                merge to avoid overwriting local changes.
 336        resolveConflict::
 337                Advice shown by various commands when conflicts
 338                prevent the operation from being performed.
 339        implicitIdentity::
 340                Advice on how to set your identity configuration when
 341                your information is guessed from the system username and
 342                domain name.
 343        detachedHead::
 344                Advice shown when you used linkgit:git-checkout[1] to
 345                move to the detach HEAD state, to instruct how to create
 346                a local branch after the fact.
 347        checkoutAmbiguousRemoteBranchName::
 348                Advice shown when the argument to
 349                linkgit:git-checkout[1] ambiguously resolves to a
 350                remote tracking branch on more than one remote in
 351                situations where an unambiguous argument would have
 352                otherwise caused a remote-tracking branch to be
 353                checked out. See the `checkout.defaultRemote`
 354                configuration variable for how to set a given remote
 355                to used by default in some situations where this
 356                advice would be printed.
 357        amWorkDir::
 358                Advice that shows the location of the patch file when
 359                linkgit:git-am[1] fails to apply it.
 360        rmHints::
 361                In case of failure in the output of linkgit:git-rm[1],
 362                show directions on how to proceed from the current state.
 363        addEmbeddedRepo::
 364                Advice on what to do when you've accidentally added one
 365                git repo inside of another.
 366        ignoredHook::
 367                Advice shown if a hook is ignored because the hook is not
 368                set as executable.
 369        waitingForEditor::
 370                Print a message to the terminal whenever Git is waiting for
 371                editor input from the user.
 372--
 373
 374core.fileMode::
 375        Tells Git if the executable bit of files in the working tree
 376        is to be honored.
 377+
 378Some filesystems lose the executable bit when a file that is
 379marked as executable is checked out, or checks out a
 380non-executable file with executable bit on.
 381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
 382to see if it handles the executable bit correctly
 383and this variable is automatically set as necessary.
 384+
 385A repository, however, may be on a filesystem that handles
 386the filemode correctly, and this variable is set to 'true'
 387when created, but later may be made accessible from another
 388environment that loses the filemode (e.g. exporting ext4 via
 389CIFS mount, visiting a Cygwin created repository with
 390Git for Windows or Eclipse).
 391In such a case it may be necessary to set this variable to 'false'.
 392See linkgit:git-update-index[1].
 393+
 394The default is true (when core.filemode is not specified in the config file).
 395
 396core.hideDotFiles::
 397        (Windows-only) If true, mark newly-created directories and files whose
 398        name starts with a dot as hidden.  If 'dotGitOnly', only the `.git/`
 399        directory is hidden, but no other files starting with a dot.  The
 400        default mode is 'dotGitOnly'.
 401
 402core.ignoreCase::
 403        Internal variable which enables various workarounds to enable
 404        Git to work better on filesystems that are not case sensitive,
 405        like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
 406        finds "makefile" when Git expects "Makefile", Git will assume
 407        it is really the same file, and continue to remember it as
 408        "Makefile".
 409+
 410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 411will probe and set core.ignoreCase true if appropriate when the repository
 412is created.
 413+
 414Git relies on the proper configuration of this variable for your operating
 415and file system. Modifying this value may result in unexpected behavior.
 416
 417core.precomposeUnicode::
 418        This option is only used by Mac OS implementation of Git.
 419        When core.precomposeUnicode=true, Git reverts the unicode decomposition
 420        of filenames done by Mac OS. This is useful when sharing a repository
 421        between Mac OS and Linux or Windows.
 422        (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
 423        When false, file names are handled fully transparent by Git,
 424        which is backward compatible with older versions of Git.
 425
 426core.protectHFS::
 427        If set to true, do not allow checkout of paths that would
 428        be considered equivalent to `.git` on an HFS+ filesystem.
 429        Defaults to `true` on Mac OS, and `false` elsewhere.
 430
 431core.protectNTFS::
 432        If set to true, do not allow checkout of paths that would
 433        cause problems with the NTFS filesystem, e.g. conflict with
 434        8.3 "short" names.
 435        Defaults to `true` on Windows, and `false` elsewhere.
 436
 437core.fsmonitor::
 438        If set, the value of this variable is used as a command which
 439        will identify all files that may have changed since the
 440        requested date/time. This information is used to speed up git by
 441        avoiding unnecessary processing of files that have not changed.
 442        See the "fsmonitor-watchman" section of linkgit:githooks[5].
 443
 444core.trustctime::
 445        If false, the ctime differences between the index and the
 446        working tree are ignored; useful when the inode change time
 447        is regularly modified by something outside Git (file system
 448        crawlers and some backup systems).
 449        See linkgit:git-update-index[1]. True by default.
 450
 451core.splitIndex::
 452        If true, the split-index feature of the index will be used.
 453        See linkgit:git-update-index[1]. False by default.
 454
 455core.untrackedCache::
 456        Determines what to do about the untracked cache feature of the
 457        index. It will be kept, if this variable is unset or set to
 458        `keep`. It will automatically be added if set to `true`. And
 459        it will automatically be removed, if set to `false`. Before
 460        setting it to `true`, you should check that mtime is working
 461        properly on your system.
 462        See linkgit:git-update-index[1]. `keep` by default.
 463
 464core.checkStat::
 465        When missing or is set to `default`, many fields in the stat
 466        structure are checked to detect if a file has been modified
 467        since Git looked at it.  When this configuration variable is
 468        set to `minimal`, sub-second part of mtime and ctime, the
 469        uid and gid of the owner of the file, the inode number (and
 470        the device number, if Git was compiled to use it), are
 471        excluded from the check among these fields, leaving only the
 472        whole-second part of mtime (and ctime, if `core.trustCtime`
 473        is set) and the filesize to be checked.
 474+
 475There are implementations of Git that do not leave usable values in
 476some fields (e.g. JGit); by excluding these fields from the
 477comparison, the `minimal` mode may help interoperability when the
 478same repository is used by these other systems at the same time.
 479
 480core.quotePath::
 481        Commands that output paths (e.g. 'ls-files', 'diff'), will
 482        quote "unusual" characters in the pathname by enclosing the
 483        pathname in double-quotes and escaping those characters with
 484        backslashes in the same way C escapes control characters (e.g.
 485        `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
 486        values larger than 0x80 (e.g. octal `\302\265` for "micro" in
 487        UTF-8).  If this variable is set to false, bytes higher than
 488        0x80 are not considered "unusual" any more. Double-quotes,
 489        backslash and control characters are always escaped regardless
 490        of the setting of this variable.  A simple space character is
 491        not considered "unusual".  Many commands can output pathnames
 492        completely verbatim using the `-z` option. The default value
 493        is true.
 494
 495core.eol::
 496        Sets the line ending type to use in the working directory for
 497        files that have the `text` property set when core.autocrlf is false.
 498        Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
 499        native line ending.  The default value is `native`.  See
 500        linkgit:gitattributes[5] for more information on end-of-line
 501        conversion.
 502
 503core.safecrlf::
 504        If true, makes Git check if converting `CRLF` is reversible when
 505        end-of-line conversion is active.  Git will verify if a command
 506        modifies a file in the work tree either directly or indirectly.
 507        For example, committing a file followed by checking out the
 508        same file should yield the original file in the work tree.  If
 509        this is not the case for the current setting of
 510        `core.autocrlf`, Git will reject the file.  The variable can
 511        be set to "warn", in which case Git will only warn about an
 512        irreversible conversion but continue the operation.
 513+
 514CRLF conversion bears a slight chance of corrupting data.
 515When it is enabled, Git will convert CRLF to LF during commit and LF to
 516CRLF during checkout.  A file that contains a mixture of LF and
 517CRLF before the commit cannot be recreated by Git.  For text
 518files this is the right thing to do: it corrects line endings
 519such that we have only LF line endings in the repository.
 520But for binary files that are accidentally classified as text the
 521conversion can corrupt data.
 522+
 523If you recognize such corruption early you can easily fix it by
 524setting the conversion type explicitly in .gitattributes.  Right
 525after committing you still have the original file in your work
 526tree and this file is not yet corrupted.  You can explicitly tell
 527Git that this file is binary and Git will handle the file
 528appropriately.
 529+
 530Unfortunately, the desired effect of cleaning up text files with
 531mixed line endings and the undesired effect of corrupting binary
 532files cannot be distinguished.  In both cases CRLFs are removed
 533in an irreversible way.  For text files this is the right thing
 534to do because CRLFs are line endings, while for binary files
 535converting CRLFs corrupts data.
 536+
 537Note, this safety check does not mean that a checkout will generate a
 538file identical to the original file for a different setting of
 539`core.eol` and `core.autocrlf`, but only for the current one.  For
 540example, a text file with `LF` would be accepted with `core.eol=lf`
 541and could later be checked out with `core.eol=crlf`, in which case the
 542resulting file would contain `CRLF`, although the original file
 543contained `LF`.  However, in both work trees the line endings would be
 544consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 545file with mixed line endings would be reported by the `core.safecrlf`
 546mechanism.
 547
 548core.autocrlf::
 549        Setting this variable to "true" is the same as setting
 550        the `text` attribute to "auto" on all files and core.eol to "crlf".
 551        Set to true if you want to have `CRLF` line endings in your
 552        working directory and the repository has LF line endings.
 553        This variable can be set to 'input',
 554        in which case no output conversion is performed.
 555
 556core.checkRoundtripEncoding::
 557        A comma and/or whitespace separated list of encodings that Git
 558        performs UTF-8 round trip checks on if they are used in an
 559        `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
 560        The default value is `SHIFT-JIS`.
 561
 562core.symlinks::
 563        If false, symbolic links are checked out as small plain files that
 564        contain the link text. linkgit:git-update-index[1] and
 565        linkgit:git-add[1] will not change the recorded type to regular
 566        file. Useful on filesystems like FAT that do not support
 567        symbolic links.
 568+
 569The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 570will probe and set core.symlinks false if appropriate when the repository
 571is created.
 572
 573core.gitProxy::
 574        A "proxy command" to execute (as 'command host port') instead
 575        of establishing direct connection to the remote server when
 576        using the Git protocol for fetching. If the variable value is
 577        in the "COMMAND for DOMAIN" format, the command is applied only
 578        on hostnames ending with the specified domain string. This variable
 579        may be set multiple times and is matched in the given order;
 580        the first match wins.
 581+
 582Can be overridden by the `GIT_PROXY_COMMAND` environment variable
 583(which always applies universally, without the special "for"
 584handling).
 585+
 586The special string `none` can be used as the proxy command to
 587specify that no proxy be used for a given domain pattern.
 588This is useful for excluding servers inside a firewall from
 589proxy use, while defaulting to a common proxy for external domains.
 590
 591core.sshCommand::
 592        If this variable is set, `git fetch` and `git push` will
 593        use the specified command instead of `ssh` when they need to
 594        connect to a remote system. The command is in the same form as
 595        the `GIT_SSH_COMMAND` environment variable and is overridden
 596        when the environment variable is set.
 597
 598core.ignoreStat::
 599        If true, Git will avoid using lstat() calls to detect if files have
 600        changed by setting the "assume-unchanged" bit for those tracked files
 601        which it has updated identically in both the index and working tree.
 602+
 603When files are modified outside of Git, the user will need to stage
 604the modified files explicitly (e.g. see 'Examples' section in
 605linkgit:git-update-index[1]).
 606Git will not normally detect changes to those files.
 607+
 608This is useful on systems where lstat() calls are very slow, such as
 609CIFS/Microsoft Windows.
 610+
 611False by default.
 612
 613core.preferSymlinkRefs::
 614        Instead of the default "symref" format for HEAD
 615        and other symbolic reference files, use symbolic links.
 616        This is sometimes needed to work with old scripts that
 617        expect HEAD to be a symbolic link.
 618
 619core.bare::
 620        If true this repository is assumed to be 'bare' and has no
 621        working directory associated with it.  If this is the case a
 622        number of commands that require a working directory will be
 623        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 624+
 625This setting is automatically guessed by linkgit:git-clone[1] or
 626linkgit:git-init[1] when the repository was created.  By default a
 627repository that ends in "/.git" is assumed to be not bare (bare =
 628false), while all other repositories are assumed to be bare (bare
 629= true).
 630
 631core.worktree::
 632        Set the path to the root of the working tree.
 633        If `GIT_COMMON_DIR` environment variable is set, core.worktree
 634        is ignored and not used for determining the root of working tree.
 635        This can be overridden by the `GIT_WORK_TREE` environment
 636        variable and the `--work-tree` command-line option.
 637        The value can be an absolute path or relative to the path to
 638        the .git directory, which is either specified by --git-dir
 639        or GIT_DIR, or automatically discovered.
 640        If --git-dir or GIT_DIR is specified but none of
 641        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 642        the current working directory is regarded as the top level
 643        of your working tree.
 644+
 645Note that this variable is honored even when set in a configuration
 646file in a ".git" subdirectory of a directory and its value differs
 647from the latter directory (e.g. "/path/to/.git/config" has
 648core.worktree set to "/different/path"), which is most likely a
 649misconfiguration.  Running Git commands in the "/path/to" directory will
 650still use "/different/path" as the root of the work tree and can cause
 651confusion unless you know what you are doing (e.g. you are creating a
 652read-only snapshot of the same index to a location different from the
 653repository's usual working tree).
 654
 655core.logAllRefUpdates::
 656        Enable the reflog. Updates to a ref <ref> is logged to the file
 657        "`$GIT_DIR/logs/<ref>`", by appending the new and old
 658        SHA-1, the date/time and the reason of the update, but
 659        only when the file exists.  If this configuration
 660        variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
 661        file is automatically created for branch heads (i.e. under
 662        `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
 663        note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
 664        If it is set to `always`, then a missing reflog is automatically
 665        created for any ref under `refs/`.
 666+
 667This information can be used to determine what commit
 668was the tip of a branch "2 days ago".
 669+
 670This value is true by default in a repository that has
 671a working directory associated with it, and false by
 672default in a bare repository.
 673
 674core.repositoryFormatVersion::
 675        Internal variable identifying the repository format and layout
 676        version.
 677
 678core.sharedRepository::
 679        When 'group' (or 'true'), the repository is made shareable between
 680        several users in a group (making sure all the files and objects are
 681        group-writable). When 'all' (or 'world' or 'everybody'), the
 682        repository will be readable by all users, additionally to being
 683        group-shareable. When 'umask' (or 'false'), Git will use permissions
 684        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 685        files in the repository will have this mode value. '0xxx' will override
 686        user's umask value (whereas the other options will only override
 687        requested parts of the user's umask value). Examples: '0660' will make
 688        the repo read/write-able for the owner and group, but inaccessible to
 689        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 690        repository that is group-readable but not group-writable.
 691        See linkgit:git-init[1]. False by default.
 692
 693core.warnAmbiguousRefs::
 694        If true, Git will warn you if the ref name you passed it is ambiguous
 695        and might match multiple refs in the repository. True by default.
 696
 697core.compression::
 698        An integer -1..9, indicating a default compression level.
 699        -1 is the zlib default. 0 means no compression,
 700        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 701        If set, this provides a default to other compression variables,
 702        such as `core.looseCompression` and `pack.compression`.
 703
 704core.looseCompression::
 705        An integer -1..9, indicating the compression level for objects that
 706        are not in a pack file. -1 is the zlib default. 0 means no
 707        compression, and 1..9 are various speed/size tradeoffs, 9 being
 708        slowest.  If not set,  defaults to core.compression.  If that is
 709        not set,  defaults to 1 (best speed).
 710
 711core.packedGitWindowSize::
 712        Number of bytes of a pack file to map into memory in a
 713        single mapping operation.  Larger window sizes may allow
 714        your system to process a smaller number of large pack files
 715        more quickly.  Smaller window sizes will negatively affect
 716        performance due to increased calls to the operating system's
 717        memory manager, but may improve performance when accessing
 718        a large number of large pack files.
 719+
 720Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 721MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 722be reasonable for all users/operating systems.  You probably do
 723not need to adjust this value.
 724+
 725Common unit suffixes of 'k', 'm', or 'g' are supported.
 726
 727core.packedGitLimit::
 728        Maximum number of bytes to map simultaneously into memory
 729        from pack files.  If Git needs to access more than this many
 730        bytes at once to complete an operation it will unmap existing
 731        regions to reclaim virtual address space within the process.
 732+
 733Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
 734unlimited) on 64 bit platforms.
 735This should be reasonable for all users/operating systems, except on
 736the largest projects.  You probably do not need to adjust this value.
 737+
 738Common unit suffixes of 'k', 'm', or 'g' are supported.
 739
 740core.deltaBaseCacheLimit::
 741        Maximum number of bytes to reserve for caching base objects
 742        that may be referenced by multiple deltified objects.  By storing the
 743        entire decompressed base objects in a cache Git is able
 744        to avoid unpacking and decompressing frequently used base
 745        objects multiple times.
 746+
 747Default is 96 MiB on all platforms.  This should be reasonable
 748for all users/operating systems, except on the largest projects.
 749You probably do not need to adjust this value.
 750+
 751Common unit suffixes of 'k', 'm', or 'g' are supported.
 752
 753core.bigFileThreshold::
 754        Files larger than this size are stored deflated, without
 755        attempting delta compression.  Storing large files without
 756        delta compression avoids excessive memory usage, at the
 757        slight expense of increased disk usage. Additionally files
 758        larger than this size are always treated as binary.
 759+
 760Default is 512 MiB on all platforms.  This should be reasonable
 761for most projects as source code and other text files can still
 762be delta compressed, but larger binary media files won't be.
 763+
 764Common unit suffixes of 'k', 'm', or 'g' are supported.
 765
 766core.excludesFile::
 767        Specifies the pathname to the file that contains patterns to
 768        describe paths that are not meant to be tracked, in addition
 769        to '.gitignore' (per-directory) and '.git/info/exclude'.
 770        Defaults to `$XDG_CONFIG_HOME/git/ignore`.
 771        If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
 772        is used instead. See linkgit:gitignore[5].
 773
 774core.askPass::
 775        Some commands (e.g. svn and http interfaces) that interactively
 776        ask for a password can be told to use an external program given
 777        via the value of this variable. Can be overridden by the `GIT_ASKPASS`
 778        environment variable. If not set, fall back to the value of the
 779        `SSH_ASKPASS` environment variable or, failing that, a simple password
 780        prompt. The external program shall be given a suitable prompt as
 781        command-line argument and write the password on its STDOUT.
 782
 783core.attributesFile::
 784        In addition to '.gitattributes' (per-directory) and
 785        '.git/info/attributes', Git looks into this file for attributes
 786        (see linkgit:gitattributes[5]). Path expansions are made the same
 787        way as for `core.excludesFile`. Its default value is
 788        `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
 789        set or empty, `$HOME/.config/git/attributes` is used instead.
 790
 791core.hooksPath::
 792        By default Git will look for your hooks in the
 793        '$GIT_DIR/hooks' directory. Set this to different path,
 794        e.g. '/etc/git/hooks', and Git will try to find your hooks in
 795        that directory, e.g. '/etc/git/hooks/pre-receive' instead of
 796        in '$GIT_DIR/hooks/pre-receive'.
 797+
 798The path can be either absolute or relative. A relative path is
 799taken as relative to the directory where the hooks are run (see
 800the "DESCRIPTION" section of linkgit:githooks[5]).
 801+
 802This configuration variable is useful in cases where you'd like to
 803centrally configure your Git hooks instead of configuring them on a
 804per-repository basis, or as a more flexible and centralized
 805alternative to having an `init.templateDir` where you've changed
 806default hooks.
 807
 808core.editor::
 809        Commands such as `commit` and `tag` that let you edit
 810        messages by launching an editor use the value of this
 811        variable when it is set, and the environment variable
 812        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 813
 814core.commentChar::
 815        Commands such as `commit` and `tag` that let you edit
 816        messages consider a line that begins with this character
 817        commented, and removes them after the editor returns
 818        (default '#').
 819+
 820If set to "auto", `git-commit` would select a character that is not
 821the beginning character of any line in existing commit messages.
 822
 823core.filesRefLockTimeout::
 824        The length of time, in milliseconds, to retry when trying to
 825        lock an individual reference. Value 0 means not to retry at
 826        all; -1 means to try indefinitely. Default is 100 (i.e.,
 827        retry for 100ms).
 828
 829core.packedRefsTimeout::
 830        The length of time, in milliseconds, to retry when trying to
 831        lock the `packed-refs` file. Value 0 means not to retry at
 832        all; -1 means to try indefinitely. Default is 1000 (i.e.,
 833        retry for 1 second).
 834
 835sequence.editor::
 836        Text editor used by `git rebase -i` for editing the rebase instruction file.
 837        The value is meant to be interpreted by the shell when it is used.
 838        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 839        When not configured the default commit message editor is used instead.
 840
 841core.pager::
 842        Text viewer for use by Git commands (e.g., 'less').  The value
 843        is meant to be interpreted by the shell.  The order of preference
 844        is the `$GIT_PAGER` environment variable, then `core.pager`
 845        configuration, then `$PAGER`, and then the default chosen at
 846        compile time (usually 'less').
 847+
 848When the `LESS` environment variable is unset, Git sets it to `FRX`
 849(if `LESS` environment variable is set, Git does not change it at
 850all).  If you want to selectively override Git's default setting
 851for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
 852be passed to the shell by Git, which will translate the final
 853command to `LESS=FRX less -S`. The environment does not set the
 854`S` option but the command line does, instructing less to truncate
 855long lines. Similarly, setting `core.pager` to `less -+F` will
 856deactivate the `F` option specified by the environment from the
 857command-line, deactivating the "quit if one screen" behavior of
 858`less`.  One can specifically activate some flags for particular
 859commands: for example, setting `pager.blame` to `less -S` enables
 860line truncation only for `git blame`.
 861+
 862Likewise, when the `LV` environment variable is unset, Git sets it
 863to `-c`.  You can override this setting by exporting `LV` with
 864another value or setting `core.pager` to `lv +c`.
 865
 866core.whitespace::
 867        A comma separated list of common whitespace problems to
 868        notice.  'git diff' will use `color.diff.whitespace` to
 869        highlight them, and 'git apply --whitespace=error' will
 870        consider them as errors.  You can prefix `-` to disable
 871        any of them (e.g. `-trailing-space`):
 872+
 873* `blank-at-eol` treats trailing whitespaces at the end of the line
 874  as an error (enabled by default).
 875* `space-before-tab` treats a space character that appears immediately
 876  before a tab character in the initial indent part of the line as an
 877  error (enabled by default).
 878* `indent-with-non-tab` treats a line that is indented with space
 879  characters instead of the equivalent tabs as an error (not enabled by
 880  default).
 881* `tab-in-indent` treats a tab character in the initial indent part of
 882  the line as an error (not enabled by default).
 883* `blank-at-eof` treats blank lines added at the end of file as an error
 884  (enabled by default).
 885* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 886  `blank-at-eof`.
 887* `cr-at-eol` treats a carriage-return at the end of line as
 888  part of the line terminator, i.e. with it, `trailing-space`
 889  does not trigger if the character before such a carriage-return
 890  is not a whitespace (not enabled by default).
 891* `tabwidth=<n>` tells how many character positions a tab occupies; this
 892  is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
 893  errors. The default tab width is 8. Allowed values are 1 to 63.
 894
 895core.fsyncObjectFiles::
 896        This boolean will enable 'fsync()' when writing object files.
 897+
 898This is a total waste of time and effort on a filesystem that orders
 899data writes properly, but can be useful for filesystems that do not use
 900journalling (traditional UNIX filesystems) or that only journal metadata
 901and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 902
 903core.preloadIndex::
 904        Enable parallel index preload for operations like 'git diff'
 905+
 906This can speed up operations like 'git diff' and 'git status' especially
 907on filesystems like NFS that have weak caching semantics and thus
 908relatively high IO latencies.  When enabled, Git will do the
 909index comparison to the filesystem data in parallel, allowing
 910overlapping IO's.  Defaults to true.
 911
 912core.createObject::
 913        You can set this to 'link', in which case a hardlink followed by
 914        a delete of the source are used to make sure that object creation
 915        will not overwrite existing objects.
 916+
 917On some file system/operating system combinations, this is unreliable.
 918Set this config setting to 'rename' there; However, This will remove the
 919check that makes sure that existing object files will not get overwritten.
 920
 921core.notesRef::
 922        When showing commit messages, also show notes which are stored in
 923        the given ref.  The ref must be fully qualified.  If the given
 924        ref does not exist, it is not an error but means that no
 925        notes should be printed.
 926+
 927This setting defaults to "refs/notes/commits", and it can be overridden by
 928the `GIT_NOTES_REF` environment variable.  See linkgit:git-notes[1].
 929
 930core.commitGraph::
 931        If true, then git will read the commit-graph file (if it exists)
 932        to parse the graph structure of commits. Defaults to false. See
 933        linkgit:git-commit-graph[1] for more information.
 934
 935core.useReplaceRefs::
 936        If set to `false`, behave as if the `--no-replace-objects`
 937        option was given on the command line. See linkgit:git[1] and
 938        linkgit:git-replace[1] for more information.
 939
 940core.sparseCheckout::
 941        Enable "sparse checkout" feature. See section "Sparse checkout" in
 942        linkgit:git-read-tree[1] for more information.
 943
 944core.abbrev::
 945        Set the length object names are abbreviated to.  If
 946        unspecified or set to "auto", an appropriate value is
 947        computed based on the approximate number of packed objects
 948        in your repository, which hopefully is enough for
 949        abbreviated object names to stay unique for some time.
 950        The minimum length is 4.
 951
 952add.ignoreErrors::
 953add.ignore-errors (deprecated)::
 954        Tells 'git add' to continue adding files when some files cannot be
 955        added due to indexing errors. Equivalent to the `--ignore-errors`
 956        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 957        as it does not follow the usual naming convention for configuration
 958        variables.
 959
 960alias.*::
 961        Command aliases for the linkgit:git[1] command wrapper - e.g.
 962        after defining "alias.last = cat-file commit HEAD", the invocation
 963        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 964        confusion and troubles with script usage, aliases that
 965        hide existing Git commands are ignored. Arguments are split by
 966        spaces, the usual shell quoting and escaping is supported.
 967        A quote pair or a backslash can be used to quote them.
 968+
 969If the alias expansion is prefixed with an exclamation point,
 970it will be treated as a shell command.  For example, defining
 971"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 972"git new" is equivalent to running the shell command
 973"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 974executed from the top-level directory of a repository, which may
 975not necessarily be the current directory.
 976`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
 977from the original current directory. See linkgit:git-rev-parse[1].
 978
 979am.keepcr::
 980        If true, git-am will call git-mailsplit for patches in mbox format
 981        with parameter `--keep-cr`. In this case git-mailsplit will
 982        not remove `\r` from lines ending with `\r\n`. Can be overridden
 983        by giving `--no-keep-cr` from the command line.
 984        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 985
 986am.threeWay::
 987        By default, `git am` will fail if the patch does not apply cleanly. When
 988        set to true, this setting tells `git am` to fall back on 3-way merge if
 989        the patch records the identity of blobs it is supposed to apply to and
 990        we have those blobs available locally (equivalent to giving the `--3way`
 991        option from the command line). Defaults to `false`.
 992        See linkgit:git-am[1].
 993
 994apply.ignoreWhitespace::
 995        When set to 'change', tells 'git apply' to ignore changes in
 996        whitespace, in the same way as the `--ignore-space-change`
 997        option.
 998        When set to one of: no, none, never, false tells 'git apply' to
 999        respect all whitespace differences.
1000        See linkgit:git-apply[1].
1001
1002apply.whitespace::
1003        Tells 'git apply' how to handle whitespaces, in the same way
1004        as the `--whitespace` option. See linkgit:git-apply[1].
1005
1006blame.blankBoundary::
1007        Show blank commit object name for boundary commits in
1008        linkgit:git-blame[1]. This option defaults to false.
1009
1010blame.coloring::
1011        This determines the coloring scheme to be applied to blame
1012        output. It can be 'repeatedLines', 'highlightRecent',
1013        or 'none' which is the default.
1014
1015blame.date::
1016        Specifies the format used to output dates in linkgit:git-blame[1].
1017        If unset the iso format is used. For supported values,
1018        see the discussion of the `--date` option at linkgit:git-log[1].
1019
1020blame.showEmail::
1021        Show the author email instead of author name in linkgit:git-blame[1].
1022        This option defaults to false.
1023
1024blame.showRoot::
1025        Do not treat root commits as boundaries in linkgit:git-blame[1].
1026        This option defaults to false.
1027
1028branch.autoSetupMerge::
1029        Tells 'git branch' and 'git checkout' to set up new branches
1030        so that linkgit:git-pull[1] will appropriately merge from the
1031        starting point branch. Note that even if this option is not set,
1032        this behavior can be chosen per-branch using the `--track`
1033        and `--no-track` options. The valid settings are: `false` -- no
1034        automatic setup is done; `true` -- automatic setup is done when the
1035        starting point is a remote-tracking branch; `always` --
1036        automatic setup is done when the starting point is either a
1037        local branch or remote-tracking
1038        branch. This option defaults to true.
1039
1040branch.autoSetupRebase::
1041        When a new branch is created with 'git branch' or 'git checkout'
1042        that tracks another branch, this variable tells Git to set
1043        up pull to rebase instead of merge (see "branch.<name>.rebase").
1044        When `never`, rebase is never automatically set to true.
1045        When `local`, rebase is set to true for tracked branches of
1046        other local branches.
1047        When `remote`, rebase is set to true for tracked branches of
1048        remote-tracking branches.
1049        When `always`, rebase will be set to true for all tracking
1050        branches.
1051        See "branch.autoSetupMerge" for details on how to set up a
1052        branch to track another branch.
1053        This option defaults to never.
1054
1055branch.sort::
1056        This variable controls the sort ordering of branches when displayed by
1057        linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1058        value of this variable will be used as the default.
1059        See linkgit:git-for-each-ref[1] field names for valid values.
1060
1061branch.<name>.remote::
1062        When on branch <name>, it tells 'git fetch' and 'git push'
1063        which remote to fetch from/push to.  The remote to push to
1064        may be overridden with `remote.pushDefault` (for all branches).
1065        The remote to push to, for the current branch, may be further
1066        overridden by `branch.<name>.pushRemote`.  If no remote is
1067        configured, or if you are not on any branch, it defaults to
1068        `origin` for fetching and `remote.pushDefault` for pushing.
1069        Additionally, `.` (a period) is the current local repository
1070        (a dot-repository), see `branch.<name>.merge`'s final note below.
1071
1072branch.<name>.pushRemote::
1073        When on branch <name>, it overrides `branch.<name>.remote` for
1074        pushing.  It also overrides `remote.pushDefault` for pushing
1075        from branch <name>.  When you pull from one place (e.g. your
1076        upstream) and push to another place (e.g. your own publishing
1077        repository), you would want to set `remote.pushDefault` to
1078        specify the remote to push to for all branches, and use this
1079        option to override it for a specific branch.
1080
1081branch.<name>.merge::
1082        Defines, together with branch.<name>.remote, the upstream branch
1083        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1084        branch to merge and can also affect 'git push' (see push.default).
1085        When in branch <name>, it tells 'git fetch' the default
1086        refspec to be marked for merging in FETCH_HEAD. The value is
1087        handled like the remote part of a refspec, and must match a
1088        ref which is fetched from the remote given by
1089        "branch.<name>.remote".
1090        The merge information is used by 'git pull' (which at first calls
1091        'git fetch') to lookup the default branch for merging. Without
1092        this option, 'git pull' defaults to merge the first refspec fetched.
1093        Specify multiple values to get an octopus merge.
1094        If you wish to setup 'git pull' so that it merges into <name> from
1095        another branch in the local repository, you can point
1096        branch.<name>.merge to the desired branch, and use the relative path
1097        setting `.` (a period) for branch.<name>.remote.
1098
1099branch.<name>.mergeOptions::
1100        Sets default options for merging into branch <name>. The syntax and
1101        supported options are the same as those of linkgit:git-merge[1], but
1102        option values containing whitespace characters are currently not
1103        supported.
1104
1105branch.<name>.rebase::
1106        When true, rebase the branch <name> on top of the fetched branch,
1107        instead of merging the default branch from the default remote when
1108        "git pull" is run. See "pull.rebase" for doing this in a non
1109        branch-specific manner.
1110+
1111When `merges`, pass the `--rebase-merges` option to 'git rebase'
1112so that the local merge commits are included in the rebase (see
1113linkgit:git-rebase[1] for details).
1114+
1115When preserve, also pass `--preserve-merges` along to 'git rebase'
1116so that locally committed merge commits will not be flattened
1117by running 'git pull'.
1118+
1119When the value is `interactive`, the rebase is run in interactive mode.
1120+
1121*NOTE*: this is a possibly dangerous operation; do *not* use
1122it unless you understand the implications (see linkgit:git-rebase[1]
1123for details).
1124
1125branch.<name>.description::
1126        Branch description, can be edited with
1127        `git branch --edit-description`. Branch description is
1128        automatically added in the format-patch cover letter or
1129        request-pull summary.
1130
1131browser.<tool>.cmd::
1132        Specify the command to invoke the specified browser. The
1133        specified command is evaluated in shell with the URLs passed
1134        as arguments. (See linkgit:git-web{litdd}browse[1].)
1135
1136browser.<tool>.path::
1137        Override the path for the given tool that may be used to
1138        browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1139        working repository in gitweb (see linkgit:git-instaweb[1]).
1140
1141checkout.defaultRemote::
1142        When you run 'git checkout <something>' and only have one
1143        remote, it may implicitly fall back on checking out and
1144        tracking e.g. 'origin/<something>'. This stops working as soon
1145        as you have more than one remote with a '<something>'
1146        reference. This setting allows for setting the name of a
1147        preferred remote that should always win when it comes to
1148        disambiguation. The typical use-case is to set this to
1149        `origin`.
1150+
1151Currently this is used by linkgit:git-checkout[1] when 'git checkout
1152<something>' will checkout the '<something>' branch on another remote,
1153and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1154remote branch. This setting might be used for other checkout-like
1155commands or functionality in the future.
1156
1157clean.requireForce::
1158        A boolean to make git-clean do nothing unless given -f,
1159        -i or -n.   Defaults to true.
1160
1161color.advice::
1162        A boolean to enable/disable color in hints (e.g. when a push
1163        failed, see `advice.*` for a list).  May be set to `always`,
1164        `false` (or `never`) or `auto` (or `true`), in which case colors
1165        are used only when the error output goes to a terminal. If
1166        unset, then the value of `color.ui` is used (`auto` by default).
1167
1168color.advice.hint::
1169        Use customized color for hints.
1170
1171color.blame.highlightRecent::
1172        This can be used to color the metadata of a blame line depending
1173        on age of the line.
1174+
1175This setting should be set to a comma-separated list of color and date settings,
1176starting and ending with a color, the dates should be set from oldest to newest.
1177The metadata will be colored given the colors if the the line was introduced
1178before the given timestamp, overwriting older timestamped colors.
1179+
1180Instead of an absolute timestamp relative timestamps work as well, e.g.
11812.weeks.ago is valid to address anything older than 2 weeks.
1182+
1183It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1184everything older than one year blue, recent changes between one month and
1185one year old are kept white, and lines introduced within the last month are
1186colored red.
1187
1188color.blame.repeatedLines::
1189        Use the customized color for the part of git-blame output that
1190        is repeated meta information per line (such as commit id,
1191        author name, date and timezone). Defaults to cyan.
1192
1193color.branch::
1194        A boolean to enable/disable color in the output of
1195        linkgit:git-branch[1]. May be set to `always`,
1196        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1197        only when the output is to a terminal. If unset, then the
1198        value of `color.ui` is used (`auto` by default).
1199
1200color.branch.<slot>::
1201        Use customized color for branch coloration. `<slot>` is one of
1202        `current` (the current branch), `local` (a local branch),
1203        `remote` (a remote-tracking branch in refs/remotes/),
1204        `upstream` (upstream tracking branch), `plain` (other
1205        refs).
1206
1207color.diff::
1208        Whether to use ANSI escape sequences to add color to patches.
1209        If this is set to `always`, linkgit:git-diff[1],
1210        linkgit:git-log[1], and linkgit:git-show[1] will use color
1211        for all patches.  If it is set to `true` or `auto`, those
1212        commands will only use color when output is to the terminal.
1213        If unset, then the value of `color.ui` is used (`auto` by
1214        default).
1215+
1216This does not affect linkgit:git-format-patch[1] or the
1217'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
1218command line with the `--color[=<when>]` option.
1219
1220color.diff.<slot>::
1221        Use customized color for diff colorization.  `<slot>` specifies
1222        which part of the patch to use the specified color, and is one
1223        of `context` (context text - `plain` is a historical synonym),
1224        `meta` (metainformation), `frag`
1225        (hunk header), 'func' (function in hunk header), `old` (removed lines),
1226        `new` (added lines), `commit` (commit headers), `whitespace`
1227        (highlighting whitespace errors), `oldMoved` (deleted lines),
1228        `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1229        `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1230        `newMovedAlternativeDimmed` (See the '<mode>'
1231        setting of '--color-moved' in linkgit:git-diff[1] for details),
1232        `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1233        `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1234
1235color.decorate.<slot>::
1236        Use customized color for 'git log --decorate' output.  `<slot>` is one
1237        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1238        branches, remote-tracking branches, tags, stash and HEAD, respectively
1239        and `grafted` for grafted commits.
1240
1241color.grep::
1242        When set to `always`, always highlight matches.  When `false` (or
1243        `never`), never.  When set to `true` or `auto`, use color only
1244        when the output is written to the terminal.  If unset, then the
1245        value of `color.ui` is used (`auto` by default).
1246
1247color.grep.<slot>::
1248        Use customized color for grep colorization.  `<slot>` specifies which
1249        part of the line to use the specified color, and is one of
1250+
1251--
1252`context`;;
1253        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1254`filename`;;
1255        filename prefix (when not using `-h`)
1256`function`;;
1257        function name lines (when using `-p`)
1258`lineNumber`;;
1259        line number prefix (when using `-n`)
1260`column`;;
1261        column number prefix (when using `--column`)
1262`match`;;
1263        matching text (same as setting `matchContext` and `matchSelected`)
1264`matchContext`;;
1265        matching text in context lines
1266`matchSelected`;;
1267        matching text in selected lines
1268`selected`;;
1269        non-matching text in selected lines
1270`separator`;;
1271        separators between fields on a line (`:`, `-`, and `=`)
1272        and between hunks (`--`)
1273--
1274
1275color.interactive::
1276        When set to `always`, always use colors for interactive prompts
1277        and displays (such as those used by "git-add --interactive" and
1278        "git-clean --interactive"). When false (or `never`), never.
1279        When set to `true` or `auto`, use colors only when the output is
1280        to the terminal. If unset, then the value of `color.ui` is
1281        used (`auto` by default).
1282
1283color.interactive.<slot>::
1284        Use customized color for 'git add --interactive' and 'git clean
1285        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1286        or `error`, for four distinct types of normal output from
1287        interactive commands.
1288
1289color.pager::
1290        A boolean to enable/disable colored output when the pager is in
1291        use (default is true).
1292
1293color.push::
1294        A boolean to enable/disable color in push errors. May be set to
1295        `always`, `false` (or `never`) or `auto` (or `true`), in which
1296        case colors are used only when the error output goes to a terminal.
1297        If unset, then the value of `color.ui` is used (`auto` by default).
1298
1299color.push.error::
1300        Use customized color for push errors.
1301
1302color.remote::
1303        If set, keywords at the start of the line are highlighted. The
1304        keywords are "error", "warning", "hint" and "success", and are
1305        matched case-insensitively. May be set to `always`, `false` (or
1306        `never`) or `auto` (or `true`). If unset, then the value of
1307        `color.ui` is used (`auto` by default).
1308
1309color.remote.<slot>::
1310        Use customized color for each remote keyword. `<slot>` may be
1311        `hint`, `warning`, `success` or `error` which match the
1312        corresponding keyword.
1313
1314color.showBranch::
1315        A boolean to enable/disable color in the output of
1316        linkgit:git-show-branch[1]. May be set to `always`,
1317        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1318        only when the output is to a terminal. If unset, then the
1319        value of `color.ui` is used (`auto` by default).
1320
1321color.status::
1322        A boolean to enable/disable color in the output of
1323        linkgit:git-status[1]. May be set to `always`,
1324        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1325        only when the output is to a terminal. If unset, then the
1326        value of `color.ui` is used (`auto` by default).
1327
1328color.status.<slot>::
1329        Use customized color for status colorization. `<slot>` is
1330        one of `header` (the header text of the status message),
1331        `added` or `updated` (files which are added but not committed),
1332        `changed` (files which are changed but not added in the index),
1333        `untracked` (files which are not tracked by Git),
1334        `branch` (the current branch),
1335        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1336        to red),
1337        `localBranch` or `remoteBranch` (the local and remote branch names,
1338        respectively, when branch and tracking information is displayed in the
1339        status short-format), or
1340        `unmerged` (files which have unmerged changes).
1341
1342color.transport::
1343        A boolean to enable/disable color when pushes are rejected. May be
1344        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1345        case colors are used only when the error output goes to a terminal.
1346        If unset, then the value of `color.ui` is used (`auto` by default).
1347
1348color.transport.rejected::
1349        Use customized color when a push was rejected.
1350
1351color.ui::
1352        This variable determines the default value for variables such
1353        as `color.diff` and `color.grep` that control the use of color
1354        per command family. Its scope will expand as more commands learn
1355        configuration to set a default for the `--color` option.  Set it
1356        to `false` or `never` if you prefer Git commands not to use
1357        color unless enabled explicitly with some other configuration
1358        or the `--color` option. Set it to `always` if you want all
1359        output not intended for machine consumption to use color, to
1360        `true` or `auto` (this is the default since Git 1.8.4) if you
1361        want such output to use color when written to the terminal.
1362
1363column.ui::
1364        Specify whether supported commands should output in columns.
1365        This variable consists of a list of tokens separated by spaces
1366        or commas:
1367+
1368These options control when the feature should be enabled
1369(defaults to 'never'):
1370+
1371--
1372`always`;;
1373        always show in columns
1374`never`;;
1375        never show in columns
1376`auto`;;
1377        show in columns if the output is to the terminal
1378--
1379+
1380These options control layout (defaults to 'column').  Setting any
1381of these implies 'always' if none of 'always', 'never', or 'auto' are
1382specified.
1383+
1384--
1385`column`;;
1386        fill columns before rows
1387`row`;;
1388        fill rows before columns
1389`plain`;;
1390        show in one column
1391--
1392+
1393Finally, these options can be combined with a layout option (defaults
1394to 'nodense'):
1395+
1396--
1397`dense`;;
1398        make unequal size columns to utilize more space
1399`nodense`;;
1400        make equal size columns
1401--
1402
1403column.branch::
1404        Specify whether to output branch listing in `git branch` in columns.
1405        See `column.ui` for details.
1406
1407column.clean::
1408        Specify the layout when list items in `git clean -i`, which always
1409        shows files and directories in columns. See `column.ui` for details.
1410
1411column.status::
1412        Specify whether to output untracked files in `git status` in columns.
1413        See `column.ui` for details.
1414
1415column.tag::
1416        Specify whether to output tag listing in `git tag` in columns.
1417        See `column.ui` for details.
1418
1419commit.cleanup::
1420        This setting overrides the default of the `--cleanup` option in
1421        `git commit`. See linkgit:git-commit[1] for details. Changing the
1422        default can be useful when you always want to keep lines that begin
1423        with comment character `#` in your log message, in which case you
1424        would do `git config commit.cleanup whitespace` (note that you will
1425        have to remove the help lines that begin with `#` in the commit log
1426        template yourself, if you do this).
1427
1428commit.gpgSign::
1429
1430        A boolean to specify whether all commits should be GPG signed.
1431        Use of this option when doing operations such as rebase can
1432        result in a large number of commits being signed. It may be
1433        convenient to use an agent to avoid typing your GPG passphrase
1434        several times.
1435
1436commit.status::
1437        A boolean to enable/disable inclusion of status information in the
1438        commit message template when using an editor to prepare the commit
1439        message.  Defaults to true.
1440
1441commit.template::
1442        Specify the pathname of a file to use as the template for
1443        new commit messages.
1444
1445commit.verbose::
1446        A boolean or int to specify the level of verbose with `git commit`.
1447        See linkgit:git-commit[1].
1448
1449credential.helper::
1450        Specify an external helper to be called when a username or
1451        password credential is needed; the helper may consult external
1452        storage to avoid prompting the user for the credentials. Note
1453        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1454        for details.
1455
1456credential.useHttpPath::
1457        When acquiring credentials, consider the "path" component of an http
1458        or https URL to be important. Defaults to false. See
1459        linkgit:gitcredentials[7] for more information.
1460
1461credential.username::
1462        If no username is set for a network authentication, use this username
1463        by default. See credential.<context>.* below, and
1464        linkgit:gitcredentials[7].
1465
1466credential.<url>.*::
1467        Any of the credential.* options above can be applied selectively to
1468        some credentials. For example "credential.https://example.com.username"
1469        would set the default username only for https connections to
1470        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1471        matched.
1472
1473credentialCache.ignoreSIGHUP::
1474        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1475
1476completion.commands::
1477        This is only used by git-completion.bash to add or remove
1478        commands from the list of completed commands. Normally only
1479        porcelain commands and a few select others are completed. You
1480        can add more commands, separated by space, in this
1481        variable. Prefixing the command with '-' will remove it from
1482        the existing list.
1483
1484include::diff-config.txt[]
1485
1486difftool.<tool>.path::
1487        Override the path for the given tool.  This is useful in case
1488        your tool is not in the PATH.
1489
1490difftool.<tool>.cmd::
1491        Specify the command to invoke the specified diff tool.
1492        The specified command is evaluated in shell with the following
1493        variables available:  'LOCAL' is set to the name of the temporary
1494        file containing the contents of the diff pre-image and 'REMOTE'
1495        is set to the name of the temporary file containing the contents
1496        of the diff post-image.
1497
1498difftool.prompt::
1499        Prompt before each invocation of the diff tool.
1500
1501fastimport.unpackLimit::
1502        If the number of objects imported by linkgit:git-fast-import[1]
1503        is below this limit, then the objects will be unpacked into
1504        loose object files.  However if the number of imported objects
1505        equals or exceeds this limit then the pack will be stored as a
1506        pack.  Storing the pack from a fast-import can make the import
1507        operation complete faster, especially on slow filesystems.  If
1508        not set, the value of `transfer.unpackLimit` is used instead.
1509
1510include::fetch-config.txt[]
1511
1512format.attach::
1513        Enable multipart/mixed attachments as the default for
1514        'format-patch'.  The value can also be a double quoted string
1515        which will enable attachments as the default and set the
1516        value as the boundary.  See the --attach option in
1517        linkgit:git-format-patch[1].
1518
1519format.from::
1520        Provides the default value for the `--from` option to format-patch.
1521        Accepts a boolean value, or a name and email address.  If false,
1522        format-patch defaults to `--no-from`, using commit authors directly in
1523        the "From:" field of patch mails.  If true, format-patch defaults to
1524        `--from`, using your committer identity in the "From:" field of patch
1525        mails and including a "From:" field in the body of the patch mail if
1526        different.  If set to a non-boolean value, format-patch uses that
1527        value instead of your committer identity.  Defaults to false.
1528
1529format.numbered::
1530        A boolean which can enable or disable sequence numbers in patch
1531        subjects.  It defaults to "auto" which enables it only if there
1532        is more than one patch.  It can be enabled or disabled for all
1533        messages by setting it to "true" or "false".  See --numbered
1534        option in linkgit:git-format-patch[1].
1535
1536format.headers::
1537        Additional email headers to include in a patch to be submitted
1538        by mail.  See linkgit:git-format-patch[1].
1539
1540format.to::
1541format.cc::
1542        Additional recipients to include in a patch to be submitted
1543        by mail.  See the --to and --cc options in
1544        linkgit:git-format-patch[1].
1545
1546format.subjectPrefix::
1547        The default for format-patch is to output files with the '[PATCH]'
1548        subject prefix. Use this variable to change that prefix.
1549
1550format.signature::
1551        The default for format-patch is to output a signature containing
1552        the Git version number. Use this variable to change that default.
1553        Set this variable to the empty string ("") to suppress
1554        signature generation.
1555
1556format.signatureFile::
1557        Works just like format.signature except the contents of the
1558        file specified by this variable will be used as the signature.
1559
1560format.suffix::
1561        The default for format-patch is to output files with the suffix
1562        `.patch`. Use this variable to change that suffix (make sure to
1563        include the dot if you want it).
1564
1565format.pretty::
1566        The default pretty format for log/show/whatchanged command,
1567        See linkgit:git-log[1], linkgit:git-show[1],
1568        linkgit:git-whatchanged[1].
1569
1570format.thread::
1571        The default threading style for 'git format-patch'.  Can be
1572        a boolean value, or `shallow` or `deep`.  `shallow` threading
1573        makes every mail a reply to the head of the series,
1574        where the head is chosen from the cover letter, the
1575        `--in-reply-to`, and the first patch mail, in this order.
1576        `deep` threading makes every mail a reply to the previous one.
1577        A true boolean value is the same as `shallow`, and a false
1578        value disables threading.
1579
1580format.signOff::
1581        A boolean value which lets you enable the `-s/--signoff` option of
1582        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1583        patch should be a conscious act and means that you certify you have
1584        the rights to submit this work under the same open source license.
1585        Please see the 'SubmittingPatches' document for further discussion.
1586
1587format.coverLetter::
1588        A boolean that controls whether to generate a cover-letter when
1589        format-patch is invoked, but in addition can be set to "auto", to
1590        generate a cover-letter only when there's more than one patch.
1591
1592format.outputDirectory::
1593        Set a custom directory to store the resulting files instead of the
1594        current working directory.
1595
1596format.useAutoBase::
1597        A boolean value which lets you enable the `--base=auto` option of
1598        format-patch by default.
1599
1600filter.<driver>.clean::
1601        The command which is used to convert the content of a worktree
1602        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1603        details.
1604
1605filter.<driver>.smudge::
1606        The command which is used to convert the content of a blob
1607        object to a worktree file upon checkout.  See
1608        linkgit:gitattributes[5] for details.
1609
1610fsck.<msg-id>::
1611        During fsck git may find issues with legacy data which
1612        wouldn't be generated by current versions of git, and which
1613        wouldn't be sent over the wire if `transfer.fsckObjects` was
1614        set. This feature is intended to support working with legacy
1615        repositories containing such data.
1616+
1617Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1618to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1619to clone or fetch it set `fetch.fsck.<msg-id>`.
1620+
1621The rest of the documentation discusses `fsck.*` for brevity, but the
1622same applies for the corresponding `receive.fsck.*` and
1623`fetch.<msg-id>.*`. variables.
1624+
1625Unlike variables like `color.ui` and `core.editor` the
1626`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1627fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1628uniformly configure the same fsck settings in different circumstances
1629all three of them they must all set to the same values.
1630+
1631When `fsck.<msg-id>` is set, errors can be switched to warnings and
1632vice versa by configuring the `fsck.<msg-id>` setting where the
1633`<msg-id>` is the fsck message ID and the value is one of `error`,
1634`warn` or `ignore`. For convenience, fsck prefixes the error/warning
1635with the message ID, e.g. "missingEmail: invalid author/committer line
1636- missing email" means that setting `fsck.missingEmail = ignore` will
1637hide that issue.
1638+
1639In general, it is better to enumerate existing objects with problems
1640with `fsck.skipList`, instead of listing the kind of breakages these
1641problematic objects share to be ignored, as doing the latter will
1642allow new instances of the same breakages go unnoticed.
1643+
1644Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1645doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1646will only cause git to warn.
1647
1648fsck.skipList::
1649        The path to a sorted list of object names (i.e. one SHA-1 per
1650        line) that are known to be broken in a non-fatal way and should
1651        be ignored. This feature is useful when an established project
1652        should be accepted despite early commits containing errors that
1653        can be safely ignored such as invalid committer email addresses.
1654        Note: corrupt objects cannot be skipped with this setting.
1655+
1656Like `fsck.<msg-id>` this variable has corresponding
1657`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1658+
1659Unlike variables like `color.ui` and `core.editor` the
1660`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1661fall back on the `fsck.skipList` configuration if they aren't set. To
1662uniformly configure the same fsck settings in different circumstances
1663all three of them they must all set to the same values.
1664
1665gc.aggressiveDepth::
1666        The depth parameter used in the delta compression
1667        algorithm used by 'git gc --aggressive'.  This defaults
1668        to 50.
1669
1670gc.aggressiveWindow::
1671        The window size parameter used in the delta compression
1672        algorithm used by 'git gc --aggressive'.  This defaults
1673        to 250.
1674
1675gc.auto::
1676        When there are approximately more than this many loose
1677        objects in the repository, `git gc --auto` will pack them.
1678        Some Porcelain commands use this command to perform a
1679        light-weight garbage collection from time to time.  The
1680        default value is 6700.  Setting this to 0 disables it.
1681
1682gc.autoPackLimit::
1683        When there are more than this many packs that are not
1684        marked with `*.keep` file in the repository, `git gc
1685        --auto` consolidates them into one larger pack.  The
1686        default value is 50.  Setting this to 0 disables it.
1687
1688gc.autoDetach::
1689        Make `git gc --auto` return immediately and run in background
1690        if the system supports it. Default is true.
1691
1692gc.bigPackThreshold::
1693        If non-zero, all packs larger than this limit are kept when
1694        `git gc` is run. This is very similar to `--keep-base-pack`
1695        except that all packs that meet the threshold are kept, not
1696        just the base pack. Defaults to zero. Common unit suffixes of
1697        'k', 'm', or 'g' are supported.
1698+
1699Note that if the number of kept packs is more than gc.autoPackLimit,
1700this configuration variable is ignored, all packs except the base pack
1701will be repacked. After this the number of packs should go below
1702gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1703
1704gc.writeCommitGraph::
1705        If true, then gc will rewrite the commit-graph file when
1706        linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1707        '--auto' the commit-graph will be updated if housekeeping is
1708        required. Default is false. See linkgit:git-commit-graph[1]
1709        for details.
1710
1711gc.logExpiry::
1712        If the file gc.log exists, then `git gc --auto` won't run
1713        unless that file is more than 'gc.logExpiry' old.  Default is
1714        "1.day".  See `gc.pruneExpire` for more ways to specify its
1715        value.
1716
1717gc.packRefs::
1718        Running `git pack-refs` in a repository renders it
1719        unclonable by Git versions prior to 1.5.1.2 over dumb
1720        transports such as HTTP.  This variable determines whether
1721        'git gc' runs `git pack-refs`. This can be set to `notbare`
1722        to enable it within all non-bare repos or it can be set to a
1723        boolean value.  The default is `true`.
1724
1725gc.pruneExpire::
1726        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1727        Override the grace period with this config variable.  The value
1728        "now" may be used to disable this grace period and always prune
1729        unreachable objects immediately, or "never" may be used to
1730        suppress pruning.  This feature helps prevent corruption when
1731        'git gc' runs concurrently with another process writing to the
1732        repository; see the "NOTES" section of linkgit:git-gc[1].
1733
1734gc.worktreePruneExpire::
1735        When 'git gc' is run, it calls
1736        'git worktree prune --expire 3.months.ago'.
1737        This config variable can be used to set a different grace
1738        period. The value "now" may be used to disable the grace
1739        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1740        may be used to suppress pruning.
1741
1742gc.reflogExpire::
1743gc.<pattern>.reflogExpire::
1744        'git reflog expire' removes reflog entries older than
1745        this time; defaults to 90 days. The value "now" expires all
1746        entries immediately, and "never" suppresses expiration
1747        altogether. With "<pattern>" (e.g.
1748        "refs/stash") in the middle the setting applies only to
1749        the refs that match the <pattern>.
1750
1751gc.reflogExpireUnreachable::
1752gc.<pattern>.reflogExpireUnreachable::
1753        'git reflog expire' removes reflog entries older than
1754        this time and are not reachable from the current tip;
1755        defaults to 30 days. The value "now" expires all entries
1756        immediately, and "never" suppresses expiration altogether.
1757        With "<pattern>" (e.g. "refs/stash")
1758        in the middle, the setting applies only to the refs that
1759        match the <pattern>.
1760
1761gc.rerereResolved::
1762        Records of conflicted merge you resolved earlier are
1763        kept for this many days when 'git rerere gc' is run.
1764        You can also use more human-readable "1.month.ago", etc.
1765        The default is 60 days.  See linkgit:git-rerere[1].
1766
1767gc.rerereUnresolved::
1768        Records of conflicted merge you have not resolved are
1769        kept for this many days when 'git rerere gc' is run.
1770        You can also use more human-readable "1.month.ago", etc.
1771        The default is 15 days.  See linkgit:git-rerere[1].
1772
1773gitcvs.commitMsgAnnotation::
1774        Append this string to each commit message. Set to empty string
1775        to disable this feature. Defaults to "via git-CVS emulator".
1776
1777gitcvs.enabled::
1778        Whether the CVS server interface is enabled for this repository.
1779        See linkgit:git-cvsserver[1].
1780
1781gitcvs.logFile::
1782        Path to a log file where the CVS server interface well... logs
1783        various stuff. See linkgit:git-cvsserver[1].
1784
1785gitcvs.usecrlfattr::
1786        If true, the server will look up the end-of-line conversion
1787        attributes for files to determine the `-k` modes to use. If
1788        the attributes force Git to treat a file as text,
1789        the `-k` mode will be left blank so CVS clients will
1790        treat it as text. If they suppress text conversion, the file
1791        will be set with '-kb' mode, which suppresses any newline munging
1792        the client might otherwise do. If the attributes do not allow
1793        the file type to be determined, then `gitcvs.allBinary` is
1794        used. See linkgit:gitattributes[5].
1795
1796gitcvs.allBinary::
1797        This is used if `gitcvs.usecrlfattr` does not resolve
1798        the correct '-kb' mode to use. If true, all
1799        unresolved files are sent to the client in
1800        mode '-kb'. This causes the client to treat them
1801        as binary files, which suppresses any newline munging it
1802        otherwise might do. Alternatively, if it is set to "guess",
1803        then the contents of the file are examined to decide if
1804        it is binary, similar to `core.autocrlf`.
1805
1806gitcvs.dbName::
1807        Database used by git-cvsserver to cache revision information
1808        derived from the Git repository. The exact meaning depends on the
1809        used database driver, for SQLite (which is the default driver) this
1810        is a filename. Supports variable substitution (see
1811        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1812        Default: '%Ggitcvs.%m.sqlite'
1813
1814gitcvs.dbDriver::
1815        Used Perl DBI driver. You can specify any available driver
1816        for this here, but it might not work. git-cvsserver is tested
1817        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1818        reported *not* to work with 'DBD::mysql'. Experimental feature.
1819        May not contain double colons (`:`). Default: 'SQLite'.
1820        See linkgit:git-cvsserver[1].
1821
1822gitcvs.dbUser, gitcvs.dbPass::
1823        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1824        since SQLite has no concept of database users and/or passwords.
1825        'gitcvs.dbUser' supports variable substitution (see
1826        linkgit:git-cvsserver[1] for details).
1827
1828gitcvs.dbTableNamePrefix::
1829        Database table name prefix.  Prepended to the names of any
1830        database tables used, allowing a single database to be used
1831        for several repositories.  Supports variable substitution (see
1832        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1833        characters will be replaced with underscores.
1834
1835All gitcvs variables except for `gitcvs.usecrlfattr` and
1836`gitcvs.allBinary` can also be specified as
1837'gitcvs.<access_method>.<varname>' (where 'access_method'
1838is one of "ext" and "pserver") to make them apply only for the given
1839access method.
1840
1841gitweb.category::
1842gitweb.description::
1843gitweb.owner::
1844gitweb.url::
1845        See linkgit:gitweb[1] for description.
1846
1847gitweb.avatar::
1848gitweb.blame::
1849gitweb.grep::
1850gitweb.highlight::
1851gitweb.patches::
1852gitweb.pickaxe::
1853gitweb.remote_heads::
1854gitweb.showSizes::
1855gitweb.snapshot::
1856        See linkgit:gitweb.conf[5] for description.
1857
1858grep.lineNumber::
1859        If set to true, enable `-n` option by default.
1860
1861grep.column::
1862        If set to true, enable the `--column` option by default.
1863
1864grep.patternType::
1865        Set the default matching behavior. Using a value of 'basic', 'extended',
1866        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1867        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1868        value 'default' will return to the default matching behavior.
1869
1870grep.extendedRegexp::
1871        If set to true, enable `--extended-regexp` option by default. This
1872        option is ignored when the `grep.patternType` option is set to a value
1873        other than 'default'.
1874
1875grep.threads::
1876        Number of grep worker threads to use.
1877        See `grep.threads` in linkgit:git-grep[1] for more information.
1878
1879grep.fallbackToNoIndex::
1880        If set to true, fall back to git grep --no-index if git grep
1881        is executed outside of a git repository.  Defaults to false.
1882
1883gpg.program::
1884        Use this custom program instead of "`gpg`" found on `$PATH` when
1885        making or verifying a PGP signature. The program must support the
1886        same command-line interface as GPG, namely, to verify a detached
1887        signature, "`gpg --verify $file - <$signature`" is run, and the
1888        program is expected to signal a good signature by exiting with
1889        code 0, and to generate an ASCII-armored detached signature, the
1890        standard input of "`gpg -bsau $key`" is fed with the contents to be
1891        signed, and the program is expected to send the result to its
1892        standard output.
1893
1894gpg.format::
1895        Specifies which key format to use when signing with `--gpg-sign`.
1896        Default is "openpgp" and another possible value is "x509".
1897
1898gpg.<format>.program::
1899        Use this to customize the program used for the signing format you
1900        chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1901        be used as a legacy synonym for `gpg.openpgp.program`. The default
1902        value for `gpg.x509.program` is "gpgsm".
1903
1904gui.commitMsgWidth::
1905        Defines how wide the commit message window is in the
1906        linkgit:git-gui[1]. "75" is the default.
1907
1908gui.diffContext::
1909        Specifies how many context lines should be used in calls to diff
1910        made by the linkgit:git-gui[1]. The default is "5".
1911
1912gui.displayUntracked::
1913        Determines if linkgit:git-gui[1] shows untracked files
1914        in the file list. The default is "true".
1915
1916gui.encoding::
1917        Specifies the default encoding to use for displaying of
1918        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1919        It can be overridden by setting the 'encoding' attribute
1920        for relevant files (see linkgit:gitattributes[5]).
1921        If this option is not set, the tools default to the
1922        locale encoding.
1923
1924gui.matchTrackingBranch::
1925        Determines if new branches created with linkgit:git-gui[1] should
1926        default to tracking remote branches with matching names or
1927        not. Default: "false".
1928
1929gui.newBranchTemplate::
1930        Is used as suggested name when creating new branches using the
1931        linkgit:git-gui[1].
1932
1933gui.pruneDuringFetch::
1934        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1935        performing a fetch. The default value is "false".
1936
1937gui.trustmtime::
1938        Determines if linkgit:git-gui[1] should trust the file modification
1939        timestamp or not. By default the timestamps are not trusted.
1940
1941gui.spellingDictionary::
1942        Specifies the dictionary used for spell checking commit messages in
1943        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1944        off.
1945
1946gui.fastCopyBlame::
1947        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1948        location detection. It makes blame significantly faster on huge
1949        repositories at the expense of less thorough copy detection.
1950
1951gui.copyBlameThreshold::
1952        Specifies the threshold to use in 'git gui blame' original location
1953        detection, measured in alphanumeric characters. See the
1954        linkgit:git-blame[1] manual for more information on copy detection.
1955
1956gui.blamehistoryctx::
1957        Specifies the radius of history context in days to show in
1958        linkgit:gitk[1] for the selected commit, when the `Show History
1959        Context` menu item is invoked from 'git gui blame'. If this
1960        variable is set to zero, the whole history is shown.
1961
1962guitool.<name>.cmd::
1963        Specifies the shell command line to execute when the corresponding item
1964        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1965        mandatory for every tool. The command is executed from the root of
1966        the working directory, and in the environment it receives the name of
1967        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1968        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1969        the head is detached, 'CUR_BRANCH' is empty).
1970
1971guitool.<name>.needsFile::
1972        Run the tool only if a diff is selected in the GUI. It guarantees
1973        that 'FILENAME' is not empty.
1974
1975guitool.<name>.noConsole::
1976        Run the command silently, without creating a window to display its
1977        output.
1978
1979guitool.<name>.noRescan::
1980        Don't rescan the working directory for changes after the tool
1981        finishes execution.
1982
1983guitool.<name>.confirm::
1984        Show a confirmation dialog before actually running the tool.
1985
1986guitool.<name>.argPrompt::
1987        Request a string argument from the user, and pass it to the tool
1988        through the `ARGS` environment variable. Since requesting an
1989        argument implies confirmation, the 'confirm' option has no effect
1990        if this is enabled. If the option is set to 'true', 'yes', or '1',
1991        the dialog uses a built-in generic prompt; otherwise the exact
1992        value of the variable is used.
1993
1994guitool.<name>.revPrompt::
1995        Request a single valid revision from the user, and set the
1996        `REVISION` environment variable. In other aspects this option
1997        is similar to 'argPrompt', and can be used together with it.
1998
1999guitool.<name>.revUnmerged::
2000        Show only unmerged branches in the 'revPrompt' subdialog.
2001        This is useful for tools similar to merge or rebase, but not
2002        for things like checkout or reset.
2003
2004guitool.<name>.title::
2005        Specifies the title to use for the prompt dialog. The default
2006        is the tool name.
2007
2008guitool.<name>.prompt::
2009        Specifies the general prompt string to display at the top of
2010        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2011        The default value includes the actual command.
2012
2013help.browser::
2014        Specify the browser that will be used to display help in the
2015        'web' format. See linkgit:git-help[1].
2016
2017help.format::
2018        Override the default help format used by linkgit:git-help[1].
2019        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2020        the default. 'web' and 'html' are the same.
2021
2022help.autoCorrect::
2023        Automatically correct and execute mistyped commands after
2024        waiting for the given number of deciseconds (0.1 sec). If more
2025        than one command can be deduced from the entered text, nothing
2026        will be executed.  If the value of this option is negative,
2027        the corrected command will be executed immediately. If the
2028        value is 0 - the command will be just shown but not executed.
2029        This is the default.
2030
2031help.htmlPath::
2032        Specify the path where the HTML documentation resides. File system paths
2033        and URLs are supported. HTML pages will be prefixed with this path when
2034        help is displayed in the 'web' format. This defaults to the documentation
2035        path of your Git installation.
2036
2037http.proxy::
2038        Override the HTTP proxy, normally configured using the 'http_proxy',
2039        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2040        addition to the syntax understood by curl, it is possible to specify a
2041        proxy string with a user name but no password, in which case git will
2042        attempt to acquire one in the same way it does for other credentials. See
2043        linkgit:gitcredentials[7] for more information. The syntax thus is
2044        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2045        on a per-remote basis; see remote.<name>.proxy
2046
2047http.proxyAuthMethod::
2048        Set the method with which to authenticate against the HTTP proxy. This
2049        only takes effect if the configured proxy string contains a user name part
2050        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2051        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2052        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2053        variable.  Possible values are:
2054+
2055--
2056* `anyauth` - Automatically pick a suitable authentication method. It is
2057  assumed that the proxy answers an unauthenticated request with a 407
2058  status code and one or more Proxy-authenticate headers with supported
2059  authentication methods. This is the default.
2060* `basic` - HTTP Basic authentication
2061* `digest` - HTTP Digest authentication; this prevents the password from being
2062  transmitted to the proxy in clear text
2063* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2064  of `curl(1)`)
2065* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2066--
2067
2068http.emptyAuth::
2069        Attempt authentication without seeking a username or password.  This
2070        can be used to attempt GSS-Negotiate authentication without specifying
2071        a username in the URL, as libcurl normally requires a username for
2072        authentication.
2073
2074http.delegation::
2075        Control GSSAPI credential delegation. The delegation is disabled
2076        by default in libcurl since version 7.21.7. Set parameter to tell
2077        the server what it is allowed to delegate when it comes to user
2078        credentials. Used with GSS/kerberos. Possible values are:
2079+
2080--
2081* `none` - Don't allow any delegation.
2082* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2083  Kerberos service ticket, which is a matter of realm policy.
2084* `always` - Unconditionally allow the server to delegate.
2085--
2086
2087
2088http.extraHeader::
2089        Pass an additional HTTP header when communicating with a server.  If
2090        more than one such entry exists, all of them are added as extra
2091        headers.  To allow overriding the settings inherited from the system
2092        config, an empty value will reset the extra headers to the empty list.
2093
2094http.cookieFile::
2095        The pathname of a file containing previously stored cookie lines,
2096        which should be used
2097        in the Git http session, if they match the server. The file format
2098        of the file to read cookies from should be plain HTTP headers or
2099        the Netscape/Mozilla cookie file format (see `curl(1)`).
2100        NOTE that the file specified with http.cookieFile is used only as
2101        input unless http.saveCookies is set.
2102
2103http.saveCookies::
2104        If set, store cookies received during requests to the file specified by
2105        http.cookieFile. Has no effect if http.cookieFile is unset.
2106
2107http.sslVersion::
2108        The SSL version to use when negotiating an SSL connection, if you
2109        want to force the default.  The available and default version
2110        depend on whether libcurl was built against NSS or OpenSSL and the
2111        particular configuration of the crypto library in use. Internally
2112        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2113        documentation for more details on the format of this option and
2114        for the ssl version supported. Actually the possible values of
2115        this option are:
2116
2117        - sslv2
2118        - sslv3
2119        - tlsv1
2120        - tlsv1.0
2121        - tlsv1.1
2122        - tlsv1.2
2123        - tlsv1.3
2124
2125+
2126Can be overridden by the `GIT_SSL_VERSION` environment variable.
2127To force git to use libcurl's default ssl version and ignore any
2128explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2129empty string.
2130
2131http.sslCipherList::
2132  A list of SSL ciphers to use when negotiating an SSL connection.
2133  The available ciphers depend on whether libcurl was built against
2134  NSS or OpenSSL and the particular configuration of the crypto
2135  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2136  option; see the libcurl documentation for more details on the format
2137  of this list.
2138+
2139Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2140To force git to use libcurl's default cipher list and ignore any
2141explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2142empty string.
2143
2144http.sslVerify::
2145        Whether to verify the SSL certificate when fetching or pushing
2146        over HTTPS. Defaults to true. Can be overridden by the
2147        `GIT_SSL_NO_VERIFY` environment variable.
2148
2149http.sslCert::
2150        File containing the SSL certificate when fetching or pushing
2151        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2152        variable.
2153
2154http.sslKey::
2155        File containing the SSL private key when fetching or pushing
2156        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2157        variable.
2158
2159http.sslCertPasswordProtected::
2160        Enable Git's password prompt for the SSL certificate.  Otherwise
2161        OpenSSL will prompt the user, possibly many times, if the
2162        certificate or private key is encrypted.  Can be overridden by the
2163        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2164
2165http.sslCAInfo::
2166        File containing the certificates to verify the peer with when
2167        fetching or pushing over HTTPS. Can be overridden by the
2168        `GIT_SSL_CAINFO` environment variable.
2169
2170http.sslCAPath::
2171        Path containing files with the CA certificates to verify the peer
2172        with when fetching or pushing over HTTPS. Can be overridden
2173        by the `GIT_SSL_CAPATH` environment variable.
2174
2175http.pinnedpubkey::
2176        Public key of the https service. It may either be the filename of
2177        a PEM or DER encoded public key file or a string starting with
2178        'sha256//' followed by the base64 encoded sha256 hash of the
2179        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2180        exit with an error if this option is set but not supported by
2181        cURL.
2182
2183http.sslTry::
2184        Attempt to use AUTH SSL/TLS and encrypted data transfers
2185        when connecting via regular FTP protocol. This might be needed
2186        if the FTP server requires it for security reasons or you wish
2187        to connect securely whenever remote FTP server supports it.
2188        Default is false since it might trigger certificate verification
2189        errors on misconfigured servers.
2190
2191http.maxRequests::
2192        How many HTTP requests to launch in parallel. Can be overridden
2193        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2194
2195http.minSessions::
2196        The number of curl sessions (counted across slots) to be kept across
2197        requests. They will not be ended with curl_easy_cleanup() until
2198        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2199        value will be capped at 1. Defaults to 1.
2200
2201http.postBuffer::
2202        Maximum size in bytes of the buffer used by smart HTTP
2203        transports when POSTing data to the remote system.
2204        For requests larger than this buffer size, HTTP/1.1 and
2205        Transfer-Encoding: chunked is used to avoid creating a
2206        massive pack file locally.  Default is 1 MiB, which is
2207        sufficient for most requests.
2208
2209http.lowSpeedLimit, http.lowSpeedTime::
2210        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2211        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2212        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2213        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2214
2215http.noEPSV::
2216        A boolean which disables using of EPSV ftp command by curl.
2217        This can helpful with some "poor" ftp servers which don't
2218        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2219        environment variable. Default is false (curl will use EPSV).
2220
2221http.userAgent::
2222        The HTTP USER_AGENT string presented to an HTTP server.  The default
2223        value represents the version of the client Git such as git/1.7.1.
2224        This option allows you to override this value to a more common value
2225        such as Mozilla/4.0.  This may be necessary, for instance, if
2226        connecting through a firewall that restricts HTTP connections to a set
2227        of common USER_AGENT strings (but not including those like git/1.7.1).
2228        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2229
2230http.followRedirects::
2231        Whether git should follow HTTP redirects. If set to `true`, git
2232        will transparently follow any redirect issued by a server it
2233        encounters. If set to `false`, git will treat all redirects as
2234        errors. If set to `initial`, git will follow redirects only for
2235        the initial request to a remote, but not for subsequent
2236        follow-up HTTP requests. Since git uses the redirected URL as
2237        the base for the follow-up requests, this is generally
2238        sufficient. The default is `initial`.
2239
2240http.<url>.*::
2241        Any of the http.* options above can be applied selectively to some URLs.
2242        For a config key to match a URL, each element of the config key is
2243        compared to that of the URL, in the following order:
2244+
2245--
2246. Scheme (e.g., `https` in `https://example.com/`). This field
2247  must match exactly between the config key and the URL.
2248
2249. Host/domain name (e.g., `example.com` in `https://example.com/`).
2250  This field must match between the config key and the URL. It is
2251  possible to specify a `*` as part of the host name to match all subdomains
2252  at this level. `https://*.example.com/` for example would match
2253  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2254
2255. Port number (e.g., `8080` in `http://example.com:8080/`).
2256  This field must match exactly between the config key and the URL.
2257  Omitted port numbers are automatically converted to the correct
2258  default for the scheme before matching.
2259
2260. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2261  path field of the config key must match the path field of the URL
2262  either exactly or as a prefix of slash-delimited path elements.  This means
2263  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2264  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2265  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2266  key with just path `foo/`).
2267
2268. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2269  the config key has a user name it must match the user name in the
2270  URL exactly. If the config key does not have a user name, that
2271  config key will match a URL with any user name (including none),
2272  but at a lower precedence than a config key with a user name.
2273--
2274+
2275The list above is ordered by decreasing precedence; a URL that matches
2276a config key's path is preferred to one that matches its user name. For example,
2277if the URL is `https://user@example.com/foo/bar` a config key match of
2278`https://example.com/foo` will be preferred over a config key match of
2279`https://user@example.com`.
2280+
2281All URLs are normalized before attempting any matching (the password part,
2282if embedded in the URL, is always ignored for matching purposes) so that
2283equivalent URLs that are simply spelled differently will match properly.
2284Environment variable settings always override any matches.  The URLs that are
2285matched against are those given directly to Git commands.  This means any URLs
2286visited as a result of a redirection do not participate in matching.
2287
2288ssh.variant::
2289        By default, Git determines the command line arguments to use
2290        based on the basename of the configured SSH command (configured
2291        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2292        the config setting `core.sshCommand`). If the basename is
2293        unrecognized, Git will attempt to detect support of OpenSSH
2294        options by first invoking the configured SSH command with the
2295        `-G` (print configuration) option and will subsequently use
2296        OpenSSH options (if that is successful) or no options besides
2297        the host and remote command (if it fails).
2298+
2299The config variable `ssh.variant` can be set to override this detection.
2300Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2301`tortoiseplink`, `simple` (no options except the host and remote command).
2302The default auto-detection can be explicitly requested using the value
2303`auto`.  Any other value is treated as `ssh`.  This setting can also be
2304overridden via the environment variable `GIT_SSH_VARIANT`.
2305+
2306The current command-line parameters used for each variant are as
2307follows:
2308+
2309--
2310
2311* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2312
2313* `simple` - [username@]host command
2314
2315* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2316
2317* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2318
2319--
2320+
2321Except for the `simple` variant, command-line parameters are likely to
2322change as git gains new features.
2323
2324i18n.commitEncoding::
2325        Character encoding the commit messages are stored in; Git itself
2326        does not care per se, but this information is necessary e.g. when
2327        importing commits from emails or in the gitk graphical history
2328        browser (and possibly at other places in the future or in other
2329        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2330
2331i18n.logOutputEncoding::
2332        Character encoding the commit messages are converted to when
2333        running 'git log' and friends.
2334
2335imap::
2336        The configuration variables in the 'imap' section are described
2337        in linkgit:git-imap-send[1].
2338
2339index.version::
2340        Specify the version with which new index files should be
2341        initialized.  This does not affect existing repositories.
2342
2343init.templateDir::
2344        Specify the directory from which templates will be copied.
2345        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2346
2347instaweb.browser::
2348        Specify the program that will be used to browse your working
2349        repository in gitweb. See linkgit:git-instaweb[1].
2350
2351instaweb.httpd::
2352        The HTTP daemon command-line to start gitweb on your working
2353        repository. See linkgit:git-instaweb[1].
2354
2355instaweb.local::
2356        If true the web server started by linkgit:git-instaweb[1] will
2357        be bound to the local IP (127.0.0.1).
2358
2359instaweb.modulePath::
2360        The default module path for linkgit:git-instaweb[1] to use
2361        instead of /usr/lib/apache2/modules.  Only used if httpd
2362        is Apache.
2363
2364instaweb.port::
2365        The port number to bind the gitweb httpd to. See
2366        linkgit:git-instaweb[1].
2367
2368interactive.singleKey::
2369        In interactive commands, allow the user to provide one-letter
2370        input with a single key (i.e., without hitting enter).
2371        Currently this is used by the `--patch` mode of
2372        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2373        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2374        setting is silently ignored if portable keystroke input
2375        is not available; requires the Perl module Term::ReadKey.
2376
2377interactive.diffFilter::
2378        When an interactive command (such as `git add --patch`) shows
2379        a colorized diff, git will pipe the diff through the shell
2380        command defined by this configuration variable. The command may
2381        mark up the diff further for human consumption, provided that it
2382        retains a one-to-one correspondence with the lines in the
2383        original diff. Defaults to disabled (no filtering).
2384
2385log.abbrevCommit::
2386        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2387        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2388        override this option with `--no-abbrev-commit`.
2389
2390log.date::
2391        Set the default date-time mode for the 'log' command.
2392        Setting a value for log.date is similar to using 'git log''s
2393        `--date` option.  See linkgit:git-log[1] for details.
2394
2395log.decorate::
2396        Print out the ref names of any commits that are shown by the log
2397        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2398        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2399        specified, the full ref name (including prefix) will be printed.
2400        If 'auto' is specified, then if the output is going to a terminal,
2401        the ref names are shown as if 'short' were given, otherwise no ref
2402        names are shown. This is the same as the `--decorate` option
2403        of the `git log`.
2404
2405log.follow::
2406        If `true`, `git log` will act as if the `--follow` option was used when
2407        a single <path> is given.  This has the same limitations as `--follow`,
2408        i.e. it cannot be used to follow multiple files and does not work well
2409        on non-linear history.
2410
2411log.graphColors::
2412        A list of colors, separated by commas, that can be used to draw
2413        history lines in `git log --graph`.
2414
2415log.showRoot::
2416        If true, the initial commit will be shown as a big creation event.
2417        This is equivalent to a diff against an empty tree.
2418        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2419        normally hide the root commit will now show it. True by default.
2420
2421log.showSignature::
2422        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2423        linkgit:git-whatchanged[1] assume `--show-signature`.
2424
2425log.mailmap::
2426        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2427        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2428
2429mailinfo.scissors::
2430        If true, makes linkgit:git-mailinfo[1] (and therefore
2431        linkgit:git-am[1]) act by default as if the --scissors option
2432        was provided on the command-line. When active, this features
2433        removes everything from the message body before a scissors
2434        line (i.e. consisting mainly of ">8", "8<" and "-").
2435
2436mailmap.file::
2437        The location of an augmenting mailmap file. The default
2438        mailmap, located in the root of the repository, is loaded
2439        first, then the mailmap file pointed to by this variable.
2440        The location of the mailmap file may be in a repository
2441        subdirectory, or somewhere outside of the repository itself.
2442        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2443
2444mailmap.blob::
2445        Like `mailmap.file`, but consider the value as a reference to a
2446        blob in the repository. If both `mailmap.file` and
2447        `mailmap.blob` are given, both are parsed, with entries from
2448        `mailmap.file` taking precedence. In a bare repository, this
2449        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2450        defaults to empty.
2451
2452man.viewer::
2453        Specify the programs that may be used to display help in the
2454        'man' format. See linkgit:git-help[1].
2455
2456man.<tool>.cmd::
2457        Specify the command to invoke the specified man viewer. The
2458        specified command is evaluated in shell with the man page
2459        passed as argument. (See linkgit:git-help[1].)
2460
2461man.<tool>.path::
2462        Override the path for the given tool that may be used to
2463        display help in the 'man' format. See linkgit:git-help[1].
2464
2465include::merge-config.txt[]
2466
2467mergetool.<tool>.path::
2468        Override the path for the given tool.  This is useful in case
2469        your tool is not in the PATH.
2470
2471mergetool.<tool>.cmd::
2472        Specify the command to invoke the specified merge tool.  The
2473        specified command is evaluated in shell with the following
2474        variables available: 'BASE' is the name of a temporary file
2475        containing the common base of the files to be merged, if available;
2476        'LOCAL' is the name of a temporary file containing the contents of
2477        the file on the current branch; 'REMOTE' is the name of a temporary
2478        file containing the contents of the file from the branch being
2479        merged; 'MERGED' contains the name of the file to which the merge
2480        tool should write the results of a successful merge.
2481
2482mergetool.<tool>.trustExitCode::
2483        For a custom merge command, specify whether the exit code of
2484        the merge command can be used to determine whether the merge was
2485        successful.  If this is not set to true then the merge target file
2486        timestamp is checked and the merge assumed to have been successful
2487        if the file has been updated, otherwise the user is prompted to
2488        indicate the success of the merge.
2489
2490mergetool.meld.hasOutput::
2491        Older versions of `meld` do not support the `--output` option.
2492        Git will attempt to detect whether `meld` supports `--output`
2493        by inspecting the output of `meld --help`.  Configuring
2494        `mergetool.meld.hasOutput` will make Git skip these checks and
2495        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2496        to `true` tells Git to unconditionally use the `--output` option,
2497        and `false` avoids using `--output`.
2498
2499mergetool.keepBackup::
2500        After performing a merge, the original file with conflict markers
2501        can be saved as a file with a `.orig` extension.  If this variable
2502        is set to `false` then this file is not preserved.  Defaults to
2503        `true` (i.e. keep the backup files).
2504
2505mergetool.keepTemporaries::
2506        When invoking a custom merge tool, Git uses a set of temporary
2507        files to pass to the tool. If the tool returns an error and this
2508        variable is set to `true`, then these temporary files will be
2509        preserved, otherwise they will be removed after the tool has
2510        exited. Defaults to `false`.
2511
2512mergetool.writeToTemp::
2513        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2514        conflicting files in the worktree by default.  Git will attempt
2515        to use a temporary directory for these files when set `true`.
2516        Defaults to `false`.
2517
2518mergetool.prompt::
2519        Prompt before each invocation of the merge resolution program.
2520
2521notes.mergeStrategy::
2522        Which merge strategy to choose by default when resolving notes
2523        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2524        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2525        section of linkgit:git-notes[1] for more information on each strategy.
2526
2527notes.<name>.mergeStrategy::
2528        Which merge strategy to choose when doing a notes merge into
2529        refs/notes/<name>.  This overrides the more general
2530        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2531        linkgit:git-notes[1] for more information on the available strategies.
2532
2533notes.displayRef::
2534        The (fully qualified) refname from which to show notes when
2535        showing commit messages.  The value of this variable can be set
2536        to a glob, in which case notes from all matching refs will be
2537        shown.  You may also specify this configuration variable
2538        several times.  A warning will be issued for refs that do not
2539        exist, but a glob that does not match any refs is silently
2540        ignored.
2541+
2542This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2543environment variable, which must be a colon separated list of refs or
2544globs.
2545+
2546The effective value of "core.notesRef" (possibly overridden by
2547GIT_NOTES_REF) is also implicitly added to the list of refs to be
2548displayed.
2549
2550notes.rewrite.<command>::
2551        When rewriting commits with <command> (currently `amend` or
2552        `rebase`) and this variable is set to `true`, Git
2553        automatically copies your notes from the original to the
2554        rewritten commit.  Defaults to `true`, but see
2555        "notes.rewriteRef" below.
2556
2557notes.rewriteMode::
2558        When copying notes during a rewrite (see the
2559        "notes.rewrite.<command>" option), determines what to do if
2560        the target commit already has a note.  Must be one of
2561        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2562        Defaults to `concatenate`.
2563+
2564This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2565environment variable.
2566
2567notes.rewriteRef::
2568        When copying notes during a rewrite, specifies the (fully
2569        qualified) ref whose notes should be copied.  The ref may be a
2570        glob, in which case notes in all matching refs will be copied.
2571        You may also specify this configuration several times.
2572+
2573Does not have a default value; you must configure this variable to
2574enable note rewriting.  Set it to `refs/notes/commits` to enable
2575rewriting for the default commit notes.
2576+
2577This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2578environment variable, which must be a colon separated list of refs or
2579globs.
2580
2581pack.window::
2582        The size of the window used by linkgit:git-pack-objects[1] when no
2583        window size is given on the command line. Defaults to 10.
2584
2585pack.depth::
2586        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2587        maximum depth is given on the command line. Defaults to 50.
2588        Maximum value is 4095.
2589
2590pack.windowMemory::
2591        The maximum size of memory that is consumed by each thread
2592        in linkgit:git-pack-objects[1] for pack window memory when
2593        no limit is given on the command line.  The value can be
2594        suffixed with "k", "m", or "g".  When left unconfigured (or
2595        set explicitly to 0), there will be no limit.
2596
2597pack.compression::
2598        An integer -1..9, indicating the compression level for objects
2599        in a pack file. -1 is the zlib default. 0 means no
2600        compression, and 1..9 are various speed/size tradeoffs, 9 being
2601        slowest.  If not set,  defaults to core.compression.  If that is
2602        not set,  defaults to -1, the zlib default, which is "a default
2603        compromise between speed and compression (currently equivalent
2604        to level 6)."
2605+
2606Note that changing the compression level will not automatically recompress
2607all existing objects. You can force recompression by passing the -F option
2608to linkgit:git-repack[1].
2609
2610pack.deltaCacheSize::
2611        The maximum memory in bytes used for caching deltas in
2612        linkgit:git-pack-objects[1] before writing them out to a pack.
2613        This cache is used to speed up the writing object phase by not
2614        having to recompute the final delta result once the best match
2615        for all objects is found.  Repacking large repositories on machines
2616        which are tight with memory might be badly impacted by this though,
2617        especially if this cache pushes the system into swapping.
2618        A value of 0 means no limit. The smallest size of 1 byte may be
2619        used to virtually disable this cache. Defaults to 256 MiB.
2620
2621pack.deltaCacheLimit::
2622        The maximum size of a delta, that is cached in
2623        linkgit:git-pack-objects[1]. This cache is used to speed up the
2624        writing object phase by not having to recompute the final delta
2625        result once the best match for all objects is found.
2626        Defaults to 1000. Maximum value is 65535.
2627
2628pack.threads::
2629        Specifies the number of threads to spawn when searching for best
2630        delta matches.  This requires that linkgit:git-pack-objects[1]
2631        be compiled with pthreads otherwise this option is ignored with a
2632        warning. This is meant to reduce packing time on multiprocessor
2633        machines. The required amount of memory for the delta search window
2634        is however multiplied by the number of threads.
2635        Specifying 0 will cause Git to auto-detect the number of CPU's
2636        and set the number of threads accordingly.
2637
2638pack.indexVersion::
2639        Specify the default pack index version.  Valid values are 1 for
2640        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2641        the new pack index with capabilities for packs larger than 4 GB
2642        as well as proper protection against the repacking of corrupted
2643        packs.  Version 2 is the default.  Note that version 2 is enforced
2644        and this config option ignored whenever the corresponding pack is
2645        larger than 2 GB.
2646+
2647If you have an old Git that does not understand the version 2 `*.idx` file,
2648cloning or fetching over a non native protocol (e.g. "http")
2649that will copy both `*.pack` file and corresponding `*.idx` file from the
2650other side may give you a repository that cannot be accessed with your
2651older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2652you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2653the `*.idx` file.
2654
2655pack.packSizeLimit::
2656        The maximum size of a pack.  This setting only affects
2657        packing to a file when repacking, i.e. the git:// protocol
2658        is unaffected.  It can be overridden by the `--max-pack-size`
2659        option of linkgit:git-repack[1].  Reaching this limit results
2660        in the creation of multiple packfiles; which in turn prevents
2661        bitmaps from being created.
2662        The minimum size allowed is limited to 1 MiB.
2663        The default is unlimited.
2664        Common unit suffixes of 'k', 'm', or 'g' are
2665        supported.
2666
2667pack.useBitmaps::
2668        When true, git will use pack bitmaps (if available) when packing
2669        to stdout (e.g., during the server side of a fetch). Defaults to
2670        true. You should not generally need to turn this off unless
2671        you are debugging pack bitmaps.
2672
2673pack.writeBitmaps (deprecated)::
2674        This is a deprecated synonym for `repack.writeBitmaps`.
2675
2676pack.writeBitmapHashCache::
2677        When true, git will include a "hash cache" section in the bitmap
2678        index (if one is written). This cache can be used to feed git's
2679        delta heuristics, potentially leading to better deltas between
2680        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2681        between an older, bitmapped pack and objects that have been
2682        pushed since the last gc). The downside is that it consumes 4
2683        bytes per object of disk space, and that JGit's bitmap
2684        implementation does not understand it, causing it to complain if
2685        Git and JGit are used on the same repository. Defaults to false.
2686
2687pager.<cmd>::
2688        If the value is boolean, turns on or off pagination of the
2689        output of a particular Git subcommand when writing to a tty.
2690        Otherwise, turns on pagination for the subcommand using the
2691        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2692        or `--no-pager` is specified on the command line, it takes
2693        precedence over this option.  To disable pagination for all
2694        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2695
2696pretty.<name>::
2697        Alias for a --pretty= format string, as specified in
2698        linkgit:git-log[1]. Any aliases defined here can be used just
2699        as the built-in pretty formats could. For example,
2700        running `git config pretty.changelog "format:* %H %s"`
2701        would cause the invocation `git log --pretty=changelog`
2702        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2703        Note that an alias with the same name as a built-in format
2704        will be silently ignored.
2705
2706protocol.allow::
2707        If set, provide a user defined default policy for all protocols which
2708        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2709        if unset, known-safe protocols (http, https, git, ssh, file) have a
2710        default policy of `always`, known-dangerous protocols (ext) have a
2711        default policy of `never`, and all other protocols have a default
2712        policy of `user`.  Supported policies:
2713+
2714--
2715
2716* `always` - protocol is always able to be used.
2717
2718* `never` - protocol is never able to be used.
2719
2720* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2721  either unset or has a value of 1.  This policy should be used when you want a
2722  protocol to be directly usable by the user but don't want it used by commands which
2723  execute clone/fetch/push commands without user input, e.g. recursive
2724  submodule initialization.
2725
2726--
2727
2728protocol.<name>.allow::
2729        Set a policy to be used by protocol `<name>` with clone/fetch/push
2730        commands. See `protocol.allow` above for the available policies.
2731+
2732The protocol names currently used by git are:
2733+
2734--
2735  - `file`: any local file-based path (including `file://` URLs,
2736    or local paths)
2737
2738  - `git`: the anonymous git protocol over a direct TCP
2739    connection (or proxy, if configured)
2740
2741  - `ssh`: git over ssh (including `host:path` syntax,
2742    `ssh://`, etc).
2743
2744  - `http`: git over http, both "smart http" and "dumb http".
2745    Note that this does _not_ include `https`; if you want to configure
2746    both, you must do so individually.
2747
2748  - any external helpers are named by their protocol (e.g., use
2749    `hg` to allow the `git-remote-hg` helper)
2750--
2751
2752protocol.version::
2753        Experimental. If set, clients will attempt to communicate with a
2754        server using the specified protocol version.  If unset, no
2755        attempt will be made by the client to communicate using a
2756        particular protocol version, this results in protocol version 0
2757        being used.
2758        Supported versions:
2759+
2760--
2761
2762* `0` - the original wire protocol.
2763
2764* `1` - the original wire protocol with the addition of a version string
2765  in the initial response from the server.
2766
2767--
2768
2769pull.ff::
2770        By default, Git does not create an extra merge commit when merging
2771        a commit that is a descendant of the current commit. Instead, the
2772        tip of the current branch is fast-forwarded. When set to `false`,
2773        this variable tells Git to create an extra merge commit in such
2774        a case (equivalent to giving the `--no-ff` option from the command
2775        line). When set to `only`, only such fast-forward merges are
2776        allowed (equivalent to giving the `--ff-only` option from the
2777        command line). This setting overrides `merge.ff` when pulling.
2778
2779pull.rebase::
2780        When true, rebase branches on top of the fetched branch, instead
2781        of merging the default branch from the default remote when "git
2782        pull" is run. See "branch.<name>.rebase" for setting this on a
2783        per-branch basis.
2784+
2785When `merges`, pass the `--rebase-merges` option to 'git rebase'
2786so that the local merge commits are included in the rebase (see
2787linkgit:git-rebase[1] for details).
2788+
2789When preserve, also pass `--preserve-merges` along to 'git rebase'
2790so that locally committed merge commits will not be flattened
2791by running 'git pull'.
2792+
2793When the value is `interactive`, the rebase is run in interactive mode.
2794+
2795*NOTE*: this is a possibly dangerous operation; do *not* use
2796it unless you understand the implications (see linkgit:git-rebase[1]
2797for details).
2798
2799pull.octopus::
2800        The default merge strategy to use when pulling multiple branches
2801        at once.
2802
2803pull.twohead::
2804        The default merge strategy to use when pulling a single branch.
2805
2806push.default::
2807        Defines the action `git push` should take if no refspec is
2808        explicitly given.  Different values are well-suited for
2809        specific workflows; for instance, in a purely central workflow
2810        (i.e. the fetch source is equal to the push destination),
2811        `upstream` is probably what you want.  Possible values are:
2812+
2813--
2814
2815* `nothing` - do not push anything (error out) unless a refspec is
2816  explicitly given. This is primarily meant for people who want to
2817  avoid mistakes by always being explicit.
2818
2819* `current` - push the current branch to update a branch with the same
2820  name on the receiving end.  Works in both central and non-central
2821  workflows.
2822
2823* `upstream` - push the current branch back to the branch whose
2824  changes are usually integrated into the current branch (which is
2825  called `@{upstream}`).  This mode only makes sense if you are
2826  pushing to the same repository you would normally pull from
2827  (i.e. central workflow).
2828
2829* `tracking` - This is a deprecated synonym for `upstream`.
2830
2831* `simple` - in centralized workflow, work like `upstream` with an
2832  added safety to refuse to push if the upstream branch's name is
2833  different from the local one.
2834+
2835When pushing to a remote that is different from the remote you normally
2836pull from, work as `current`.  This is the safest option and is suited
2837for beginners.
2838+
2839This mode has become the default in Git 2.0.
2840
2841* `matching` - push all branches having the same name on both ends.
2842  This makes the repository you are pushing to remember the set of
2843  branches that will be pushed out (e.g. if you always push 'maint'
2844  and 'master' there and no other branches, the repository you push
2845  to will have these two branches, and your local 'maint' and
2846  'master' will be pushed there).
2847+
2848To use this mode effectively, you have to make sure _all_ the
2849branches you would push out are ready to be pushed out before
2850running 'git push', as the whole point of this mode is to allow you
2851to push all of the branches in one go.  If you usually finish work
2852on only one branch and push out the result, while other branches are
2853unfinished, this mode is not for you.  Also this mode is not
2854suitable for pushing into a shared central repository, as other
2855people may add new branches there, or update the tip of existing
2856branches outside your control.
2857+
2858This used to be the default, but not since Git 2.0 (`simple` is the
2859new default).
2860
2861--
2862
2863push.followTags::
2864        If set to true enable `--follow-tags` option by default.  You
2865        may override this configuration at time of push by specifying
2866        `--no-follow-tags`.
2867
2868push.gpgSign::
2869        May be set to a boolean value, or the string 'if-asked'. A true
2870        value causes all pushes to be GPG signed, as if `--signed` is
2871        passed to linkgit:git-push[1]. The string 'if-asked' causes
2872        pushes to be signed if the server supports it, as if
2873        `--signed=if-asked` is passed to 'git push'. A false value may
2874        override a value from a lower-priority config file. An explicit
2875        command-line flag always overrides this config option.
2876
2877push.pushOption::
2878        When no `--push-option=<option>` argument is given from the
2879        command line, `git push` behaves as if each <value> of
2880        this variable is given as `--push-option=<value>`.
2881+
2882This is a multi-valued variable, and an empty value can be used in a
2883higher priority configuration file (e.g. `.git/config` in a
2884repository) to clear the values inherited from a lower priority
2885configuration files (e.g. `$HOME/.gitconfig`).
2886+
2887--
2888
2889Example:
2890
2891/etc/gitconfig
2892  push.pushoption = a
2893  push.pushoption = b
2894
2895~/.gitconfig
2896  push.pushoption = c
2897
2898repo/.git/config
2899  push.pushoption =
2900  push.pushoption = b
2901
2902This will result in only b (a and c are cleared).
2903
2904--
2905
2906push.recurseSubmodules::
2907        Make sure all submodule commits used by the revisions to be pushed
2908        are available on a remote-tracking branch. If the value is 'check'
2909        then Git will verify that all submodule commits that changed in the
2910        revisions to be pushed are available on at least one remote of the
2911        submodule. If any commits are missing, the push will be aborted and
2912        exit with non-zero status. If the value is 'on-demand' then all
2913        submodules that changed in the revisions to be pushed will be
2914        pushed. If on-demand was not able to push all necessary revisions
2915        it will also be aborted and exit with non-zero status. If the value
2916        is 'no' then default behavior of ignoring submodules when pushing
2917        is retained. You may override this configuration at time of push by
2918        specifying '--recurse-submodules=check|on-demand|no'.
2919
2920include::rebase-config.txt[]
2921
2922receive.advertiseAtomic::
2923        By default, git-receive-pack will advertise the atomic push
2924        capability to its clients. If you don't want to advertise this
2925        capability, set this variable to false.
2926
2927receive.advertisePushOptions::
2928        When set to true, git-receive-pack will advertise the push options
2929        capability to its clients. False by default.
2930
2931receive.autogc::
2932        By default, git-receive-pack will run "git-gc --auto" after
2933        receiving data from git-push and updating refs.  You can stop
2934        it by setting this variable to false.
2935
2936receive.certNonceSeed::
2937        By setting this variable to a string, `git receive-pack`
2938        will accept a `git push --signed` and verifies it by using
2939        a "nonce" protected by HMAC using this string as a secret
2940        key.
2941
2942receive.certNonceSlop::
2943        When a `git push --signed` sent a push certificate with a
2944        "nonce" that was issued by a receive-pack serving the same
2945        repository within this many seconds, export the "nonce"
2946        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2947        hooks (instead of what the receive-pack asked the sending
2948        side to include).  This may allow writing checks in
2949        `pre-receive` and `post-receive` a bit easier.  Instead of
2950        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2951        that records by how many seconds the nonce is stale to
2952        decide if they want to accept the certificate, they only
2953        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2954
2955receive.fsckObjects::
2956        If it is set to true, git-receive-pack will check all received
2957        objects. See `transfer.fsckObjects` for what's checked.
2958        Defaults to false. If not set, the value of
2959        `transfer.fsckObjects` is used instead.
2960
2961receive.fsck.<msg-id>::
2962        Acts like `fsck.<msg-id>`, but is used by
2963        linkgit:git-receive-pack[1] instead of
2964        linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
2965        details.
2966
2967receive.fsck.skipList::
2968        Acts like `fsck.skipList`, but is used by
2969        linkgit:git-receive-pack[1] instead of
2970        linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
2971        details.
2972
2973receive.keepAlive::
2974        After receiving the pack from the client, `receive-pack` may
2975        produce no output (if `--quiet` was specified) while processing
2976        the pack, causing some networks to drop the TCP connection.
2977        With this option set, if `receive-pack` does not transmit
2978        any data in this phase for `receive.keepAlive` seconds, it will
2979        send a short keepalive packet.  The default is 5 seconds; set
2980        to 0 to disable keepalives entirely.
2981
2982receive.unpackLimit::
2983        If the number of objects received in a push is below this
2984        limit then the objects will be unpacked into loose object
2985        files. However if the number of received objects equals or
2986        exceeds this limit then the received pack will be stored as
2987        a pack, after adding any missing delta bases.  Storing the
2988        pack from a push can make the push operation complete faster,
2989        especially on slow filesystems.  If not set, the value of
2990        `transfer.unpackLimit` is used instead.
2991
2992receive.maxInputSize::
2993        If the size of the incoming pack stream is larger than this
2994        limit, then git-receive-pack will error out, instead of
2995        accepting the pack file. If not set or set to 0, then the size
2996        is unlimited.
2997
2998receive.denyDeletes::
2999        If set to true, git-receive-pack will deny a ref update that deletes
3000        the ref. Use this to prevent such a ref deletion via a push.
3001
3002receive.denyDeleteCurrent::
3003        If set to true, git-receive-pack will deny a ref update that
3004        deletes the currently checked out branch of a non-bare repository.
3005
3006receive.denyCurrentBranch::
3007        If set to true or "refuse", git-receive-pack will deny a ref update
3008        to the currently checked out branch of a non-bare repository.
3009        Such a push is potentially dangerous because it brings the HEAD
3010        out of sync with the index and working tree. If set to "warn",
3011        print a warning of such a push to stderr, but allow the push to
3012        proceed. If set to false or "ignore", allow such pushes with no
3013        message. Defaults to "refuse".
3014+
3015Another option is "updateInstead" which will update the working
3016tree if pushing into the current branch.  This option is
3017intended for synchronizing working directories when one side is not easily
3018accessible via interactive ssh (e.g. a live web site, hence the requirement
3019that the working directory be clean). This mode also comes in handy when
3020developing inside a VM to test and fix code on different Operating Systems.
3021+
3022By default, "updateInstead" will refuse the push if the working tree or
3023the index have any difference from the HEAD, but the `push-to-checkout`
3024hook can be used to customize this.  See linkgit:githooks[5].
3025
3026receive.denyNonFastForwards::
3027        If set to true, git-receive-pack will deny a ref update which is
3028        not a fast-forward. Use this to prevent such an update via a push,
3029        even if that push is forced. This configuration variable is
3030        set when initializing a shared repository.
3031
3032receive.hideRefs::
3033        This variable is the same as `transfer.hideRefs`, but applies
3034        only to `receive-pack` (and so affects pushes, but not fetches).
3035        An attempt to update or delete a hidden ref by `git push` is
3036        rejected.
3037
3038receive.updateServerInfo::
3039        If set to true, git-receive-pack will run git-update-server-info
3040        after receiving data from git-push and updating refs.
3041
3042receive.shallowUpdate::
3043        If set to true, .git/shallow can be updated when new refs
3044        require new shallow roots. Otherwise those refs are rejected.
3045
3046remote.pushDefault::
3047        The remote to push to by default.  Overrides
3048        `branch.<name>.remote` for all branches, and is overridden by
3049        `branch.<name>.pushRemote` for specific branches.
3050
3051remote.<name>.url::
3052        The URL of a remote repository.  See linkgit:git-fetch[1] or
3053        linkgit:git-push[1].
3054
3055remote.<name>.pushurl::
3056        The push URL of a remote repository.  See linkgit:git-push[1].
3057
3058remote.<name>.proxy::
3059        For remotes that require curl (http, https and ftp), the URL to
3060        the proxy to use for that remote.  Set to the empty string to
3061        disable proxying for that remote.
3062
3063remote.<name>.proxyAuthMethod::
3064        For remotes that require curl (http, https and ftp), the method to use for
3065        authenticating against the proxy in use (probably set in
3066        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3067
3068remote.<name>.fetch::
3069        The default set of "refspec" for linkgit:git-fetch[1]. See
3070        linkgit:git-fetch[1].
3071
3072remote.<name>.push::
3073        The default set of "refspec" for linkgit:git-push[1]. See
3074        linkgit:git-push[1].
3075
3076remote.<name>.mirror::
3077        If true, pushing to this remote will automatically behave
3078        as if the `--mirror` option was given on the command line.
3079
3080remote.<name>.skipDefaultUpdate::
3081        If true, this remote will be skipped by default when updating
3082        using linkgit:git-fetch[1] or the `update` subcommand of
3083        linkgit:git-remote[1].
3084
3085remote.<name>.skipFetchAll::
3086        If true, this remote will be skipped by default when updating
3087        using linkgit:git-fetch[1] or the `update` subcommand of
3088        linkgit:git-remote[1].
3089
3090remote.<name>.receivepack::
3091        The default program to execute on the remote side when pushing.  See
3092        option --receive-pack of linkgit:git-push[1].
3093
3094remote.<name>.uploadpack::
3095        The default program to execute on the remote side when fetching.  See
3096        option --upload-pack of linkgit:git-fetch-pack[1].
3097
3098remote.<name>.tagOpt::
3099        Setting this value to --no-tags disables automatic tag following when
3100        fetching from remote <name>. Setting it to --tags will fetch every
3101        tag from remote <name>, even if they are not reachable from remote
3102        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3103        override this setting. See options --tags and --no-tags of
3104        linkgit:git-fetch[1].
3105
3106remote.<name>.vcs::
3107        Setting this to a value <vcs> will cause Git to interact with
3108        the remote with the git-remote-<vcs> helper.
3109
3110remote.<name>.prune::
3111        When set to true, fetching from this remote by default will also
3112        remove any remote-tracking references that no longer exist on the
3113        remote (as if the `--prune` option was given on the command line).
3114        Overrides `fetch.prune` settings, if any.
3115
3116remote.<name>.pruneTags::
3117        When set to true, fetching from this remote by default will also
3118        remove any local tags that no longer exist on the remote if pruning
3119        is activated in general via `remote.<name>.prune`, `fetch.prune` or
3120        `--prune`. Overrides `fetch.pruneTags` settings, if any.
3121+
3122See also `remote.<name>.prune` and the PRUNING section of
3123linkgit:git-fetch[1].
3124
3125remotes.<group>::
3126        The list of remotes which are fetched by "git remote update
3127        <group>".  See linkgit:git-remote[1].
3128
3129repack.useDeltaBaseOffset::
3130        By default, linkgit:git-repack[1] creates packs that use
3131        delta-base offset. If you need to share your repository with
3132        Git older than version 1.4.4, either directly or via a dumb
3133        protocol such as http, then you need to set this option to
3134        "false" and repack. Access from old Git versions over the
3135        native protocol are unaffected by this option.
3136
3137repack.packKeptObjects::
3138        If set to true, makes `git repack` act as if
3139        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3140        details. Defaults to `false` normally, but `true` if a bitmap
3141        index is being written (either via `--write-bitmap-index` or
3142        `repack.writeBitmaps`).
3143
3144repack.writeBitmaps::
3145        When true, git will write a bitmap index when packing all
3146        objects to disk (e.g., when `git repack -a` is run).  This
3147        index can speed up the "counting objects" phase of subsequent
3148        packs created for clones and fetches, at the cost of some disk
3149        space and extra time spent on the initial repack.  This has
3150        no effect if multiple packfiles are created.
3151        Defaults to false.
3152
3153rerere.autoUpdate::
3154        When set to true, `git-rerere` updates the index with the
3155        resulting contents after it cleanly resolves conflicts using
3156        previously recorded resolution.  Defaults to false.
3157
3158rerere.enabled::
3159        Activate recording of resolved conflicts, so that identical
3160        conflict hunks can be resolved automatically, should they be
3161        encountered again.  By default, linkgit:git-rerere[1] is
3162        enabled if there is an `rr-cache` directory under the
3163        `$GIT_DIR`, e.g. if "rerere" was previously used in the
3164        repository.
3165
3166sendemail.identity::
3167        A configuration identity. When given, causes values in the
3168        'sendemail.<identity>' subsection to take precedence over
3169        values in the 'sendemail' section. The default identity is
3170        the value of `sendemail.identity`.
3171
3172sendemail.smtpEncryption::
3173        See linkgit:git-send-email[1] for description.  Note that this
3174        setting is not subject to the 'identity' mechanism.
3175
3176sendemail.smtpssl (deprecated)::
3177        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3178
3179sendemail.smtpsslcertpath::
3180        Path to ca-certificates (either a directory or a single file).
3181        Set it to an empty string to disable certificate verification.
3182
3183sendemail.<identity>.*::
3184        Identity-specific versions of the 'sendemail.*' parameters
3185        found below, taking precedence over those when this
3186        identity is selected, through either the command-line or
3187        `sendemail.identity`.
3188
3189sendemail.aliasesFile::
3190sendemail.aliasFileType::
3191sendemail.annotate::
3192sendemail.bcc::
3193sendemail.cc::
3194sendemail.ccCmd::
3195sendemail.chainReplyTo::
3196sendemail.confirm::
3197sendemail.envelopeSender::
3198sendemail.from::
3199sendemail.multiEdit::
3200sendemail.signedoffbycc::
3201sendemail.smtpPass::
3202sendemail.suppresscc::
3203sendemail.suppressFrom::
3204sendemail.to::
3205sendemail.tocmd::
3206sendemail.smtpDomain::
3207sendemail.smtpServer::
3208sendemail.smtpServerPort::
3209sendemail.smtpServerOption::
3210sendemail.smtpUser::
3211sendemail.thread::
3212sendemail.transferEncoding::
3213sendemail.validate::
3214sendemail.xmailer::
3215        See linkgit:git-send-email[1] for description.
3216
3217sendemail.signedoffcc (deprecated)::
3218        Deprecated alias for `sendemail.signedoffbycc`.
3219
3220sendemail.smtpBatchSize::
3221        Number of messages to be sent per connection, after that a relogin
3222        will happen.  If the value is 0 or undefined, send all messages in
3223        one connection.
3224        See also the `--batch-size` option of linkgit:git-send-email[1].
3225
3226sendemail.smtpReloginDelay::
3227        Seconds wait before reconnecting to smtp server.
3228        See also the `--relogin-delay` option of linkgit:git-send-email[1].
3229
3230showBranch.default::
3231        The default set of branches for linkgit:git-show-branch[1].
3232        See linkgit:git-show-branch[1].
3233
3234splitIndex.maxPercentChange::
3235        When the split index feature is used, this specifies the
3236        percent of entries the split index can contain compared to the
3237        total number of entries in both the split index and the shared
3238        index before a new shared index is written.
3239        The value should be between 0 and 100. If the value is 0 then
3240        a new shared index is always written, if it is 100 a new
3241        shared index is never written.
3242        By default the value is 20, so a new shared index is written
3243        if the number of entries in the split index would be greater
3244        than 20 percent of the total number of entries.
3245        See linkgit:git-update-index[1].
3246
3247splitIndex.sharedIndexExpire::
3248        When the split index feature is used, shared index files that
3249        were not modified since the time this variable specifies will
3250        be removed when a new shared index file is created. The value
3251        "now" expires all entries immediately, and "never" suppresses
3252        expiration altogether.
3253        The default value is "2.weeks.ago".
3254        Note that a shared index file is considered modified (for the
3255        purpose of expiration) each time a new split-index file is
3256        either created based on it or read from it.
3257        See linkgit:git-update-index[1].
3258
3259status.relativePaths::
3260        By default, linkgit:git-status[1] shows paths relative to the
3261        current directory. Setting this variable to `false` shows paths
3262        relative to the repository root (this was the default for Git
3263        prior to v1.5.4).
3264
3265status.short::
3266        Set to true to enable --short by default in linkgit:git-status[1].
3267        The option --no-short takes precedence over this variable.
3268
3269status.branch::
3270        Set to true to enable --branch by default in linkgit:git-status[1].
3271        The option --no-branch takes precedence over this variable.
3272
3273status.displayCommentPrefix::
3274        If set to true, linkgit:git-status[1] will insert a comment
3275        prefix before each output line (starting with
3276        `core.commentChar`, i.e. `#` by default). This was the
3277        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3278        Defaults to false.
3279
3280status.renameLimit::
3281        The number of files to consider when performing rename detection
3282        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3283        the value of diff.renameLimit.
3284
3285status.renames::
3286        Whether and how Git detects renames in linkgit:git-status[1] and
3287        linkgit:git-commit[1] .  If set to "false", rename detection is
3288        disabled. If set to "true", basic rename detection is enabled.
3289        If set to "copies" or "copy", Git will detect copies, as well.
3290        Defaults to the value of diff.renames.
3291
3292status.showStash::
3293        If set to true, linkgit:git-status[1] will display the number of
3294        entries currently stashed away.
3295        Defaults to false.
3296
3297status.showUntrackedFiles::
3298        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3299        files which are not currently tracked by Git. Directories which
3300        contain only untracked files, are shown with the directory name
3301        only. Showing untracked files means that Git needs to lstat() all
3302        the files in the whole repository, which might be slow on some
3303        systems. So, this variable controls how the commands displays
3304        the untracked files. Possible values are:
3305+
3306--
3307* `no` - Show no untracked files.
3308* `normal` - Show untracked files and directories.
3309* `all` - Show also individual files in untracked directories.
3310--
3311+
3312If this variable is not specified, it defaults to 'normal'.
3313This variable can be overridden with the -u|--untracked-files option
3314of linkgit:git-status[1] and linkgit:git-commit[1].
3315
3316status.submoduleSummary::
3317        Defaults to false.
3318        If this is set to a non zero number or true (identical to -1 or an
3319        unlimited number), the submodule summary will be enabled and a
3320        summary of commits for modified submodules will be shown (see
3321        --summary-limit option of linkgit:git-submodule[1]). Please note
3322        that the summary output command will be suppressed for all
3323        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3324        for those submodules where `submodule.<name>.ignore=all`. The only
3325        exception to that rule is that status and commit will show staged
3326        submodule changes. To
3327        also view the summary for ignored submodules you can either use
3328        the --ignore-submodules=dirty command-line option or the 'git
3329        submodule summary' command, which shows a similar output but does
3330        not honor these settings.
3331
3332stash.showPatch::
3333        If this is set to true, the `git stash show` command without an
3334        option will show the stash entry in patch form.  Defaults to false.
3335        See description of 'show' command in linkgit:git-stash[1].
3336
3337stash.showStat::
3338        If this is set to true, the `git stash show` command without an
3339        option will show diffstat of the stash entry.  Defaults to true.
3340        See description of 'show' command in linkgit:git-stash[1].
3341
3342submodule.<name>.url::
3343        The URL for a submodule. This variable is copied from the .gitmodules
3344        file to the git config via 'git submodule init'. The user can change
3345        the configured URL before obtaining the submodule via 'git submodule
3346        update'. If neither submodule.<name>.active or submodule.active are
3347        set, the presence of this variable is used as a fallback to indicate
3348        whether the submodule is of interest to git commands.
3349        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3350
3351submodule.<name>.update::
3352        The method by which a submodule is updated by 'git submodule update',
3353        which is the only affected command, others such as
3354        'git checkout --recurse-submodules' are unaffected. It exists for
3355        historical reasons, when 'git submodule' was the only command to
3356        interact with submodules; settings like `submodule.active`
3357        and `pull.rebase` are more specific. It is populated by
3358        `git submodule init` from the linkgit:gitmodules[5] file.
3359        See description of 'update' command in linkgit:git-submodule[1].
3360
3361submodule.<name>.branch::
3362        The remote branch name for a submodule, used by `git submodule
3363        update --remote`.  Set this option to override the value found in
3364        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3365        linkgit:gitmodules[5] for details.
3366
3367submodule.<name>.fetchRecurseSubmodules::
3368        This option can be used to control recursive fetching of this
3369        submodule. It can be overridden by using the --[no-]recurse-submodules
3370        command-line option to "git fetch" and "git pull".
3371        This setting will override that from in the linkgit:gitmodules[5]
3372        file.
3373
3374submodule.<name>.ignore::
3375        Defines under what circumstances "git status" and the diff family show
3376        a submodule as modified. When set to "all", it will never be considered
3377        modified (but it will nonetheless show up in the output of status and
3378        commit when it has been staged), "dirty" will ignore all changes
3379        to the submodules work tree and
3380        takes only differences between the HEAD of the submodule and the commit
3381        recorded in the superproject into account. "untracked" will additionally
3382        let submodules with modified tracked files in their work tree show up.
3383        Using "none" (the default when this option is not set) also shows
3384        submodules that have untracked files in their work tree as changed.
3385        This setting overrides any setting made in .gitmodules for this submodule,
3386        both settings can be overridden on the command line by using the
3387        "--ignore-submodules" option. The 'git submodule' commands are not
3388        affected by this setting.
3389
3390submodule.<name>.active::
3391        Boolean value indicating if the submodule is of interest to git
3392        commands.  This config option takes precedence over the
3393        submodule.active config option. See linkgit:gitsubmodules[7] for
3394        details.
3395
3396submodule.active::
3397        A repeated field which contains a pathspec used to match against a
3398        submodule's path to determine if the submodule is of interest to git
3399        commands. See linkgit:gitsubmodules[7] for details.
3400
3401submodule.recurse::
3402        Specifies if commands recurse into submodules by default. This
3403        applies to all commands that have a `--recurse-submodules` option,
3404        except `clone`.
3405        Defaults to false.
3406
3407submodule.fetchJobs::
3408        Specifies how many submodules are fetched/cloned at the same time.
3409        A positive integer allows up to that number of submodules fetched
3410        in parallel. A value of 0 will give some reasonable default.
3411        If unset, it defaults to 1.
3412
3413submodule.alternateLocation::
3414        Specifies how the submodules obtain alternates when submodules are
3415        cloned. Possible values are `no`, `superproject`.
3416        By default `no` is assumed, which doesn't add references. When the
3417        value is set to `superproject` the submodule to be cloned computes
3418        its alternates location relative to the superprojects alternate.
3419
3420submodule.alternateErrorStrategy::
3421        Specifies how to treat errors with the alternates for a submodule
3422        as computed via `submodule.alternateLocation`. Possible values are
3423        `ignore`, `info`, `die`. Default is `die`.
3424
3425tag.forceSignAnnotated::
3426        A boolean to specify whether annotated tags created should be GPG signed.
3427        If `--annotate` is specified on the command line, it takes
3428        precedence over this option.
3429
3430tag.sort::
3431        This variable controls the sort ordering of tags when displayed by
3432        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3433        value of this variable will be used as the default.
3434
3435tar.umask::
3436        This variable can be used to restrict the permission bits of
3437        tar archive entries.  The default is 0002, which turns off the
3438        world write bit.  The special value "user" indicates that the
3439        archiving user's umask will be used instead.  See umask(2) and
3440        linkgit:git-archive[1].
3441
3442transfer.fsckObjects::
3443        When `fetch.fsckObjects` or `receive.fsckObjects` are
3444        not set, the value of this variable is used instead.
3445        Defaults to false.
3446+
3447When set, the fetch or receive will abort in the case of a malformed
3448object or a link to a nonexistent object. In addition, various other
3449issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3450and potential security issues like the existence of a `.GIT` directory
3451or a malicious `.gitmodules` file (see the release notes for v2.2.1
3452and v2.17.1 for details). Other sanity and security checks may be
3453added in future releases.
3454+
3455On the receiving side, failing fsckObjects will make those objects
3456unreachable, see "QUARANTINE ENVIRONMENT" in
3457linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3458instead be left unreferenced in the repository.
3459+
3460Due to the non-quarantine nature of the `fetch.fsckObjects`
3461implementation it can not be relied upon to leave the object store
3462clean like `receive.fsckObjects` can.
3463+
3464As objects are unpacked they're written to the object store, so there
3465can be cases where malicious objects get introduced even though the
3466"fetch" failed, only to have a subsequent "fetch" succeed because only
3467new incoming objects are checked, not those that have already been
3468written to the object store. That difference in behavior should not be
3469relied upon. In the future, such objects may be quarantined for
3470"fetch" as well.
3471+
3472For now, the paranoid need to find some way to emulate the quarantine
3473environment if they'd like the same protection as "push". E.g. in the
3474case of an internal mirror do the mirroring in two steps, one to fetch
3475the untrusted objects, and then do a second "push" (which will use the
3476quarantine) to another internal repo, and have internal clients
3477consume this pushed-to repository, or embargo internal fetches and
3478only allow them once a full "fsck" has run (and no new fetches have
3479happened in the meantime).
3480
3481transfer.hideRefs::
3482        String(s) `receive-pack` and `upload-pack` use to decide which
3483        refs to omit from their initial advertisements.  Use more than
3484        one definition to specify multiple prefix strings. A ref that is
3485        under the hierarchies listed in the value of this variable is
3486        excluded, and is hidden when responding to `git push` or `git
3487        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3488        program-specific versions of this config.
3489+
3490You may also include a `!` in front of the ref name to negate the entry,
3491explicitly exposing it, even if an earlier entry marked it as hidden.
3492If you have multiple hideRefs values, later entries override earlier ones
3493(and entries in more-specific config files override less-specific ones).
3494+
3495If a namespace is in use, the namespace prefix is stripped from each
3496reference before it is matched against `transfer.hiderefs` patterns.
3497For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3498the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3499is omitted from the advertisements but `refs/heads/master` and
3500`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3501"have" lines. In order to match refs before stripping, add a `^` in front of
3502the ref name. If you combine `!` and `^`, `!` must be specified first.
3503+
3504Even if you hide refs, a client may still be able to steal the target
3505objects via the techniques described in the "SECURITY" section of the
3506linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3507separate repository.
3508
3509transfer.unpackLimit::
3510        When `fetch.unpackLimit` or `receive.unpackLimit` are
3511        not set, the value of this variable is used instead.
3512        The default value is 100.
3513
3514uploadarchive.allowUnreachable::
3515        If true, allow clients to use `git archive --remote` to request
3516        any tree, whether reachable from the ref tips or not. See the
3517        discussion in the "SECURITY" section of
3518        linkgit:git-upload-archive[1] for more details. Defaults to
3519        `false`.
3520
3521uploadpack.hideRefs::
3522        This variable is the same as `transfer.hideRefs`, but applies
3523        only to `upload-pack` (and so affects only fetches, not pushes).
3524        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3525        also `uploadpack.allowTipSHA1InWant`.
3526
3527uploadpack.allowTipSHA1InWant::
3528        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3529        to accept a fetch request that asks for an object at the tip
3530        of a hidden ref (by default, such a request is rejected).
3531        See also `uploadpack.hideRefs`.  Even if this is false, a client
3532        may be able to steal objects via the techniques described in the
3533        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3534        best to keep private data in a separate repository.
3535
3536uploadpack.allowReachableSHA1InWant::
3537        Allow `upload-pack` to accept a fetch request that asks for an
3538        object that is reachable from any ref tip. However, note that
3539        calculating object reachability is computationally expensive.
3540        Defaults to `false`.  Even if this is false, a client may be able
3541        to steal objects via the techniques described in the "SECURITY"
3542        section of the linkgit:gitnamespaces[7] man page; it's best to
3543        keep private data in a separate repository.
3544
3545uploadpack.allowAnySHA1InWant::
3546        Allow `upload-pack` to accept a fetch request that asks for any
3547        object at all.
3548        Defaults to `false`.
3549
3550uploadpack.keepAlive::
3551        When `upload-pack` has started `pack-objects`, there may be a
3552        quiet period while `pack-objects` prepares the pack. Normally
3553        it would output progress information, but if `--quiet` was used
3554        for the fetch, `pack-objects` will output nothing at all until
3555        the pack data begins. Some clients and networks may consider
3556        the server to be hung and give up. Setting this option instructs
3557        `upload-pack` to send an empty keepalive packet every
3558        `uploadpack.keepAlive` seconds. Setting this option to 0
3559        disables keepalive packets entirely. The default is 5 seconds.
3560
3561uploadpack.packObjectsHook::
3562        If this option is set, when `upload-pack` would run
3563        `git pack-objects` to create a packfile for a client, it will
3564        run this shell command instead.  The `pack-objects` command and
3565        arguments it _would_ have run (including the `git pack-objects`
3566        at the beginning) are appended to the shell command. The stdin
3567        and stdout of the hook are treated as if `pack-objects` itself
3568        was run. I.e., `upload-pack` will feed input intended for
3569        `pack-objects` to the hook, and expects a completed packfile on
3570        stdout.
3571
3572uploadpack.allowFilter::
3573        If this option is set, `upload-pack` will support partial
3574        clone and partial fetch object filtering.
3575+
3576Note that this configuration variable is ignored if it is seen in the
3577repository-level config (this is a safety measure against fetching from
3578untrusted repositories).
3579
3580uploadpack.allowRefInWant::
3581        If this option is set, `upload-pack` will support the `ref-in-want`
3582        feature of the protocol version 2 `fetch` command.  This feature
3583        is intended for the benefit of load-balanced servers which may
3584        not have the same view of what OIDs their refs point to due to
3585        replication delay.
3586
3587url.<base>.insteadOf::
3588        Any URL that starts with this value will be rewritten to
3589        start, instead, with <base>. In cases where some site serves a
3590        large number of repositories, and serves them with multiple
3591        access methods, and some users need to use different access
3592        methods, this feature allows people to specify any of the
3593        equivalent URLs and have Git automatically rewrite the URL to
3594        the best alternative for the particular user, even for a
3595        never-before-seen repository on the site.  When more than one
3596        insteadOf strings match a given URL, the longest match is used.
3597+
3598Note that any protocol restrictions will be applied to the rewritten
3599URL. If the rewrite changes the URL to use a custom protocol or remote
3600helper, you may need to adjust the `protocol.*.allow` config to permit
3601the request.  In particular, protocols you expect to use for submodules
3602must be set to `always` rather than the default of `user`. See the
3603description of `protocol.allow` above.
3604
3605url.<base>.pushInsteadOf::
3606        Any URL that starts with this value will not be pushed to;
3607        instead, it will be rewritten to start with <base>, and the
3608        resulting URL will be pushed to. In cases where some site serves
3609        a large number of repositories, and serves them with multiple
3610        access methods, some of which do not allow push, this feature
3611        allows people to specify a pull-only URL and have Git
3612        automatically use an appropriate URL to push, even for a
3613        never-before-seen repository on the site.  When more than one
3614        pushInsteadOf strings match a given URL, the longest match is
3615        used.  If a remote has an explicit pushurl, Git will ignore this
3616        setting for that remote.
3617
3618user.email::
3619        Your email address to be recorded in any newly created commits.
3620        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3621        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3622
3623user.name::
3624        Your full name to be recorded in any newly created commits.
3625        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3626        environment variables.  See linkgit:git-commit-tree[1].
3627
3628user.useConfigOnly::
3629        Instruct Git to avoid trying to guess defaults for `user.email`
3630        and `user.name`, and instead retrieve the values only from the
3631        configuration. For example, if you have multiple email addresses
3632        and would like to use a different one for each repository, then
3633        with this configuration option set to `true` in the global config
3634        along with a name, Git will prompt you to set up an email before
3635        making new commits in a newly cloned repository.
3636        Defaults to `false`.
3637
3638user.signingKey::
3639        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3640        key you want it to automatically when creating a signed tag or
3641        commit, you can override the default selection with this variable.
3642        This option is passed unchanged to gpg's --local-user parameter,
3643        so you may specify a key using any method that gpg supports.
3644
3645versionsort.prereleaseSuffix (deprecated)::
3646        Deprecated alias for `versionsort.suffix`.  Ignored if
3647        `versionsort.suffix` is set.
3648
3649versionsort.suffix::
3650        Even when version sort is used in linkgit:git-tag[1], tagnames
3651        with the same base version but different suffixes are still sorted
3652        lexicographically, resulting e.g. in prerelease tags appearing
3653        after the main release (e.g. "1.0-rc1" after "1.0").  This
3654        variable can be specified to determine the sorting order of tags
3655        with different suffixes.
3656+
3657By specifying a single suffix in this variable, any tagname containing
3658that suffix will appear before the corresponding main release.  E.g. if
3659the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3660"1.0".  If specified multiple times, once per suffix, then the order of
3661suffixes in the configuration will determine the sorting order of tagnames
3662with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3663configuration, then all "1.0-preX" tags will be listed before any
3664"1.0-rcX" tags.  The placement of the main release tag relative to tags
3665with various suffixes can be determined by specifying the empty suffix
3666among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3667"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3668are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3669"v4.8-bfsX".
3670+
3671If more than one suffixes match the same tagname, then that tagname will
3672be sorted according to the suffix which starts at the earliest position in
3673the tagname.  If more than one different matching suffixes start at
3674that earliest position, then that tagname will be sorted according to the
3675longest of those suffixes.
3676The sorting order between different suffixes is undefined if they are
3677in multiple config files.
3678
3679web.browser::
3680        Specify a web browser that may be used by some commands.
3681        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3682        may use it.
3683
3684worktree.guessRemote::
3685        With `add`, if no branch argument, and neither of `-b` nor
3686        `-B` nor `--detach` are given, the command defaults to
3687        creating a new branch from HEAD.  If `worktree.guessRemote` is
3688        set to true, `worktree add` tries to find a remote-tracking
3689        branch whose name uniquely matches the new branch name.  If
3690        such a branch exists, it is checked out and set as "upstream"
3691        for the new branch.  If no such match can be found, it falls
3692        back to creating a new branch from the current HEAD.