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