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