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