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