Documentation / config.txton commit Merge branch 'sb/diff-color-move' (b6c4058)
   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        The default is 60 days.  See linkgit:git-rerere[1].
1568
1569gc.rerereUnresolved::
1570        Records of conflicted merge you have not resolved are
1571        kept for this many days when 'git rerere gc' is run.
1572        The default is 15 days.  See linkgit:git-rerere[1].
1573
1574gitcvs.commitMsgAnnotation::
1575        Append this string to each commit message. Set to empty string
1576        to disable this feature. Defaults to "via git-CVS emulator".
1577
1578gitcvs.enabled::
1579        Whether the CVS server interface is enabled for this repository.
1580        See linkgit:git-cvsserver[1].
1581
1582gitcvs.logFile::
1583        Path to a log file where the CVS server interface well... logs
1584        various stuff. See linkgit:git-cvsserver[1].
1585
1586gitcvs.usecrlfattr::
1587        If true, the server will look up the end-of-line conversion
1588        attributes for files to determine the `-k` modes to use. If
1589        the attributes force Git to treat a file as text,
1590        the `-k` mode will be left blank so CVS clients will
1591        treat it as text. If they suppress text conversion, the file
1592        will be set with '-kb' mode, which suppresses any newline munging
1593        the client might otherwise do. If the attributes do not allow
1594        the file type to be determined, then `gitcvs.allBinary` is
1595        used. See linkgit:gitattributes[5].
1596
1597gitcvs.allBinary::
1598        This is used if `gitcvs.usecrlfattr` does not resolve
1599        the correct '-kb' mode to use. If true, all
1600        unresolved files are sent to the client in
1601        mode '-kb'. This causes the client to treat them
1602        as binary files, which suppresses any newline munging it
1603        otherwise might do. Alternatively, if it is set to "guess",
1604        then the contents of the file are examined to decide if
1605        it is binary, similar to `core.autocrlf`.
1606
1607gitcvs.dbName::
1608        Database used by git-cvsserver to cache revision information
1609        derived from the Git repository. The exact meaning depends on the
1610        used database driver, for SQLite (which is the default driver) this
1611        is a filename. Supports variable substitution (see
1612        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1613        Default: '%Ggitcvs.%m.sqlite'
1614
1615gitcvs.dbDriver::
1616        Used Perl DBI driver. You can specify any available driver
1617        for this here, but it might not work. git-cvsserver is tested
1618        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1619        reported *not* to work with 'DBD::mysql'. Experimental feature.
1620        May not contain double colons (`:`). Default: 'SQLite'.
1621        See linkgit:git-cvsserver[1].
1622
1623gitcvs.dbUser, gitcvs.dbPass::
1624        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1625        since SQLite has no concept of database users and/or passwords.
1626        'gitcvs.dbUser' supports variable substitution (see
1627        linkgit:git-cvsserver[1] for details).
1628
1629gitcvs.dbTableNamePrefix::
1630        Database table name prefix.  Prepended to the names of any
1631        database tables used, allowing a single database to be used
1632        for several repositories.  Supports variable substitution (see
1633        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1634        characters will be replaced with underscores.
1635
1636All gitcvs variables except for `gitcvs.usecrlfattr` and
1637`gitcvs.allBinary` can also be specified as
1638'gitcvs.<access_method>.<varname>' (where 'access_method'
1639is one of "ext" and "pserver") to make them apply only for the given
1640access method.
1641
1642gitweb.category::
1643gitweb.description::
1644gitweb.owner::
1645gitweb.url::
1646        See linkgit:gitweb[1] for description.
1647
1648gitweb.avatar::
1649gitweb.blame::
1650gitweb.grep::
1651gitweb.highlight::
1652gitweb.patches::
1653gitweb.pickaxe::
1654gitweb.remote_heads::
1655gitweb.showSizes::
1656gitweb.snapshot::
1657        See linkgit:gitweb.conf[5] for description.
1658
1659grep.lineNumber::
1660        If set to true, enable `-n` option by default.
1661
1662grep.patternType::
1663        Set the default matching behavior. Using a value of 'basic', 'extended',
1664        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1665        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1666        value 'default' will return to the default matching behavior.
1667
1668grep.extendedRegexp::
1669        If set to true, enable `--extended-regexp` option by default. This
1670        option is ignored when the `grep.patternType` option is set to a value
1671        other than 'default'.
1672
1673grep.threads::
1674        Number of grep worker threads to use.
1675        See `grep.threads` in linkgit:git-grep[1] for more information.
1676
1677grep.fallbackToNoIndex::
1678        If set to true, fall back to git grep --no-index if git grep
1679        is executed outside of a git repository.  Defaults to false.
1680
1681gpg.program::
1682        Use this custom program instead of "`gpg`" found on `$PATH` when
1683        making or verifying a PGP signature. The program must support the
1684        same command-line interface as GPG, namely, to verify a detached
1685        signature, "`gpg --verify $file - <$signature`" is run, and the
1686        program is expected to signal a good signature by exiting with
1687        code 0, and to generate an ASCII-armored detached signature, the
1688        standard input of "`gpg -bsau $key`" is fed with the contents to be
1689        signed, and the program is expected to send the result to its
1690        standard output.
1691
1692gui.commitMsgWidth::
1693        Defines how wide the commit message window is in the
1694        linkgit:git-gui[1]. "75" is the default.
1695
1696gui.diffContext::
1697        Specifies how many context lines should be used in calls to diff
1698        made by the linkgit:git-gui[1]. The default is "5".
1699
1700gui.displayUntracked::
1701        Determines if linkgit:git-gui[1] shows untracked files
1702        in the file list. The default is "true".
1703
1704gui.encoding::
1705        Specifies the default encoding to use for displaying of
1706        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1707        It can be overridden by setting the 'encoding' attribute
1708        for relevant files (see linkgit:gitattributes[5]).
1709        If this option is not set, the tools default to the
1710        locale encoding.
1711
1712gui.matchTrackingBranch::
1713        Determines if new branches created with linkgit:git-gui[1] should
1714        default to tracking remote branches with matching names or
1715        not. Default: "false".
1716
1717gui.newBranchTemplate::
1718        Is used as suggested name when creating new branches using the
1719        linkgit:git-gui[1].
1720
1721gui.pruneDuringFetch::
1722        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1723        performing a fetch. The default value is "false".
1724
1725gui.trustmtime::
1726        Determines if linkgit:git-gui[1] should trust the file modification
1727        timestamp or not. By default the timestamps are not trusted.
1728
1729gui.spellingDictionary::
1730        Specifies the dictionary used for spell checking commit messages in
1731        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1732        off.
1733
1734gui.fastCopyBlame::
1735        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1736        location detection. It makes blame significantly faster on huge
1737        repositories at the expense of less thorough copy detection.
1738
1739gui.copyBlameThreshold::
1740        Specifies the threshold to use in 'git gui blame' original location
1741        detection, measured in alphanumeric characters. See the
1742        linkgit:git-blame[1] manual for more information on copy detection.
1743
1744gui.blamehistoryctx::
1745        Specifies the radius of history context in days to show in
1746        linkgit:gitk[1] for the selected commit, when the `Show History
1747        Context` menu item is invoked from 'git gui blame'. If this
1748        variable is set to zero, the whole history is shown.
1749
1750guitool.<name>.cmd::
1751        Specifies the shell command line to execute when the corresponding item
1752        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1753        mandatory for every tool. The command is executed from the root of
1754        the working directory, and in the environment it receives the name of
1755        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1756        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1757        the head is detached, 'CUR_BRANCH' is empty).
1758
1759guitool.<name>.needsFile::
1760        Run the tool only if a diff is selected in the GUI. It guarantees
1761        that 'FILENAME' is not empty.
1762
1763guitool.<name>.noConsole::
1764        Run the command silently, without creating a window to display its
1765        output.
1766
1767guitool.<name>.noRescan::
1768        Don't rescan the working directory for changes after the tool
1769        finishes execution.
1770
1771guitool.<name>.confirm::
1772        Show a confirmation dialog before actually running the tool.
1773
1774guitool.<name>.argPrompt::
1775        Request a string argument from the user, and pass it to the tool
1776        through the `ARGS` environment variable. Since requesting an
1777        argument implies confirmation, the 'confirm' option has no effect
1778        if this is enabled. If the option is set to 'true', 'yes', or '1',
1779        the dialog uses a built-in generic prompt; otherwise the exact
1780        value of the variable is used.
1781
1782guitool.<name>.revPrompt::
1783        Request a single valid revision from the user, and set the
1784        `REVISION` environment variable. In other aspects this option
1785        is similar to 'argPrompt', and can be used together with it.
1786
1787guitool.<name>.revUnmerged::
1788        Show only unmerged branches in the 'revPrompt' subdialog.
1789        This is useful for tools similar to merge or rebase, but not
1790        for things like checkout or reset.
1791
1792guitool.<name>.title::
1793        Specifies the title to use for the prompt dialog. The default
1794        is the tool name.
1795
1796guitool.<name>.prompt::
1797        Specifies the general prompt string to display at the top of
1798        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1799        The default value includes the actual command.
1800
1801help.browser::
1802        Specify the browser that will be used to display help in the
1803        'web' format. See linkgit:git-help[1].
1804
1805help.format::
1806        Override the default help format used by linkgit:git-help[1].
1807        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1808        the default. 'web' and 'html' are the same.
1809
1810help.autoCorrect::
1811        Automatically correct and execute mistyped commands after
1812        waiting for the given number of deciseconds (0.1 sec). If more
1813        than one command can be deduced from the entered text, nothing
1814        will be executed.  If the value of this option is negative,
1815        the corrected command will be executed immediately. If the
1816        value is 0 - the command will be just shown but not executed.
1817        This is the default.
1818
1819help.htmlPath::
1820        Specify the path where the HTML documentation resides. File system paths
1821        and URLs are supported. HTML pages will be prefixed with this path when
1822        help is displayed in the 'web' format. This defaults to the documentation
1823        path of your Git installation.
1824
1825http.proxy::
1826        Override the HTTP proxy, normally configured using the 'http_proxy',
1827        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1828        addition to the syntax understood by curl, it is possible to specify a
1829        proxy string with a user name but no password, in which case git will
1830        attempt to acquire one in the same way it does for other credentials. See
1831        linkgit:gitcredentials[7] for more information. The syntax thus is
1832        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1833        on a per-remote basis; see remote.<name>.proxy
1834
1835http.proxyAuthMethod::
1836        Set the method with which to authenticate against the HTTP proxy. This
1837        only takes effect if the configured proxy string contains a user name part
1838        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1839        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1840        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1841        variable.  Possible values are:
1842+
1843--
1844* `anyauth` - Automatically pick a suitable authentication method. It is
1845  assumed that the proxy answers an unauthenticated request with a 407
1846  status code and one or more Proxy-authenticate headers with supported
1847  authentication methods. This is the default.
1848* `basic` - HTTP Basic authentication
1849* `digest` - HTTP Digest authentication; this prevents the password from being
1850  transmitted to the proxy in clear text
1851* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1852  of `curl(1)`)
1853* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1854--
1855
1856http.emptyAuth::
1857        Attempt authentication without seeking a username or password.  This
1858        can be used to attempt GSS-Negotiate authentication without specifying
1859        a username in the URL, as libcurl normally requires a username for
1860        authentication.
1861
1862http.delegation::
1863        Control GSSAPI credential delegation. The delegation is disabled
1864        by default in libcurl since version 7.21.7. Set parameter to tell
1865        the server what it is allowed to delegate when it comes to user
1866        credentials. Used with GSS/kerberos. Possible values are:
1867+
1868--
1869* `none` - Don't allow any delegation.
1870* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1871  Kerberos service ticket, which is a matter of realm policy.
1872* `always` - Unconditionally allow the server to delegate.
1873--
1874
1875
1876http.extraHeader::
1877        Pass an additional HTTP header when communicating with a server.  If
1878        more than one such entry exists, all of them are added as extra
1879        headers.  To allow overriding the settings inherited from the system
1880        config, an empty value will reset the extra headers to the empty list.
1881
1882http.cookieFile::
1883        The pathname of a file containing previously stored cookie lines,
1884        which should be used
1885        in the Git http session, if they match the server. The file format
1886        of the file to read cookies from should be plain HTTP headers or
1887        the Netscape/Mozilla cookie file format (see `curl(1)`).
1888        NOTE that the file specified with http.cookieFile is used only as
1889        input unless http.saveCookies is set.
1890
1891http.saveCookies::
1892        If set, store cookies received during requests to the file specified by
1893        http.cookieFile. Has no effect if http.cookieFile is unset.
1894
1895http.sslVersion::
1896        The SSL version to use when negotiating an SSL connection, if you
1897        want to force the default.  The available and default version
1898        depend on whether libcurl was built against NSS or OpenSSL and the
1899        particular configuration of the crypto library in use. Internally
1900        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1901        documentation for more details on the format of this option and
1902        for the ssl version supported. Actually the possible values of
1903        this option are:
1904
1905        - sslv2
1906        - sslv3
1907        - tlsv1
1908        - tlsv1.0
1909        - tlsv1.1
1910        - tlsv1.2
1911
1912+
1913Can be overridden by the `GIT_SSL_VERSION` environment variable.
1914To force git to use libcurl's default ssl version and ignore any
1915explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1916empty string.
1917
1918http.sslCipherList::
1919  A list of SSL ciphers to use when negotiating an SSL connection.
1920  The available ciphers depend on whether libcurl was built against
1921  NSS or OpenSSL and the particular configuration of the crypto
1922  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1923  option; see the libcurl documentation for more details on the format
1924  of this list.
1925+
1926Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1927To force git to use libcurl's default cipher list and ignore any
1928explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1929empty string.
1930
1931http.sslVerify::
1932        Whether to verify the SSL certificate when fetching or pushing
1933        over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1934        variable.
1935
1936http.sslCert::
1937        File containing the SSL certificate when fetching or pushing
1938        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1939        variable.
1940
1941http.sslKey::
1942        File containing the SSL private key when fetching or pushing
1943        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1944        variable.
1945
1946http.sslCertPasswordProtected::
1947        Enable Git's password prompt for the SSL certificate.  Otherwise
1948        OpenSSL will prompt the user, possibly many times, if the
1949        certificate or private key is encrypted.  Can be overridden by the
1950        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1951
1952http.sslCAInfo::
1953        File containing the certificates to verify the peer with when
1954        fetching or pushing over HTTPS. Can be overridden by the
1955        `GIT_SSL_CAINFO` environment variable.
1956
1957http.sslCAPath::
1958        Path containing files with the CA certificates to verify the peer
1959        with when fetching or pushing over HTTPS. Can be overridden
1960        by the `GIT_SSL_CAPATH` environment variable.
1961
1962http.pinnedpubkey::
1963        Public key of the https service. It may either be the filename of
1964        a PEM or DER encoded public key file or a string starting with
1965        'sha256//' followed by the base64 encoded sha256 hash of the
1966        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1967        exit with an error if this option is set but not supported by
1968        cURL.
1969
1970http.sslTry::
1971        Attempt to use AUTH SSL/TLS and encrypted data transfers
1972        when connecting via regular FTP protocol. This might be needed
1973        if the FTP server requires it for security reasons or you wish
1974        to connect securely whenever remote FTP server supports it.
1975        Default is false since it might trigger certificate verification
1976        errors on misconfigured servers.
1977
1978http.maxRequests::
1979        How many HTTP requests to launch in parallel. Can be overridden
1980        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1981
1982http.minSessions::
1983        The number of curl sessions (counted across slots) to be kept across
1984        requests. They will not be ended with curl_easy_cleanup() until
1985        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1986        value will be capped at 1. Defaults to 1.
1987
1988http.postBuffer::
1989        Maximum size in bytes of the buffer used by smart HTTP
1990        transports when POSTing data to the remote system.
1991        For requests larger than this buffer size, HTTP/1.1 and
1992        Transfer-Encoding: chunked is used to avoid creating a
1993        massive pack file locally.  Default is 1 MiB, which is
1994        sufficient for most requests.
1995
1996http.lowSpeedLimit, http.lowSpeedTime::
1997        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1998        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1999        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2000        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2001
2002http.noEPSV::
2003        A boolean which disables using of EPSV ftp command by curl.
2004        This can helpful with some "poor" ftp servers which don't
2005        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2006        environment variable. Default is false (curl will use EPSV).
2007
2008http.userAgent::
2009        The HTTP USER_AGENT string presented to an HTTP server.  The default
2010        value represents the version of the client Git such as git/1.7.1.
2011        This option allows you to override this value to a more common value
2012        such as Mozilla/4.0.  This may be necessary, for instance, if
2013        connecting through a firewall that restricts HTTP connections to a set
2014        of common USER_AGENT strings (but not including those like git/1.7.1).
2015        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2016
2017http.followRedirects::
2018        Whether git should follow HTTP redirects. If set to `true`, git
2019        will transparently follow any redirect issued by a server it
2020        encounters. If set to `false`, git will treat all redirects as
2021        errors. If set to `initial`, git will follow redirects only for
2022        the initial request to a remote, but not for subsequent
2023        follow-up HTTP requests. Since git uses the redirected URL as
2024        the base for the follow-up requests, this is generally
2025        sufficient. The default is `initial`.
2026
2027http.<url>.*::
2028        Any of the http.* options above can be applied selectively to some URLs.
2029        For a config key to match a URL, each element of the config key is
2030        compared to that of the URL, in the following order:
2031+
2032--
2033. Scheme (e.g., `https` in `https://example.com/`). This field
2034  must match exactly between the config key and the URL.
2035
2036. Host/domain name (e.g., `example.com` in `https://example.com/`).
2037  This field must match between the config key and the URL. It is
2038  possible to specify a `*` as part of the host name to match all subdomains
2039  at this level. `https://*.example.com/` for example would match
2040  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2041
2042. Port number (e.g., `8080` in `http://example.com:8080/`).
2043  This field must match exactly between the config key and the URL.
2044  Omitted port numbers are automatically converted to the correct
2045  default for the scheme before matching.
2046
2047. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2048  path field of the config key must match the path field of the URL
2049  either exactly or as a prefix of slash-delimited path elements.  This means
2050  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2051  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2052  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2053  key with just path `foo/`).
2054
2055. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2056  the config key has a user name it must match the user name in the
2057  URL exactly. If the config key does not have a user name, that
2058  config key will match a URL with any user name (including none),
2059  but at a lower precedence than a config key with a user name.
2060--
2061+
2062The list above is ordered by decreasing precedence; a URL that matches
2063a config key's path is preferred to one that matches its user name. For example,
2064if the URL is `https://user@example.com/foo/bar` a config key match of
2065`https://example.com/foo` will be preferred over a config key match of
2066`https://user@example.com`.
2067+
2068All URLs are normalized before attempting any matching (the password part,
2069if embedded in the URL, is always ignored for matching purposes) so that
2070equivalent URLs that are simply spelled differently will match properly.
2071Environment variable settings always override any matches.  The URLs that are
2072matched against are those given directly to Git commands.  This means any URLs
2073visited as a result of a redirection do not participate in matching.
2074
2075ssh.variant::
2076        Depending on the value of the environment variables `GIT_SSH` or
2077        `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2078        auto-detects whether to adjust its command-line parameters for use
2079        with plink or tortoiseplink, as opposed to the default (OpenSSH).
2080+
2081The config variable `ssh.variant` can be set to override this auto-detection;
2082valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2083will be treated as normal ssh. This setting can be overridden via the
2084environment variable `GIT_SSH_VARIANT`.
2085
2086i18n.commitEncoding::
2087        Character encoding the commit messages are stored in; Git itself
2088        does not care per se, but this information is necessary e.g. when
2089        importing commits from emails or in the gitk graphical history
2090        browser (and possibly at other places in the future or in other
2091        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2092
2093i18n.logOutputEncoding::
2094        Character encoding the commit messages are converted to when
2095        running 'git log' and friends.
2096
2097imap::
2098        The configuration variables in the 'imap' section are described
2099        in linkgit:git-imap-send[1].
2100
2101index.version::
2102        Specify the version with which new index files should be
2103        initialized.  This does not affect existing repositories.
2104
2105init.templateDir::
2106        Specify the directory from which templates will be copied.
2107        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2108
2109instaweb.browser::
2110        Specify the program that will be used to browse your working
2111        repository in gitweb. See linkgit:git-instaweb[1].
2112
2113instaweb.httpd::
2114        The HTTP daemon command-line to start gitweb on your working
2115        repository. See linkgit:git-instaweb[1].
2116
2117instaweb.local::
2118        If true the web server started by linkgit:git-instaweb[1] will
2119        be bound to the local IP (127.0.0.1).
2120
2121instaweb.modulePath::
2122        The default module path for linkgit:git-instaweb[1] to use
2123        instead of /usr/lib/apache2/modules.  Only used if httpd
2124        is Apache.
2125
2126instaweb.port::
2127        The port number to bind the gitweb httpd to. See
2128        linkgit:git-instaweb[1].
2129
2130interactive.singleKey::
2131        In interactive commands, allow the user to provide one-letter
2132        input with a single key (i.e., without hitting enter).
2133        Currently this is used by the `--patch` mode of
2134        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2135        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2136        setting is silently ignored if portable keystroke input
2137        is not available; requires the Perl module Term::ReadKey.
2138
2139interactive.diffFilter::
2140        When an interactive command (such as `git add --patch`) shows
2141        a colorized diff, git will pipe the diff through the shell
2142        command defined by this configuration variable. The command may
2143        mark up the diff further for human consumption, provided that it
2144        retains a one-to-one correspondence with the lines in the
2145        original diff. Defaults to disabled (no filtering).
2146
2147log.abbrevCommit::
2148        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2149        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2150        override this option with `--no-abbrev-commit`.
2151
2152log.date::
2153        Set the default date-time mode for the 'log' command.
2154        Setting a value for log.date is similar to using 'git log''s
2155        `--date` option.  See linkgit:git-log[1] for details.
2156
2157log.decorate::
2158        Print out the ref names of any commits that are shown by the log
2159        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2160        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2161        specified, the full ref name (including prefix) will be printed.
2162        If 'auto' is specified, then if the output is going to a terminal,
2163        the ref names are shown as if 'short' were given, otherwise no ref
2164        names are shown. This is the same as the `--decorate` option
2165        of the `git log`.
2166
2167log.follow::
2168        If `true`, `git log` will act as if the `--follow` option was used when
2169        a single <path> is given.  This has the same limitations as `--follow`,
2170        i.e. it cannot be used to follow multiple files and does not work well
2171        on non-linear history.
2172
2173log.graphColors::
2174        A list of colors, separated by commas, that can be used to draw
2175        history lines in `git log --graph`.
2176
2177log.showRoot::
2178        If true, the initial commit will be shown as a big creation event.
2179        This is equivalent to a diff against an empty tree.
2180        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2181        normally hide the root commit will now show it. True by default.
2182
2183log.showSignature::
2184        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2185        linkgit:git-whatchanged[1] assume `--show-signature`.
2186
2187log.mailmap::
2188        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2189        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2190
2191mailinfo.scissors::
2192        If true, makes linkgit:git-mailinfo[1] (and therefore
2193        linkgit:git-am[1]) act by default as if the --scissors option
2194        was provided on the command-line. When active, this features
2195        removes everything from the message body before a scissors
2196        line (i.e. consisting mainly of ">8", "8<" and "-").
2197
2198mailmap.file::
2199        The location of an augmenting mailmap file. The default
2200        mailmap, located in the root of the repository, is loaded
2201        first, then the mailmap file pointed to by this variable.
2202        The location of the mailmap file may be in a repository
2203        subdirectory, or somewhere outside of the repository itself.
2204        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2205
2206mailmap.blob::
2207        Like `mailmap.file`, but consider the value as a reference to a
2208        blob in the repository. If both `mailmap.file` and
2209        `mailmap.blob` are given, both are parsed, with entries from
2210        `mailmap.file` taking precedence. In a bare repository, this
2211        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2212        defaults to empty.
2213
2214man.viewer::
2215        Specify the programs that may be used to display help in the
2216        'man' format. See linkgit:git-help[1].
2217
2218man.<tool>.cmd::
2219        Specify the command to invoke the specified man viewer. The
2220        specified command is evaluated in shell with the man page
2221        passed as argument. (See linkgit:git-help[1].)
2222
2223man.<tool>.path::
2224        Override the path for the given tool that may be used to
2225        display help in the 'man' format. See linkgit:git-help[1].
2226
2227include::merge-config.txt[]
2228
2229mergetool.<tool>.path::
2230        Override the path for the given tool.  This is useful in case
2231        your tool is not in the PATH.
2232
2233mergetool.<tool>.cmd::
2234        Specify the command to invoke the specified merge tool.  The
2235        specified command is evaluated in shell with the following
2236        variables available: 'BASE' is the name of a temporary file
2237        containing the common base of the files to be merged, if available;
2238        'LOCAL' is the name of a temporary file containing the contents of
2239        the file on the current branch; 'REMOTE' is the name of a temporary
2240        file containing the contents of the file from the branch being
2241        merged; 'MERGED' contains the name of the file to which the merge
2242        tool should write the results of a successful merge.
2243
2244mergetool.<tool>.trustExitCode::
2245        For a custom merge command, specify whether the exit code of
2246        the merge command can be used to determine whether the merge was
2247        successful.  If this is not set to true then the merge target file
2248        timestamp is checked and the merge assumed to have been successful
2249        if the file has been updated, otherwise the user is prompted to
2250        indicate the success of the merge.
2251
2252mergetool.meld.hasOutput::
2253        Older versions of `meld` do not support the `--output` option.
2254        Git will attempt to detect whether `meld` supports `--output`
2255        by inspecting the output of `meld --help`.  Configuring
2256        `mergetool.meld.hasOutput` will make Git skip these checks and
2257        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2258        to `true` tells Git to unconditionally use the `--output` option,
2259        and `false` avoids using `--output`.
2260
2261mergetool.keepBackup::
2262        After performing a merge, the original file with conflict markers
2263        can be saved as a file with a `.orig` extension.  If this variable
2264        is set to `false` then this file is not preserved.  Defaults to
2265        `true` (i.e. keep the backup files).
2266
2267mergetool.keepTemporaries::
2268        When invoking a custom merge tool, Git uses a set of temporary
2269        files to pass to the tool. If the tool returns an error and this
2270        variable is set to `true`, then these temporary files will be
2271        preserved, otherwise they will be removed after the tool has
2272        exited. Defaults to `false`.
2273
2274mergetool.writeToTemp::
2275        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2276        conflicting files in the worktree by default.  Git will attempt
2277        to use a temporary directory for these files when set `true`.
2278        Defaults to `false`.
2279
2280mergetool.prompt::
2281        Prompt before each invocation of the merge resolution program.
2282
2283notes.mergeStrategy::
2284        Which merge strategy to choose by default when resolving notes
2285        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2286        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2287        section of linkgit:git-notes[1] for more information on each strategy.
2288
2289notes.<name>.mergeStrategy::
2290        Which merge strategy to choose when doing a notes merge into
2291        refs/notes/<name>.  This overrides the more general
2292        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2293        linkgit:git-notes[1] for more information on the available strategies.
2294
2295notes.displayRef::
2296        The (fully qualified) refname from which to show notes when
2297        showing commit messages.  The value of this variable can be set
2298        to a glob, in which case notes from all matching refs will be
2299        shown.  You may also specify this configuration variable
2300        several times.  A warning will be issued for refs that do not
2301        exist, but a glob that does not match any refs is silently
2302        ignored.
2303+
2304This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2305environment variable, which must be a colon separated list of refs or
2306globs.
2307+
2308The effective value of "core.notesRef" (possibly overridden by
2309GIT_NOTES_REF) is also implicitly added to the list of refs to be
2310displayed.
2311
2312notes.rewrite.<command>::
2313        When rewriting commits with <command> (currently `amend` or
2314        `rebase`) and this variable is set to `true`, Git
2315        automatically copies your notes from the original to the
2316        rewritten commit.  Defaults to `true`, but see
2317        "notes.rewriteRef" below.
2318
2319notes.rewriteMode::
2320        When copying notes during a rewrite (see the
2321        "notes.rewrite.<command>" option), determines what to do if
2322        the target commit already has a note.  Must be one of
2323        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2324        Defaults to `concatenate`.
2325+
2326This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2327environment variable.
2328
2329notes.rewriteRef::
2330        When copying notes during a rewrite, specifies the (fully
2331        qualified) ref whose notes should be copied.  The ref may be a
2332        glob, in which case notes in all matching refs will be copied.
2333        You may also specify this configuration several times.
2334+
2335Does not have a default value; you must configure this variable to
2336enable note rewriting.  Set it to `refs/notes/commits` to enable
2337rewriting for the default commit notes.
2338+
2339This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2340environment variable, which must be a colon separated list of refs or
2341globs.
2342
2343pack.window::
2344        The size of the window used by linkgit:git-pack-objects[1] when no
2345        window size is given on the command line. Defaults to 10.
2346
2347pack.depth::
2348        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2349        maximum depth is given on the command line. Defaults to 50.
2350
2351pack.windowMemory::
2352        The maximum size of memory that is consumed by each thread
2353        in linkgit:git-pack-objects[1] for pack window memory when
2354        no limit is given on the command line.  The value can be
2355        suffixed with "k", "m", or "g".  When left unconfigured (or
2356        set explicitly to 0), there will be no limit.
2357
2358pack.compression::
2359        An integer -1..9, indicating the compression level for objects
2360        in a pack file. -1 is the zlib default. 0 means no
2361        compression, and 1..9 are various speed/size tradeoffs, 9 being
2362        slowest.  If not set,  defaults to core.compression.  If that is
2363        not set,  defaults to -1, the zlib default, which is "a default
2364        compromise between speed and compression (currently equivalent
2365        to level 6)."
2366+
2367Note that changing the compression level will not automatically recompress
2368all existing objects. You can force recompression by passing the -F option
2369to linkgit:git-repack[1].
2370
2371pack.deltaCacheSize::
2372        The maximum memory in bytes used for caching deltas in
2373        linkgit:git-pack-objects[1] before writing them out to a pack.
2374        This cache is used to speed up the writing object phase by not
2375        having to recompute the final delta result once the best match
2376        for all objects is found.  Repacking large repositories on machines
2377        which are tight with memory might be badly impacted by this though,
2378        especially if this cache pushes the system into swapping.
2379        A value of 0 means no limit. The smallest size of 1 byte may be
2380        used to virtually disable this cache. Defaults to 256 MiB.
2381
2382pack.deltaCacheLimit::
2383        The maximum size of a delta, that is cached in
2384        linkgit:git-pack-objects[1]. This cache is used to speed up the
2385        writing object phase by not having to recompute the final delta
2386        result once the best match for all objects is found. Defaults to 1000.
2387
2388pack.threads::
2389        Specifies the number of threads to spawn when searching for best
2390        delta matches.  This requires that linkgit:git-pack-objects[1]
2391        be compiled with pthreads otherwise this option is ignored with a
2392        warning. This is meant to reduce packing time on multiprocessor
2393        machines. The required amount of memory for the delta search window
2394        is however multiplied by the number of threads.
2395        Specifying 0 will cause Git to auto-detect the number of CPU's
2396        and set the number of threads accordingly.
2397
2398pack.indexVersion::
2399        Specify the default pack index version.  Valid values are 1 for
2400        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2401        the new pack index with capabilities for packs larger than 4 GB
2402        as well as proper protection against the repacking of corrupted
2403        packs.  Version 2 is the default.  Note that version 2 is enforced
2404        and this config option ignored whenever the corresponding pack is
2405        larger than 2 GB.
2406+
2407If you have an old Git that does not understand the version 2 `*.idx` file,
2408cloning or fetching over a non native protocol (e.g. "http")
2409that will copy both `*.pack` file and corresponding `*.idx` file from the
2410other side may give you a repository that cannot be accessed with your
2411older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2412you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2413the `*.idx` file.
2414
2415pack.packSizeLimit::
2416        The maximum size of a pack.  This setting only affects
2417        packing to a file when repacking, i.e. the git:// protocol
2418        is unaffected.  It can be overridden by the `--max-pack-size`
2419        option of linkgit:git-repack[1].  Reaching this limit results
2420        in the creation of multiple packfiles; which in turn prevents
2421        bitmaps from being created.
2422        The minimum size allowed is limited to 1 MiB.
2423        The default is unlimited.
2424        Common unit suffixes of 'k', 'm', or 'g' are
2425        supported.
2426
2427pack.useBitmaps::
2428        When true, git will use pack bitmaps (if available) when packing
2429        to stdout (e.g., during the server side of a fetch). Defaults to
2430        true. You should not generally need to turn this off unless
2431        you are debugging pack bitmaps.
2432
2433pack.writeBitmaps (deprecated)::
2434        This is a deprecated synonym for `repack.writeBitmaps`.
2435
2436pack.writeBitmapHashCache::
2437        When true, git will include a "hash cache" section in the bitmap
2438        index (if one is written). This cache can be used to feed git's
2439        delta heuristics, potentially leading to better deltas between
2440        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2441        between an older, bitmapped pack and objects that have been
2442        pushed since the last gc). The downside is that it consumes 4
2443        bytes per object of disk space, and that JGit's bitmap
2444        implementation does not understand it, causing it to complain if
2445        Git and JGit are used on the same repository. Defaults to false.
2446
2447pager.<cmd>::
2448        If the value is boolean, turns on or off pagination of the
2449        output of a particular Git subcommand when writing to a tty.
2450        Otherwise, turns on pagination for the subcommand using the
2451        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2452        or `--no-pager` is specified on the command line, it takes
2453        precedence over this option.  To disable pagination for all
2454        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2455
2456pretty.<name>::
2457        Alias for a --pretty= format string, as specified in
2458        linkgit:git-log[1]. Any aliases defined here can be used just
2459        as the built-in pretty formats could. For example,
2460        running `git config pretty.changelog "format:* %H %s"`
2461        would cause the invocation `git log --pretty=changelog`
2462        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2463        Note that an alias with the same name as a built-in format
2464        will be silently ignored.
2465
2466protocol.allow::
2467        If set, provide a user defined default policy for all protocols which
2468        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2469        if unset, known-safe protocols (http, https, git, ssh, file) have a
2470        default policy of `always`, known-dangerous protocols (ext) have a
2471        default policy of `never`, and all other protocols have a default
2472        policy of `user`.  Supported policies:
2473+
2474--
2475
2476* `always` - protocol is always able to be used.
2477
2478* `never` - protocol is never able to be used.
2479
2480* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2481  either unset or has a value of 1.  This policy should be used when you want a
2482  protocol to be directly usable by the user but don't want it used by commands which
2483  execute clone/fetch/push commands without user input, e.g. recursive
2484  submodule initialization.
2485
2486--
2487
2488protocol.<name>.allow::
2489        Set a policy to be used by protocol `<name>` with clone/fetch/push
2490        commands. See `protocol.allow` above for the available policies.
2491+
2492The protocol names currently used by git are:
2493+
2494--
2495  - `file`: any local file-based path (including `file://` URLs,
2496    or local paths)
2497
2498  - `git`: the anonymous git protocol over a direct TCP
2499    connection (or proxy, if configured)
2500
2501  - `ssh`: git over ssh (including `host:path` syntax,
2502    `ssh://`, etc).
2503
2504  - `http`: git over http, both "smart http" and "dumb http".
2505    Note that this does _not_ include `https`; if you want to configure
2506    both, you must do so individually.
2507
2508  - any external helpers are named by their protocol (e.g., use
2509    `hg` to allow the `git-remote-hg` helper)
2510--
2511
2512pull.ff::
2513        By default, Git does not create an extra merge commit when merging
2514        a commit that is a descendant of the current commit. Instead, the
2515        tip of the current branch is fast-forwarded. When set to `false`,
2516        this variable tells Git to create an extra merge commit in such
2517        a case (equivalent to giving the `--no-ff` option from the command
2518        line). When set to `only`, only such fast-forward merges are
2519        allowed (equivalent to giving the `--ff-only` option from the
2520        command line). This setting overrides `merge.ff` when pulling.
2521
2522pull.rebase::
2523        When true, rebase branches on top of the fetched branch, instead
2524        of merging the default branch from the default remote when "git
2525        pull" is run. See "branch.<name>.rebase" for setting this on a
2526        per-branch basis.
2527+
2528When preserve, also pass `--preserve-merges` along to 'git rebase'
2529so that locally committed merge commits will not be flattened
2530by running 'git pull'.
2531+
2532When the value is `interactive`, the rebase is run in interactive mode.
2533+
2534*NOTE*: this is a possibly dangerous operation; do *not* use
2535it unless you understand the implications (see linkgit:git-rebase[1]
2536for details).
2537
2538pull.octopus::
2539        The default merge strategy to use when pulling multiple branches
2540        at once.
2541
2542pull.twohead::
2543        The default merge strategy to use when pulling a single branch.
2544
2545push.default::
2546        Defines the action `git push` should take if no refspec is
2547        explicitly given.  Different values are well-suited for
2548        specific workflows; for instance, in a purely central workflow
2549        (i.e. the fetch source is equal to the push destination),
2550        `upstream` is probably what you want.  Possible values are:
2551+
2552--
2553
2554* `nothing` - do not push anything (error out) unless a refspec is
2555  explicitly given. This is primarily meant for people who want to
2556  avoid mistakes by always being explicit.
2557
2558* `current` - push the current branch to update a branch with the same
2559  name on the receiving end.  Works in both central and non-central
2560  workflows.
2561
2562* `upstream` - push the current branch back to the branch whose
2563  changes are usually integrated into the current branch (which is
2564  called `@{upstream}`).  This mode only makes sense if you are
2565  pushing to the same repository you would normally pull from
2566  (i.e. central workflow).
2567
2568* `tracking` - This is a deprecated synonym for `upstream`.
2569
2570* `simple` - in centralized workflow, work like `upstream` with an
2571  added safety to refuse to push if the upstream branch's name is
2572  different from the local one.
2573+
2574When pushing to a remote that is different from the remote you normally
2575pull from, work as `current`.  This is the safest option and is suited
2576for beginners.
2577+
2578This mode has become the default in Git 2.0.
2579
2580* `matching` - push all branches having the same name on both ends.
2581  This makes the repository you are pushing to remember the set of
2582  branches that will be pushed out (e.g. if you always push 'maint'
2583  and 'master' there and no other branches, the repository you push
2584  to will have these two branches, and your local 'maint' and
2585  'master' will be pushed there).
2586+
2587To use this mode effectively, you have to make sure _all_ the
2588branches you would push out are ready to be pushed out before
2589running 'git push', as the whole point of this mode is to allow you
2590to push all of the branches in one go.  If you usually finish work
2591on only one branch and push out the result, while other branches are
2592unfinished, this mode is not for you.  Also this mode is not
2593suitable for pushing into a shared central repository, as other
2594people may add new branches there, or update the tip of existing
2595branches outside your control.
2596+
2597This used to be the default, but not since Git 2.0 (`simple` is the
2598new default).
2599
2600--
2601
2602push.followTags::
2603        If set to true enable `--follow-tags` option by default.  You
2604        may override this configuration at time of push by specifying
2605        `--no-follow-tags`.
2606
2607push.gpgSign::
2608        May be set to a boolean value, or the string 'if-asked'. A true
2609        value causes all pushes to be GPG signed, as if `--signed` is
2610        passed to linkgit:git-push[1]. The string 'if-asked' causes
2611        pushes to be signed if the server supports it, as if
2612        `--signed=if-asked` is passed to 'git push'. A false value may
2613        override a value from a lower-priority config file. An explicit
2614        command-line flag always overrides this config option.
2615
2616push.recurseSubmodules::
2617        Make sure all submodule commits used by the revisions to be pushed
2618        are available on a remote-tracking branch. If the value is 'check'
2619        then Git will verify that all submodule commits that changed in the
2620        revisions to be pushed are available on at least one remote of the
2621        submodule. If any commits are missing, the push will be aborted and
2622        exit with non-zero status. If the value is 'on-demand' then all
2623        submodules that changed in the revisions to be pushed will be
2624        pushed. If on-demand was not able to push all necessary revisions
2625        it will also be aborted and exit with non-zero status. If the value
2626        is 'no' then default behavior of ignoring submodules when pushing
2627        is retained. You may override this configuration at time of push by
2628        specifying '--recurse-submodules=check|on-demand|no'.
2629
2630rebase.stat::
2631        Whether to show a diffstat of what changed upstream since the last
2632        rebase. False by default.
2633
2634rebase.autoSquash::
2635        If set to true enable `--autosquash` option by default.
2636
2637rebase.autoStash::
2638        When set to true, automatically create a temporary stash entry
2639        before the operation begins, and apply it after the operation
2640        ends.  This means that you can run rebase on a dirty worktree.
2641        However, use with care: the final stash application after a
2642        successful rebase might result in non-trivial conflicts.
2643        Defaults to false.
2644
2645rebase.missingCommitsCheck::
2646        If set to "warn", git rebase -i will print a warning if some
2647        commits are removed (e.g. a line was deleted), however the
2648        rebase will still proceed. If set to "error", it will print
2649        the previous warning and stop the rebase, 'git rebase
2650        --edit-todo' can then be used to correct the error. If set to
2651        "ignore", no checking is done.
2652        To drop a commit without warning or error, use the `drop`
2653        command in the todo-list.
2654        Defaults to "ignore".
2655
2656rebase.instructionFormat::
2657        A format string, as specified in linkgit:git-log[1], to be used for
2658        the instruction list during an interactive rebase.  The format will automatically
2659        have the long commit hash prepended to the format.
2660
2661receive.advertiseAtomic::
2662        By default, git-receive-pack will advertise the atomic push
2663        capability to its clients. If you don't want to advertise this
2664        capability, set this variable to false.
2665
2666receive.advertisePushOptions::
2667        When set to true, git-receive-pack will advertise the push options
2668        capability to its clients. False by default.
2669
2670receive.autogc::
2671        By default, git-receive-pack will run "git-gc --auto" after
2672        receiving data from git-push and updating refs.  You can stop
2673        it by setting this variable to false.
2674
2675receive.certNonceSeed::
2676        By setting this variable to a string, `git receive-pack`
2677        will accept a `git push --signed` and verifies it by using
2678        a "nonce" protected by HMAC using this string as a secret
2679        key.
2680
2681receive.certNonceSlop::
2682        When a `git push --signed` sent a push certificate with a
2683        "nonce" that was issued by a receive-pack serving the same
2684        repository within this many seconds, export the "nonce"
2685        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2686        hooks (instead of what the receive-pack asked the sending
2687        side to include).  This may allow writing checks in
2688        `pre-receive` and `post-receive` a bit easier.  Instead of
2689        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2690        that records by how many seconds the nonce is stale to
2691        decide if they want to accept the certificate, they only
2692        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2693
2694receive.fsckObjects::
2695        If it is set to true, git-receive-pack will check all received
2696        objects. It will abort in the case of a malformed object or a
2697        broken link. The result of an abort are only dangling objects.
2698        Defaults to false. If not set, the value of `transfer.fsckObjects`
2699        is used instead.
2700
2701receive.fsck.<msg-id>::
2702        When `receive.fsckObjects` is set to true, errors can be switched
2703        to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2704        setting where the `<msg-id>` is the fsck message ID and the value
2705        is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2706        the error/warning with the message ID, e.g. "missingEmail: invalid
2707        author/committer line - missing email" means that setting
2708        `receive.fsck.missingEmail = ignore` will hide that issue.
2709+
2710This feature is intended to support working with legacy repositories
2711which would not pass pushing when `receive.fsckObjects = true`, allowing
2712the host to accept repositories with certain known issues but still catch
2713other issues.
2714
2715receive.fsck.skipList::
2716        The path to a sorted list of object names (i.e. one SHA-1 per
2717        line) that are known to be broken in a non-fatal way and should
2718        be ignored. This feature is useful when an established project
2719        should be accepted despite early commits containing errors that
2720        can be safely ignored such as invalid committer email addresses.
2721        Note: corrupt objects cannot be skipped with this setting.
2722
2723receive.keepAlive::
2724        After receiving the pack from the client, `receive-pack` may
2725        produce no output (if `--quiet` was specified) while processing
2726        the pack, causing some networks to drop the TCP connection.
2727        With this option set, if `receive-pack` does not transmit
2728        any data in this phase for `receive.keepAlive` seconds, it will
2729        send a short keepalive packet.  The default is 5 seconds; set
2730        to 0 to disable keepalives entirely.
2731
2732receive.unpackLimit::
2733        If the number of objects received in a push is below this
2734        limit then the objects will be unpacked into loose object
2735        files. However if the number of received objects equals or
2736        exceeds this limit then the received pack will be stored as
2737        a pack, after adding any missing delta bases.  Storing the
2738        pack from a push can make the push operation complete faster,
2739        especially on slow filesystems.  If not set, the value of
2740        `transfer.unpackLimit` is used instead.
2741
2742receive.maxInputSize::
2743        If the size of the incoming pack stream is larger than this
2744        limit, then git-receive-pack will error out, instead of
2745        accepting the pack file. If not set or set to 0, then the size
2746        is unlimited.
2747
2748receive.denyDeletes::
2749        If set to true, git-receive-pack will deny a ref update that deletes
2750        the ref. Use this to prevent such a ref deletion via a push.
2751
2752receive.denyDeleteCurrent::
2753        If set to true, git-receive-pack will deny a ref update that
2754        deletes the currently checked out branch of a non-bare repository.
2755
2756receive.denyCurrentBranch::
2757        If set to true or "refuse", git-receive-pack will deny a ref update
2758        to the currently checked out branch of a non-bare repository.
2759        Such a push is potentially dangerous because it brings the HEAD
2760        out of sync with the index and working tree. If set to "warn",
2761        print a warning of such a push to stderr, but allow the push to
2762        proceed. If set to false or "ignore", allow such pushes with no
2763        message. Defaults to "refuse".
2764+
2765Another option is "updateInstead" which will update the working
2766tree if pushing into the current branch.  This option is
2767intended for synchronizing working directories when one side is not easily
2768accessible via interactive ssh (e.g. a live web site, hence the requirement
2769that the working directory be clean). This mode also comes in handy when
2770developing inside a VM to test and fix code on different Operating Systems.
2771+
2772By default, "updateInstead" will refuse the push if the working tree or
2773the index have any difference from the HEAD, but the `push-to-checkout`
2774hook can be used to customize this.  See linkgit:githooks[5].
2775
2776receive.denyNonFastForwards::
2777        If set to true, git-receive-pack will deny a ref update which is
2778        not a fast-forward. Use this to prevent such an update via a push,
2779        even if that push is forced. This configuration variable is
2780        set when initializing a shared repository.
2781
2782receive.hideRefs::
2783        This variable is the same as `transfer.hideRefs`, but applies
2784        only to `receive-pack` (and so affects pushes, but not fetches).
2785        An attempt to update or delete a hidden ref by `git push` is
2786        rejected.
2787
2788receive.updateServerInfo::
2789        If set to true, git-receive-pack will run git-update-server-info
2790        after receiving data from git-push and updating refs.
2791
2792receive.shallowUpdate::
2793        If set to true, .git/shallow can be updated when new refs
2794        require new shallow roots. Otherwise those refs are rejected.
2795
2796remote.pushDefault::
2797        The remote to push to by default.  Overrides
2798        `branch.<name>.remote` for all branches, and is overridden by
2799        `branch.<name>.pushRemote` for specific branches.
2800
2801remote.<name>.url::
2802        The URL of a remote repository.  See linkgit:git-fetch[1] or
2803        linkgit:git-push[1].
2804
2805remote.<name>.pushurl::
2806        The push URL of a remote repository.  See linkgit:git-push[1].
2807
2808remote.<name>.proxy::
2809        For remotes that require curl (http, https and ftp), the URL to
2810        the proxy to use for that remote.  Set to the empty string to
2811        disable proxying for that remote.
2812
2813remote.<name>.proxyAuthMethod::
2814        For remotes that require curl (http, https and ftp), the method to use for
2815        authenticating against the proxy in use (probably set in
2816        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2817
2818remote.<name>.fetch::
2819        The default set of "refspec" for linkgit:git-fetch[1]. See
2820        linkgit:git-fetch[1].
2821
2822remote.<name>.push::
2823        The default set of "refspec" for linkgit:git-push[1]. See
2824        linkgit:git-push[1].
2825
2826remote.<name>.mirror::
2827        If true, pushing to this remote will automatically behave
2828        as if the `--mirror` option was given on the command line.
2829
2830remote.<name>.skipDefaultUpdate::
2831        If true, this remote will be skipped by default when updating
2832        using linkgit:git-fetch[1] or the `update` subcommand of
2833        linkgit:git-remote[1].
2834
2835remote.<name>.skipFetchAll::
2836        If true, this remote will be skipped by default when updating
2837        using linkgit:git-fetch[1] or the `update` subcommand of
2838        linkgit:git-remote[1].
2839
2840remote.<name>.receivepack::
2841        The default program to execute on the remote side when pushing.  See
2842        option --receive-pack of linkgit:git-push[1].
2843
2844remote.<name>.uploadpack::
2845        The default program to execute on the remote side when fetching.  See
2846        option --upload-pack of linkgit:git-fetch-pack[1].
2847
2848remote.<name>.tagOpt::
2849        Setting this value to --no-tags disables automatic tag following when
2850        fetching from remote <name>. Setting it to --tags will fetch every
2851        tag from remote <name>, even if they are not reachable from remote
2852        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2853        override this setting. See options --tags and --no-tags of
2854        linkgit:git-fetch[1].
2855
2856remote.<name>.vcs::
2857        Setting this to a value <vcs> will cause Git to interact with
2858        the remote with the git-remote-<vcs> helper.
2859
2860remote.<name>.prune::
2861        When set to true, fetching from this remote by default will also
2862        remove any remote-tracking references that no longer exist on the
2863        remote (as if the `--prune` option was given on the command line).
2864        Overrides `fetch.prune` settings, if any.
2865
2866remotes.<group>::
2867        The list of remotes which are fetched by "git remote update
2868        <group>".  See linkgit:git-remote[1].
2869
2870repack.useDeltaBaseOffset::
2871        By default, linkgit:git-repack[1] creates packs that use
2872        delta-base offset. If you need to share your repository with
2873        Git older than version 1.4.4, either directly or via a dumb
2874        protocol such as http, then you need to set this option to
2875        "false" and repack. Access from old Git versions over the
2876        native protocol are unaffected by this option.
2877
2878repack.packKeptObjects::
2879        If set to true, makes `git repack` act as if
2880        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2881        details. Defaults to `false` normally, but `true` if a bitmap
2882        index is being written (either via `--write-bitmap-index` or
2883        `repack.writeBitmaps`).
2884
2885repack.writeBitmaps::
2886        When true, git will write a bitmap index when packing all
2887        objects to disk (e.g., when `git repack -a` is run).  This
2888        index can speed up the "counting objects" phase of subsequent
2889        packs created for clones and fetches, at the cost of some disk
2890        space and extra time spent on the initial repack.  This has
2891        no effect if multiple packfiles are created.
2892        Defaults to false.
2893
2894rerere.autoUpdate::
2895        When set to true, `git-rerere` updates the index with the
2896        resulting contents after it cleanly resolves conflicts using
2897        previously recorded resolution.  Defaults to false.
2898
2899rerere.enabled::
2900        Activate recording of resolved conflicts, so that identical
2901        conflict hunks can be resolved automatically, should they be
2902        encountered again.  By default, linkgit:git-rerere[1] is
2903        enabled if there is an `rr-cache` directory under the
2904        `$GIT_DIR`, e.g. if "rerere" was previously used in the
2905        repository.
2906
2907sendemail.identity::
2908        A configuration identity. When given, causes values in the
2909        'sendemail.<identity>' subsection to take precedence over
2910        values in the 'sendemail' section. The default identity is
2911        the value of `sendemail.identity`.
2912
2913sendemail.smtpEncryption::
2914        See linkgit:git-send-email[1] for description.  Note that this
2915        setting is not subject to the 'identity' mechanism.
2916
2917sendemail.smtpssl (deprecated)::
2918        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2919
2920sendemail.smtpsslcertpath::
2921        Path to ca-certificates (either a directory or a single file).
2922        Set it to an empty string to disable certificate verification.
2923
2924sendemail.<identity>.*::
2925        Identity-specific versions of the 'sendemail.*' parameters
2926        found below, taking precedence over those when this
2927        identity is selected, through either the command-line or
2928        `sendemail.identity`.
2929
2930sendemail.aliasesFile::
2931sendemail.aliasFileType::
2932sendemail.annotate::
2933sendemail.bcc::
2934sendemail.cc::
2935sendemail.ccCmd::
2936sendemail.chainReplyTo::
2937sendemail.confirm::
2938sendemail.envelopeSender::
2939sendemail.from::
2940sendemail.multiEdit::
2941sendemail.signedoffbycc::
2942sendemail.smtpPass::
2943sendemail.suppresscc::
2944sendemail.suppressFrom::
2945sendemail.to::
2946sendemail.smtpDomain::
2947sendemail.smtpServer::
2948sendemail.smtpServerPort::
2949sendemail.smtpServerOption::
2950sendemail.smtpUser::
2951sendemail.thread::
2952sendemail.transferEncoding::
2953sendemail.validate::
2954sendemail.xmailer::
2955        See linkgit:git-send-email[1] for description.
2956
2957sendemail.signedoffcc (deprecated)::
2958        Deprecated alias for `sendemail.signedoffbycc`.
2959
2960sendemail.smtpBatchSize::
2961        Number of messages to be sent per connection, after that a relogin
2962        will happen.  If the value is 0 or undefined, send all messages in
2963        one connection.
2964        See also the `--batch-size` option of linkgit:git-send-email[1].
2965
2966sendemail.smtpReloginDelay::
2967        Seconds wait before reconnecting to smtp server.
2968        See also the `--relogin-delay` option of linkgit:git-send-email[1].
2969
2970showbranch.default::
2971        The default set of branches for linkgit:git-show-branch[1].
2972        See linkgit:git-show-branch[1].
2973
2974splitIndex.maxPercentChange::
2975        When the split index feature is used, this specifies the
2976        percent of entries the split index can contain compared to the
2977        total number of entries in both the split index and the shared
2978        index before a new shared index is written.
2979        The value should be between 0 and 100. If the value is 0 then
2980        a new shared index is always written, if it is 100 a new
2981        shared index is never written.
2982        By default the value is 20, so a new shared index is written
2983        if the number of entries in the split index would be greater
2984        than 20 percent of the total number of entries.
2985        See linkgit:git-update-index[1].
2986
2987splitIndex.sharedIndexExpire::
2988        When the split index feature is used, shared index files that
2989        were not modified since the time this variable specifies will
2990        be removed when a new shared index file is created. The value
2991        "now" expires all entries immediately, and "never" suppresses
2992        expiration altogether.
2993        The default value is "2.weeks.ago".
2994        Note that a shared index file is considered modified (for the
2995        purpose of expiration) each time a new split-index file is
2996        either created based on it or read from it.
2997        See linkgit:git-update-index[1].
2998
2999status.relativePaths::
3000        By default, linkgit:git-status[1] shows paths relative to the
3001        current directory. Setting this variable to `false` shows paths
3002        relative to the repository root (this was the default for Git
3003        prior to v1.5.4).
3004
3005status.short::
3006        Set to true to enable --short by default in linkgit:git-status[1].
3007        The option --no-short takes precedence over this variable.
3008
3009status.branch::
3010        Set to true to enable --branch by default in linkgit:git-status[1].
3011        The option --no-branch takes precedence over this variable.
3012
3013status.displayCommentPrefix::
3014        If set to true, linkgit:git-status[1] will insert a comment
3015        prefix before each output line (starting with
3016        `core.commentChar`, i.e. `#` by default). This was the
3017        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3018        Defaults to false.
3019
3020status.showStash::
3021        If set to true, linkgit:git-status[1] will display the number of
3022        entries currently stashed away.
3023        Defaults to false.
3024
3025status.showUntrackedFiles::
3026        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3027        files which are not currently tracked by Git. Directories which
3028        contain only untracked files, are shown with the directory name
3029        only. Showing untracked files means that Git needs to lstat() all
3030        the files in the whole repository, which might be slow on some
3031        systems. So, this variable controls how the commands displays
3032        the untracked files. Possible values are:
3033+
3034--
3035* `no` - Show no untracked files.
3036* `normal` - Show untracked files and directories.
3037* `all` - Show also individual files in untracked directories.
3038--
3039+
3040If this variable is not specified, it defaults to 'normal'.
3041This variable can be overridden with the -u|--untracked-files option
3042of linkgit:git-status[1] and linkgit:git-commit[1].
3043
3044status.submoduleSummary::
3045        Defaults to false.
3046        If this is set to a non zero number or true (identical to -1 or an
3047        unlimited number), the submodule summary will be enabled and a
3048        summary of commits for modified submodules will be shown (see
3049        --summary-limit option of linkgit:git-submodule[1]). Please note
3050        that the summary output command will be suppressed for all
3051        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3052        for those submodules where `submodule.<name>.ignore=all`. The only
3053        exception to that rule is that status and commit will show staged
3054        submodule changes. To
3055        also view the summary for ignored submodules you can either use
3056        the --ignore-submodules=dirty command-line option or the 'git
3057        submodule summary' command, which shows a similar output but does
3058        not honor these settings.
3059
3060stash.showPatch::
3061        If this is set to true, the `git stash show` command without an
3062        option will show the stash entry in patch form.  Defaults to false.
3063        See description of 'show' command in linkgit:git-stash[1].
3064
3065stash.showStat::
3066        If this is set to true, the `git stash show` command without an
3067        option will show diffstat of the stash entry.  Defaults to true.
3068        See description of 'show' command in linkgit:git-stash[1].
3069
3070submodule.<name>.url::
3071        The URL for a submodule. This variable is copied from the .gitmodules
3072        file to the git config via 'git submodule init'. The user can change
3073        the configured URL before obtaining the submodule via 'git submodule
3074        update'. If neither submodule.<name>.active or submodule.active are
3075        set, the presence of this variable is used as a fallback to indicate
3076        whether the submodule is of interest to git commands.
3077        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3078
3079submodule.<name>.update::
3080        The default update procedure for a submodule. This variable
3081        is populated by `git submodule init` from the
3082        linkgit:gitmodules[5] file. See description of 'update'
3083        command in linkgit:git-submodule[1].
3084
3085submodule.<name>.branch::
3086        The remote branch name for a submodule, used by `git submodule
3087        update --remote`.  Set this option to override the value found in
3088        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3089        linkgit:gitmodules[5] for details.
3090
3091submodule.<name>.fetchRecurseSubmodules::
3092        This option can be used to control recursive fetching of this
3093        submodule. It can be overridden by using the --[no-]recurse-submodules
3094        command-line option to "git fetch" and "git pull".
3095        This setting will override that from in the linkgit:gitmodules[5]
3096        file.
3097
3098submodule.<name>.ignore::
3099        Defines under what circumstances "git status" and the diff family show
3100        a submodule as modified. When set to "all", it will never be considered
3101        modified (but it will nonetheless show up in the output of status and
3102        commit when it has been staged), "dirty" will ignore all changes
3103        to the submodules work tree and
3104        takes only differences between the HEAD of the submodule and the commit
3105        recorded in the superproject into account. "untracked" will additionally
3106        let submodules with modified tracked files in their work tree show up.
3107        Using "none" (the default when this option is not set) also shows
3108        submodules that have untracked files in their work tree as changed.
3109        This setting overrides any setting made in .gitmodules for this submodule,
3110        both settings can be overridden on the command line by using the
3111        "--ignore-submodules" option. The 'git submodule' commands are not
3112        affected by this setting.
3113
3114submodule.<name>.active::
3115        Boolean value indicating if the submodule is of interest to git
3116        commands.  This config option takes precedence over the
3117        submodule.active config option.
3118
3119submodule.active::
3120        A repeated field which contains a pathspec used to match against a
3121        submodule's path to determine if the submodule is of interest to git
3122        commands.
3123
3124submodule.recurse::
3125        Specifies if commands recurse into submodules by default. This
3126        applies to all commands that have a `--recurse-submodules` option.
3127        Defaults to false.
3128
3129submodule.fetchJobs::
3130        Specifies how many submodules are fetched/cloned at the same time.
3131        A positive integer allows up to that number of submodules fetched
3132        in parallel. A value of 0 will give some reasonable default.
3133        If unset, it defaults to 1.
3134
3135submodule.alternateLocation::
3136        Specifies how the submodules obtain alternates when submodules are
3137        cloned. Possible values are `no`, `superproject`.
3138        By default `no` is assumed, which doesn't add references. When the
3139        value is set to `superproject` the submodule to be cloned computes
3140        its alternates location relative to the superprojects alternate.
3141
3142submodule.alternateErrorStrategy::
3143        Specifies how to treat errors with the alternates for a submodule
3144        as computed via `submodule.alternateLocation`. Possible values are
3145        `ignore`, `info`, `die`. Default is `die`.
3146
3147tag.forceSignAnnotated::
3148        A boolean to specify whether annotated tags created should be GPG signed.
3149        If `--annotate` is specified on the command line, it takes
3150        precedence over this option.
3151
3152tag.sort::
3153        This variable controls the sort ordering of tags when displayed by
3154        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3155        value of this variable will be used as the default.
3156
3157tar.umask::
3158        This variable can be used to restrict the permission bits of
3159        tar archive entries.  The default is 0002, which turns off the
3160        world write bit.  The special value "user" indicates that the
3161        archiving user's umask will be used instead.  See umask(2) and
3162        linkgit:git-archive[1].
3163
3164transfer.fsckObjects::
3165        When `fetch.fsckObjects` or `receive.fsckObjects` are
3166        not set, the value of this variable is used instead.
3167        Defaults to false.
3168
3169transfer.hideRefs::
3170        String(s) `receive-pack` and `upload-pack` use to decide which
3171        refs to omit from their initial advertisements.  Use more than
3172        one definition to specify multiple prefix strings. A ref that is
3173        under the hierarchies listed in the value of this variable is
3174        excluded, and is hidden when responding to `git push` or `git
3175        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3176        program-specific versions of this config.
3177+
3178You may also include a `!` in front of the ref name to negate the entry,
3179explicitly exposing it, even if an earlier entry marked it as hidden.
3180If you have multiple hideRefs values, later entries override earlier ones
3181(and entries in more-specific config files override less-specific ones).
3182+
3183If a namespace is in use, the namespace prefix is stripped from each
3184reference before it is matched against `transfer.hiderefs` patterns.
3185For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3186the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3187is omitted from the advertisements but `refs/heads/master` and
3188`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3189"have" lines. In order to match refs before stripping, add a `^` in front of
3190the ref name. If you combine `!` and `^`, `!` must be specified first.
3191+
3192Even if you hide refs, a client may still be able to steal the target
3193objects via the techniques described in the "SECURITY" section of the
3194linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3195separate repository.
3196
3197transfer.unpackLimit::
3198        When `fetch.unpackLimit` or `receive.unpackLimit` are
3199        not set, the value of this variable is used instead.
3200        The default value is 100.
3201
3202uploadarchive.allowUnreachable::
3203        If true, allow clients to use `git archive --remote` to request
3204        any tree, whether reachable from the ref tips or not. See the
3205        discussion in the "SECURITY" section of
3206        linkgit:git-upload-archive[1] for more details. Defaults to
3207        `false`.
3208
3209uploadpack.hideRefs::
3210        This variable is the same as `transfer.hideRefs`, but applies
3211        only to `upload-pack` (and so affects only fetches, not pushes).
3212        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3213        also `uploadpack.allowTipSHA1InWant`.
3214
3215uploadpack.allowTipSHA1InWant::
3216        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3217        to accept a fetch request that asks for an object at the tip
3218        of a hidden ref (by default, such a request is rejected).
3219        See also `uploadpack.hideRefs`.  Even if this is false, a client
3220        may be able to steal objects via the techniques described in the
3221        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3222        best to keep private data in a separate repository.
3223
3224uploadpack.allowReachableSHA1InWant::
3225        Allow `upload-pack` to accept a fetch request that asks for an
3226        object that is reachable from any ref tip. However, note that
3227        calculating object reachability is computationally expensive.
3228        Defaults to `false`.  Even if this is false, a client may be able
3229        to steal objects via the techniques described in the "SECURITY"
3230        section of the linkgit:gitnamespaces[7] man page; it's best to
3231        keep private data in a separate repository.
3232
3233uploadpack.allowAnySHA1InWant::
3234        Allow `upload-pack` to accept a fetch request that asks for any
3235        object at all.
3236        Defaults to `false`.
3237
3238uploadpack.keepAlive::
3239        When `upload-pack` has started `pack-objects`, there may be a
3240        quiet period while `pack-objects` prepares the pack. Normally
3241        it would output progress information, but if `--quiet` was used
3242        for the fetch, `pack-objects` will output nothing at all until
3243        the pack data begins. Some clients and networks may consider
3244        the server to be hung and give up. Setting this option instructs
3245        `upload-pack` to send an empty keepalive packet every
3246        `uploadpack.keepAlive` seconds. Setting this option to 0
3247        disables keepalive packets entirely. The default is 5 seconds.
3248
3249uploadpack.packObjectsHook::
3250        If this option is set, when `upload-pack` would run
3251        `git pack-objects` to create a packfile for a client, it will
3252        run this shell command instead.  The `pack-objects` command and
3253        arguments it _would_ have run (including the `git pack-objects`
3254        at the beginning) are appended to the shell command. The stdin
3255        and stdout of the hook are treated as if `pack-objects` itself
3256        was run. I.e., `upload-pack` will feed input intended for
3257        `pack-objects` to the hook, and expects a completed packfile on
3258        stdout.
3259+
3260Note that this configuration variable is ignored if it is seen in the
3261repository-level config (this is a safety measure against fetching from
3262untrusted repositories).
3263
3264url.<base>.insteadOf::
3265        Any URL that starts with this value will be rewritten to
3266        start, instead, with <base>. In cases where some site serves a
3267        large number of repositories, and serves them with multiple
3268        access methods, and some users need to use different access
3269        methods, this feature allows people to specify any of the
3270        equivalent URLs and have Git automatically rewrite the URL to
3271        the best alternative for the particular user, even for a
3272        never-before-seen repository on the site.  When more than one
3273        insteadOf strings match a given URL, the longest match is used.
3274+
3275Note that any protocol restrictions will be applied to the rewritten
3276URL. If the rewrite changes the URL to use a custom protocol or remote
3277helper, you may need to adjust the `protocol.*.allow` config to permit
3278the request.  In particular, protocols you expect to use for submodules
3279must be set to `always` rather than the default of `user`. See the
3280description of `protocol.allow` above.
3281
3282url.<base>.pushInsteadOf::
3283        Any URL that starts with this value will not be pushed to;
3284        instead, it will be rewritten to start with <base>, and the
3285        resulting URL will be pushed to. In cases where some site serves
3286        a large number of repositories, and serves them with multiple
3287        access methods, some of which do not allow push, this feature
3288        allows people to specify a pull-only URL and have Git
3289        automatically use an appropriate URL to push, even for a
3290        never-before-seen repository on the site.  When more than one
3291        pushInsteadOf strings match a given URL, the longest match is
3292        used.  If a remote has an explicit pushurl, Git will ignore this
3293        setting for that remote.
3294
3295user.email::
3296        Your email address to be recorded in any newly created commits.
3297        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3298        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3299
3300user.name::
3301        Your full name to be recorded in any newly created commits.
3302        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3303        environment variables.  See linkgit:git-commit-tree[1].
3304
3305user.useConfigOnly::
3306        Instruct Git to avoid trying to guess defaults for `user.email`
3307        and `user.name`, and instead retrieve the values only from the
3308        configuration. For example, if you have multiple email addresses
3309        and would like to use a different one for each repository, then
3310        with this configuration option set to `true` in the global config
3311        along with a name, Git will prompt you to set up an email before
3312        making new commits in a newly cloned repository.
3313        Defaults to `false`.
3314
3315user.signingKey::
3316        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3317        key you want it to automatically when creating a signed tag or
3318        commit, you can override the default selection with this variable.
3319        This option is passed unchanged to gpg's --local-user parameter,
3320        so you may specify a key using any method that gpg supports.
3321
3322versionsort.prereleaseSuffix (deprecated)::
3323        Deprecated alias for `versionsort.suffix`.  Ignored if
3324        `versionsort.suffix` is set.
3325
3326versionsort.suffix::
3327        Even when version sort is used in linkgit:git-tag[1], tagnames
3328        with the same base version but different suffixes are still sorted
3329        lexicographically, resulting e.g. in prerelease tags appearing
3330        after the main release (e.g. "1.0-rc1" after "1.0").  This
3331        variable can be specified to determine the sorting order of tags
3332        with different suffixes.
3333+
3334By specifying a single suffix in this variable, any tagname containing
3335that suffix will appear before the corresponding main release.  E.g. if
3336the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3337"1.0".  If specified multiple times, once per suffix, then the order of
3338suffixes in the configuration will determine the sorting order of tagnames
3339with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3340configuration, then all "1.0-preX" tags will be listed before any
3341"1.0-rcX" tags.  The placement of the main release tag relative to tags
3342with various suffixes can be determined by specifying the empty suffix
3343among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3344"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3345are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3346"v4.8-bfsX".
3347+
3348If more than one suffixes match the same tagname, then that tagname will
3349be sorted according to the suffix which starts at the earliest position in
3350the tagname.  If more than one different matching suffixes start at
3351that earliest position, then that tagname will be sorted according to the
3352longest of those suffixes.
3353The sorting order between different suffixes is undefined if they are
3354in multiple config files.
3355
3356web.browser::
3357        Specify a web browser that may be used by some commands.
3358        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3359        may use it.