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