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