Documentation / config.txton commit checkout & worktree: introduce checkout.defaultRemote (8d7b558)
   1CONFIGURATION FILE
   2------------------
   3
   4The Git configuration file contains a number of variables that affect
   5the Git commands' behavior. The `.git/config` file in each repository
   6is used to store the configuration for that repository, and
   7`$HOME/.gitconfig` is used to store a per-user configuration as
   8fallback values for the `.git/config` file. The file `/etc/gitconfig`
   9can be used to store a system-wide default configuration.
  10
  11The configuration variables are used by both the Git plumbing
  12and the porcelains. The variables are divided into sections, wherein
  13the fully qualified variable name of the variable itself is the last
  14dot-separated segment and the section name is everything before the last
  15dot. The variable names are case-insensitive, allow only alphanumeric
  16characters and `-`, and must start with an alphabetic character.  Some
  17variables may appear multiple times; we say then that the variable is
  18multivalued.
  19
  20Syntax
  21~~~~~~
  22
  23The syntax is fairly flexible and permissive; whitespaces are mostly
  24ignored.  The '#' and ';' characters begin comments to the end of line,
  25blank lines are ignored.
  26
  27The file consists of sections and variables.  A section begins with
  28the name of the section in square brackets and continues until the next
  29section begins.  Section names are case-insensitive.  Only alphanumeric
  30characters, `-` and `.` are allowed in section names.  Each variable
  31must belong to some section, which means that there must be a section
  32header before the first setting of a variable.
  33
  34Sections can be further divided into subsections.  To begin a subsection
  35put its name in double quotes, separated by space from the section name,
  36in the section header, like in the example below:
  37
  38--------
  39        [section "subsection"]
  40
  41--------
  42
  43Subsection names are case sensitive and can contain any characters except
  44newline and the null byte. Doublequote `"` and backslash can be included
  45by escaping them as `\"` and `\\`, respectively. Backslashes preceding
  46other characters are dropped when reading; for example, `\t` is read as
  47`t` and `\0` is read as `0` Section headers cannot span multiple lines.
  48Variables may belong directly to a section or to a given subsection. You
  49can have `[section]` if you have `[section "subsection"]`, but you don't
  50need to.
  51
  52There is also a deprecated `[section.subsection]` syntax. With this
  53syntax, the subsection name is converted to lower-case and is also
  54compared case sensitively. These subsection names follow the same
  55restrictions as section names.
  56
  57All the other lines (and the remainder of the line after the section
  58header) are recognized as setting variables, in the form
  59'name = value' (or just 'name', which is a short-hand to say that
  60the variable is the boolean "true").
  61The variable names are case-insensitive, allow only alphanumeric characters
  62and `-`, and must start with an alphabetic character.
  63
  64A line that defines a value can be continued to the next line by
  65ending it with a `\`; the backquote and the end-of-line are
  66stripped.  Leading whitespaces after 'name =', the remainder of the
  67line after the first comment character '#' or ';', and trailing
  68whitespaces of the line are discarded unless they are enclosed in
  69double quotes.  Internal whitespaces within the value are retained
  70verbatim.
  71
  72Inside double quotes, double quote `"` and backslash `\` characters
  73must be escaped: use `\"` for `"` and `\\` for `\`.
  74
  75The following escape sequences (beside `\"` and `\\`) are recognized:
  76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  77and `\b` for backspace (BS).  Other char escape sequences (including octal
  78escape sequences) are invalid.
  79
  80
  81Includes
  82~~~~~~~~
  83
  84The `include` and `includeIf` sections allow you to include config
  85directives from another source. These sections behave identically to
  86each other with the exception that `includeIf` sections may be ignored
  87if their condition does not evaluate to true; see "Conditional includes"
  88below.
  89
  90You can include a config file from another by setting the special
  91`include.path` (or `includeIf.*.path`) variable to the name of the file
  92to be included. The variable takes a pathname as its value, and is
  93subject to tilde expansion. These variables can be given multiple times.
  94
  95The contents of the included file are inserted immediately, as if they
  96had been found at the location of the include directive. If the value of the
  97variable is a relative path, the path is considered to
  98be relative to the configuration file in which the include directive
  99was found.  See below for examples.
 100
 101Conditional includes
 102~~~~~~~~~~~~~~~~~~~~
 103
 104You can include a config file from another conditionally by setting a
 105`includeIf.<condition>.path` variable to the name of the file to be
 106included.
 107
 108The condition starts with a keyword followed by a colon and some data
 109whose format and meaning depends on the keyword. Supported keywords
 110are:
 111
 112`gitdir`::
 113
 114        The data that follows the keyword `gitdir:` is used as a glob
 115        pattern. If the location of the .git directory matches the
 116        pattern, the include condition is met.
 117+
 118The .git location may be auto-discovered, or come from `$GIT_DIR`
 119environment variable. If the repository is auto discovered via a .git
 120file (e.g. from submodules, or a linked worktree), the .git location
 121would be the final location where the .git directory is, not where the
 122.git file is.
 123+
 124The pattern can contain standard globbing wildcards and two additional
 125ones, `**/` and `/**`, that can match multiple path components. Please
 126refer to linkgit:gitignore[5] for details. For convenience:
 127
 128 * If the pattern starts with `~/`, `~` will be substituted with the
 129   content of the environment variable `HOME`.
 130
 131 * If the pattern starts with `./`, it is replaced with the directory
 132   containing the current config file.
 133
 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
 135   will be automatically prepended. For example, the pattern `foo/bar`
 136   becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
 137
 138 * If the pattern ends with `/`, `**` will be automatically added. For
 139   example, the pattern `foo/` becomes `foo/**`. In other words, it
 140   matches "foo" and everything inside, recursively.
 141
 142`gitdir/i`::
 143        This is the same as `gitdir` except that matching is done
 144        case-insensitively (e.g. on case-insensitive file sytems)
 145
 146A few more notes on matching via `gitdir` and `gitdir/i`:
 147
 148 * Symlinks in `$GIT_DIR` are not resolved before matching.
 149
 150 * Both the symlink & realpath versions of paths will be matched
 151   outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
 152   /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
 153   will match.
 154+
 155This was not the case in the initial release of this feature in
 156v2.13.0, which only matched the realpath version. Configuration that
 157wants to be compatible with the initial release of this feature needs
 158to either specify only the realpath version, or both versions.
 159
 160 * Note that "../" is not special and will match literally, which is
 161   unlikely what you want.
 162
 163Example
 164~~~~~~~
 165
 166        # Core variables
 167        [core]
 168                ; Don't trust file modes
 169                filemode = false
 170
 171        # Our diff algorithm
 172        [diff]
 173                external = /usr/local/bin/diff-wrapper
 174                renames = true
 175
 176        [branch "devel"]
 177                remote = origin
 178                merge = refs/heads/devel
 179
 180        # Proxy settings
 181        [core]
 182                gitProxy="ssh" for "kernel.org"
 183                gitProxy=default-proxy ; for the rest
 184
 185        [include]
 186                path = /path/to/foo.inc ; include by absolute path
 187                path = foo.inc ; find "foo.inc" relative to the current file
 188                path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
 189
 190        ; include if $GIT_DIR is /path/to/foo/.git
 191        [includeIf "gitdir:/path/to/foo/.git"]
 192                path = /path/to/foo.inc
 193
 194        ; include for all repositories inside /path/to/group
 195        [includeIf "gitdir:/path/to/group/"]
 196                path = /path/to/foo.inc
 197
 198        ; include for all repositories inside $HOME/to/group
 199        [includeIf "gitdir:~/to/group/"]
 200                path = /path/to/foo.inc
 201
 202        ; relative paths are always relative to the including
 203        ; file (if the condition is true); their location is not
 204        ; affected by the condition
 205        [includeIf "gitdir:/path/to/group/"]
 206                path = foo.inc
 207
 208Values
 209~~~~~~
 210
 211Values of many variables are treated as a simple string, but there
 212are variables that take values of specific types and there are rules
 213as to how to spell them.
 214
 215boolean::
 216
 217       When a variable is said to take a boolean value, many
 218       synonyms are accepted for 'true' and 'false'; these are all
 219       case-insensitive.
 220
 221        true;; Boolean true literals are `yes`, `on`, `true`,
 222                and `1`.  Also, a variable defined without `= <value>`
 223                is taken as true.
 224
 225        false;; Boolean false literals are `no`, `off`, `false`,
 226                `0` and the empty string.
 227+
 228When converting value to the canonical form using `--bool` type
 229specifier, 'git config' will ensure that the output is "true" or
 230"false" (spelled in lowercase).
 231
 232integer::
 233       The value for many variables that specify various sizes can
 234       be suffixed with `k`, `M`,... to mean "scale the number by
 235       1024", "by 1024x1024", etc.
 236
 237color::
 238       The value for a variable that takes a color is a list of
 239       colors (at most two, one for foreground and one for background)
 240       and attributes (as many as you want), separated by spaces.
 241+
 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
 243`blue`, `magenta`, `cyan` and `white`.  The first color given is the
 244foreground; the second is the background.
 245+
 246Colors may also be given as numbers between 0 and 255; these use ANSI
 247256-color mode (but note that not all terminals may support this).  If
 248your terminal supports it, you may also specify 24-bit RGB values as
 249hex, like `#ff0ab3`.
 250+
 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
 252`italic`, and `strike` (for crossed-out or "strikethrough" letters).
 253The position of any attributes with respect to the colors
 254(before, after, or in between), doesn't matter. Specific attributes may
 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
 256`no-ul`, etc).
 257+
 258An empty color string produces no color effect at all. This can be used
 259to avoid coloring specific elements without disabling color entirely.
 260+
 261For git's pre-defined color slots, the attributes are meant to be reset
 262at the beginning of each item in the colored output. So setting
 263`color.decorate.branch` to `black` will paint that branch name in a
 264plain `black`, even if the previous thing on the same output line (e.g.
 265opening parenthesis before the list of branch names in `log --decorate`
 266output) is set to be painted with `bold` or some other attribute.
 267However, custom log formats may do more complicated and layered
 268coloring, and the negated forms may be useful there.
 269
 270pathname::
 271        A variable that takes a pathname value can be given a
 272        string that begins with "`~/`" or "`~user/`", and the usual
 273        tilde expansion happens to such a string: `~/`
 274        is expanded to the value of `$HOME`, and `~user/` to the
 275        specified user's home directory.
 276
 277
 278Variables
 279~~~~~~~~~
 280
 281Note that this list is non-comprehensive and not necessarily complete.
 282For command-specific variables, you will find a more detailed description
 283in the appropriate manual page.
 284
 285Other git-related tools may and do use their own variables.  When
 286inventing new variables for use in your own tool, make sure their
 287names do not conflict with those that are used by Git itself and
 288other popular tools, and describe them in your documentation.
 289
 290
 291advice.*::
 292        These variables control various optional help messages designed to
 293        aid new users. All 'advice.*' variables default to 'true', and you
 294        can tell Git that you do not need help by setting these to 'false':
 295+
 296--
 297        pushUpdateRejected::
 298                Set this variable to 'false' if you want to disable
 299                'pushNonFFCurrent',
 300                'pushNonFFMatching', 'pushAlreadyExists',
 301                'pushFetchFirst', and 'pushNeedsForce'
 302                simultaneously.
 303        pushNonFFCurrent::
 304                Advice shown when linkgit:git-push[1] fails due to a
 305                non-fast-forward update to the current branch.
 306        pushNonFFMatching::
 307                Advice shown when you ran linkgit:git-push[1] and pushed
 308                'matching refs' explicitly (i.e. you used ':', or
 309                specified a refspec that isn't your current branch) and
 310                it resulted in a non-fast-forward error.
 311        pushAlreadyExists::
 312                Shown when linkgit:git-push[1] rejects an update that
 313                does not qualify for fast-forwarding (e.g., a tag.)
 314        pushFetchFirst::
 315                Shown when linkgit:git-push[1] rejects an update that
 316                tries to overwrite a remote ref that points at an
 317                object we do not have.
 318        pushNeedsForce::
 319                Shown when linkgit:git-push[1] rejects an update that
 320                tries to overwrite a remote ref that points at an
 321                object that is not a commit-ish, or make the remote
 322                ref point at an object that is not a commit-ish.
 323        statusHints::
 324                Show directions on how to proceed from the current
 325                state in the output of linkgit:git-status[1], in
 326                the template shown when writing commit messages in
 327                linkgit:git-commit[1], and in the help message shown
 328                by linkgit:git-checkout[1] when switching branch.
 329        statusUoption::
 330                Advise to consider using the `-u` option to linkgit:git-status[1]
 331                when the command takes more than 2 seconds to enumerate untracked
 332                files.
 333        commitBeforeMerge::
 334                Advice shown when linkgit:git-merge[1] refuses to
 335                merge to avoid overwriting local changes.
 336        resolveConflict::
 337                Advice shown by various commands when conflicts
 338                prevent the operation from being performed.
 339        implicitIdentity::
 340                Advice on how to set your identity configuration when
 341                your information is guessed from the system username and
 342                domain name.
 343        detachedHead::
 344                Advice shown when you used linkgit:git-checkout[1] to
 345                move to the detach HEAD state, to instruct how to create
 346                a local branch after the fact.
 347        checkoutAmbiguousRemoteBranchName::
 348                Advice shown when the argument to
 349                linkgit:git-checkout[1] ambiguously resolves to a
 350                remote tracking branch on more than one remote in
 351                situations where an unambiguous argument would have
 352                otherwise caused a remote-tracking branch to be
 353                checked out. See the `checkout.defaultRemote`
 354                configuration variable for how to set a given remote
 355                to used by default in some situations where this
 356                advice would be printed.
 357        amWorkDir::
 358                Advice that shows the location of the patch file when
 359                linkgit:git-am[1] fails to apply it.
 360        rmHints::
 361                In case of failure in the output of linkgit:git-rm[1],
 362                show directions on how to proceed from the current state.
 363        addEmbeddedRepo::
 364                Advice on what to do when you've accidentally added one
 365                git repo inside of another.
 366        ignoredHook::
 367                Advice shown if an hook is ignored because the hook is not
 368                set as executable.
 369        waitingForEditor::
 370                Print a message to the terminal whenever Git is waiting for
 371                editor input from the user.
 372--
 373
 374core.fileMode::
 375        Tells Git if the executable bit of files in the working tree
 376        is to be honored.
 377+
 378Some filesystems lose the executable bit when a file that is
 379marked as executable is checked out, or checks out a
 380non-executable file with executable bit on.
 381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
 382to see if it handles the executable bit correctly
 383and this variable is automatically set as necessary.
 384+
 385A repository, however, may be on a filesystem that handles
 386the filemode correctly, and this variable is set to 'true'
 387when created, but later may be made accessible from another
 388environment that loses the filemode (e.g. exporting ext4 via
 389CIFS mount, visiting a Cygwin created repository with
 390Git for Windows or Eclipse).
 391In such a case it may be necessary to set this variable to 'false'.
 392See linkgit:git-update-index[1].
 393+
 394The default is true (when core.filemode is not specified in the config file).
 395
 396core.hideDotFiles::
 397        (Windows-only) If true, mark newly-created directories and files whose
 398        name starts with a dot as hidden.  If 'dotGitOnly', only the `.git/`
 399        directory is hidden, but no other files starting with a dot.  The
 400        default mode is 'dotGitOnly'.
 401
 402core.ignoreCase::
 403        If true, this option enables various workarounds to enable
 404        Git to work better on filesystems that are not case sensitive,
 405        like FAT. For example, if a directory listing finds
 406        "makefile" when Git expects "Makefile", Git will assume
 407        it is really the same file, and continue to remember it as
 408        "Makefile".
 409+
 410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 411will probe and set core.ignoreCase true if appropriate when the repository
 412is created.
 413
 414core.precomposeUnicode::
 415        This option is only used by Mac OS implementation of Git.
 416        When core.precomposeUnicode=true, Git reverts the unicode decomposition
 417        of filenames done by Mac OS. This is useful when sharing a repository
 418        between Mac OS and Linux or Windows.
 419        (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
 420        When false, file names are handled fully transparent by Git,
 421        which is backward compatible with older versions of Git.
 422
 423core.protectHFS::
 424        If set to true, do not allow checkout of paths that would
 425        be considered equivalent to `.git` on an HFS+ filesystem.
 426        Defaults to `true` on Mac OS, and `false` elsewhere.
 427
 428core.protectNTFS::
 429        If set to true, do not allow checkout of paths that would
 430        cause problems with the NTFS filesystem, e.g. conflict with
 431        8.3 "short" names.
 432        Defaults to `true` on Windows, and `false` elsewhere.
 433
 434core.fsmonitor::
 435        If set, the value of this variable is used as a command which
 436        will identify all files that may have changed since the
 437        requested date/time. This information is used to speed up git by
 438        avoiding unnecessary processing of files that have not changed.
 439        See the "fsmonitor-watchman" section of linkgit:githooks[5].
 440
 441core.trustctime::
 442        If false, the ctime differences between the index and the
 443        working tree are ignored; useful when the inode change time
 444        is regularly modified by something outside Git (file system
 445        crawlers and some backup systems).
 446        See linkgit:git-update-index[1]. True by default.
 447
 448core.splitIndex::
 449        If true, the split-index feature of the index will be used.
 450        See linkgit:git-update-index[1]. False by default.
 451
 452core.untrackedCache::
 453        Determines what to do about the untracked cache feature of the
 454        index. It will be kept, if this variable is unset or set to
 455        `keep`. It will automatically be added if set to `true`. And
 456        it will automatically be removed, if set to `false`. Before
 457        setting it to `true`, you should check that mtime is working
 458        properly on your system.
 459        See linkgit:git-update-index[1]. `keep` by default.
 460
 461core.checkStat::
 462        Determines which stat fields to match between the index
 463        and work tree. The user can set this to 'default' or
 464        'minimal'. Default (or explicitly 'default'), is to check
 465        all fields, including the sub-second part of mtime and ctime.
 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
1111checkout.defaultRemote::
1112        When you run 'git checkout <something>' and only have one
1113        remote, it may implicitly fall back on checking out and
1114        tracking e.g. 'origin/<something>'. This stops working as soon
1115        as you have more than one remote with a '<something>'
1116        reference. This setting allows for setting the name of a
1117        preferred remote that should always win when it comes to
1118        disambiguation. The typical use-case is to set this to
1119        `origin`.
1120+
1121Currently this is used by linkgit:git-checkout[1] when 'git checkout
1122<something>' will checkout the '<something>' branch on another remote,
1123and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1124remote branch. This setting might be used for other checkout-like
1125commands or functionality in the future.
1126
1127clean.requireForce::
1128        A boolean to make git-clean do nothing unless given -f,
1129        -i or -n.   Defaults to true.
1130
1131color.advice::
1132        A boolean to enable/disable color in hints (e.g. when a push
1133        failed, see `advice.*` for a list).  May be set to `always`,
1134        `false` (or `never`) or `auto` (or `true`), in which case colors
1135        are used only when the error output goes to a terminal. If
1136        unset, then the value of `color.ui` is used (`auto` by default).
1137
1138color.advice.hint::
1139        Use customized color for hints.
1140
1141color.branch::
1142        A boolean to enable/disable color in the output of
1143        linkgit:git-branch[1]. May be set to `always`,
1144        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1145        only when the output is to a terminal. If unset, then the
1146        value of `color.ui` is used (`auto` by default).
1147
1148color.branch.<slot>::
1149        Use customized color for branch coloration. `<slot>` is one of
1150        `current` (the current branch), `local` (a local branch),
1151        `remote` (a remote-tracking branch in refs/remotes/),
1152        `upstream` (upstream tracking branch), `plain` (other
1153        refs).
1154
1155color.diff::
1156        Whether to use ANSI escape sequences to add color to patches.
1157        If this is set to `always`, linkgit:git-diff[1],
1158        linkgit:git-log[1], and linkgit:git-show[1] will use color
1159        for all patches.  If it is set to `true` or `auto`, those
1160        commands will only use color when output is to the terminal.
1161        If unset, then the value of `color.ui` is used (`auto` by
1162        default).
1163+
1164This does not affect linkgit:git-format-patch[1] or the
1165'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
1166command line with the `--color[=<when>]` option.
1167
1168diff.colorMoved::
1169        If set to either a valid `<mode>` or a true value, moved lines
1170        in a diff are colored differently, for details of valid modes
1171        see '--color-moved' in linkgit:git-diff[1]. If simply set to
1172        true the default color mode will be used. When set to false,
1173        moved lines are not colored.
1174
1175color.diff.<slot>::
1176        Use customized color for diff colorization.  `<slot>` specifies
1177        which part of the patch to use the specified color, and is one
1178        of `context` (context text - `plain` is a historical synonym),
1179        `meta` (metainformation), `frag`
1180        (hunk header), 'func' (function in hunk header), `old` (removed lines),
1181        `new` (added lines), `commit` (commit headers), `whitespace`
1182        (highlighting whitespace errors), `oldMoved` (deleted lines),
1183        `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1184        `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1185        and `newMovedAlternativeDimmed` (See the '<mode>'
1186        setting of '--color-moved' in linkgit:git-diff[1] for details).
1187
1188color.decorate.<slot>::
1189        Use customized color for 'git log --decorate' output.  `<slot>` is one
1190        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1191        branches, remote-tracking branches, tags, stash and HEAD, respectively.
1192
1193color.grep::
1194        When set to `always`, always highlight matches.  When `false` (or
1195        `never`), never.  When set to `true` or `auto`, use color only
1196        when the output is written to the terminal.  If unset, then the
1197        value of `color.ui` is used (`auto` by default).
1198
1199color.grep.<slot>::
1200        Use customized color for grep colorization.  `<slot>` specifies which
1201        part of the line to use the specified color, and is one of
1202+
1203--
1204`context`;;
1205        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1206`filename`;;
1207        filename prefix (when not using `-h`)
1208`function`;;
1209        function name lines (when using `-p`)
1210`linenumber`;;
1211        line number prefix (when using `-n`)
1212`match`;;
1213        matching text (same as setting `matchContext` and `matchSelected`)
1214`matchContext`;;
1215        matching text in context lines
1216`matchSelected`;;
1217        matching text in selected lines
1218`selected`;;
1219        non-matching text in selected lines
1220`separator`;;
1221        separators between fields on a line (`:`, `-`, and `=`)
1222        and between hunks (`--`)
1223--
1224
1225color.interactive::
1226        When set to `always`, always use colors for interactive prompts
1227        and displays (such as those used by "git-add --interactive" and
1228        "git-clean --interactive"). When false (or `never`), never.
1229        When set to `true` or `auto`, use colors only when the output is
1230        to the terminal. If unset, then the value of `color.ui` is
1231        used (`auto` by default).
1232
1233color.interactive.<slot>::
1234        Use customized color for 'git add --interactive' and 'git clean
1235        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1236        or `error`, for four distinct types of normal output from
1237        interactive commands.
1238
1239color.pager::
1240        A boolean to enable/disable colored output when the pager is in
1241        use (default is true).
1242
1243color.push::
1244        A boolean to enable/disable color in push errors. May be set to
1245        `always`, `false` (or `never`) or `auto` (or `true`), in which
1246        case colors are used only when the error output goes to a terminal.
1247        If unset, then the value of `color.ui` is used (`auto` by default).
1248
1249color.push.error::
1250        Use customized color for push errors.
1251
1252color.showBranch::
1253        A boolean to enable/disable color in the output of
1254        linkgit:git-show-branch[1]. May be set to `always`,
1255        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1256        only when the output is to a terminal. If unset, then the
1257        value of `color.ui` is used (`auto` by default).
1258
1259color.status::
1260        A boolean to enable/disable color in the output of
1261        linkgit:git-status[1]. May be set to `always`,
1262        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1263        only when the output is to a terminal. If unset, then the
1264        value of `color.ui` is used (`auto` by default).
1265
1266color.status.<slot>::
1267        Use customized color for status colorization. `<slot>` is
1268        one of `header` (the header text of the status message),
1269        `added` or `updated` (files which are added but not committed),
1270        `changed` (files which are changed but not added in the index),
1271        `untracked` (files which are not tracked by Git),
1272        `branch` (the current branch),
1273        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1274        to red),
1275        `localBranch` or `remoteBranch` (the local and remote branch names,
1276        respectively, when branch and tracking information is displayed in the
1277        status short-format), or
1278        `unmerged` (files which have unmerged changes).
1279
1280color.blame.repeatedLines::
1281        Use the customized color for the part of git-blame output that
1282        is repeated meta information per line (such as commit id,
1283        author name, date and timezone). Defaults to cyan.
1284
1285color.blame.highlightRecent::
1286        This can be used to color the metadata of a blame line depending
1287        on age of the line.
1288+
1289This setting should be set to a comma-separated list of color and date settings,
1290starting and ending with a color, the dates should be set from oldest to newest.
1291The metadata will be colored given the colors if the the line was introduced
1292before the given timestamp, overwriting older timestamped colors.
1293+
1294Instead of an absolute timestamp relative timestamps work as well, e.g.
12952.weeks.ago is valid to address anything older than 2 weeks.
1296+
1297It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1298everything older than one year blue, recent changes between one month and
1299one year old are kept white, and lines introduced within the last month are
1300colored red.
1301
1302blame.coloring::
1303        This determines the coloring scheme to be applied to blame
1304        output. It can be 'repeatedLines', 'highlightRecent',
1305        or 'none' which is the default.
1306
1307color.transport::
1308        A boolean to enable/disable color when pushes are rejected. May be
1309        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1310        case colors are used only when the error output goes to a terminal.
1311        If unset, then the value of `color.ui` is used (`auto` by default).
1312
1313color.transport.rejected::
1314        Use customized color when a push was rejected.
1315
1316color.ui::
1317        This variable determines the default value for variables such
1318        as `color.diff` and `color.grep` that control the use of color
1319        per command family. Its scope will expand as more commands learn
1320        configuration to set a default for the `--color` option.  Set it
1321        to `false` or `never` if you prefer Git commands not to use
1322        color unless enabled explicitly with some other configuration
1323        or the `--color` option. Set it to `always` if you want all
1324        output not intended for machine consumption to use color, to
1325        `true` or `auto` (this is the default since Git 1.8.4) if you
1326        want such output to use color when written to the terminal.
1327
1328column.ui::
1329        Specify whether supported commands should output in columns.
1330        This variable consists of a list of tokens separated by spaces
1331        or commas:
1332+
1333These options control when the feature should be enabled
1334(defaults to 'never'):
1335+
1336--
1337`always`;;
1338        always show in columns
1339`never`;;
1340        never show in columns
1341`auto`;;
1342        show in columns if the output is to the terminal
1343--
1344+
1345These options control layout (defaults to 'column').  Setting any
1346of these implies 'always' if none of 'always', 'never', or 'auto' are
1347specified.
1348+
1349--
1350`column`;;
1351        fill columns before rows
1352`row`;;
1353        fill rows before columns
1354`plain`;;
1355        show in one column
1356--
1357+
1358Finally, these options can be combined with a layout option (defaults
1359to 'nodense'):
1360+
1361--
1362`dense`;;
1363        make unequal size columns to utilize more space
1364`nodense`;;
1365        make equal size columns
1366--
1367
1368column.branch::
1369        Specify whether to output branch listing in `git branch` in columns.
1370        See `column.ui` for details.
1371
1372column.clean::
1373        Specify the layout when list items in `git clean -i`, which always
1374        shows files and directories in columns. See `column.ui` for details.
1375
1376column.status::
1377        Specify whether to output untracked files in `git status` in columns.
1378        See `column.ui` for details.
1379
1380column.tag::
1381        Specify whether to output tag listing in `git tag` in columns.
1382        See `column.ui` for details.
1383
1384commit.cleanup::
1385        This setting overrides the default of the `--cleanup` option in
1386        `git commit`. See linkgit:git-commit[1] for details. Changing the
1387        default can be useful when you always want to keep lines that begin
1388        with comment character `#` in your log message, in which case you
1389        would do `git config commit.cleanup whitespace` (note that you will
1390        have to remove the help lines that begin with `#` in the commit log
1391        template yourself, if you do this).
1392
1393commit.gpgSign::
1394
1395        A boolean to specify whether all commits should be GPG signed.
1396        Use of this option when doing operations such as rebase can
1397        result in a large number of commits being signed. It may be
1398        convenient to use an agent to avoid typing your GPG passphrase
1399        several times.
1400
1401commit.status::
1402        A boolean to enable/disable inclusion of status information in the
1403        commit message template when using an editor to prepare the commit
1404        message.  Defaults to true.
1405
1406commit.template::
1407        Specify the pathname of a file to use as the template for
1408        new commit messages.
1409
1410commit.verbose::
1411        A boolean or int to specify the level of verbose with `git commit`.
1412        See linkgit:git-commit[1].
1413
1414credential.helper::
1415        Specify an external helper to be called when a username or
1416        password credential is needed; the helper may consult external
1417        storage to avoid prompting the user for the credentials. Note
1418        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1419        for details.
1420
1421credential.useHttpPath::
1422        When acquiring credentials, consider the "path" component of an http
1423        or https URL to be important. Defaults to false. See
1424        linkgit:gitcredentials[7] for more information.
1425
1426credential.username::
1427        If no username is set for a network authentication, use this username
1428        by default. See credential.<context>.* below, and
1429        linkgit:gitcredentials[7].
1430
1431credential.<url>.*::
1432        Any of the credential.* options above can be applied selectively to
1433        some credentials. For example "credential.https://example.com.username"
1434        would set the default username only for https connections to
1435        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1436        matched.
1437
1438credentialCache.ignoreSIGHUP::
1439        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1440
1441completion.commands::
1442        This is only used by git-completion.bash to add or remove
1443        commands from the list of completed commands. Normally only
1444        porcelain commands and a few select others are completed. You
1445        can add more commands, separated by space, in this
1446        variable. Prefixing the command with '-' will remove it from
1447        the existing list.
1448
1449include::diff-config.txt[]
1450
1451difftool.<tool>.path::
1452        Override the path for the given tool.  This is useful in case
1453        your tool is not in the PATH.
1454
1455difftool.<tool>.cmd::
1456        Specify the command to invoke the specified diff tool.
1457        The specified command is evaluated in shell with the following
1458        variables available:  'LOCAL' is set to the name of the temporary
1459        file containing the contents of the diff pre-image and 'REMOTE'
1460        is set to the name of the temporary file containing the contents
1461        of the diff post-image.
1462
1463difftool.prompt::
1464        Prompt before each invocation of the diff tool.
1465
1466fastimport.unpackLimit::
1467        If the number of objects imported by linkgit:git-fast-import[1]
1468        is below this limit, then the objects will be unpacked into
1469        loose object files.  However if the number of imported objects
1470        equals or exceeds this limit then the pack will be stored as a
1471        pack.  Storing the pack from a fast-import can make the import
1472        operation complete faster, especially on slow filesystems.  If
1473        not set, the value of `transfer.unpackLimit` is used instead.
1474
1475fetch.recurseSubmodules::
1476        This option can be either set to a boolean value or to 'on-demand'.
1477        Setting it to a boolean changes the behavior of fetch and pull to
1478        unconditionally recurse into submodules when set to true or to not
1479        recurse at all when set to false. When set to 'on-demand' (the default
1480        value), fetch and pull will only recurse into a populated submodule
1481        when its superproject retrieves a commit that updates the submodule's
1482        reference.
1483
1484fetch.fsckObjects::
1485        If it is set to true, git-fetch-pack will check all fetched
1486        objects. It will abort in the case of a malformed object or a
1487        broken link. The result of an abort are only dangling objects.
1488        Defaults to false. If not set, the value of `transfer.fsckObjects`
1489        is used instead.
1490
1491fetch.unpackLimit::
1492        If the number of objects fetched over the Git native
1493        transfer is below this
1494        limit, then the objects will be unpacked into loose object
1495        files. However if the number of received objects equals or
1496        exceeds this limit then the received pack will be stored as
1497        a pack, after adding any missing delta bases.  Storing the
1498        pack from a push can make the push operation complete faster,
1499        especially on slow filesystems.  If not set, the value of
1500        `transfer.unpackLimit` is used instead.
1501
1502fetch.prune::
1503        If true, fetch will automatically behave as if the `--prune`
1504        option was given on the command line.  See also `remote.<name>.prune`
1505        and the PRUNING section of linkgit:git-fetch[1].
1506
1507fetch.pruneTags::
1508        If true, fetch will automatically behave as if the
1509        `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1510        if not set already. This allows for setting both this option
1511        and `fetch.prune` to maintain a 1=1 mapping to upstream
1512        refs. See also `remote.<name>.pruneTags` and the PRUNING
1513        section of linkgit:git-fetch[1].
1514
1515fetch.output::
1516        Control how ref update status is printed. Valid values are
1517        `full` and `compact`. Default value is `full`. See section
1518        OUTPUT in linkgit:git-fetch[1] for detail.
1519
1520format.attach::
1521        Enable multipart/mixed attachments as the default for
1522        'format-patch'.  The value can also be a double quoted string
1523        which will enable attachments as the default and set the
1524        value as the boundary.  See the --attach option in
1525        linkgit:git-format-patch[1].
1526
1527format.from::
1528        Provides the default value for the `--from` option to format-patch.
1529        Accepts a boolean value, or a name and email address.  If false,
1530        format-patch defaults to `--no-from`, using commit authors directly in
1531        the "From:" field of patch mails.  If true, format-patch defaults to
1532        `--from`, using your committer identity in the "From:" field of patch
1533        mails and including a "From:" field in the body of the patch mail if
1534        different.  If set to a non-boolean value, format-patch uses that
1535        value instead of your committer identity.  Defaults to false.
1536
1537format.numbered::
1538        A boolean which can enable or disable sequence numbers in patch
1539        subjects.  It defaults to "auto" which enables it only if there
1540        is more than one patch.  It can be enabled or disabled for all
1541        messages by setting it to "true" or "false".  See --numbered
1542        option in linkgit:git-format-patch[1].
1543
1544format.headers::
1545        Additional email headers to include in a patch to be submitted
1546        by mail.  See linkgit:git-format-patch[1].
1547
1548format.to::
1549format.cc::
1550        Additional recipients to include in a patch to be submitted
1551        by mail.  See the --to and --cc options in
1552        linkgit:git-format-patch[1].
1553
1554format.subjectPrefix::
1555        The default for format-patch is to output files with the '[PATCH]'
1556        subject prefix. Use this variable to change that prefix.
1557
1558format.signature::
1559        The default for format-patch is to output a signature containing
1560        the Git version number. Use this variable to change that default.
1561        Set this variable to the empty string ("") to suppress
1562        signature generation.
1563
1564format.signatureFile::
1565        Works just like format.signature except the contents of the
1566        file specified by this variable will be used as the signature.
1567
1568format.suffix::
1569        The default for format-patch is to output files with the suffix
1570        `.patch`. Use this variable to change that suffix (make sure to
1571        include the dot if you want it).
1572
1573format.pretty::
1574        The default pretty format for log/show/whatchanged command,
1575        See linkgit:git-log[1], linkgit:git-show[1],
1576        linkgit:git-whatchanged[1].
1577
1578format.thread::
1579        The default threading style for 'git format-patch'.  Can be
1580        a boolean value, or `shallow` or `deep`.  `shallow` threading
1581        makes every mail a reply to the head of the series,
1582        where the head is chosen from the cover letter, the
1583        `--in-reply-to`, and the first patch mail, in this order.
1584        `deep` threading makes every mail a reply to the previous one.
1585        A true boolean value is the same as `shallow`, and a false
1586        value disables threading.
1587
1588format.signOff::
1589        A boolean value which lets you enable the `-s/--signoff` option of
1590        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1591        patch should be a conscious act and means that you certify you have
1592        the rights to submit this work under the same open source license.
1593        Please see the 'SubmittingPatches' document for further discussion.
1594
1595format.coverLetter::
1596        A boolean that controls whether to generate a cover-letter when
1597        format-patch is invoked, but in addition can be set to "auto", to
1598        generate a cover-letter only when there's more than one patch.
1599
1600format.outputDirectory::
1601        Set a custom directory to store the resulting files instead of the
1602        current working directory.
1603
1604format.useAutoBase::
1605        A boolean value which lets you enable the `--base=auto` option of
1606        format-patch by default.
1607
1608filter.<driver>.clean::
1609        The command which is used to convert the content of a worktree
1610        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1611        details.
1612
1613filter.<driver>.smudge::
1614        The command which is used to convert the content of a blob
1615        object to a worktree file upon checkout.  See
1616        linkgit:gitattributes[5] for details.
1617
1618fsck.<msg-id>::
1619        Allows overriding the message type (error, warn or ignore) of a
1620        specific message ID such as `missingEmail`.
1621+
1622For convenience, fsck prefixes the error/warning with the message ID,
1623e.g.  "missingEmail: invalid author/committer line - missing email" means
1624that setting `fsck.missingEmail = ignore` will hide that issue.
1625+
1626This feature is intended to support working with legacy repositories
1627which cannot be repaired without disruptive changes.
1628
1629fsck.skipList::
1630        The path to a sorted list of object names (i.e. one SHA-1 per
1631        line) that are known to be broken in a non-fatal way and should
1632        be ignored. This feature is useful when an established project
1633        should be accepted despite early commits containing errors that
1634        can be safely ignored such as invalid committer email addresses.
1635        Note: corrupt objects cannot be skipped with this setting.
1636
1637gc.aggressiveDepth::
1638        The depth parameter used in the delta compression
1639        algorithm used by 'git gc --aggressive'.  This defaults
1640        to 50.
1641
1642gc.aggressiveWindow::
1643        The window size parameter used in the delta compression
1644        algorithm used by 'git gc --aggressive'.  This defaults
1645        to 250.
1646
1647gc.auto::
1648        When there are approximately more than this many loose
1649        objects in the repository, `git gc --auto` will pack them.
1650        Some Porcelain commands use this command to perform a
1651        light-weight garbage collection from time to time.  The
1652        default value is 6700.  Setting this to 0 disables it.
1653
1654gc.autoPackLimit::
1655        When there are more than this many packs that are not
1656        marked with `*.keep` file in the repository, `git gc
1657        --auto` consolidates them into one larger pack.  The
1658        default value is 50.  Setting this to 0 disables it.
1659
1660gc.autoDetach::
1661        Make `git gc --auto` return immediately and run in background
1662        if the system supports it. Default is true.
1663
1664gc.bigPackThreshold::
1665        If non-zero, all packs larger than this limit are kept when
1666        `git gc` is run. This is very similar to `--keep-base-pack`
1667        except that all packs that meet the threshold are kept, not
1668        just the base pack. Defaults to zero. Common unit suffixes of
1669        'k', 'm', or 'g' are supported.
1670+
1671Note that if the number of kept packs is more than gc.autoPackLimit,
1672this configuration variable is ignored, all packs except the base pack
1673will be repacked. After this the number of packs should go below
1674gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1675
1676gc.logExpiry::
1677        If the file gc.log exists, then `git gc --auto` won't run
1678        unless that file is more than 'gc.logExpiry' old.  Default is
1679        "1.day".  See `gc.pruneExpire` for more ways to specify its
1680        value.
1681
1682gc.packRefs::
1683        Running `git pack-refs` in a repository renders it
1684        unclonable by Git versions prior to 1.5.1.2 over dumb
1685        transports such as HTTP.  This variable determines whether
1686        'git gc' runs `git pack-refs`. This can be set to `notbare`
1687        to enable it within all non-bare repos or it can be set to a
1688        boolean value.  The default is `true`.
1689
1690gc.pruneExpire::
1691        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1692        Override the grace period with this config variable.  The value
1693        "now" may be used to disable this grace period and always prune
1694        unreachable objects immediately, or "never" may be used to
1695        suppress pruning.  This feature helps prevent corruption when
1696        'git gc' runs concurrently with another process writing to the
1697        repository; see the "NOTES" section of linkgit:git-gc[1].
1698
1699gc.worktreePruneExpire::
1700        When 'git gc' is run, it calls
1701        'git worktree prune --expire 3.months.ago'.
1702        This config variable can be used to set a different grace
1703        period. The value "now" may be used to disable the grace
1704        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1705        may be used to suppress pruning.
1706
1707gc.reflogExpire::
1708gc.<pattern>.reflogExpire::
1709        'git reflog expire' removes reflog entries older than
1710        this time; defaults to 90 days. The value "now" expires all
1711        entries immediately, and "never" suppresses expiration
1712        altogether. With "<pattern>" (e.g.
1713        "refs/stash") in the middle the setting applies only to
1714        the refs that match the <pattern>.
1715
1716gc.reflogExpireUnreachable::
1717gc.<pattern>.reflogExpireUnreachable::
1718        'git reflog expire' removes reflog entries older than
1719        this time and are not reachable from the current tip;
1720        defaults to 30 days. The value "now" expires all entries
1721        immediately, and "never" suppresses expiration altogether.
1722        With "<pattern>" (e.g. "refs/stash")
1723        in the middle, the setting applies only to the refs that
1724        match the <pattern>.
1725
1726gc.rerereResolved::
1727        Records of conflicted merge you resolved earlier are
1728        kept for this many days when 'git rerere gc' is run.
1729        You can also use more human-readable "1.month.ago", etc.
1730        The default is 60 days.  See linkgit:git-rerere[1].
1731
1732gc.rerereUnresolved::
1733        Records of conflicted merge you have not resolved are
1734        kept for this many days when 'git rerere gc' is run.
1735        You can also use more human-readable "1.month.ago", etc.
1736        The default is 15 days.  See linkgit:git-rerere[1].
1737
1738gitcvs.commitMsgAnnotation::
1739        Append this string to each commit message. Set to empty string
1740        to disable this feature. Defaults to "via git-CVS emulator".
1741
1742gitcvs.enabled::
1743        Whether the CVS server interface is enabled for this repository.
1744        See linkgit:git-cvsserver[1].
1745
1746gitcvs.logFile::
1747        Path to a log file where the CVS server interface well... logs
1748        various stuff. See linkgit:git-cvsserver[1].
1749
1750gitcvs.usecrlfattr::
1751        If true, the server will look up the end-of-line conversion
1752        attributes for files to determine the `-k` modes to use. If
1753        the attributes force Git to treat a file as text,
1754        the `-k` mode will be left blank so CVS clients will
1755        treat it as text. If they suppress text conversion, the file
1756        will be set with '-kb' mode, which suppresses any newline munging
1757        the client might otherwise do. If the attributes do not allow
1758        the file type to be determined, then `gitcvs.allBinary` is
1759        used. See linkgit:gitattributes[5].
1760
1761gitcvs.allBinary::
1762        This is used if `gitcvs.usecrlfattr` does not resolve
1763        the correct '-kb' mode to use. If true, all
1764        unresolved files are sent to the client in
1765        mode '-kb'. This causes the client to treat them
1766        as binary files, which suppresses any newline munging it
1767        otherwise might do. Alternatively, if it is set to "guess",
1768        then the contents of the file are examined to decide if
1769        it is binary, similar to `core.autocrlf`.
1770
1771gitcvs.dbName::
1772        Database used by git-cvsserver to cache revision information
1773        derived from the Git repository. The exact meaning depends on the
1774        used database driver, for SQLite (which is the default driver) this
1775        is a filename. Supports variable substitution (see
1776        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1777        Default: '%Ggitcvs.%m.sqlite'
1778
1779gitcvs.dbDriver::
1780        Used Perl DBI driver. You can specify any available driver
1781        for this here, but it might not work. git-cvsserver is tested
1782        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1783        reported *not* to work with 'DBD::mysql'. Experimental feature.
1784        May not contain double colons (`:`). Default: 'SQLite'.
1785        See linkgit:git-cvsserver[1].
1786
1787gitcvs.dbUser, gitcvs.dbPass::
1788        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1789        since SQLite has no concept of database users and/or passwords.
1790        'gitcvs.dbUser' supports variable substitution (see
1791        linkgit:git-cvsserver[1] for details).
1792
1793gitcvs.dbTableNamePrefix::
1794        Database table name prefix.  Prepended to the names of any
1795        database tables used, allowing a single database to be used
1796        for several repositories.  Supports variable substitution (see
1797        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1798        characters will be replaced with underscores.
1799
1800All gitcvs variables except for `gitcvs.usecrlfattr` and
1801`gitcvs.allBinary` can also be specified as
1802'gitcvs.<access_method>.<varname>' (where 'access_method'
1803is one of "ext" and "pserver") to make them apply only for the given
1804access method.
1805
1806gitweb.category::
1807gitweb.description::
1808gitweb.owner::
1809gitweb.url::
1810        See linkgit:gitweb[1] for description.
1811
1812gitweb.avatar::
1813gitweb.blame::
1814gitweb.grep::
1815gitweb.highlight::
1816gitweb.patches::
1817gitweb.pickaxe::
1818gitweb.remote_heads::
1819gitweb.showSizes::
1820gitweb.snapshot::
1821        See linkgit:gitweb.conf[5] for description.
1822
1823grep.lineNumber::
1824        If set to true, enable `-n` option by default.
1825
1826grep.patternType::
1827        Set the default matching behavior. Using a value of 'basic', 'extended',
1828        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1829        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1830        value 'default' will return to the default matching behavior.
1831
1832grep.extendedRegexp::
1833        If set to true, enable `--extended-regexp` option by default. This
1834        option is ignored when the `grep.patternType` option is set to a value
1835        other than 'default'.
1836
1837grep.threads::
1838        Number of grep worker threads to use.
1839        See `grep.threads` in linkgit:git-grep[1] for more information.
1840
1841grep.fallbackToNoIndex::
1842        If set to true, fall back to git grep --no-index if git grep
1843        is executed outside of a git repository.  Defaults to false.
1844
1845gpg.program::
1846        Use this custom program instead of "`gpg`" found on `$PATH` when
1847        making or verifying a PGP signature. The program must support the
1848        same command-line interface as GPG, namely, to verify a detached
1849        signature, "`gpg --verify $file - <$signature`" is run, and the
1850        program is expected to signal a good signature by exiting with
1851        code 0, and to generate an ASCII-armored detached signature, the
1852        standard input of "`gpg -bsau $key`" is fed with the contents to be
1853        signed, and the program is expected to send the result to its
1854        standard output.
1855
1856gui.commitMsgWidth::
1857        Defines how wide the commit message window is in the
1858        linkgit:git-gui[1]. "75" is the default.
1859
1860gui.diffContext::
1861        Specifies how many context lines should be used in calls to diff
1862        made by the linkgit:git-gui[1]. The default is "5".
1863
1864gui.displayUntracked::
1865        Determines if linkgit:git-gui[1] shows untracked files
1866        in the file list. The default is "true".
1867
1868gui.encoding::
1869        Specifies the default encoding to use for displaying of
1870        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1871        It can be overridden by setting the 'encoding' attribute
1872        for relevant files (see linkgit:gitattributes[5]).
1873        If this option is not set, the tools default to the
1874        locale encoding.
1875
1876gui.matchTrackingBranch::
1877        Determines if new branches created with linkgit:git-gui[1] should
1878        default to tracking remote branches with matching names or
1879        not. Default: "false".
1880
1881gui.newBranchTemplate::
1882        Is used as suggested name when creating new branches using the
1883        linkgit:git-gui[1].
1884
1885gui.pruneDuringFetch::
1886        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1887        performing a fetch. The default value is "false".
1888
1889gui.trustmtime::
1890        Determines if linkgit:git-gui[1] should trust the file modification
1891        timestamp or not. By default the timestamps are not trusted.
1892
1893gui.spellingDictionary::
1894        Specifies the dictionary used for spell checking commit messages in
1895        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1896        off.
1897
1898gui.fastCopyBlame::
1899        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1900        location detection. It makes blame significantly faster on huge
1901        repositories at the expense of less thorough copy detection.
1902
1903gui.copyBlameThreshold::
1904        Specifies the threshold to use in 'git gui blame' original location
1905        detection, measured in alphanumeric characters. See the
1906        linkgit:git-blame[1] manual for more information on copy detection.
1907
1908gui.blamehistoryctx::
1909        Specifies the radius of history context in days to show in
1910        linkgit:gitk[1] for the selected commit, when the `Show History
1911        Context` menu item is invoked from 'git gui blame'. If this
1912        variable is set to zero, the whole history is shown.
1913
1914guitool.<name>.cmd::
1915        Specifies the shell command line to execute when the corresponding item
1916        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1917        mandatory for every tool. The command is executed from the root of
1918        the working directory, and in the environment it receives the name of
1919        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1920        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1921        the head is detached, 'CUR_BRANCH' is empty).
1922
1923guitool.<name>.needsFile::
1924        Run the tool only if a diff is selected in the GUI. It guarantees
1925        that 'FILENAME' is not empty.
1926
1927guitool.<name>.noConsole::
1928        Run the command silently, without creating a window to display its
1929        output.
1930
1931guitool.<name>.noRescan::
1932        Don't rescan the working directory for changes after the tool
1933        finishes execution.
1934
1935guitool.<name>.confirm::
1936        Show a confirmation dialog before actually running the tool.
1937
1938guitool.<name>.argPrompt::
1939        Request a string argument from the user, and pass it to the tool
1940        through the `ARGS` environment variable. Since requesting an
1941        argument implies confirmation, the 'confirm' option has no effect
1942        if this is enabled. If the option is set to 'true', 'yes', or '1',
1943        the dialog uses a built-in generic prompt; otherwise the exact
1944        value of the variable is used.
1945
1946guitool.<name>.revPrompt::
1947        Request a single valid revision from the user, and set the
1948        `REVISION` environment variable. In other aspects this option
1949        is similar to 'argPrompt', and can be used together with it.
1950
1951guitool.<name>.revUnmerged::
1952        Show only unmerged branches in the 'revPrompt' subdialog.
1953        This is useful for tools similar to merge or rebase, but not
1954        for things like checkout or reset.
1955
1956guitool.<name>.title::
1957        Specifies the title to use for the prompt dialog. The default
1958        is the tool name.
1959
1960guitool.<name>.prompt::
1961        Specifies the general prompt string to display at the top of
1962        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1963        The default value includes the actual command.
1964
1965help.browser::
1966        Specify the browser that will be used to display help in the
1967        'web' format. See linkgit:git-help[1].
1968
1969help.format::
1970        Override the default help format used by linkgit:git-help[1].
1971        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1972        the default. 'web' and 'html' are the same.
1973
1974help.autoCorrect::
1975        Automatically correct and execute mistyped commands after
1976        waiting for the given number of deciseconds (0.1 sec). If more
1977        than one command can be deduced from the entered text, nothing
1978        will be executed.  If the value of this option is negative,
1979        the corrected command will be executed immediately. If the
1980        value is 0 - the command will be just shown but not executed.
1981        This is the default.
1982
1983help.htmlPath::
1984        Specify the path where the HTML documentation resides. File system paths
1985        and URLs are supported. HTML pages will be prefixed with this path when
1986        help is displayed in the 'web' format. This defaults to the documentation
1987        path of your Git installation.
1988
1989http.proxy::
1990        Override the HTTP proxy, normally configured using the 'http_proxy',
1991        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1992        addition to the syntax understood by curl, it is possible to specify a
1993        proxy string with a user name but no password, in which case git will
1994        attempt to acquire one in the same way it does for other credentials. See
1995        linkgit:gitcredentials[7] for more information. The syntax thus is
1996        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1997        on a per-remote basis; see remote.<name>.proxy
1998
1999http.proxyAuthMethod::
2000        Set the method with which to authenticate against the HTTP proxy. This
2001        only takes effect if the configured proxy string contains a user name part
2002        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2003        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2004        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2005        variable.  Possible values are:
2006+
2007--
2008* `anyauth` - Automatically pick a suitable authentication method. It is
2009  assumed that the proxy answers an unauthenticated request with a 407
2010  status code and one or more Proxy-authenticate headers with supported
2011  authentication methods. This is the default.
2012* `basic` - HTTP Basic authentication
2013* `digest` - HTTP Digest authentication; this prevents the password from being
2014  transmitted to the proxy in clear text
2015* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2016  of `curl(1)`)
2017* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2018--
2019
2020http.emptyAuth::
2021        Attempt authentication without seeking a username or password.  This
2022        can be used to attempt GSS-Negotiate authentication without specifying
2023        a username in the URL, as libcurl normally requires a username for
2024        authentication.
2025
2026http.delegation::
2027        Control GSSAPI credential delegation. The delegation is disabled
2028        by default in libcurl since version 7.21.7. Set parameter to tell
2029        the server what it is allowed to delegate when it comes to user
2030        credentials. Used with GSS/kerberos. Possible values are:
2031+
2032--
2033* `none` - Don't allow any delegation.
2034* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2035  Kerberos service ticket, which is a matter of realm policy.
2036* `always` - Unconditionally allow the server to delegate.
2037--
2038
2039
2040http.extraHeader::
2041        Pass an additional HTTP header when communicating with a server.  If
2042        more than one such entry exists, all of them are added as extra
2043        headers.  To allow overriding the settings inherited from the system
2044        config, an empty value will reset the extra headers to the empty list.
2045
2046http.cookieFile::
2047        The pathname of a file containing previously stored cookie lines,
2048        which should be used
2049        in the Git http session, if they match the server. The file format
2050        of the file to read cookies from should be plain HTTP headers or
2051        the Netscape/Mozilla cookie file format (see `curl(1)`).
2052        NOTE that the file specified with http.cookieFile is used only as
2053        input unless http.saveCookies is set.
2054
2055http.saveCookies::
2056        If set, store cookies received during requests to the file specified by
2057        http.cookieFile. Has no effect if http.cookieFile is unset.
2058
2059http.sslVersion::
2060        The SSL version to use when negotiating an SSL connection, if you
2061        want to force the default.  The available and default version
2062        depend on whether libcurl was built against NSS or OpenSSL and the
2063        particular configuration of the crypto library in use. Internally
2064        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2065        documentation for more details on the format of this option and
2066        for the ssl version supported. Actually the possible values of
2067        this option are:
2068
2069        - sslv2
2070        - sslv3
2071        - tlsv1
2072        - tlsv1.0
2073        - tlsv1.1
2074        - tlsv1.2
2075        - tlsv1.3
2076
2077+
2078Can be overridden by the `GIT_SSL_VERSION` environment variable.
2079To force git to use libcurl's default ssl version and ignore any
2080explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2081empty string.
2082
2083http.sslCipherList::
2084  A list of SSL ciphers to use when negotiating an SSL connection.
2085  The available ciphers depend on whether libcurl was built against
2086  NSS or OpenSSL and the particular configuration of the crypto
2087  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2088  option; see the libcurl documentation for more details on the format
2089  of this list.
2090+
2091Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2092To force git to use libcurl's default cipher list and ignore any
2093explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2094empty string.
2095
2096http.sslVerify::
2097        Whether to verify the SSL certificate when fetching or pushing
2098        over HTTPS. Defaults to true. Can be overridden by the
2099        `GIT_SSL_NO_VERIFY` environment variable.
2100
2101http.sslCert::
2102        File containing the SSL certificate when fetching or pushing
2103        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2104        variable.
2105
2106http.sslKey::
2107        File containing the SSL private key when fetching or pushing
2108        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2109        variable.
2110
2111http.sslCertPasswordProtected::
2112        Enable Git's password prompt for the SSL certificate.  Otherwise
2113        OpenSSL will prompt the user, possibly many times, if the
2114        certificate or private key is encrypted.  Can be overridden by the
2115        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2116
2117http.sslCAInfo::
2118        File containing the certificates to verify the peer with when
2119        fetching or pushing over HTTPS. Can be overridden by the
2120        `GIT_SSL_CAINFO` environment variable.
2121
2122http.sslCAPath::
2123        Path containing files with the CA certificates to verify the peer
2124        with when fetching or pushing over HTTPS. Can be overridden
2125        by the `GIT_SSL_CAPATH` environment variable.
2126
2127http.pinnedpubkey::
2128        Public key of the https service. It may either be the filename of
2129        a PEM or DER encoded public key file or a string starting with
2130        'sha256//' followed by the base64 encoded sha256 hash of the
2131        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2132        exit with an error if this option is set but not supported by
2133        cURL.
2134
2135http.sslTry::
2136        Attempt to use AUTH SSL/TLS and encrypted data transfers
2137        when connecting via regular FTP protocol. This might be needed
2138        if the FTP server requires it for security reasons or you wish
2139        to connect securely whenever remote FTP server supports it.
2140        Default is false since it might trigger certificate verification
2141        errors on misconfigured servers.
2142
2143http.maxRequests::
2144        How many HTTP requests to launch in parallel. Can be overridden
2145        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2146
2147http.minSessions::
2148        The number of curl sessions (counted across slots) to be kept across
2149        requests. They will not be ended with curl_easy_cleanup() until
2150        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2151        value will be capped at 1. Defaults to 1.
2152
2153http.postBuffer::
2154        Maximum size in bytes of the buffer used by smart HTTP
2155        transports when POSTing data to the remote system.
2156        For requests larger than this buffer size, HTTP/1.1 and
2157        Transfer-Encoding: chunked is used to avoid creating a
2158        massive pack file locally.  Default is 1 MiB, which is
2159        sufficient for most requests.
2160
2161http.lowSpeedLimit, http.lowSpeedTime::
2162        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2163        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2164        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2165        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2166
2167http.noEPSV::
2168        A boolean which disables using of EPSV ftp command by curl.
2169        This can helpful with some "poor" ftp servers which don't
2170        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2171        environment variable. Default is false (curl will use EPSV).
2172
2173http.userAgent::
2174        The HTTP USER_AGENT string presented to an HTTP server.  The default
2175        value represents the version of the client Git such as git/1.7.1.
2176        This option allows you to override this value to a more common value
2177        such as Mozilla/4.0.  This may be necessary, for instance, if
2178        connecting through a firewall that restricts HTTP connections to a set
2179        of common USER_AGENT strings (but not including those like git/1.7.1).
2180        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2181
2182http.followRedirects::
2183        Whether git should follow HTTP redirects. If set to `true`, git
2184        will transparently follow any redirect issued by a server it
2185        encounters. If set to `false`, git will treat all redirects as
2186        errors. If set to `initial`, git will follow redirects only for
2187        the initial request to a remote, but not for subsequent
2188        follow-up HTTP requests. Since git uses the redirected URL as
2189        the base for the follow-up requests, this is generally
2190        sufficient. The default is `initial`.
2191
2192http.<url>.*::
2193        Any of the http.* options above can be applied selectively to some URLs.
2194        For a config key to match a URL, each element of the config key is
2195        compared to that of the URL, in the following order:
2196+
2197--
2198. Scheme (e.g., `https` in `https://example.com/`). This field
2199  must match exactly between the config key and the URL.
2200
2201. Host/domain name (e.g., `example.com` in `https://example.com/`).
2202  This field must match between the config key and the URL. It is
2203  possible to specify a `*` as part of the host name to match all subdomains
2204  at this level. `https://*.example.com/` for example would match
2205  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2206
2207. Port number (e.g., `8080` in `http://example.com:8080/`).
2208  This field must match exactly between the config key and the URL.
2209  Omitted port numbers are automatically converted to the correct
2210  default for the scheme before matching.
2211
2212. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2213  path field of the config key must match the path field of the URL
2214  either exactly or as a prefix of slash-delimited path elements.  This means
2215  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2216  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2217  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2218  key with just path `foo/`).
2219
2220. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2221  the config key has a user name it must match the user name in the
2222  URL exactly. If the config key does not have a user name, that
2223  config key will match a URL with any user name (including none),
2224  but at a lower precedence than a config key with a user name.
2225--
2226+
2227The list above is ordered by decreasing precedence; a URL that matches
2228a config key's path is preferred to one that matches its user name. For example,
2229if the URL is `https://user@example.com/foo/bar` a config key match of
2230`https://example.com/foo` will be preferred over a config key match of
2231`https://user@example.com`.
2232+
2233All URLs are normalized before attempting any matching (the password part,
2234if embedded in the URL, is always ignored for matching purposes) so that
2235equivalent URLs that are simply spelled differently will match properly.
2236Environment variable settings always override any matches.  The URLs that are
2237matched against are those given directly to Git commands.  This means any URLs
2238visited as a result of a redirection do not participate in matching.
2239
2240ssh.variant::
2241        By default, Git determines the command line arguments to use
2242        based on the basename of the configured SSH command (configured
2243        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2244        the config setting `core.sshCommand`). If the basename is
2245        unrecognized, Git will attempt to detect support of OpenSSH
2246        options by first invoking the configured SSH command with the
2247        `-G` (print configuration) option and will subsequently use
2248        OpenSSH options (if that is successful) or no options besides
2249        the host and remote command (if it fails).
2250+
2251The config variable `ssh.variant` can be set to override this detection.
2252Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2253`tortoiseplink`, `simple` (no options except the host and remote command).
2254The default auto-detection can be explicitly requested using the value
2255`auto`.  Any other value is treated as `ssh`.  This setting can also be
2256overridden via the environment variable `GIT_SSH_VARIANT`.
2257+
2258The current command-line parameters used for each variant are as
2259follows:
2260+
2261--
2262
2263* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2264
2265* `simple` - [username@]host command
2266
2267* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2268
2269* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2270
2271--
2272+
2273Except for the `simple` variant, command-line parameters are likely to
2274change as git gains new features.
2275
2276i18n.commitEncoding::
2277        Character encoding the commit messages are stored in; Git itself
2278        does not care per se, but this information is necessary e.g. when
2279        importing commits from emails or in the gitk graphical history
2280        browser (and possibly at other places in the future or in other
2281        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2282
2283i18n.logOutputEncoding::
2284        Character encoding the commit messages are converted to when
2285        running 'git log' and friends.
2286
2287imap::
2288        The configuration variables in the 'imap' section are described
2289        in linkgit:git-imap-send[1].
2290
2291index.version::
2292        Specify the version with which new index files should be
2293        initialized.  This does not affect existing repositories.
2294
2295init.templateDir::
2296        Specify the directory from which templates will be copied.
2297        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2298
2299instaweb.browser::
2300        Specify the program that will be used to browse your working
2301        repository in gitweb. See linkgit:git-instaweb[1].
2302
2303instaweb.httpd::
2304        The HTTP daemon command-line to start gitweb on your working
2305        repository. See linkgit:git-instaweb[1].
2306
2307instaweb.local::
2308        If true the web server started by linkgit:git-instaweb[1] will
2309        be bound to the local IP (127.0.0.1).
2310
2311instaweb.modulePath::
2312        The default module path for linkgit:git-instaweb[1] to use
2313        instead of /usr/lib/apache2/modules.  Only used if httpd
2314        is Apache.
2315
2316instaweb.port::
2317        The port number to bind the gitweb httpd to. See
2318        linkgit:git-instaweb[1].
2319
2320interactive.singleKey::
2321        In interactive commands, allow the user to provide one-letter
2322        input with a single key (i.e., without hitting enter).
2323        Currently this is used by the `--patch` mode of
2324        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2325        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2326        setting is silently ignored if portable keystroke input
2327        is not available; requires the Perl module Term::ReadKey.
2328
2329interactive.diffFilter::
2330        When an interactive command (such as `git add --patch`) shows
2331        a colorized diff, git will pipe the diff through the shell
2332        command defined by this configuration variable. The command may
2333        mark up the diff further for human consumption, provided that it
2334        retains a one-to-one correspondence with the lines in the
2335        original diff. Defaults to disabled (no filtering).
2336
2337log.abbrevCommit::
2338        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2339        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2340        override this option with `--no-abbrev-commit`.
2341
2342log.date::
2343        Set the default date-time mode for the 'log' command.
2344        Setting a value for log.date is similar to using 'git log''s
2345        `--date` option.  See linkgit:git-log[1] for details.
2346
2347log.decorate::
2348        Print out the ref names of any commits that are shown by the log
2349        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2350        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2351        specified, the full ref name (including prefix) will be printed.
2352        If 'auto' is specified, then if the output is going to a terminal,
2353        the ref names are shown as if 'short' were given, otherwise no ref
2354        names are shown. This is the same as the `--decorate` option
2355        of the `git log`.
2356
2357log.follow::
2358        If `true`, `git log` will act as if the `--follow` option was used when
2359        a single <path> is given.  This has the same limitations as `--follow`,
2360        i.e. it cannot be used to follow multiple files and does not work well
2361        on non-linear history.
2362
2363log.graphColors::
2364        A list of colors, separated by commas, that can be used to draw
2365        history lines in `git log --graph`.
2366
2367log.showRoot::
2368        If true, the initial commit will be shown as a big creation event.
2369        This is equivalent to a diff against an empty tree.
2370        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2371        normally hide the root commit will now show it. True by default.
2372
2373log.showSignature::
2374        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2375        linkgit:git-whatchanged[1] assume `--show-signature`.
2376
2377log.mailmap::
2378        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2379        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2380
2381mailinfo.scissors::
2382        If true, makes linkgit:git-mailinfo[1] (and therefore
2383        linkgit:git-am[1]) act by default as if the --scissors option
2384        was provided on the command-line. When active, this features
2385        removes everything from the message body before a scissors
2386        line (i.e. consisting mainly of ">8", "8<" and "-").
2387
2388mailmap.file::
2389        The location of an augmenting mailmap file. The default
2390        mailmap, located in the root of the repository, is loaded
2391        first, then the mailmap file pointed to by this variable.
2392        The location of the mailmap file may be in a repository
2393        subdirectory, or somewhere outside of the repository itself.
2394        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2395
2396mailmap.blob::
2397        Like `mailmap.file`, but consider the value as a reference to a
2398        blob in the repository. If both `mailmap.file` and
2399        `mailmap.blob` are given, both are parsed, with entries from
2400        `mailmap.file` taking precedence. In a bare repository, this
2401        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2402        defaults to empty.
2403
2404man.viewer::
2405        Specify the programs that may be used to display help in the
2406        'man' format. See linkgit:git-help[1].
2407
2408man.<tool>.cmd::
2409        Specify the command to invoke the specified man viewer. The
2410        specified command is evaluated in shell with the man page
2411        passed as argument. (See linkgit:git-help[1].)
2412
2413man.<tool>.path::
2414        Override the path for the given tool that may be used to
2415        display help in the 'man' format. See linkgit:git-help[1].
2416
2417include::merge-config.txt[]
2418
2419mergetool.<tool>.path::
2420        Override the path for the given tool.  This is useful in case
2421        your tool is not in the PATH.
2422
2423mergetool.<tool>.cmd::
2424        Specify the command to invoke the specified merge tool.  The
2425        specified command is evaluated in shell with the following
2426        variables available: 'BASE' is the name of a temporary file
2427        containing the common base of the files to be merged, if available;
2428        'LOCAL' is the name of a temporary file containing the contents of
2429        the file on the current branch; 'REMOTE' is the name of a temporary
2430        file containing the contents of the file from the branch being
2431        merged; 'MERGED' contains the name of the file to which the merge
2432        tool should write the results of a successful merge.
2433
2434mergetool.<tool>.trustExitCode::
2435        For a custom merge command, specify whether the exit code of
2436        the merge command can be used to determine whether the merge was
2437        successful.  If this is not set to true then the merge target file
2438        timestamp is checked and the merge assumed to have been successful
2439        if the file has been updated, otherwise the user is prompted to
2440        indicate the success of the merge.
2441
2442mergetool.meld.hasOutput::
2443        Older versions of `meld` do not support the `--output` option.
2444        Git will attempt to detect whether `meld` supports `--output`
2445        by inspecting the output of `meld --help`.  Configuring
2446        `mergetool.meld.hasOutput` will make Git skip these checks and
2447        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2448        to `true` tells Git to unconditionally use the `--output` option,
2449        and `false` avoids using `--output`.
2450
2451mergetool.keepBackup::
2452        After performing a merge, the original file with conflict markers
2453        can be saved as a file with a `.orig` extension.  If this variable
2454        is set to `false` then this file is not preserved.  Defaults to
2455        `true` (i.e. keep the backup files).
2456
2457mergetool.keepTemporaries::
2458        When invoking a custom merge tool, Git uses a set of temporary
2459        files to pass to the tool. If the tool returns an error and this
2460        variable is set to `true`, then these temporary files will be
2461        preserved, otherwise they will be removed after the tool has
2462        exited. Defaults to `false`.
2463
2464mergetool.writeToTemp::
2465        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2466        conflicting files in the worktree by default.  Git will attempt
2467        to use a temporary directory for these files when set `true`.
2468        Defaults to `false`.
2469
2470mergetool.prompt::
2471        Prompt before each invocation of the merge resolution program.
2472
2473notes.mergeStrategy::
2474        Which merge strategy to choose by default when resolving notes
2475        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2476        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2477        section of linkgit:git-notes[1] for more information on each strategy.
2478
2479notes.<name>.mergeStrategy::
2480        Which merge strategy to choose when doing a notes merge into
2481        refs/notes/<name>.  This overrides the more general
2482        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2483        linkgit:git-notes[1] for more information on the available strategies.
2484
2485notes.displayRef::
2486        The (fully qualified) refname from which to show notes when
2487        showing commit messages.  The value of this variable can be set
2488        to a glob, in which case notes from all matching refs will be
2489        shown.  You may also specify this configuration variable
2490        several times.  A warning will be issued for refs that do not
2491        exist, but a glob that does not match any refs is silently
2492        ignored.
2493+
2494This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2495environment variable, which must be a colon separated list of refs or
2496globs.
2497+
2498The effective value of "core.notesRef" (possibly overridden by
2499GIT_NOTES_REF) is also implicitly added to the list of refs to be
2500displayed.
2501
2502notes.rewrite.<command>::
2503        When rewriting commits with <command> (currently `amend` or
2504        `rebase`) and this variable is set to `true`, Git
2505        automatically copies your notes from the original to the
2506        rewritten commit.  Defaults to `true`, but see
2507        "notes.rewriteRef" below.
2508
2509notes.rewriteMode::
2510        When copying notes during a rewrite (see the
2511        "notes.rewrite.<command>" option), determines what to do if
2512        the target commit already has a note.  Must be one of
2513        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2514        Defaults to `concatenate`.
2515+
2516This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2517environment variable.
2518
2519notes.rewriteRef::
2520        When copying notes during a rewrite, specifies the (fully
2521        qualified) ref whose notes should be copied.  The ref may be a
2522        glob, in which case notes in all matching refs will be copied.
2523        You may also specify this configuration several times.
2524+
2525Does not have a default value; you must configure this variable to
2526enable note rewriting.  Set it to `refs/notes/commits` to enable
2527rewriting for the default commit notes.
2528+
2529This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2530environment variable, which must be a colon separated list of refs or
2531globs.
2532
2533pack.window::
2534        The size of the window used by linkgit:git-pack-objects[1] when no
2535        window size is given on the command line. Defaults to 10.
2536
2537pack.depth::
2538        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2539        maximum depth is given on the command line. Defaults to 50.
2540        Maximum value is 4095.
2541
2542pack.windowMemory::
2543        The maximum size of memory that is consumed by each thread
2544        in linkgit:git-pack-objects[1] for pack window memory when
2545        no limit is given on the command line.  The value can be
2546        suffixed with "k", "m", or "g".  When left unconfigured (or
2547        set explicitly to 0), there will be no limit.
2548
2549pack.compression::
2550        An integer -1..9, indicating the compression level for objects
2551        in a pack file. -1 is the zlib default. 0 means no
2552        compression, and 1..9 are various speed/size tradeoffs, 9 being
2553        slowest.  If not set,  defaults to core.compression.  If that is
2554        not set,  defaults to -1, the zlib default, which is "a default
2555        compromise between speed and compression (currently equivalent
2556        to level 6)."
2557+
2558Note that changing the compression level will not automatically recompress
2559all existing objects. You can force recompression by passing the -F option
2560to linkgit:git-repack[1].
2561
2562pack.deltaCacheSize::
2563        The maximum memory in bytes used for caching deltas in
2564        linkgit:git-pack-objects[1] before writing them out to a pack.
2565        This cache is used to speed up the writing object phase by not
2566        having to recompute the final delta result once the best match
2567        for all objects is found.  Repacking large repositories on machines
2568        which are tight with memory might be badly impacted by this though,
2569        especially if this cache pushes the system into swapping.
2570        A value of 0 means no limit. The smallest size of 1 byte may be
2571        used to virtually disable this cache. Defaults to 256 MiB.
2572
2573pack.deltaCacheLimit::
2574        The maximum size of a delta, that is cached in
2575        linkgit:git-pack-objects[1]. This cache is used to speed up the
2576        writing object phase by not having to recompute the final delta
2577        result once the best match for all objects is found.
2578        Defaults to 1000. Maximum value is 65535.
2579
2580pack.threads::
2581        Specifies the number of threads to spawn when searching for best
2582        delta matches.  This requires that linkgit:git-pack-objects[1]
2583        be compiled with pthreads otherwise this option is ignored with a
2584        warning. This is meant to reduce packing time on multiprocessor
2585        machines. The required amount of memory for the delta search window
2586        is however multiplied by the number of threads.
2587        Specifying 0 will cause Git to auto-detect the number of CPU's
2588        and set the number of threads accordingly.
2589
2590pack.indexVersion::
2591        Specify the default pack index version.  Valid values are 1 for
2592        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2593        the new pack index with capabilities for packs larger than 4 GB
2594        as well as proper protection against the repacking of corrupted
2595        packs.  Version 2 is the default.  Note that version 2 is enforced
2596        and this config option ignored whenever the corresponding pack is
2597        larger than 2 GB.
2598+
2599If you have an old Git that does not understand the version 2 `*.idx` file,
2600cloning or fetching over a non native protocol (e.g. "http")
2601that will copy both `*.pack` file and corresponding `*.idx` file from the
2602other side may give you a repository that cannot be accessed with your
2603older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2604you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2605the `*.idx` file.
2606
2607pack.packSizeLimit::
2608        The maximum size of a pack.  This setting only affects
2609        packing to a file when repacking, i.e. the git:// protocol
2610        is unaffected.  It can be overridden by the `--max-pack-size`
2611        option of linkgit:git-repack[1].  Reaching this limit results
2612        in the creation of multiple packfiles; which in turn prevents
2613        bitmaps from being created.
2614        The minimum size allowed is limited to 1 MiB.
2615        The default is unlimited.
2616        Common unit suffixes of 'k', 'm', or 'g' are
2617        supported.
2618
2619pack.useBitmaps::
2620        When true, git will use pack bitmaps (if available) when packing
2621        to stdout (e.g., during the server side of a fetch). Defaults to
2622        true. You should not generally need to turn this off unless
2623        you are debugging pack bitmaps.
2624
2625pack.writeBitmaps (deprecated)::
2626        This is a deprecated synonym for `repack.writeBitmaps`.
2627
2628pack.writeBitmapHashCache::
2629        When true, git will include a "hash cache" section in the bitmap
2630        index (if one is written). This cache can be used to feed git's
2631        delta heuristics, potentially leading to better deltas between
2632        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2633        between an older, bitmapped pack and objects that have been
2634        pushed since the last gc). The downside is that it consumes 4
2635        bytes per object of disk space, and that JGit's bitmap
2636        implementation does not understand it, causing it to complain if
2637        Git and JGit are used on the same repository. Defaults to false.
2638
2639pager.<cmd>::
2640        If the value is boolean, turns on or off pagination of the
2641        output of a particular Git subcommand when writing to a tty.
2642        Otherwise, turns on pagination for the subcommand using the
2643        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2644        or `--no-pager` is specified on the command line, it takes
2645        precedence over this option.  To disable pagination for all
2646        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2647
2648pretty.<name>::
2649        Alias for a --pretty= format string, as specified in
2650        linkgit:git-log[1]. Any aliases defined here can be used just
2651        as the built-in pretty formats could. For example,
2652        running `git config pretty.changelog "format:* %H %s"`
2653        would cause the invocation `git log --pretty=changelog`
2654        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2655        Note that an alias with the same name as a built-in format
2656        will be silently ignored.
2657
2658protocol.allow::
2659        If set, provide a user defined default policy for all protocols which
2660        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2661        if unset, known-safe protocols (http, https, git, ssh, file) have a
2662        default policy of `always`, known-dangerous protocols (ext) have a
2663        default policy of `never`, and all other protocols have a default
2664        policy of `user`.  Supported policies:
2665+
2666--
2667
2668* `always` - protocol is always able to be used.
2669
2670* `never` - protocol is never able to be used.
2671
2672* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2673  either unset or has a value of 1.  This policy should be used when you want a
2674  protocol to be directly usable by the user but don't want it used by commands which
2675  execute clone/fetch/push commands without user input, e.g. recursive
2676  submodule initialization.
2677
2678--
2679
2680protocol.<name>.allow::
2681        Set a policy to be used by protocol `<name>` with clone/fetch/push
2682        commands. See `protocol.allow` above for the available policies.
2683+
2684The protocol names currently used by git are:
2685+
2686--
2687  - `file`: any local file-based path (including `file://` URLs,
2688    or local paths)
2689
2690  - `git`: the anonymous git protocol over a direct TCP
2691    connection (or proxy, if configured)
2692
2693  - `ssh`: git over ssh (including `host:path` syntax,
2694    `ssh://`, etc).
2695
2696  - `http`: git over http, both "smart http" and "dumb http".
2697    Note that this does _not_ include `https`; if you want to configure
2698    both, you must do so individually.
2699
2700  - any external helpers are named by their protocol (e.g., use
2701    `hg` to allow the `git-remote-hg` helper)
2702--
2703
2704protocol.version::
2705        Experimental. If set, clients will attempt to communicate with a
2706        server using the specified protocol version.  If unset, no
2707        attempt will be made by the client to communicate using a
2708        particular protocol version, this results in protocol version 0
2709        being used.
2710        Supported versions:
2711+
2712--
2713
2714* `0` - the original wire protocol.
2715
2716* `1` - the original wire protocol with the addition of a version string
2717  in the initial response from the server.
2718
2719--
2720
2721pull.ff::
2722        By default, Git does not create an extra merge commit when merging
2723        a commit that is a descendant of the current commit. Instead, the
2724        tip of the current branch is fast-forwarded. When set to `false`,
2725        this variable tells Git to create an extra merge commit in such
2726        a case (equivalent to giving the `--no-ff` option from the command
2727        line). When set to `only`, only such fast-forward merges are
2728        allowed (equivalent to giving the `--ff-only` option from the
2729        command line). This setting overrides `merge.ff` when pulling.
2730
2731pull.rebase::
2732        When true, rebase branches on top of the fetched branch, instead
2733        of merging the default branch from the default remote when "git
2734        pull" is run. See "branch.<name>.rebase" for setting this on a
2735        per-branch basis.
2736+
2737When `merges`, pass the `--rebase-merges` option to 'git rebase'
2738so that the local merge commits are included in the rebase (see
2739linkgit:git-rebase[1] for details).
2740+
2741When preserve, also pass `--preserve-merges` along to 'git rebase'
2742so that locally committed merge commits will not be flattened
2743by running 'git pull'.
2744+
2745When the value is `interactive`, the rebase is run in interactive mode.
2746+
2747*NOTE*: this is a possibly dangerous operation; do *not* use
2748it unless you understand the implications (see linkgit:git-rebase[1]
2749for details).
2750
2751pull.octopus::
2752        The default merge strategy to use when pulling multiple branches
2753        at once.
2754
2755pull.twohead::
2756        The default merge strategy to use when pulling a single branch.
2757
2758push.default::
2759        Defines the action `git push` should take if no refspec is
2760        explicitly given.  Different values are well-suited for
2761        specific workflows; for instance, in a purely central workflow
2762        (i.e. the fetch source is equal to the push destination),
2763        `upstream` is probably what you want.  Possible values are:
2764+
2765--
2766
2767* `nothing` - do not push anything (error out) unless a refspec is
2768  explicitly given. This is primarily meant for people who want to
2769  avoid mistakes by always being explicit.
2770
2771* `current` - push the current branch to update a branch with the same
2772  name on the receiving end.  Works in both central and non-central
2773  workflows.
2774
2775* `upstream` - push the current branch back to the branch whose
2776  changes are usually integrated into the current branch (which is
2777  called `@{upstream}`).  This mode only makes sense if you are
2778  pushing to the same repository you would normally pull from
2779  (i.e. central workflow).
2780
2781* `tracking` - This is a deprecated synonym for `upstream`.
2782
2783* `simple` - in centralized workflow, work like `upstream` with an
2784  added safety to refuse to push if the upstream branch's name is
2785  different from the local one.
2786+
2787When pushing to a remote that is different from the remote you normally
2788pull from, work as `current`.  This is the safest option and is suited
2789for beginners.
2790+
2791This mode has become the default in Git 2.0.
2792
2793* `matching` - push all branches having the same name on both ends.
2794  This makes the repository you are pushing to remember the set of
2795  branches that will be pushed out (e.g. if you always push 'maint'
2796  and 'master' there and no other branches, the repository you push
2797  to will have these two branches, and your local 'maint' and
2798  'master' will be pushed there).
2799+
2800To use this mode effectively, you have to make sure _all_ the
2801branches you would push out are ready to be pushed out before
2802running 'git push', as the whole point of this mode is to allow you
2803to push all of the branches in one go.  If you usually finish work
2804on only one branch and push out the result, while other branches are
2805unfinished, this mode is not for you.  Also this mode is not
2806suitable for pushing into a shared central repository, as other
2807people may add new branches there, or update the tip of existing
2808branches outside your control.
2809+
2810This used to be the default, but not since Git 2.0 (`simple` is the
2811new default).
2812
2813--
2814
2815push.followTags::
2816        If set to true enable `--follow-tags` option by default.  You
2817        may override this configuration at time of push by specifying
2818        `--no-follow-tags`.
2819
2820push.gpgSign::
2821        May be set to a boolean value, or the string 'if-asked'. A true
2822        value causes all pushes to be GPG signed, as if `--signed` is
2823        passed to linkgit:git-push[1]. The string 'if-asked' causes
2824        pushes to be signed if the server supports it, as if
2825        `--signed=if-asked` is passed to 'git push'. A false value may
2826        override a value from a lower-priority config file. An explicit
2827        command-line flag always overrides this config option.
2828
2829push.pushOption::
2830        When no `--push-option=<option>` argument is given from the
2831        command line, `git push` behaves as if each <value> of
2832        this variable is given as `--push-option=<value>`.
2833+
2834This is a multi-valued variable, and an empty value can be used in a
2835higher priority configuration file (e.g. `.git/config` in a
2836repository) to clear the values inherited from a lower priority
2837configuration files (e.g. `$HOME/.gitconfig`).
2838+
2839--
2840
2841Example:
2842
2843/etc/gitconfig
2844  push.pushoption = a
2845  push.pushoption = b
2846
2847~/.gitconfig
2848  push.pushoption = c
2849
2850repo/.git/config
2851  push.pushoption =
2852  push.pushoption = b
2853
2854This will result in only b (a and c are cleared).
2855
2856--
2857
2858push.recurseSubmodules::
2859        Make sure all submodule commits used by the revisions to be pushed
2860        are available on a remote-tracking branch. If the value is 'check'
2861        then Git will verify that all submodule commits that changed in the
2862        revisions to be pushed are available on at least one remote of the
2863        submodule. If any commits are missing, the push will be aborted and
2864        exit with non-zero status. If the value is 'on-demand' then all
2865        submodules that changed in the revisions to be pushed will be
2866        pushed. If on-demand was not able to push all necessary revisions
2867        it will also be aborted and exit with non-zero status. If the value
2868        is 'no' then default behavior of ignoring submodules when pushing
2869        is retained. You may override this configuration at time of push by
2870        specifying '--recurse-submodules=check|on-demand|no'.
2871
2872include::rebase-config.txt[]
2873
2874receive.advertiseAtomic::
2875        By default, git-receive-pack will advertise the atomic push
2876        capability to its clients. If you don't want to advertise this
2877        capability, set this variable to false.
2878
2879receive.advertisePushOptions::
2880        When set to true, git-receive-pack will advertise the push options
2881        capability to its clients. False by default.
2882
2883receive.autogc::
2884        By default, git-receive-pack will run "git-gc --auto" after
2885        receiving data from git-push and updating refs.  You can stop
2886        it by setting this variable to false.
2887
2888receive.certNonceSeed::
2889        By setting this variable to a string, `git receive-pack`
2890        will accept a `git push --signed` and verifies it by using
2891        a "nonce" protected by HMAC using this string as a secret
2892        key.
2893
2894receive.certNonceSlop::
2895        When a `git push --signed` sent a push certificate with a
2896        "nonce" that was issued by a receive-pack serving the same
2897        repository within this many seconds, export the "nonce"
2898        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2899        hooks (instead of what the receive-pack asked the sending
2900        side to include).  This may allow writing checks in
2901        `pre-receive` and `post-receive` a bit easier.  Instead of
2902        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2903        that records by how many seconds the nonce is stale to
2904        decide if they want to accept the certificate, they only
2905        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2906
2907receive.fsckObjects::
2908        If it is set to true, git-receive-pack will check all received
2909        objects. It will abort in the case of a malformed object or a
2910        broken link. The result of an abort are only dangling objects.
2911        Defaults to false. If not set, the value of `transfer.fsckObjects`
2912        is used instead.
2913
2914receive.fsck.<msg-id>::
2915        When `receive.fsckObjects` is set to true, errors can be switched
2916        to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2917        setting where the `<msg-id>` is the fsck message ID and the value
2918        is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2919        the error/warning with the message ID, e.g. "missingEmail: invalid
2920        author/committer line - missing email" means that setting
2921        `receive.fsck.missingEmail = ignore` will hide that issue.
2922+
2923This feature is intended to support working with legacy repositories
2924which would not pass pushing when `receive.fsckObjects = true`, allowing
2925the host to accept repositories with certain known issues but still catch
2926other issues.
2927
2928receive.fsck.skipList::
2929        The path to a sorted list of object names (i.e. one SHA-1 per
2930        line) that are known to be broken in a non-fatal way and should
2931        be ignored. This feature is useful when an established project
2932        should be accepted despite early commits containing errors that
2933        can be safely ignored such as invalid committer email addresses.
2934        Note: corrupt objects cannot be skipped with this setting.
2935
2936receive.keepAlive::
2937        After receiving the pack from the client, `receive-pack` may
2938        produce no output (if `--quiet` was specified) while processing
2939        the pack, causing some networks to drop the TCP connection.
2940        With this option set, if `receive-pack` does not transmit
2941        any data in this phase for `receive.keepAlive` seconds, it will
2942        send a short keepalive packet.  The default is 5 seconds; set
2943        to 0 to disable keepalives entirely.
2944
2945receive.unpackLimit::
2946        If the number of objects received in a push is below this
2947        limit then the objects will be unpacked into loose object
2948        files. However if the number of received objects equals or
2949        exceeds this limit then the received pack will be stored as
2950        a pack, after adding any missing delta bases.  Storing the
2951        pack from a push can make the push operation complete faster,
2952        especially on slow filesystems.  If not set, the value of
2953        `transfer.unpackLimit` is used instead.
2954
2955receive.maxInputSize::
2956        If the size of the incoming pack stream is larger than this
2957        limit, then git-receive-pack will error out, instead of
2958        accepting the pack file. If not set or set to 0, then the size
2959        is unlimited.
2960
2961receive.denyDeletes::
2962        If set to true, git-receive-pack will deny a ref update that deletes
2963        the ref. Use this to prevent such a ref deletion via a push.
2964
2965receive.denyDeleteCurrent::
2966        If set to true, git-receive-pack will deny a ref update that
2967        deletes the currently checked out branch of a non-bare repository.
2968
2969receive.denyCurrentBranch::
2970        If set to true or "refuse", git-receive-pack will deny a ref update
2971        to the currently checked out branch of a non-bare repository.
2972        Such a push is potentially dangerous because it brings the HEAD
2973        out of sync with the index and working tree. If set to "warn",
2974        print a warning of such a push to stderr, but allow the push to
2975        proceed. If set to false or "ignore", allow such pushes with no
2976        message. Defaults to "refuse".
2977+
2978Another option is "updateInstead" which will update the working
2979tree if pushing into the current branch.  This option is
2980intended for synchronizing working directories when one side is not easily
2981accessible via interactive ssh (e.g. a live web site, hence the requirement
2982that the working directory be clean). This mode also comes in handy when
2983developing inside a VM to test and fix code on different Operating Systems.
2984+
2985By default, "updateInstead" will refuse the push if the working tree or
2986the index have any difference from the HEAD, but the `push-to-checkout`
2987hook can be used to customize this.  See linkgit:githooks[5].
2988
2989receive.denyNonFastForwards::
2990        If set to true, git-receive-pack will deny a ref update which is
2991        not a fast-forward. Use this to prevent such an update via a push,
2992        even if that push is forced. This configuration variable is
2993        set when initializing a shared repository.
2994
2995receive.hideRefs::
2996        This variable is the same as `transfer.hideRefs`, but applies
2997        only to `receive-pack` (and so affects pushes, but not fetches).
2998        An attempt to update or delete a hidden ref by `git push` is
2999        rejected.
3000
3001receive.updateServerInfo::
3002        If set to true, git-receive-pack will run git-update-server-info
3003        after receiving data from git-push and updating refs.
3004
3005receive.shallowUpdate::
3006        If set to true, .git/shallow can be updated when new refs
3007        require new shallow roots. Otherwise those refs are rejected.
3008
3009remote.pushDefault::
3010        The remote to push to by default.  Overrides
3011        `branch.<name>.remote` for all branches, and is overridden by
3012        `branch.<name>.pushRemote` for specific branches.
3013
3014remote.<name>.url::
3015        The URL of a remote repository.  See linkgit:git-fetch[1] or
3016        linkgit:git-push[1].
3017
3018remote.<name>.pushurl::
3019        The push URL of a remote repository.  See linkgit:git-push[1].
3020
3021remote.<name>.proxy::
3022        For remotes that require curl (http, https and ftp), the URL to
3023        the proxy to use for that remote.  Set to the empty string to
3024        disable proxying for that remote.
3025
3026remote.<name>.proxyAuthMethod::
3027        For remotes that require curl (http, https and ftp), the method to use for
3028        authenticating against the proxy in use (probably set in
3029        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3030
3031remote.<name>.fetch::
3032        The default set of "refspec" for linkgit:git-fetch[1]. See
3033        linkgit:git-fetch[1].
3034
3035remote.<name>.push::
3036        The default set of "refspec" for linkgit:git-push[1]. See
3037        linkgit:git-push[1].
3038
3039remote.<name>.mirror::
3040        If true, pushing to this remote will automatically behave
3041        as if the `--mirror` option was given on the command line.
3042
3043remote.<name>.skipDefaultUpdate::
3044        If true, this remote will be skipped by default when updating
3045        using linkgit:git-fetch[1] or the `update` subcommand of
3046        linkgit:git-remote[1].
3047
3048remote.<name>.skipFetchAll::
3049        If true, this remote will be skipped by default when updating
3050        using linkgit:git-fetch[1] or the `update` subcommand of
3051        linkgit:git-remote[1].
3052
3053remote.<name>.receivepack::
3054        The default program to execute on the remote side when pushing.  See
3055        option --receive-pack of linkgit:git-push[1].
3056
3057remote.<name>.uploadpack::
3058        The default program to execute on the remote side when fetching.  See
3059        option --upload-pack of linkgit:git-fetch-pack[1].
3060
3061remote.<name>.tagOpt::
3062        Setting this value to --no-tags disables automatic tag following when
3063        fetching from remote <name>. Setting it to --tags will fetch every
3064        tag from remote <name>, even if they are not reachable from remote
3065        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3066        override this setting. See options --tags and --no-tags of
3067        linkgit:git-fetch[1].
3068
3069remote.<name>.vcs::
3070        Setting this to a value <vcs> will cause Git to interact with
3071        the remote with the git-remote-<vcs> helper.
3072
3073remote.<name>.prune::
3074        When set to true, fetching from this remote by default will also
3075        remove any remote-tracking references that no longer exist on the
3076        remote (as if the `--prune` option was given on the command line).
3077        Overrides `fetch.prune` settings, if any.
3078
3079remote.<name>.pruneTags::
3080        When set to true, fetching from this remote by default will also
3081        remove any local tags that no longer exist on the remote if pruning
3082        is activated in general via `remote.<name>.prune`, `fetch.prune` or
3083        `--prune`. Overrides `fetch.pruneTags` settings, if any.
3084+
3085See also `remote.<name>.prune` and the PRUNING section of
3086linkgit:git-fetch[1].
3087
3088remotes.<group>::
3089        The list of remotes which are fetched by "git remote update
3090        <group>".  See linkgit:git-remote[1].
3091
3092repack.useDeltaBaseOffset::
3093        By default, linkgit:git-repack[1] creates packs that use
3094        delta-base offset. If you need to share your repository with
3095        Git older than version 1.4.4, either directly or via a dumb
3096        protocol such as http, then you need to set this option to
3097        "false" and repack. Access from old Git versions over the
3098        native protocol are unaffected by this option.
3099
3100repack.packKeptObjects::
3101        If set to true, makes `git repack` act as if
3102        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3103        details. Defaults to `false` normally, but `true` if a bitmap
3104        index is being written (either via `--write-bitmap-index` or
3105        `repack.writeBitmaps`).
3106
3107repack.writeBitmaps::
3108        When true, git will write a bitmap index when packing all
3109        objects to disk (e.g., when `git repack -a` is run).  This
3110        index can speed up the "counting objects" phase of subsequent
3111        packs created for clones and fetches, at the cost of some disk
3112        space and extra time spent on the initial repack.  This has
3113        no effect if multiple packfiles are created.
3114        Defaults to false.
3115
3116rerere.autoUpdate::
3117        When set to true, `git-rerere` updates the index with the
3118        resulting contents after it cleanly resolves conflicts using
3119        previously recorded resolution.  Defaults to false.
3120
3121rerere.enabled::
3122        Activate recording of resolved conflicts, so that identical
3123        conflict hunks can be resolved automatically, should they be
3124        encountered again.  By default, linkgit:git-rerere[1] is
3125        enabled if there is an `rr-cache` directory under the
3126        `$GIT_DIR`, e.g. if "rerere" was previously used in the
3127        repository.
3128
3129sendemail.identity::
3130        A configuration identity. When given, causes values in the
3131        'sendemail.<identity>' subsection to take precedence over
3132        values in the 'sendemail' section. The default identity is
3133        the value of `sendemail.identity`.
3134
3135sendemail.smtpEncryption::
3136        See linkgit:git-send-email[1] for description.  Note that this
3137        setting is not subject to the 'identity' mechanism.
3138
3139sendemail.smtpssl (deprecated)::
3140        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3141
3142sendemail.smtpsslcertpath::
3143        Path to ca-certificates (either a directory or a single file).
3144        Set it to an empty string to disable certificate verification.
3145
3146sendemail.<identity>.*::
3147        Identity-specific versions of the 'sendemail.*' parameters
3148        found below, taking precedence over those when this
3149        identity is selected, through either the command-line or
3150        `sendemail.identity`.
3151
3152sendemail.aliasesFile::
3153sendemail.aliasFileType::
3154sendemail.annotate::
3155sendemail.bcc::
3156sendemail.cc::
3157sendemail.ccCmd::
3158sendemail.chainReplyTo::
3159sendemail.confirm::
3160sendemail.envelopeSender::
3161sendemail.from::
3162sendemail.multiEdit::
3163sendemail.signedoffbycc::
3164sendemail.smtpPass::
3165sendemail.suppresscc::
3166sendemail.suppressFrom::
3167sendemail.to::
3168sendemail.tocmd::
3169sendemail.smtpDomain::
3170sendemail.smtpServer::
3171sendemail.smtpServerPort::
3172sendemail.smtpServerOption::
3173sendemail.smtpUser::
3174sendemail.thread::
3175sendemail.transferEncoding::
3176sendemail.validate::
3177sendemail.xmailer::
3178        See linkgit:git-send-email[1] for description.
3179
3180sendemail.signedoffcc (deprecated)::
3181        Deprecated alias for `sendemail.signedoffbycc`.
3182
3183sendemail.smtpBatchSize::
3184        Number of messages to be sent per connection, after that a relogin
3185        will happen.  If the value is 0 or undefined, send all messages in
3186        one connection.
3187        See also the `--batch-size` option of linkgit:git-send-email[1].
3188
3189sendemail.smtpReloginDelay::
3190        Seconds wait before reconnecting to smtp server.
3191        See also the `--relogin-delay` option of linkgit:git-send-email[1].
3192
3193showbranch.default::
3194        The default set of branches for linkgit:git-show-branch[1].
3195        See linkgit:git-show-branch[1].
3196
3197splitIndex.maxPercentChange::
3198        When the split index feature is used, this specifies the
3199        percent of entries the split index can contain compared to the
3200        total number of entries in both the split index and the shared
3201        index before a new shared index is written.
3202        The value should be between 0 and 100. If the value is 0 then
3203        a new shared index is always written, if it is 100 a new
3204        shared index is never written.
3205        By default the value is 20, so a new shared index is written
3206        if the number of entries in the split index would be greater
3207        than 20 percent of the total number of entries.
3208        See linkgit:git-update-index[1].
3209
3210splitIndex.sharedIndexExpire::
3211        When the split index feature is used, shared index files that
3212        were not modified since the time this variable specifies will
3213        be removed when a new shared index file is created. The value
3214        "now" expires all entries immediately, and "never" suppresses
3215        expiration altogether.
3216        The default value is "2.weeks.ago".
3217        Note that a shared index file is considered modified (for the
3218        purpose of expiration) each time a new split-index file is
3219        either created based on it or read from it.
3220        See linkgit:git-update-index[1].
3221
3222status.relativePaths::
3223        By default, linkgit:git-status[1] shows paths relative to the
3224        current directory. Setting this variable to `false` shows paths
3225        relative to the repository root (this was the default for Git
3226        prior to v1.5.4).
3227
3228status.short::
3229        Set to true to enable --short by default in linkgit:git-status[1].
3230        The option --no-short takes precedence over this variable.
3231
3232status.branch::
3233        Set to true to enable --branch by default in linkgit:git-status[1].
3234        The option --no-branch takes precedence over this variable.
3235
3236status.displayCommentPrefix::
3237        If set to true, linkgit:git-status[1] will insert a comment
3238        prefix before each output line (starting with
3239        `core.commentChar`, i.e. `#` by default). This was the
3240        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3241        Defaults to false.
3242
3243status.renameLimit::
3244        The number of files to consider when performing rename detection
3245        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3246        the value of diff.renameLimit.
3247
3248status.renames::
3249        Whether and how Git detects renames in linkgit:git-status[1] and
3250        linkgit:git-commit[1] .  If set to "false", rename detection is
3251        disabled. If set to "true", basic rename detection is enabled.
3252        If set to "copies" or "copy", Git will detect copies, as well.
3253        Defaults to the value of diff.renames.
3254
3255status.showStash::
3256        If set to true, linkgit:git-status[1] will display the number of
3257        entries currently stashed away.
3258        Defaults to false.
3259
3260status.showUntrackedFiles::
3261        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3262        files which are not currently tracked by Git. Directories which
3263        contain only untracked files, are shown with the directory name
3264        only. Showing untracked files means that Git needs to lstat() all
3265        the files in the whole repository, which might be slow on some
3266        systems. So, this variable controls how the commands displays
3267        the untracked files. Possible values are:
3268+
3269--
3270* `no` - Show no untracked files.
3271* `normal` - Show untracked files and directories.
3272* `all` - Show also individual files in untracked directories.
3273--
3274+
3275If this variable is not specified, it defaults to 'normal'.
3276This variable can be overridden with the -u|--untracked-files option
3277of linkgit:git-status[1] and linkgit:git-commit[1].
3278
3279status.submoduleSummary::
3280        Defaults to false.
3281        If this is set to a non zero number or true (identical to -1 or an
3282        unlimited number), the submodule summary will be enabled and a
3283        summary of commits for modified submodules will be shown (see
3284        --summary-limit option of linkgit:git-submodule[1]). Please note
3285        that the summary output command will be suppressed for all
3286        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3287        for those submodules where `submodule.<name>.ignore=all`. The only
3288        exception to that rule is that status and commit will show staged
3289        submodule changes. To
3290        also view the summary for ignored submodules you can either use
3291        the --ignore-submodules=dirty command-line option or the 'git
3292        submodule summary' command, which shows a similar output but does
3293        not honor these settings.
3294
3295stash.showPatch::
3296        If this is set to true, the `git stash show` command without an
3297        option will show the stash entry in patch form.  Defaults to false.
3298        See description of 'show' command in linkgit:git-stash[1].
3299
3300stash.showStat::
3301        If this is set to true, the `git stash show` command without an
3302        option will show diffstat of the stash entry.  Defaults to true.
3303        See description of 'show' command in linkgit:git-stash[1].
3304
3305submodule.<name>.url::
3306        The URL for a submodule. This variable is copied from the .gitmodules
3307        file to the git config via 'git submodule init'. The user can change
3308        the configured URL before obtaining the submodule via 'git submodule
3309        update'. If neither submodule.<name>.active or submodule.active are
3310        set, the presence of this variable is used as a fallback to indicate
3311        whether the submodule is of interest to git commands.
3312        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3313
3314submodule.<name>.update::
3315        The method by which a submodule is updated by 'git submodule update',
3316        which is the only affected command, others such as
3317        'git checkout --recurse-submodules' are unaffected. It exists for
3318        historical reasons, when 'git submodule' was the only command to
3319        interact with submodules; settings like `submodule.active`
3320        and `pull.rebase` are more specific. It is populated by
3321        `git submodule init` from the linkgit:gitmodules[5] file.
3322        See description of 'update' command in linkgit:git-submodule[1].
3323
3324submodule.<name>.branch::
3325        The remote branch name for a submodule, used by `git submodule
3326        update --remote`.  Set this option to override the value found in
3327        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3328        linkgit:gitmodules[5] for details.
3329
3330submodule.<name>.fetchRecurseSubmodules::
3331        This option can be used to control recursive fetching of this
3332        submodule. It can be overridden by using the --[no-]recurse-submodules
3333        command-line option to "git fetch" and "git pull".
3334        This setting will override that from in the linkgit:gitmodules[5]
3335        file.
3336
3337submodule.<name>.ignore::
3338        Defines under what circumstances "git status" and the diff family show
3339        a submodule as modified. When set to "all", it will never be considered
3340        modified (but it will nonetheless show up in the output of status and
3341        commit when it has been staged), "dirty" will ignore all changes
3342        to the submodules work tree and
3343        takes only differences between the HEAD of the submodule and the commit
3344        recorded in the superproject into account. "untracked" will additionally
3345        let submodules with modified tracked files in their work tree show up.
3346        Using "none" (the default when this option is not set) also shows
3347        submodules that have untracked files in their work tree as changed.
3348        This setting overrides any setting made in .gitmodules for this submodule,
3349        both settings can be overridden on the command line by using the
3350        "--ignore-submodules" option. The 'git submodule' commands are not
3351        affected by this setting.
3352
3353submodule.<name>.active::
3354        Boolean value indicating if the submodule is of interest to git
3355        commands.  This config option takes precedence over the
3356        submodule.active config option.
3357
3358submodule.active::
3359        A repeated field which contains a pathspec used to match against a
3360        submodule's path to determine if the submodule is of interest to git
3361        commands.
3362
3363submodule.recurse::
3364        Specifies if commands recurse into submodules by default. This
3365        applies to all commands that have a `--recurse-submodules` option,
3366        except `clone`.
3367        Defaults to false.
3368
3369submodule.fetchJobs::
3370        Specifies how many submodules are fetched/cloned at the same time.
3371        A positive integer allows up to that number of submodules fetched
3372        in parallel. A value of 0 will give some reasonable default.
3373        If unset, it defaults to 1.
3374
3375submodule.alternateLocation::
3376        Specifies how the submodules obtain alternates when submodules are
3377        cloned. Possible values are `no`, `superproject`.
3378        By default `no` is assumed, which doesn't add references. When the
3379        value is set to `superproject` the submodule to be cloned computes
3380        its alternates location relative to the superprojects alternate.
3381
3382submodule.alternateErrorStrategy::
3383        Specifies how to treat errors with the alternates for a submodule
3384        as computed via `submodule.alternateLocation`. Possible values are
3385        `ignore`, `info`, `die`. Default is `die`.
3386
3387tag.forceSignAnnotated::
3388        A boolean to specify whether annotated tags created should be GPG signed.
3389        If `--annotate` is specified on the command line, it takes
3390        precedence over this option.
3391
3392tag.sort::
3393        This variable controls the sort ordering of tags when displayed by
3394        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3395        value of this variable will be used as the default.
3396
3397tar.umask::
3398        This variable can be used to restrict the permission bits of
3399        tar archive entries.  The default is 0002, which turns off the
3400        world write bit.  The special value "user" indicates that the
3401        archiving user's umask will be used instead.  See umask(2) and
3402        linkgit:git-archive[1].
3403
3404transfer.fsckObjects::
3405        When `fetch.fsckObjects` or `receive.fsckObjects` are
3406        not set, the value of this variable is used instead.
3407        Defaults to false.
3408
3409transfer.hideRefs::
3410        String(s) `receive-pack` and `upload-pack` use to decide which
3411        refs to omit from their initial advertisements.  Use more than
3412        one definition to specify multiple prefix strings. A ref that is
3413        under the hierarchies listed in the value of this variable is
3414        excluded, and is hidden when responding to `git push` or `git
3415        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3416        program-specific versions of this config.
3417+
3418You may also include a `!` in front of the ref name to negate the entry,
3419explicitly exposing it, even if an earlier entry marked it as hidden.
3420If you have multiple hideRefs values, later entries override earlier ones
3421(and entries in more-specific config files override less-specific ones).
3422+
3423If a namespace is in use, the namespace prefix is stripped from each
3424reference before it is matched against `transfer.hiderefs` patterns.
3425For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3426the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3427is omitted from the advertisements but `refs/heads/master` and
3428`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3429"have" lines. In order to match refs before stripping, add a `^` in front of
3430the ref name. If you combine `!` and `^`, `!` must be specified first.
3431+
3432Even if you hide refs, a client may still be able to steal the target
3433objects via the techniques described in the "SECURITY" section of the
3434linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3435separate repository.
3436
3437transfer.unpackLimit::
3438        When `fetch.unpackLimit` or `receive.unpackLimit` are
3439        not set, the value of this variable is used instead.
3440        The default value is 100.
3441
3442uploadarchive.allowUnreachable::
3443        If true, allow clients to use `git archive --remote` to request
3444        any tree, whether reachable from the ref tips or not. See the
3445        discussion in the "SECURITY" section of
3446        linkgit:git-upload-archive[1] for more details. Defaults to
3447        `false`.
3448
3449uploadpack.hideRefs::
3450        This variable is the same as `transfer.hideRefs`, but applies
3451        only to `upload-pack` (and so affects only fetches, not pushes).
3452        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3453        also `uploadpack.allowTipSHA1InWant`.
3454
3455uploadpack.allowTipSHA1InWant::
3456        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3457        to accept a fetch request that asks for an object at the tip
3458        of a hidden ref (by default, such a request is rejected).
3459        See also `uploadpack.hideRefs`.  Even if this is false, a client
3460        may be able to steal objects via the techniques described in the
3461        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3462        best to keep private data in a separate repository.
3463
3464uploadpack.allowReachableSHA1InWant::
3465        Allow `upload-pack` to accept a fetch request that asks for an
3466        object that is reachable from any ref tip. However, note that
3467        calculating object reachability is computationally expensive.
3468        Defaults to `false`.  Even if this is false, a client may be able
3469        to steal objects via the techniques described in the "SECURITY"
3470        section of the linkgit:gitnamespaces[7] man page; it's best to
3471        keep private data in a separate repository.
3472
3473uploadpack.allowAnySHA1InWant::
3474        Allow `upload-pack` to accept a fetch request that asks for any
3475        object at all.
3476        Defaults to `false`.
3477
3478uploadpack.keepAlive::
3479        When `upload-pack` has started `pack-objects`, there may be a
3480        quiet period while `pack-objects` prepares the pack. Normally
3481        it would output progress information, but if `--quiet` was used
3482        for the fetch, `pack-objects` will output nothing at all until
3483        the pack data begins. Some clients and networks may consider
3484        the server to be hung and give up. Setting this option instructs
3485        `upload-pack` to send an empty keepalive packet every
3486        `uploadpack.keepAlive` seconds. Setting this option to 0
3487        disables keepalive packets entirely. The default is 5 seconds.
3488
3489uploadpack.packObjectsHook::
3490        If this option is set, when `upload-pack` would run
3491        `git pack-objects` to create a packfile for a client, it will
3492        run this shell command instead.  The `pack-objects` command and
3493        arguments it _would_ have run (including the `git pack-objects`
3494        at the beginning) are appended to the shell command. The stdin
3495        and stdout of the hook are treated as if `pack-objects` itself
3496        was run. I.e., `upload-pack` will feed input intended for
3497        `pack-objects` to the hook, and expects a completed packfile on
3498        stdout.
3499
3500uploadpack.allowFilter::
3501        If this option is set, `upload-pack` will support partial
3502        clone and partial fetch object filtering.
3503+
3504Note that this configuration variable is ignored if it is seen in the
3505repository-level config (this is a safety measure against fetching from
3506untrusted repositories).
3507
3508url.<base>.insteadOf::
3509        Any URL that starts with this value will be rewritten to
3510        start, instead, with <base>. In cases where some site serves a
3511        large number of repositories, and serves them with multiple
3512        access methods, and some users need to use different access
3513        methods, this feature allows people to specify any of the
3514        equivalent URLs and have Git automatically rewrite the URL to
3515        the best alternative for the particular user, even for a
3516        never-before-seen repository on the site.  When more than one
3517        insteadOf strings match a given URL, the longest match is used.
3518+
3519Note that any protocol restrictions will be applied to the rewritten
3520URL. If the rewrite changes the URL to use a custom protocol or remote
3521helper, you may need to adjust the `protocol.*.allow` config to permit
3522the request.  In particular, protocols you expect to use for submodules
3523must be set to `always` rather than the default of `user`. See the
3524description of `protocol.allow` above.
3525
3526url.<base>.pushInsteadOf::
3527        Any URL that starts with this value will not be pushed to;
3528        instead, it will be rewritten to start with <base>, and the
3529        resulting URL will be pushed to. In cases where some site serves
3530        a large number of repositories, and serves them with multiple
3531        access methods, some of which do not allow push, this feature
3532        allows people to specify a pull-only URL and have Git
3533        automatically use an appropriate URL to push, even for a
3534        never-before-seen repository on the site.  When more than one
3535        pushInsteadOf strings match a given URL, the longest match is
3536        used.  If a remote has an explicit pushurl, Git will ignore this
3537        setting for that remote.
3538
3539user.email::
3540        Your email address to be recorded in any newly created commits.
3541        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3542        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3543
3544user.name::
3545        Your full name to be recorded in any newly created commits.
3546        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3547        environment variables.  See linkgit:git-commit-tree[1].
3548
3549user.useConfigOnly::
3550        Instruct Git to avoid trying to guess defaults for `user.email`
3551        and `user.name`, and instead retrieve the values only from the
3552        configuration. For example, if you have multiple email addresses
3553        and would like to use a different one for each repository, then
3554        with this configuration option set to `true` in the global config
3555        along with a name, Git will prompt you to set up an email before
3556        making new commits in a newly cloned repository.
3557        Defaults to `false`.
3558
3559user.signingKey::
3560        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3561        key you want it to automatically when creating a signed tag or
3562        commit, you can override the default selection with this variable.
3563        This option is passed unchanged to gpg's --local-user parameter,
3564        so you may specify a key using any method that gpg supports.
3565
3566versionsort.prereleaseSuffix (deprecated)::
3567        Deprecated alias for `versionsort.suffix`.  Ignored if
3568        `versionsort.suffix` is set.
3569
3570versionsort.suffix::
3571        Even when version sort is used in linkgit:git-tag[1], tagnames
3572        with the same base version but different suffixes are still sorted
3573        lexicographically, resulting e.g. in prerelease tags appearing
3574        after the main release (e.g. "1.0-rc1" after "1.0").  This
3575        variable can be specified to determine the sorting order of tags
3576        with different suffixes.
3577+
3578By specifying a single suffix in this variable, any tagname containing
3579that suffix will appear before the corresponding main release.  E.g. if
3580the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3581"1.0".  If specified multiple times, once per suffix, then the order of
3582suffixes in the configuration will determine the sorting order of tagnames
3583with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3584configuration, then all "1.0-preX" tags will be listed before any
3585"1.0-rcX" tags.  The placement of the main release tag relative to tags
3586with various suffixes can be determined by specifying the empty suffix
3587among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3588"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3589are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3590"v4.8-bfsX".
3591+
3592If more than one suffixes match the same tagname, then that tagname will
3593be sorted according to the suffix which starts at the earliest position in
3594the tagname.  If more than one different matching suffixes start at
3595that earliest position, then that tagname will be sorted according to the
3596longest of those suffixes.
3597The sorting order between different suffixes is undefined if they are
3598in multiple config files.
3599
3600web.browser::
3601        Specify a web browser that may be used by some commands.
3602        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3603        may use it.
3604
3605worktree.guessRemote::
3606        With `add`, if no branch argument, and neither of `-b` nor
3607        `-B` nor `--detach` are given, the command defaults to
3608        creating a new branch from HEAD.  If `worktree.guessRemote` is
3609        set to true, `worktree add` tries to find a remote-tracking
3610        branch whose name uniquely matches the new branch name.  If
3611        such a branch exists, it is checked out and set as "upstream"
3612        for the new branch.  If no such match can be found, it falls
3613        back to creating a new branch from the current HEAD.