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