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