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