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