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