Documentation / config.txton commit Merge branch 'nd/conditional-config-include' (4b7989b)
   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 lets you edit
 741        messages by launching an editor uses 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 lets 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), or
1141        `unmerged` (files which have unmerged changes).
1142
1143color.ui::
1144        This variable determines the default value for variables such
1145        as `color.diff` and `color.grep` that control the use of color
1146        per command family. Its scope will expand as more commands learn
1147        configuration to set a default for the `--color` option.  Set it
1148        to `false` or `never` if you prefer Git commands not to use
1149        color unless enabled explicitly with some other configuration
1150        or the `--color` option. Set it to `always` if you want all
1151        output not intended for machine consumption to use color, to
1152        `true` or `auto` (this is the default since Git 1.8.4) if you
1153        want such output to use color when written to the terminal.
1154
1155column.ui::
1156        Specify whether supported commands should output in columns.
1157        This variable consists of a list of tokens separated by spaces
1158        or commas:
1159+
1160These options control when the feature should be enabled
1161(defaults to 'never'):
1162+
1163--
1164`always`;;
1165        always show in columns
1166`never`;;
1167        never show in columns
1168`auto`;;
1169        show in columns if the output is to the terminal
1170--
1171+
1172These options control layout (defaults to 'column').  Setting any
1173of these implies 'always' if none of 'always', 'never', or 'auto' are
1174specified.
1175+
1176--
1177`column`;;
1178        fill columns before rows
1179`row`;;
1180        fill rows before columns
1181`plain`;;
1182        show in one column
1183--
1184+
1185Finally, these options can be combined with a layout option (defaults
1186to 'nodense'):
1187+
1188--
1189`dense`;;
1190        make unequal size columns to utilize more space
1191`nodense`;;
1192        make equal size columns
1193--
1194
1195column.branch::
1196        Specify whether to output branch listing in `git branch` in columns.
1197        See `column.ui` for details.
1198
1199column.clean::
1200        Specify the layout when list items in `git clean -i`, which always
1201        shows files and directories in columns. See `column.ui` for details.
1202
1203column.status::
1204        Specify whether to output untracked files in `git status` in columns.
1205        See `column.ui` for details.
1206
1207column.tag::
1208        Specify whether to output tag listing in `git tag` in columns.
1209        See `column.ui` for details.
1210
1211commit.cleanup::
1212        This setting overrides the default of the `--cleanup` option in
1213        `git commit`. See linkgit:git-commit[1] for details. Changing the
1214        default can be useful when you always want to keep lines that begin
1215        with comment character `#` in your log message, in which case you
1216        would do `git config commit.cleanup whitespace` (note that you will
1217        have to remove the help lines that begin with `#` in the commit log
1218        template yourself, if you do this).
1219
1220commit.gpgSign::
1221
1222        A boolean to specify whether all commits should be GPG signed.
1223        Use of this option when doing operations such as rebase can
1224        result in a large number of commits being signed. It may be
1225        convenient to use an agent to avoid typing your GPG passphrase
1226        several times.
1227
1228commit.status::
1229        A boolean to enable/disable inclusion of status information in the
1230        commit message template when using an editor to prepare the commit
1231        message.  Defaults to true.
1232
1233commit.template::
1234        Specify the pathname of a file to use as the template for
1235        new commit messages.
1236
1237commit.verbose::
1238        A boolean or int to specify the level of verbose with `git commit`.
1239        See linkgit:git-commit[1].
1240
1241credential.helper::
1242        Specify an external helper to be called when a username or
1243        password credential is needed; the helper may consult external
1244        storage to avoid prompting the user for the credentials. Note
1245        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1246        for details.
1247
1248credential.useHttpPath::
1249        When acquiring credentials, consider the "path" component of an http
1250        or https URL to be important. Defaults to false. See
1251        linkgit:gitcredentials[7] for more information.
1252
1253credential.username::
1254        If no username is set for a network authentication, use this username
1255        by default. See credential.<context>.* below, and
1256        linkgit:gitcredentials[7].
1257
1258credential.<url>.*::
1259        Any of the credential.* options above can be applied selectively to
1260        some credentials. For example "credential.https://example.com.username"
1261        would set the default username only for https connections to
1262        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1263        matched.
1264
1265credentialCache.ignoreSIGHUP::
1266        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1267
1268include::diff-config.txt[]
1269
1270difftool.<tool>.path::
1271        Override the path for the given tool.  This is useful in case
1272        your tool is not in the PATH.
1273
1274difftool.<tool>.cmd::
1275        Specify the command to invoke the specified diff tool.
1276        The specified command is evaluated in shell with the following
1277        variables available:  'LOCAL' is set to the name of the temporary
1278        file containing the contents of the diff pre-image and 'REMOTE'
1279        is set to the name of the temporary file containing the contents
1280        of the diff post-image.
1281
1282difftool.prompt::
1283        Prompt before each invocation of the diff tool.
1284
1285fastimport.unpackLimit::
1286        If the number of objects imported by linkgit:git-fast-import[1]
1287        is below this limit, then the objects will be unpacked into
1288        loose object files.  However if the number of imported objects
1289        equals or exceeds this limit then the pack will be stored as a
1290        pack.  Storing the pack from a fast-import can make the import
1291        operation complete faster, especially on slow filesystems.  If
1292        not set, the value of `transfer.unpackLimit` is used instead.
1293
1294fetch.recurseSubmodules::
1295        This option can be either set to a boolean value or to 'on-demand'.
1296        Setting it to a boolean changes the behavior of fetch and pull to
1297        unconditionally recurse into submodules when set to true or to not
1298        recurse at all when set to false. When set to 'on-demand' (the default
1299        value), fetch and pull will only recurse into a populated submodule
1300        when its superproject retrieves a commit that updates the submodule's
1301        reference.
1302
1303fetch.fsckObjects::
1304        If it is set to true, git-fetch-pack will check all fetched
1305        objects. It will abort in the case of a malformed object or a
1306        broken link. The result of an abort are only dangling objects.
1307        Defaults to false. If not set, the value of `transfer.fsckObjects`
1308        is used instead.
1309
1310fetch.unpackLimit::
1311        If the number of objects fetched over the Git native
1312        transfer is below this
1313        limit, then the objects will be unpacked into loose object
1314        files. However if the number of received objects equals or
1315        exceeds this limit then the received pack will be stored as
1316        a pack, after adding any missing delta bases.  Storing the
1317        pack from a push can make the push operation complete faster,
1318        especially on slow filesystems.  If not set, the value of
1319        `transfer.unpackLimit` is used instead.
1320
1321fetch.prune::
1322        If true, fetch will automatically behave as if the `--prune`
1323        option was given on the command line.  See also `remote.<name>.prune`.
1324
1325fetch.output::
1326        Control how ref update status is printed. Valid values are
1327        `full` and `compact`. Default value is `full`. See section
1328        OUTPUT in linkgit:git-fetch[1] for detail.
1329
1330format.attach::
1331        Enable multipart/mixed attachments as the default for
1332        'format-patch'.  The value can also be a double quoted string
1333        which will enable attachments as the default and set the
1334        value as the boundary.  See the --attach option in
1335        linkgit:git-format-patch[1].
1336
1337format.from::
1338        Provides the default value for the `--from` option to format-patch.
1339        Accepts a boolean value, or a name and email address.  If false,
1340        format-patch defaults to `--no-from`, using commit authors directly in
1341        the "From:" field of patch mails.  If true, format-patch defaults to
1342        `--from`, using your committer identity in the "From:" field of patch
1343        mails and including a "From:" field in the body of the patch mail if
1344        different.  If set to a non-boolean value, format-patch uses that
1345        value instead of your committer identity.  Defaults to false.
1346
1347format.numbered::
1348        A boolean which can enable or disable sequence numbers in patch
1349        subjects.  It defaults to "auto" which enables it only if there
1350        is more than one patch.  It can be enabled or disabled for all
1351        messages by setting it to "true" or "false".  See --numbered
1352        option in linkgit:git-format-patch[1].
1353
1354format.headers::
1355        Additional email headers to include in a patch to be submitted
1356        by mail.  See linkgit:git-format-patch[1].
1357
1358format.to::
1359format.cc::
1360        Additional recipients to include in a patch to be submitted
1361        by mail.  See the --to and --cc options in
1362        linkgit:git-format-patch[1].
1363
1364format.subjectPrefix::
1365        The default for format-patch is to output files with the '[PATCH]'
1366        subject prefix. Use this variable to change that prefix.
1367
1368format.signature::
1369        The default for format-patch is to output a signature containing
1370        the Git version number. Use this variable to change that default.
1371        Set this variable to the empty string ("") to suppress
1372        signature generation.
1373
1374format.signatureFile::
1375        Works just like format.signature except the contents of the
1376        file specified by this variable will be used as the signature.
1377
1378format.suffix::
1379        The default for format-patch is to output files with the suffix
1380        `.patch`. Use this variable to change that suffix (make sure to
1381        include the dot if you want it).
1382
1383format.pretty::
1384        The default pretty format for log/show/whatchanged command,
1385        See linkgit:git-log[1], linkgit:git-show[1],
1386        linkgit:git-whatchanged[1].
1387
1388format.thread::
1389        The default threading style for 'git format-patch'.  Can be
1390        a boolean value, or `shallow` or `deep`.  `shallow` threading
1391        makes every mail a reply to the head of the series,
1392        where the head is chosen from the cover letter, the
1393        `--in-reply-to`, and the first patch mail, in this order.
1394        `deep` threading makes every mail a reply to the previous one.
1395        A true boolean value is the same as `shallow`, and a false
1396        value disables threading.
1397
1398format.signOff::
1399        A boolean value which lets you enable the `-s/--signoff` option of
1400        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1401        patch should be a conscious act and means that you certify you have
1402        the rights to submit this work under the same open source license.
1403        Please see the 'SubmittingPatches' document for further discussion.
1404
1405format.coverLetter::
1406        A boolean that controls whether to generate a cover-letter when
1407        format-patch is invoked, but in addition can be set to "auto", to
1408        generate a cover-letter only when there's more than one patch.
1409
1410format.outputDirectory::
1411        Set a custom directory to store the resulting files instead of the
1412        current working directory.
1413
1414format.useAutoBase::
1415        A boolean value which lets you enable the `--base=auto` option of
1416        format-patch by default.
1417
1418filter.<driver>.clean::
1419        The command which is used to convert the content of a worktree
1420        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1421        details.
1422
1423filter.<driver>.smudge::
1424        The command which is used to convert the content of a blob
1425        object to a worktree file upon checkout.  See
1426        linkgit:gitattributes[5] for details.
1427
1428fsck.<msg-id>::
1429        Allows overriding the message type (error, warn or ignore) of a
1430        specific message ID such as `missingEmail`.
1431+
1432For convenience, fsck prefixes the error/warning with the message ID,
1433e.g.  "missingEmail: invalid author/committer line - missing email" means
1434that setting `fsck.missingEmail = ignore` will hide that issue.
1435+
1436This feature is intended to support working with legacy repositories
1437which cannot be repaired without disruptive changes.
1438
1439fsck.skipList::
1440        The path to a sorted list of object names (i.e. one SHA-1 per
1441        line) that are known to be broken in a non-fatal way and should
1442        be ignored. This feature is useful when an established project
1443        should be accepted despite early commits containing errors that
1444        can be safely ignored such as invalid committer email addresses.
1445        Note: corrupt objects cannot be skipped with this setting.
1446
1447gc.aggressiveDepth::
1448        The depth parameter used in the delta compression
1449        algorithm used by 'git gc --aggressive'.  This defaults
1450        to 50.
1451
1452gc.aggressiveWindow::
1453        The window size parameter used in the delta compression
1454        algorithm used by 'git gc --aggressive'.  This defaults
1455        to 250.
1456
1457gc.auto::
1458        When there are approximately more than this many loose
1459        objects in the repository, `git gc --auto` will pack them.
1460        Some Porcelain commands use this command to perform a
1461        light-weight garbage collection from time to time.  The
1462        default value is 6700.  Setting this to 0 disables it.
1463
1464gc.autoPackLimit::
1465        When there are more than this many packs that are not
1466        marked with `*.keep` file in the repository, `git gc
1467        --auto` consolidates them into one larger pack.  The
1468        default value is 50.  Setting this to 0 disables it.
1469
1470gc.autoDetach::
1471        Make `git gc --auto` return immediately and run in background
1472        if the system supports it. Default is true.
1473
1474gc.logExpiry::
1475        If the file gc.log exists, then `git gc --auto` won't run
1476        unless that file is more than 'gc.logExpiry' old.  Default is
1477        "1.day".  See `gc.pruneExpire` for more ways to specify its
1478        value.
1479
1480gc.packRefs::
1481        Running `git pack-refs` in a repository renders it
1482        unclonable by Git versions prior to 1.5.1.2 over dumb
1483        transports such as HTTP.  This variable determines whether
1484        'git gc' runs `git pack-refs`. This can be set to `notbare`
1485        to enable it within all non-bare repos or it can be set to a
1486        boolean value.  The default is `true`.
1487
1488gc.pruneExpire::
1489        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1490        Override the grace period with this config variable.  The value
1491        "now" may be used to disable this grace period and always prune
1492        unreachable objects immediately, or "never" may be used to
1493        suppress pruning.  This feature helps prevent corruption when
1494        'git gc' runs concurrently with another process writing to the
1495        repository; see the "NOTES" section of linkgit:git-gc[1].
1496
1497gc.worktreePruneExpire::
1498        When 'git gc' is run, it calls
1499        'git worktree prune --expire 3.months.ago'.
1500        This config variable can be used to set a different grace
1501        period. The value "now" may be used to disable the grace
1502        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1503        may be used to suppress pruning.
1504
1505gc.reflogExpire::
1506gc.<pattern>.reflogExpire::
1507        'git reflog expire' removes reflog entries older than
1508        this time; defaults to 90 days. The value "now" expires all
1509        entries immediately, and "never" suppresses expiration
1510        altogether. With "<pattern>" (e.g.
1511        "refs/stash") in the middle the setting applies only to
1512        the refs that match the <pattern>.
1513
1514gc.reflogExpireUnreachable::
1515gc.<pattern>.reflogExpireUnreachable::
1516        'git reflog expire' removes reflog entries older than
1517        this time and are not reachable from the current tip;
1518        defaults to 30 days. The value "now" expires all entries
1519        immediately, and "never" suppresses expiration altogether.
1520        With "<pattern>" (e.g. "refs/stash")
1521        in the middle, the setting applies only to the refs that
1522        match the <pattern>.
1523
1524gc.rerereResolved::
1525        Records of conflicted merge you resolved earlier are
1526        kept for this many days when 'git rerere gc' is run.
1527        The default is 60 days.  See linkgit:git-rerere[1].
1528
1529gc.rerereUnresolved::
1530        Records of conflicted merge you have not resolved are
1531        kept for this many days when 'git rerere gc' is run.
1532        The default is 15 days.  See linkgit:git-rerere[1].
1533
1534gitcvs.commitMsgAnnotation::
1535        Append this string to each commit message. Set to empty string
1536        to disable this feature. Defaults to "via git-CVS emulator".
1537
1538gitcvs.enabled::
1539        Whether the CVS server interface is enabled for this repository.
1540        See linkgit:git-cvsserver[1].
1541
1542gitcvs.logFile::
1543        Path to a log file where the CVS server interface well... logs
1544        various stuff. See linkgit:git-cvsserver[1].
1545
1546gitcvs.usecrlfattr::
1547        If true, the server will look up the end-of-line conversion
1548        attributes for files to determine the `-k` modes to use. If
1549        the attributes force Git to treat a file as text,
1550        the `-k` mode will be left blank so CVS clients will
1551        treat it as text. If they suppress text conversion, the file
1552        will be set with '-kb' mode, which suppresses any newline munging
1553        the client might otherwise do. If the attributes do not allow
1554        the file type to be determined, then `gitcvs.allBinary` is
1555        used. See linkgit:gitattributes[5].
1556
1557gitcvs.allBinary::
1558        This is used if `gitcvs.usecrlfattr` does not resolve
1559        the correct '-kb' mode to use. If true, all
1560        unresolved files are sent to the client in
1561        mode '-kb'. This causes the client to treat them
1562        as binary files, which suppresses any newline munging it
1563        otherwise might do. Alternatively, if it is set to "guess",
1564        then the contents of the file are examined to decide if
1565        it is binary, similar to `core.autocrlf`.
1566
1567gitcvs.dbName::
1568        Database used by git-cvsserver to cache revision information
1569        derived from the Git repository. The exact meaning depends on the
1570        used database driver, for SQLite (which is the default driver) this
1571        is a filename. Supports variable substitution (see
1572        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1573        Default: '%Ggitcvs.%m.sqlite'
1574
1575gitcvs.dbDriver::
1576        Used Perl DBI driver. You can specify any available driver
1577        for this here, but it might not work. git-cvsserver is tested
1578        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1579        reported *not* to work with 'DBD::mysql'. Experimental feature.
1580        May not contain double colons (`:`). Default: 'SQLite'.
1581        See linkgit:git-cvsserver[1].
1582
1583gitcvs.dbUser, gitcvs.dbPass::
1584        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1585        since SQLite has no concept of database users and/or passwords.
1586        'gitcvs.dbUser' supports variable substitution (see
1587        linkgit:git-cvsserver[1] for details).
1588
1589gitcvs.dbTableNamePrefix::
1590        Database table name prefix.  Prepended to the names of any
1591        database tables used, allowing a single database to be used
1592        for several repositories.  Supports variable substitution (see
1593        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1594        characters will be replaced with underscores.
1595
1596All gitcvs variables except for `gitcvs.usecrlfattr` and
1597`gitcvs.allBinary` can also be specified as
1598'gitcvs.<access_method>.<varname>' (where 'access_method'
1599is one of "ext" and "pserver") to make them apply only for the given
1600access method.
1601
1602gitweb.category::
1603gitweb.description::
1604gitweb.owner::
1605gitweb.url::
1606        See linkgit:gitweb[1] for description.
1607
1608gitweb.avatar::
1609gitweb.blame::
1610gitweb.grep::
1611gitweb.highlight::
1612gitweb.patches::
1613gitweb.pickaxe::
1614gitweb.remote_heads::
1615gitweb.showSizes::
1616gitweb.snapshot::
1617        See linkgit:gitweb.conf[5] for description.
1618
1619grep.lineNumber::
1620        If set to true, enable `-n` option by default.
1621
1622grep.patternType::
1623        Set the default matching behavior. Using a value of 'basic', 'extended',
1624        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1625        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1626        value 'default' will return to the default matching behavior.
1627
1628grep.extendedRegexp::
1629        If set to true, enable `--extended-regexp` option by default. This
1630        option is ignored when the `grep.patternType` option is set to a value
1631        other than 'default'.
1632
1633grep.threads::
1634        Number of grep worker threads to use.
1635        See `grep.threads` in linkgit:git-grep[1] for more information.
1636
1637grep.fallbackToNoIndex::
1638        If set to true, fall back to git grep --no-index if git grep
1639        is executed outside of a git repository.  Defaults to false.
1640
1641gpg.program::
1642        Use this custom program instead of "`gpg`" found on `$PATH` when
1643        making or verifying a PGP signature. The program must support the
1644        same command-line interface as GPG, namely, to verify a detached
1645        signature, "`gpg --verify $file - <$signature`" is run, and the
1646        program is expected to signal a good signature by exiting with
1647        code 0, and to generate an ASCII-armored detached signature, the
1648        standard input of "`gpg -bsau $key`" is fed with the contents to be
1649        signed, and the program is expected to send the result to its
1650        standard output.
1651
1652gui.commitMsgWidth::
1653        Defines how wide the commit message window is in the
1654        linkgit:git-gui[1]. "75" is the default.
1655
1656gui.diffContext::
1657        Specifies how many context lines should be used in calls to diff
1658        made by the linkgit:git-gui[1]. The default is "5".
1659
1660gui.displayUntracked::
1661        Determines if linkgit:git-gui[1] shows untracked files
1662        in the file list. The default is "true".
1663
1664gui.encoding::
1665        Specifies the default encoding to use for displaying of
1666        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1667        It can be overridden by setting the 'encoding' attribute
1668        for relevant files (see linkgit:gitattributes[5]).
1669        If this option is not set, the tools default to the
1670        locale encoding.
1671
1672gui.matchTrackingBranch::
1673        Determines if new branches created with linkgit:git-gui[1] should
1674        default to tracking remote branches with matching names or
1675        not. Default: "false".
1676
1677gui.newBranchTemplate::
1678        Is used as suggested name when creating new branches using the
1679        linkgit:git-gui[1].
1680
1681gui.pruneDuringFetch::
1682        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1683        performing a fetch. The default value is "false".
1684
1685gui.trustmtime::
1686        Determines if linkgit:git-gui[1] should trust the file modification
1687        timestamp or not. By default the timestamps are not trusted.
1688
1689gui.spellingDictionary::
1690        Specifies the dictionary used for spell checking commit messages in
1691        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1692        off.
1693
1694gui.fastCopyBlame::
1695        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1696        location detection. It makes blame significantly faster on huge
1697        repositories at the expense of less thorough copy detection.
1698
1699gui.copyBlameThreshold::
1700        Specifies the threshold to use in 'git gui blame' original location
1701        detection, measured in alphanumeric characters. See the
1702        linkgit:git-blame[1] manual for more information on copy detection.
1703
1704gui.blamehistoryctx::
1705        Specifies the radius of history context in days to show in
1706        linkgit:gitk[1] for the selected commit, when the `Show History
1707        Context` menu item is invoked from 'git gui blame'. If this
1708        variable is set to zero, the whole history is shown.
1709
1710guitool.<name>.cmd::
1711        Specifies the shell command line to execute when the corresponding item
1712        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1713        mandatory for every tool. The command is executed from the root of
1714        the working directory, and in the environment it receives the name of
1715        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1716        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1717        the head is detached, 'CUR_BRANCH' is empty).
1718
1719guitool.<name>.needsFile::
1720        Run the tool only if a diff is selected in the GUI. It guarantees
1721        that 'FILENAME' is not empty.
1722
1723guitool.<name>.noConsole::
1724        Run the command silently, without creating a window to display its
1725        output.
1726
1727guitool.<name>.noRescan::
1728        Don't rescan the working directory for changes after the tool
1729        finishes execution.
1730
1731guitool.<name>.confirm::
1732        Show a confirmation dialog before actually running the tool.
1733
1734guitool.<name>.argPrompt::
1735        Request a string argument from the user, and pass it to the tool
1736        through the `ARGS` environment variable. Since requesting an
1737        argument implies confirmation, the 'confirm' option has no effect
1738        if this is enabled. If the option is set to 'true', 'yes', or '1',
1739        the dialog uses a built-in generic prompt; otherwise the exact
1740        value of the variable is used.
1741
1742guitool.<name>.revPrompt::
1743        Request a single valid revision from the user, and set the
1744        `REVISION` environment variable. In other aspects this option
1745        is similar to 'argPrompt', and can be used together with it.
1746
1747guitool.<name>.revUnmerged::
1748        Show only unmerged branches in the 'revPrompt' subdialog.
1749        This is useful for tools similar to merge or rebase, but not
1750        for things like checkout or reset.
1751
1752guitool.<name>.title::
1753        Specifies the title to use for the prompt dialog. The default
1754        is the tool name.
1755
1756guitool.<name>.prompt::
1757        Specifies the general prompt string to display at the top of
1758        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1759        The default value includes the actual command.
1760
1761help.browser::
1762        Specify the browser that will be used to display help in the
1763        'web' format. See linkgit:git-help[1].
1764
1765help.format::
1766        Override the default help format used by linkgit:git-help[1].
1767        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1768        the default. 'web' and 'html' are the same.
1769
1770help.autoCorrect::
1771        Automatically correct and execute mistyped commands after
1772        waiting for the given number of deciseconds (0.1 sec). If more
1773        than one command can be deduced from the entered text, nothing
1774        will be executed.  If the value of this option is negative,
1775        the corrected command will be executed immediately. If the
1776        value is 0 - the command will be just shown but not executed.
1777        This is the default.
1778
1779help.htmlPath::
1780        Specify the path where the HTML documentation resides. File system paths
1781        and URLs are supported. HTML pages will be prefixed with this path when
1782        help is displayed in the 'web' format. This defaults to the documentation
1783        path of your Git installation.
1784
1785http.proxy::
1786        Override the HTTP proxy, normally configured using the 'http_proxy',
1787        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1788        addition to the syntax understood by curl, it is possible to specify a
1789        proxy string with a user name but no password, in which case git will
1790        attempt to acquire one in the same way it does for other credentials. See
1791        linkgit:gitcredentials[7] for more information. The syntax thus is
1792        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1793        on a per-remote basis; see remote.<name>.proxy
1794
1795http.proxyAuthMethod::
1796        Set the method with which to authenticate against the HTTP proxy. This
1797        only takes effect if the configured proxy string contains a user name part
1798        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1799        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1800        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1801        variable.  Possible values are:
1802+
1803--
1804* `anyauth` - Automatically pick a suitable authentication method. It is
1805  assumed that the proxy answers an unauthenticated request with a 407
1806  status code and one or more Proxy-authenticate headers with supported
1807  authentication methods. This is the default.
1808* `basic` - HTTP Basic authentication
1809* `digest` - HTTP Digest authentication; this prevents the password from being
1810  transmitted to the proxy in clear text
1811* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1812  of `curl(1)`)
1813* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1814--
1815
1816http.emptyAuth::
1817        Attempt authentication without seeking a username or password.  This
1818        can be used to attempt GSS-Negotiate authentication without specifying
1819        a username in the URL, as libcurl normally requires a username for
1820        authentication.
1821
1822http.delegation::
1823        Control GSSAPI credential delegation. The delegation is disabled
1824        by default in libcurl since version 7.21.7. Set parameter to tell
1825        the server what it is allowed to delegate when it comes to user
1826        credentials. Used with GSS/kerberos. Possible values are:
1827+
1828--
1829* `none` - Don't allow any delegation.
1830* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1831  Kerberos service ticket, which is a matter of realm policy.
1832* `always` - Unconditionally allow the server to delegate.
1833--
1834
1835
1836http.extraHeader::
1837        Pass an additional HTTP header when communicating with a server.  If
1838        more than one such entry exists, all of them are added as extra
1839        headers.  To allow overriding the settings inherited from the system
1840        config, an empty value will reset the extra headers to the empty list.
1841
1842http.cookieFile::
1843        The pathname of a file containing previously stored cookie lines,
1844        which should be used
1845        in the Git http session, if they match the server. The file format
1846        of the file to read cookies from should be plain HTTP headers or
1847        the Netscape/Mozilla cookie file format (see `curl(1)`).
1848        NOTE that the file specified with http.cookieFile is used only as
1849        input unless http.saveCookies is set.
1850
1851http.saveCookies::
1852        If set, store cookies received during requests to the file specified by
1853        http.cookieFile. Has no effect if http.cookieFile is unset.
1854
1855http.sslVersion::
1856        The SSL version to use when negotiating an SSL connection, if you
1857        want to force the default.  The available and default version
1858        depend on whether libcurl was built against NSS or OpenSSL and the
1859        particular configuration of the crypto library in use. Internally
1860        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1861        documentation for more details on the format of this option and
1862        for the ssl version supported. Actually the possible values of
1863        this option are:
1864
1865        - sslv2
1866        - sslv3
1867        - tlsv1
1868        - tlsv1.0
1869        - tlsv1.1
1870        - tlsv1.2
1871
1872+
1873Can be overridden by the `GIT_SSL_VERSION` environment variable.
1874To force git to use libcurl's default ssl version and ignore any
1875explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1876empty string.
1877
1878http.sslCipherList::
1879  A list of SSL ciphers to use when negotiating an SSL connection.
1880  The available ciphers depend on whether libcurl was built against
1881  NSS or OpenSSL and the particular configuration of the crypto
1882  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1883  option; see the libcurl documentation for more details on the format
1884  of this list.
1885+
1886Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1887To force git to use libcurl's default cipher list and ignore any
1888explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1889empty string.
1890
1891http.sslVerify::
1892        Whether to verify the SSL certificate when fetching or pushing
1893        over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1894        variable.
1895
1896http.sslCert::
1897        File containing the SSL certificate when fetching or pushing
1898        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1899        variable.
1900
1901http.sslKey::
1902        File containing the SSL private key when fetching or pushing
1903        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1904        variable.
1905
1906http.sslCertPasswordProtected::
1907        Enable Git's password prompt for the SSL certificate.  Otherwise
1908        OpenSSL will prompt the user, possibly many times, if the
1909        certificate or private key is encrypted.  Can be overridden by the
1910        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1911
1912http.sslCAInfo::
1913        File containing the certificates to verify the peer with when
1914        fetching or pushing over HTTPS. Can be overridden by the
1915        `GIT_SSL_CAINFO` environment variable.
1916
1917http.sslCAPath::
1918        Path containing files with the CA certificates to verify the peer
1919        with when fetching or pushing over HTTPS. Can be overridden
1920        by the `GIT_SSL_CAPATH` environment variable.
1921
1922http.pinnedpubkey::
1923        Public key of the https service. It may either be the filename of
1924        a PEM or DER encoded public key file or a string starting with
1925        'sha256//' followed by the base64 encoded sha256 hash of the
1926        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1927        exit with an error if this option is set but not supported by
1928        cURL.
1929
1930http.sslTry::
1931        Attempt to use AUTH SSL/TLS and encrypted data transfers
1932        when connecting via regular FTP protocol. This might be needed
1933        if the FTP server requires it for security reasons or you wish
1934        to connect securely whenever remote FTP server supports it.
1935        Default is false since it might trigger certificate verification
1936        errors on misconfigured servers.
1937
1938http.maxRequests::
1939        How many HTTP requests to launch in parallel. Can be overridden
1940        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1941
1942http.minSessions::
1943        The number of curl sessions (counted across slots) to be kept across
1944        requests. They will not be ended with curl_easy_cleanup() until
1945        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1946        value will be capped at 1. Defaults to 1.
1947
1948http.postBuffer::
1949        Maximum size in bytes of the buffer used by smart HTTP
1950        transports when POSTing data to the remote system.
1951        For requests larger than this buffer size, HTTP/1.1 and
1952        Transfer-Encoding: chunked is used to avoid creating a
1953        massive pack file locally.  Default is 1 MiB, which is
1954        sufficient for most requests.
1955
1956http.lowSpeedLimit, http.lowSpeedTime::
1957        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1958        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1959        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1960        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1961
1962http.noEPSV::
1963        A boolean which disables using of EPSV ftp command by curl.
1964        This can helpful with some "poor" ftp servers which don't
1965        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1966        environment variable. Default is false (curl will use EPSV).
1967
1968http.userAgent::
1969        The HTTP USER_AGENT string presented to an HTTP server.  The default
1970        value represents the version of the client Git such as git/1.7.1.
1971        This option allows you to override this value to a more common value
1972        such as Mozilla/4.0.  This may be necessary, for instance, if
1973        connecting through a firewall that restricts HTTP connections to a set
1974        of common USER_AGENT strings (but not including those like git/1.7.1).
1975        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1976
1977http.followRedirects::
1978        Whether git should follow HTTP redirects. If set to `true`, git
1979        will transparently follow any redirect issued by a server it
1980        encounters. If set to `false`, git will treat all redirects as
1981        errors. If set to `initial`, git will follow redirects only for
1982        the initial request to a remote, but not for subsequent
1983        follow-up HTTP requests. Since git uses the redirected URL as
1984        the base for the follow-up requests, this is generally
1985        sufficient. The default is `initial`.
1986
1987http.<url>.*::
1988        Any of the http.* options above can be applied selectively to some URLs.
1989        For a config key to match a URL, each element of the config key is
1990        compared to that of the URL, in the following order:
1991+
1992--
1993. Scheme (e.g., `https` in `https://example.com/`). This field
1994  must match exactly between the config key and the URL.
1995
1996. Host/domain name (e.g., `example.com` in `https://example.com/`).
1997  This field must match between the config key and the URL. It is
1998  possible to specify a `*` as part of the host name to match all subdomains
1999  at this level. `https://*.example.com/` for example would match
2000  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2001
2002. Port number (e.g., `8080` in `http://example.com:8080/`).
2003  This field must match exactly between the config key and the URL.
2004  Omitted port numbers are automatically converted to the correct
2005  default for the scheme before matching.
2006
2007. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2008  path field of the config key must match the path field of the URL
2009  either exactly or as a prefix of slash-delimited path elements.  This means
2010  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2011  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2012  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2013  key with just path `foo/`).
2014
2015. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2016  the config key has a user name it must match the user name in the
2017  URL exactly. If the config key does not have a user name, that
2018  config key will match a URL with any user name (including none),
2019  but at a lower precedence than a config key with a user name.
2020--
2021+
2022The list above is ordered by decreasing precedence; a URL that matches
2023a config key's path is preferred to one that matches its user name. For example,
2024if the URL is `https://user@example.com/foo/bar` a config key match of
2025`https://example.com/foo` will be preferred over a config key match of
2026`https://user@example.com`.
2027+
2028All URLs are normalized before attempting any matching (the password part,
2029if embedded in the URL, is always ignored for matching purposes) so that
2030equivalent URLs that are simply spelled differently will match properly.
2031Environment variable settings always override any matches.  The URLs that are
2032matched against are those given directly to Git commands.  This means any URLs
2033visited as a result of a redirection do not participate in matching.
2034
2035ssh.variant::
2036        Depending on the value of the environment variables `GIT_SSH` or
2037        `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2038        auto-detects whether to adjust its command-line parameters for use
2039        with plink or tortoiseplink, as opposed to the default (OpenSSH).
2040+
2041The config variable `ssh.variant` can be set to override this auto-detection;
2042valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2043will be treated as normal ssh. This setting can be overridden via the
2044environment variable `GIT_SSH_VARIANT`.
2045
2046i18n.commitEncoding::
2047        Character encoding the commit messages are stored in; Git itself
2048        does not care per se, but this information is necessary e.g. when
2049        importing commits from emails or in the gitk graphical history
2050        browser (and possibly at other places in the future or in other
2051        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2052
2053i18n.logOutputEncoding::
2054        Character encoding the commit messages are converted to when
2055        running 'git log' and friends.
2056
2057imap::
2058        The configuration variables in the 'imap' section are described
2059        in linkgit:git-imap-send[1].
2060
2061index.version::
2062        Specify the version with which new index files should be
2063        initialized.  This does not affect existing repositories.
2064
2065init.templateDir::
2066        Specify the directory from which templates will be copied.
2067        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2068
2069instaweb.browser::
2070        Specify the program that will be used to browse your working
2071        repository in gitweb. See linkgit:git-instaweb[1].
2072
2073instaweb.httpd::
2074        The HTTP daemon command-line to start gitweb on your working
2075        repository. See linkgit:git-instaweb[1].
2076
2077instaweb.local::
2078        If true the web server started by linkgit:git-instaweb[1] will
2079        be bound to the local IP (127.0.0.1).
2080
2081instaweb.modulePath::
2082        The default module path for linkgit:git-instaweb[1] to use
2083        instead of /usr/lib/apache2/modules.  Only used if httpd
2084        is Apache.
2085
2086instaweb.port::
2087        The port number to bind the gitweb httpd to. See
2088        linkgit:git-instaweb[1].
2089
2090interactive.singleKey::
2091        In interactive commands, allow the user to provide one-letter
2092        input with a single key (i.e., without hitting enter).
2093        Currently this is used by the `--patch` mode of
2094        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2095        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2096        setting is silently ignored if portable keystroke input
2097        is not available; requires the Perl module Term::ReadKey.
2098
2099interactive.diffFilter::
2100        When an interactive command (such as `git add --patch`) shows
2101        a colorized diff, git will pipe the diff through the shell
2102        command defined by this configuration variable. The command may
2103        mark up the diff further for human consumption, provided that it
2104        retains a one-to-one correspondence with the lines in the
2105        original diff. Defaults to disabled (no filtering).
2106
2107log.abbrevCommit::
2108        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2109        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2110        override this option with `--no-abbrev-commit`.
2111
2112log.date::
2113        Set the default date-time mode for the 'log' command.
2114        Setting a value for log.date is similar to using 'git log''s
2115        `--date` option.  See linkgit:git-log[1] for details.
2116
2117log.decorate::
2118        Print out the ref names of any commits that are shown by the log
2119        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2120        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2121        specified, the full ref name (including prefix) will be printed.
2122        If 'auto' is specified, then if the output is going to a terminal,
2123        the ref names are shown as if 'short' were given, otherwise no ref
2124        names are shown. This is the same as the `--decorate` option
2125        of the `git log`.
2126
2127log.follow::
2128        If `true`, `git log` will act as if the `--follow` option was used when
2129        a single <path> is given.  This has the same limitations as `--follow`,
2130        i.e. it cannot be used to follow multiple files and does not work well
2131        on non-linear history.
2132
2133log.graphColors::
2134        A list of colors, separated by commas, that can be used to draw
2135        history lines in `git log --graph`.
2136
2137log.showRoot::
2138        If true, the initial commit will be shown as a big creation event.
2139        This is equivalent to a diff against an empty tree.
2140        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2141        normally hide the root commit will now show it. True by default.
2142
2143log.mailmap::
2144        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2145        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2146
2147mailinfo.scissors::
2148        If true, makes linkgit:git-mailinfo[1] (and therefore
2149        linkgit:git-am[1]) act by default as if the --scissors option
2150        was provided on the command-line. When active, this features
2151        removes everything from the message body before a scissors
2152        line (i.e. consisting mainly of ">8", "8<" and "-").
2153
2154mailmap.file::
2155        The location of an augmenting mailmap file. The default
2156        mailmap, located in the root of the repository, is loaded
2157        first, then the mailmap file pointed to by this variable.
2158        The location of the mailmap file may be in a repository
2159        subdirectory, or somewhere outside of the repository itself.
2160        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2161
2162mailmap.blob::
2163        Like `mailmap.file`, but consider the value as a reference to a
2164        blob in the repository. If both `mailmap.file` and
2165        `mailmap.blob` are given, both are parsed, with entries from
2166        `mailmap.file` taking precedence. In a bare repository, this
2167        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2168        defaults to empty.
2169
2170man.viewer::
2171        Specify the programs that may be used to display help in the
2172        'man' format. See linkgit:git-help[1].
2173
2174man.<tool>.cmd::
2175        Specify the command to invoke the specified man viewer. The
2176        specified command is evaluated in shell with the man page
2177        passed as argument. (See linkgit:git-help[1].)
2178
2179man.<tool>.path::
2180        Override the path for the given tool that may be used to
2181        display help in the 'man' format. See linkgit:git-help[1].
2182
2183include::merge-config.txt[]
2184
2185mergetool.<tool>.path::
2186        Override the path for the given tool.  This is useful in case
2187        your tool is not in the PATH.
2188
2189mergetool.<tool>.cmd::
2190        Specify the command to invoke the specified merge tool.  The
2191        specified command is evaluated in shell with the following
2192        variables available: 'BASE' is the name of a temporary file
2193        containing the common base of the files to be merged, if available;
2194        'LOCAL' is the name of a temporary file containing the contents of
2195        the file on the current branch; 'REMOTE' is the name of a temporary
2196        file containing the contents of the file from the branch being
2197        merged; 'MERGED' contains the name of the file to which the merge
2198        tool should write the results of a successful merge.
2199
2200mergetool.<tool>.trustExitCode::
2201        For a custom merge command, specify whether the exit code of
2202        the merge command can be used to determine whether the merge was
2203        successful.  If this is not set to true then the merge target file
2204        timestamp is checked and the merge assumed to have been successful
2205        if the file has been updated, otherwise the user is prompted to
2206        indicate the success of the merge.
2207
2208mergetool.meld.hasOutput::
2209        Older versions of `meld` do not support the `--output` option.
2210        Git will attempt to detect whether `meld` supports `--output`
2211        by inspecting the output of `meld --help`.  Configuring
2212        `mergetool.meld.hasOutput` will make Git skip these checks and
2213        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2214        to `true` tells Git to unconditionally use the `--output` option,
2215        and `false` avoids using `--output`.
2216
2217mergetool.keepBackup::
2218        After performing a merge, the original file with conflict markers
2219        can be saved as a file with a `.orig` extension.  If this variable
2220        is set to `false` then this file is not preserved.  Defaults to
2221        `true` (i.e. keep the backup files).
2222
2223mergetool.keepTemporaries::
2224        When invoking a custom merge tool, Git uses a set of temporary
2225        files to pass to the tool. If the tool returns an error and this
2226        variable is set to `true`, then these temporary files will be
2227        preserved, otherwise they will be removed after the tool has
2228        exited. Defaults to `false`.
2229
2230mergetool.writeToTemp::
2231        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2232        conflicting files in the worktree by default.  Git will attempt
2233        to use a temporary directory for these files when set `true`.
2234        Defaults to `false`.
2235
2236mergetool.prompt::
2237        Prompt before each invocation of the merge resolution program.
2238
2239notes.mergeStrategy::
2240        Which merge strategy to choose by default when resolving notes
2241        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2242        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2243        section of linkgit:git-notes[1] for more information on each strategy.
2244
2245notes.<name>.mergeStrategy::
2246        Which merge strategy to choose when doing a notes merge into
2247        refs/notes/<name>.  This overrides the more general
2248        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2249        linkgit:git-notes[1] for more information on the available strategies.
2250
2251notes.displayRef::
2252        The (fully qualified) refname from which to show notes when
2253        showing commit messages.  The value of this variable can be set
2254        to a glob, in which case notes from all matching refs will be
2255        shown.  You may also specify this configuration variable
2256        several times.  A warning will be issued for refs that do not
2257        exist, but a glob that does not match any refs is silently
2258        ignored.
2259+
2260This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2261environment variable, which must be a colon separated list of refs or
2262globs.
2263+
2264The effective value of "core.notesRef" (possibly overridden by
2265GIT_NOTES_REF) is also implicitly added to the list of refs to be
2266displayed.
2267
2268notes.rewrite.<command>::
2269        When rewriting commits with <command> (currently `amend` or
2270        `rebase`) and this variable is set to `true`, Git
2271        automatically copies your notes from the original to the
2272        rewritten commit.  Defaults to `true`, but see
2273        "notes.rewriteRef" below.
2274
2275notes.rewriteMode::
2276        When copying notes during a rewrite (see the
2277        "notes.rewrite.<command>" option), determines what to do if
2278        the target commit already has a note.  Must be one of
2279        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2280        Defaults to `concatenate`.
2281+
2282This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2283environment variable.
2284
2285notes.rewriteRef::
2286        When copying notes during a rewrite, specifies the (fully
2287        qualified) ref whose notes should be copied.  The ref may be a
2288        glob, in which case notes in all matching refs will be copied.
2289        You may also specify this configuration several times.
2290+
2291Does not have a default value; you must configure this variable to
2292enable note rewriting.  Set it to `refs/notes/commits` to enable
2293rewriting for the default commit notes.
2294+
2295This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2296environment variable, which must be a colon separated list of refs or
2297globs.
2298
2299pack.window::
2300        The size of the window used by linkgit:git-pack-objects[1] when no
2301        window size is given on the command line. Defaults to 10.
2302
2303pack.depth::
2304        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2305        maximum depth is given on the command line. Defaults to 50.
2306
2307pack.windowMemory::
2308        The maximum size of memory that is consumed by each thread
2309        in linkgit:git-pack-objects[1] for pack window memory when
2310        no limit is given on the command line.  The value can be
2311        suffixed with "k", "m", or "g".  When left unconfigured (or
2312        set explicitly to 0), there will be no limit.
2313
2314pack.compression::
2315        An integer -1..9, indicating the compression level for objects
2316        in a pack file. -1 is the zlib default. 0 means no
2317        compression, and 1..9 are various speed/size tradeoffs, 9 being
2318        slowest.  If not set,  defaults to core.compression.  If that is
2319        not set,  defaults to -1, the zlib default, which is "a default
2320        compromise between speed and compression (currently equivalent
2321        to level 6)."
2322+
2323Note that changing the compression level will not automatically recompress
2324all existing objects. You can force recompression by passing the -F option
2325to linkgit:git-repack[1].
2326
2327pack.deltaCacheSize::
2328        The maximum memory in bytes used for caching deltas in
2329        linkgit:git-pack-objects[1] before writing them out to a pack.
2330        This cache is used to speed up the writing object phase by not
2331        having to recompute the final delta result once the best match
2332        for all objects is found.  Repacking large repositories on machines
2333        which are tight with memory might be badly impacted by this though,
2334        especially if this cache pushes the system into swapping.
2335        A value of 0 means no limit. The smallest size of 1 byte may be
2336        used to virtually disable this cache. Defaults to 256 MiB.
2337
2338pack.deltaCacheLimit::
2339        The maximum size of a delta, that is cached in
2340        linkgit:git-pack-objects[1]. This cache is used to speed up the
2341        writing object phase by not having to recompute the final delta
2342        result once the best match for all objects is found. Defaults to 1000.
2343
2344pack.threads::
2345        Specifies the number of threads to spawn when searching for best
2346        delta matches.  This requires that linkgit:git-pack-objects[1]
2347        be compiled with pthreads otherwise this option is ignored with a
2348        warning. This is meant to reduce packing time on multiprocessor
2349        machines. The required amount of memory for the delta search window
2350        is however multiplied by the number of threads.
2351        Specifying 0 will cause Git to auto-detect the number of CPU's
2352        and set the number of threads accordingly.
2353
2354pack.indexVersion::
2355        Specify the default pack index version.  Valid values are 1 for
2356        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2357        the new pack index with capabilities for packs larger than 4 GB
2358        as well as proper protection against the repacking of corrupted
2359        packs.  Version 2 is the default.  Note that version 2 is enforced
2360        and this config option ignored whenever the corresponding pack is
2361        larger than 2 GB.
2362+
2363If you have an old Git that does not understand the version 2 `*.idx` file,
2364cloning or fetching over a non native protocol (e.g. "http")
2365that will copy both `*.pack` file and corresponding `*.idx` file from the
2366other side may give you a repository that cannot be accessed with your
2367older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2368you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2369the `*.idx` file.
2370
2371pack.packSizeLimit::
2372        The maximum size of a pack.  This setting only affects
2373        packing to a file when repacking, i.e. the git:// protocol
2374        is unaffected.  It can be overridden by the `--max-pack-size`
2375        option of linkgit:git-repack[1].  Reaching this limit results
2376        in the creation of multiple packfiles; which in turn prevents
2377        bitmaps from being created.
2378        The minimum size allowed is limited to 1 MiB.
2379        The default is unlimited.
2380        Common unit suffixes of 'k', 'm', or 'g' are
2381        supported.
2382
2383pack.useBitmaps::
2384        When true, git will use pack bitmaps (if available) when packing
2385        to stdout (e.g., during the server side of a fetch). Defaults to
2386        true. You should not generally need to turn this off unless
2387        you are debugging pack bitmaps.
2388
2389pack.writeBitmaps (deprecated)::
2390        This is a deprecated synonym for `repack.writeBitmaps`.
2391
2392pack.writeBitmapHashCache::
2393        When true, git will include a "hash cache" section in the bitmap
2394        index (if one is written). This cache can be used to feed git's
2395        delta heuristics, potentially leading to better deltas between
2396        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2397        between an older, bitmapped pack and objects that have been
2398        pushed since the last gc). The downside is that it consumes 4
2399        bytes per object of disk space, and that JGit's bitmap
2400        implementation does not understand it, causing it to complain if
2401        Git and JGit are used on the same repository. Defaults to false.
2402
2403pager.<cmd>::
2404        If the value is boolean, turns on or off pagination of the
2405        output of a particular Git subcommand when writing to a tty.
2406        Otherwise, turns on pagination for the subcommand using the
2407        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2408        or `--no-pager` is specified on the command line, it takes
2409        precedence over this option.  To disable pagination for all
2410        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2411
2412pretty.<name>::
2413        Alias for a --pretty= format string, as specified in
2414        linkgit:git-log[1]. Any aliases defined here can be used just
2415        as the built-in pretty formats could. For example,
2416        running `git config pretty.changelog "format:* %H %s"`
2417        would cause the invocation `git log --pretty=changelog`
2418        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2419        Note that an alias with the same name as a built-in format
2420        will be silently ignored.
2421
2422protocol.allow::
2423        If set, provide a user defined default policy for all protocols which
2424        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2425        if unset, known-safe protocols (http, https, git, ssh, file) have a
2426        default policy of `always`, known-dangerous protocols (ext) have a
2427        default policy of `never`, and all other protocols have a default
2428        policy of `user`.  Supported policies:
2429+
2430--
2431
2432* `always` - protocol is always able to be used.
2433
2434* `never` - protocol is never able to be used.
2435
2436* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2437  either unset or has a value of 1.  This policy should be used when you want a
2438  protocol to be directly usable by the user but don't want it used by commands which
2439  execute clone/fetch/push commands without user input, e.g. recursive
2440  submodule initialization.
2441
2442--
2443
2444protocol.<name>.allow::
2445        Set a policy to be used by protocol `<name>` with clone/fetch/push
2446        commands. See `protocol.allow` above for the available policies.
2447+
2448The protocol names currently used by git are:
2449+
2450--
2451  - `file`: any local file-based path (including `file://` URLs,
2452    or local paths)
2453
2454  - `git`: the anonymous git protocol over a direct TCP
2455    connection (or proxy, if configured)
2456
2457  - `ssh`: git over ssh (including `host:path` syntax,
2458    `ssh://`, etc).
2459
2460  - `http`: git over http, both "smart http" and "dumb http".
2461    Note that this does _not_ include `https`; if you want to configure
2462    both, you must do so individually.
2463
2464  - any external helpers are named by their protocol (e.g., use
2465    `hg` to allow the `git-remote-hg` helper)
2466--
2467
2468pull.ff::
2469        By default, Git does not create an extra merge commit when merging
2470        a commit that is a descendant of the current commit. Instead, the
2471        tip of the current branch is fast-forwarded. When set to `false`,
2472        this variable tells Git to create an extra merge commit in such
2473        a case (equivalent to giving the `--no-ff` option from the command
2474        line). When set to `only`, only such fast-forward merges are
2475        allowed (equivalent to giving the `--ff-only` option from the
2476        command line). This setting overrides `merge.ff` when pulling.
2477
2478pull.rebase::
2479        When true, rebase branches on top of the fetched branch, instead
2480        of merging the default branch from the default remote when "git
2481        pull" is run. See "branch.<name>.rebase" for setting this on a
2482        per-branch basis.
2483+
2484When preserve, also pass `--preserve-merges` along to 'git rebase'
2485so that locally committed merge commits will not be flattened
2486by running 'git pull'.
2487+
2488When the value is `interactive`, the rebase is run in interactive mode.
2489+
2490*NOTE*: this is a possibly dangerous operation; do *not* use
2491it unless you understand the implications (see linkgit:git-rebase[1]
2492for details).
2493
2494pull.octopus::
2495        The default merge strategy to use when pulling multiple branches
2496        at once.
2497
2498pull.twohead::
2499        The default merge strategy to use when pulling a single branch.
2500
2501push.default::
2502        Defines the action `git push` should take if no refspec is
2503        explicitly given.  Different values are well-suited for
2504        specific workflows; for instance, in a purely central workflow
2505        (i.e. the fetch source is equal to the push destination),
2506        `upstream` is probably what you want.  Possible values are:
2507+
2508--
2509
2510* `nothing` - do not push anything (error out) unless a refspec is
2511  explicitly given. This is primarily meant for people who want to
2512  avoid mistakes by always being explicit.
2513
2514* `current` - push the current branch to update a branch with the same
2515  name on the receiving end.  Works in both central and non-central
2516  workflows.
2517
2518* `upstream` - push the current branch back to the branch whose
2519  changes are usually integrated into the current branch (which is
2520  called `@{upstream}`).  This mode only makes sense if you are
2521  pushing to the same repository you would normally pull from
2522  (i.e. central workflow).
2523
2524* `simple` - in centralized workflow, work like `upstream` with an
2525  added safety to refuse to push if the upstream branch's name is
2526  different from the local one.
2527+
2528When pushing to a remote that is different from the remote you normally
2529pull from, work as `current`.  This is the safest option and is suited
2530for beginners.
2531+
2532This mode has become the default in Git 2.0.
2533
2534* `matching` - push all branches having the same name on both ends.
2535  This makes the repository you are pushing to remember the set of
2536  branches that will be pushed out (e.g. if you always push 'maint'
2537  and 'master' there and no other branches, the repository you push
2538  to will have these two branches, and your local 'maint' and
2539  'master' will be pushed there).
2540+
2541To use this mode effectively, you have to make sure _all_ the
2542branches you would push out are ready to be pushed out before
2543running 'git push', as the whole point of this mode is to allow you
2544to push all of the branches in one go.  If you usually finish work
2545on only one branch and push out the result, while other branches are
2546unfinished, this mode is not for you.  Also this mode is not
2547suitable for pushing into a shared central repository, as other
2548people may add new branches there, or update the tip of existing
2549branches outside your control.
2550+
2551This used to be the default, but not since Git 2.0 (`simple` is the
2552new default).
2553
2554--
2555
2556push.followTags::
2557        If set to true enable `--follow-tags` option by default.  You
2558        may override this configuration at time of push by specifying
2559        `--no-follow-tags`.
2560
2561push.gpgSign::
2562        May be set to a boolean value, or the string 'if-asked'. A true
2563        value causes all pushes to be GPG signed, as if `--signed` is
2564        passed to linkgit:git-push[1]. The string 'if-asked' causes
2565        pushes to be signed if the server supports it, as if
2566        `--signed=if-asked` is passed to 'git push'. A false value may
2567        override a value from a lower-priority config file. An explicit
2568        command-line flag always overrides this config option.
2569
2570push.recurseSubmodules::
2571        Make sure all submodule commits used by the revisions to be pushed
2572        are available on a remote-tracking branch. If the value is 'check'
2573        then Git will verify that all submodule commits that changed in the
2574        revisions to be pushed are available on at least one remote of the
2575        submodule. If any commits are missing, the push will be aborted and
2576        exit with non-zero status. If the value is 'on-demand' then all
2577        submodules that changed in the revisions to be pushed will be
2578        pushed. If on-demand was not able to push all necessary revisions
2579        it will also be aborted and exit with non-zero status. If the value
2580        is 'no' then default behavior of ignoring submodules when pushing
2581        is retained. You may override this configuration at time of push by
2582        specifying '--recurse-submodules=check|on-demand|no'.
2583
2584rebase.stat::
2585        Whether to show a diffstat of what changed upstream since the last
2586        rebase. False by default.
2587
2588rebase.autoSquash::
2589        If set to true enable `--autosquash` option by default.
2590
2591rebase.autoStash::
2592        When set to true, automatically create a temporary stash
2593        before the operation begins, and apply it after the operation
2594        ends.  This means that you can run rebase on a dirty worktree.
2595        However, use with care: the final stash application after a
2596        successful rebase might result in non-trivial conflicts.
2597        Defaults to false.
2598
2599rebase.missingCommitsCheck::
2600        If set to "warn", git rebase -i will print a warning if some
2601        commits are removed (e.g. a line was deleted), however the
2602        rebase will still proceed. If set to "error", it will print
2603        the previous warning and stop the rebase, 'git rebase
2604        --edit-todo' can then be used to correct the error. If set to
2605        "ignore", no checking is done.
2606        To drop a commit without warning or error, use the `drop`
2607        command in the todo-list.
2608        Defaults to "ignore".
2609
2610rebase.instructionFormat::
2611        A format string, as specified in linkgit:git-log[1], to be used for
2612        the instruction list during an interactive rebase.  The format will automatically
2613        have the long commit hash prepended to the format.
2614
2615receive.advertiseAtomic::
2616        By default, git-receive-pack will advertise the atomic push
2617        capability to its clients. If you don't want to advertise this
2618        capability, set this variable to false.
2619
2620receive.advertisePushOptions::
2621        By default, git-receive-pack will advertise the push options
2622        capability to its clients. If you don't want to advertise this
2623        capability, set this variable to false.
2624
2625receive.autogc::
2626        By default, git-receive-pack will run "git-gc --auto" after
2627        receiving data from git-push and updating refs.  You can stop
2628        it by setting this variable to false.
2629
2630receive.certNonceSeed::
2631        By setting this variable to a string, `git receive-pack`
2632        will accept a `git push --signed` and verifies it by using
2633        a "nonce" protected by HMAC using this string as a secret
2634        key.
2635
2636receive.certNonceSlop::
2637        When a `git push --signed` sent a push certificate with a
2638        "nonce" that was issued by a receive-pack serving the same
2639        repository within this many seconds, export the "nonce"
2640        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2641        hooks (instead of what the receive-pack asked the sending
2642        side to include).  This may allow writing checks in
2643        `pre-receive` and `post-receive` a bit easier.  Instead of
2644        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2645        that records by how many seconds the nonce is stale to
2646        decide if they want to accept the certificate, they only
2647        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2648
2649receive.fsckObjects::
2650        If it is set to true, git-receive-pack will check all received
2651        objects. It will abort in the case of a malformed object or a
2652        broken link. The result of an abort are only dangling objects.
2653        Defaults to false. If not set, the value of `transfer.fsckObjects`
2654        is used instead.
2655
2656receive.fsck.<msg-id>::
2657        When `receive.fsckObjects` is set to true, errors can be switched
2658        to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2659        setting where the `<msg-id>` is the fsck message ID and the value
2660        is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2661        the error/warning with the message ID, e.g. "missingEmail: invalid
2662        author/committer line - missing email" means that setting
2663        `receive.fsck.missingEmail = ignore` will hide that issue.
2664+
2665This feature is intended to support working with legacy repositories
2666which would not pass pushing when `receive.fsckObjects = true`, allowing
2667the host to accept repositories with certain known issues but still catch
2668other issues.
2669
2670receive.fsck.skipList::
2671        The path to a sorted list of object names (i.e. one SHA-1 per
2672        line) that are known to be broken in a non-fatal way and should
2673        be ignored. This feature is useful when an established project
2674        should be accepted despite early commits containing errors that
2675        can be safely ignored such as invalid committer email addresses.
2676        Note: corrupt objects cannot be skipped with this setting.
2677
2678receive.keepAlive::
2679        After receiving the pack from the client, `receive-pack` may
2680        produce no output (if `--quiet` was specified) while processing
2681        the pack, causing some networks to drop the TCP connection.
2682        With this option set, if `receive-pack` does not transmit
2683        any data in this phase for `receive.keepAlive` seconds, it will
2684        send a short keepalive packet.  The default is 5 seconds; set
2685        to 0 to disable keepalives entirely.
2686
2687receive.unpackLimit::
2688        If the number of objects received in a push is below this
2689        limit then the objects will be unpacked into loose object
2690        files. However if the number of received objects equals or
2691        exceeds this limit then the received pack will be stored as
2692        a pack, after adding any missing delta bases.  Storing the
2693        pack from a push can make the push operation complete faster,
2694        especially on slow filesystems.  If not set, the value of
2695        `transfer.unpackLimit` is used instead.
2696
2697receive.maxInputSize::
2698        If the size of the incoming pack stream is larger than this
2699        limit, then git-receive-pack will error out, instead of
2700        accepting the pack file. If not set or set to 0, then the size
2701        is unlimited.
2702
2703receive.denyDeletes::
2704        If set to true, git-receive-pack will deny a ref update that deletes
2705        the ref. Use this to prevent such a ref deletion via a push.
2706
2707receive.denyDeleteCurrent::
2708        If set to true, git-receive-pack will deny a ref update that
2709        deletes the currently checked out branch of a non-bare repository.
2710
2711receive.denyCurrentBranch::
2712        If set to true or "refuse", git-receive-pack will deny a ref update
2713        to the currently checked out branch of a non-bare repository.
2714        Such a push is potentially dangerous because it brings the HEAD
2715        out of sync with the index and working tree. If set to "warn",
2716        print a warning of such a push to stderr, but allow the push to
2717        proceed. If set to false or "ignore", allow such pushes with no
2718        message. Defaults to "refuse".
2719+
2720Another option is "updateInstead" which will update the working
2721tree if pushing into the current branch.  This option is
2722intended for synchronizing working directories when one side is not easily
2723accessible via interactive ssh (e.g. a live web site, hence the requirement
2724that the working directory be clean). This mode also comes in handy when
2725developing inside a VM to test and fix code on different Operating Systems.
2726+
2727By default, "updateInstead" will refuse the push if the working tree or
2728the index have any difference from the HEAD, but the `push-to-checkout`
2729hook can be used to customize this.  See linkgit:githooks[5].
2730
2731receive.denyNonFastForwards::
2732        If set to true, git-receive-pack will deny a ref update which is
2733        not a fast-forward. Use this to prevent such an update via a push,
2734        even if that push is forced. This configuration variable is
2735        set when initializing a shared repository.
2736
2737receive.hideRefs::
2738        This variable is the same as `transfer.hideRefs`, but applies
2739        only to `receive-pack` (and so affects pushes, but not fetches).
2740        An attempt to update or delete a hidden ref by `git push` is
2741        rejected.
2742
2743receive.updateServerInfo::
2744        If set to true, git-receive-pack will run git-update-server-info
2745        after receiving data from git-push and updating refs.
2746
2747receive.shallowUpdate::
2748        If set to true, .git/shallow can be updated when new refs
2749        require new shallow roots. Otherwise those refs are rejected.
2750
2751remote.pushDefault::
2752        The remote to push to by default.  Overrides
2753        `branch.<name>.remote` for all branches, and is overridden by
2754        `branch.<name>.pushRemote` for specific branches.
2755
2756remote.<name>.url::
2757        The URL of a remote repository.  See linkgit:git-fetch[1] or
2758        linkgit:git-push[1].
2759
2760remote.<name>.pushurl::
2761        The push URL of a remote repository.  See linkgit:git-push[1].
2762
2763remote.<name>.proxy::
2764        For remotes that require curl (http, https and ftp), the URL to
2765        the proxy to use for that remote.  Set to the empty string to
2766        disable proxying for that remote.
2767
2768remote.<name>.proxyAuthMethod::
2769        For remotes that require curl (http, https and ftp), the method to use for
2770        authenticating against the proxy in use (probably set in
2771        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2772
2773remote.<name>.fetch::
2774        The default set of "refspec" for linkgit:git-fetch[1]. See
2775        linkgit:git-fetch[1].
2776
2777remote.<name>.push::
2778        The default set of "refspec" for linkgit:git-push[1]. See
2779        linkgit:git-push[1].
2780
2781remote.<name>.mirror::
2782        If true, pushing to this remote will automatically behave
2783        as if the `--mirror` option was given on the command line.
2784
2785remote.<name>.skipDefaultUpdate::
2786        If true, this remote will be skipped by default when updating
2787        using linkgit:git-fetch[1] or the `update` subcommand of
2788        linkgit:git-remote[1].
2789
2790remote.<name>.skipFetchAll::
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>.receivepack::
2796        The default program to execute on the remote side when pushing.  See
2797        option --receive-pack of linkgit:git-push[1].
2798
2799remote.<name>.uploadpack::
2800        The default program to execute on the remote side when fetching.  See
2801        option --upload-pack of linkgit:git-fetch-pack[1].
2802
2803remote.<name>.tagOpt::
2804        Setting this value to --no-tags disables automatic tag following when
2805        fetching from remote <name>. Setting it to --tags will fetch every
2806        tag from remote <name>, even if they are not reachable from remote
2807        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2808        override this setting. See options --tags and --no-tags of
2809        linkgit:git-fetch[1].
2810
2811remote.<name>.vcs::
2812        Setting this to a value <vcs> will cause Git to interact with
2813        the remote with the git-remote-<vcs> helper.
2814
2815remote.<name>.prune::
2816        When set to true, fetching from this remote by default will also
2817        remove any remote-tracking references that no longer exist on the
2818        remote (as if the `--prune` option was given on the command line).
2819        Overrides `fetch.prune` settings, if any.
2820
2821remotes.<group>::
2822        The list of remotes which are fetched by "git remote update
2823        <group>".  See linkgit:git-remote[1].
2824
2825repack.useDeltaBaseOffset::
2826        By default, linkgit:git-repack[1] creates packs that use
2827        delta-base offset. If you need to share your repository with
2828        Git older than version 1.4.4, either directly or via a dumb
2829        protocol such as http, then you need to set this option to
2830        "false" and repack. Access from old Git versions over the
2831        native protocol are unaffected by this option.
2832
2833repack.packKeptObjects::
2834        If set to true, makes `git repack` act as if
2835        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2836        details. Defaults to `false` normally, but `true` if a bitmap
2837        index is being written (either via `--write-bitmap-index` or
2838        `repack.writeBitmaps`).
2839
2840repack.writeBitmaps::
2841        When true, git will write a bitmap index when packing all
2842        objects to disk (e.g., when `git repack -a` is run).  This
2843        index can speed up the "counting objects" phase of subsequent
2844        packs created for clones and fetches, at the cost of some disk
2845        space and extra time spent on the initial repack.  This has
2846        no effect if multiple packfiles are created.
2847        Defaults to false.
2848
2849rerere.autoUpdate::
2850        When set to true, `git-rerere` updates the index with the
2851        resulting contents after it cleanly resolves conflicts using
2852        previously recorded resolution.  Defaults to false.
2853
2854rerere.enabled::
2855        Activate recording of resolved conflicts, so that identical
2856        conflict hunks can be resolved automatically, should they be
2857        encountered again.  By default, linkgit:git-rerere[1] is
2858        enabled if there is an `rr-cache` directory under the
2859        `$GIT_DIR`, e.g. if "rerere" was previously used in the
2860        repository.
2861
2862sendemail.identity::
2863        A configuration identity. When given, causes values in the
2864        'sendemail.<identity>' subsection to take precedence over
2865        values in the 'sendemail' section. The default identity is
2866        the value of `sendemail.identity`.
2867
2868sendemail.smtpEncryption::
2869        See linkgit:git-send-email[1] for description.  Note that this
2870        setting is not subject to the 'identity' mechanism.
2871
2872sendemail.smtpssl (deprecated)::
2873        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2874
2875sendemail.smtpsslcertpath::
2876        Path to ca-certificates (either a directory or a single file).
2877        Set it to an empty string to disable certificate verification.
2878
2879sendemail.<identity>.*::
2880        Identity-specific versions of the 'sendemail.*' parameters
2881        found below, taking precedence over those when the this
2882        identity is selected, through command-line or
2883        `sendemail.identity`.
2884
2885sendemail.aliasesFile::
2886sendemail.aliasFileType::
2887sendemail.annotate::
2888sendemail.bcc::
2889sendemail.cc::
2890sendemail.ccCmd::
2891sendemail.chainReplyTo::
2892sendemail.confirm::
2893sendemail.envelopeSender::
2894sendemail.from::
2895sendemail.multiEdit::
2896sendemail.signedoffbycc::
2897sendemail.smtpPass::
2898sendemail.suppresscc::
2899sendemail.suppressFrom::
2900sendemail.to::
2901sendemail.smtpDomain::
2902sendemail.smtpServer::
2903sendemail.smtpServerPort::
2904sendemail.smtpServerOption::
2905sendemail.smtpUser::
2906sendemail.thread::
2907sendemail.transferEncoding::
2908sendemail.validate::
2909sendemail.xmailer::
2910        See linkgit:git-send-email[1] for description.
2911
2912sendemail.signedoffcc (deprecated)::
2913        Deprecated alias for `sendemail.signedoffbycc`.
2914
2915showbranch.default::
2916        The default set of branches for linkgit:git-show-branch[1].
2917        See linkgit:git-show-branch[1].
2918
2919splitIndex.maxPercentChange::
2920        When the split index feature is used, this specifies the
2921        percent of entries the split index can contain compared to the
2922        total number of entries in both the split index and the shared
2923        index before a new shared index is written.
2924        The value should be between 0 and 100. If the value is 0 then
2925        a new shared index is always written, if it is 100 a new
2926        shared index is never written.
2927        By default the value is 20, so a new shared index is written
2928        if the number of entries in the split index would be greater
2929        than 20 percent of the total number of entries.
2930        See linkgit:git-update-index[1].
2931
2932splitIndex.sharedIndexExpire::
2933        When the split index feature is used, shared index files that
2934        were not modified since the time this variable specifies will
2935        be removed when a new shared index file is created. The value
2936        "now" expires all entries immediately, and "never" suppresses
2937        expiration altogether.
2938        The default value is "2.weeks.ago".
2939        Note that a shared index file is considered modified (for the
2940        purpose of expiration) each time a new split-index file is
2941        either created based on it or read from it.
2942        See linkgit:git-update-index[1].
2943
2944status.relativePaths::
2945        By default, linkgit:git-status[1] shows paths relative to the
2946        current directory. Setting this variable to `false` shows paths
2947        relative to the repository root (this was the default for Git
2948        prior to v1.5.4).
2949
2950status.short::
2951        Set to true to enable --short by default in linkgit:git-status[1].
2952        The option --no-short takes precedence over this variable.
2953
2954status.branch::
2955        Set to true to enable --branch by default in linkgit:git-status[1].
2956        The option --no-branch takes precedence over this variable.
2957
2958status.displayCommentPrefix::
2959        If set to true, linkgit:git-status[1] will insert a comment
2960        prefix before each output line (starting with
2961        `core.commentChar`, i.e. `#` by default). This was the
2962        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2963        Defaults to false.
2964
2965status.showUntrackedFiles::
2966        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2967        files which are not currently tracked by Git. Directories which
2968        contain only untracked files, are shown with the directory name
2969        only. Showing untracked files means that Git needs to lstat() all
2970        the files in the whole repository, which might be slow on some
2971        systems. So, this variable controls how the commands displays
2972        the untracked files. Possible values are:
2973+
2974--
2975* `no` - Show no untracked files.
2976* `normal` - Show untracked files and directories.
2977* `all` - Show also individual files in untracked directories.
2978--
2979+
2980If this variable is not specified, it defaults to 'normal'.
2981This variable can be overridden with the -u|--untracked-files option
2982of linkgit:git-status[1] and linkgit:git-commit[1].
2983
2984status.submoduleSummary::
2985        Defaults to false.
2986        If this is set to a non zero number or true (identical to -1 or an
2987        unlimited number), the submodule summary will be enabled and a
2988        summary of commits for modified submodules will be shown (see
2989        --summary-limit option of linkgit:git-submodule[1]). Please note
2990        that the summary output command will be suppressed for all
2991        submodules when `diff.ignoreSubmodules` is set to 'all' or only
2992        for those submodules where `submodule.<name>.ignore=all`. The only
2993        exception to that rule is that status and commit will show staged
2994        submodule changes. To
2995        also view the summary for ignored submodules you can either use
2996        the --ignore-submodules=dirty command-line option or the 'git
2997        submodule summary' command, which shows a similar output but does
2998        not honor these settings.
2999
3000stash.showPatch::
3001        If this is set to true, the `git stash show` command without an
3002        option will show the stash in patch form.  Defaults to false.
3003        See description of 'show' command in linkgit:git-stash[1].
3004
3005stash.showStat::
3006        If this is set to true, the `git stash show` command without an
3007        option will show diffstat of the stash.  Defaults to true.
3008        See description of 'show' command in linkgit:git-stash[1].
3009
3010submodule.<name>.url::
3011        The URL for a submodule. This variable is copied from the .gitmodules
3012        file to the git config via 'git submodule init'. The user can change
3013        the configured URL before obtaining the submodule via 'git submodule
3014        update'. After obtaining the submodule, the presence of this variable
3015        is used as a sign whether the submodule is of interest to git commands.
3016        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3017
3018submodule.<name>.update::
3019        The default update procedure for a submodule. This variable
3020        is populated by `git submodule init` from the
3021        linkgit:gitmodules[5] file. See description of 'update'
3022        command in linkgit:git-submodule[1].
3023
3024submodule.<name>.branch::
3025        The remote branch name for a submodule, used by `git submodule
3026        update --remote`.  Set this option to override the value found in
3027        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3028        linkgit:gitmodules[5] for details.
3029
3030submodule.<name>.fetchRecurseSubmodules::
3031        This option can be used to control recursive fetching of this
3032        submodule. It can be overridden by using the --[no-]recurse-submodules
3033        command-line option to "git fetch" and "git pull".
3034        This setting will override that from in the linkgit:gitmodules[5]
3035        file.
3036
3037submodule.<name>.ignore::
3038        Defines under what circumstances "git status" and the diff family show
3039        a submodule as modified. When set to "all", it will never be considered
3040        modified (but it will nonetheless show up in the output of status and
3041        commit when it has been staged), "dirty" will ignore all changes
3042        to the submodules work tree and
3043        takes only differences between the HEAD of the submodule and the commit
3044        recorded in the superproject into account. "untracked" will additionally
3045        let submodules with modified tracked files in their work tree show up.
3046        Using "none" (the default when this option is not set) also shows
3047        submodules that have untracked files in their work tree as changed.
3048        This setting overrides any setting made in .gitmodules for this submodule,
3049        both settings can be overridden on the command line by using the
3050        "--ignore-submodules" option. The 'git submodule' commands are not
3051        affected by this setting.
3052
3053submodule.fetchJobs::
3054        Specifies how many submodules are fetched/cloned at the same time.
3055        A positive integer allows up to that number of submodules fetched
3056        in parallel. A value of 0 will give some reasonable default.
3057        If unset, it defaults to 1.
3058
3059submodule.alternateLocation::
3060        Specifies how the submodules obtain alternates when submodules are
3061        cloned. Possible values are `no`, `superproject`.
3062        By default `no` is assumed, which doesn't add references. When the
3063        value is set to `superproject` the submodule to be cloned computes
3064        its alternates location relative to the superprojects alternate.
3065
3066submodule.alternateErrorStrategy::
3067        Specifies how to treat errors with the alternates for a submodule
3068        as computed via `submodule.alternateLocation`. Possible values are
3069        `ignore`, `info`, `die`. Default is `die`.
3070
3071tag.forceSignAnnotated::
3072        A boolean to specify whether annotated tags created should be GPG signed.
3073        If `--annotate` is specified on the command line, it takes
3074        precedence over this option.
3075
3076tag.sort::
3077        This variable controls the sort ordering of tags when displayed by
3078        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3079        value of this variable will be used as the default.
3080
3081tar.umask::
3082        This variable can be used to restrict the permission bits of
3083        tar archive entries.  The default is 0002, which turns off the
3084        world write bit.  The special value "user" indicates that the
3085        archiving user's umask will be used instead.  See umask(2) and
3086        linkgit:git-archive[1].
3087
3088transfer.fsckObjects::
3089        When `fetch.fsckObjects` or `receive.fsckObjects` are
3090        not set, the value of this variable is used instead.
3091        Defaults to false.
3092
3093transfer.hideRefs::
3094        String(s) `receive-pack` and `upload-pack` use to decide which
3095        refs to omit from their initial advertisements.  Use more than
3096        one definition to specify multiple prefix strings. A ref that is
3097        under the hierarchies listed in the value of this variable is
3098        excluded, and is hidden when responding to `git push` or `git
3099        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3100        program-specific versions of this config.
3101+
3102You may also include a `!` in front of the ref name to negate the entry,
3103explicitly exposing it, even if an earlier entry marked it as hidden.
3104If you have multiple hideRefs values, later entries override earlier ones
3105(and entries in more-specific config files override less-specific ones).
3106+
3107If a namespace is in use, the namespace prefix is stripped from each
3108reference before it is matched against `transfer.hiderefs` patterns.
3109For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3110the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3111is omitted from the advertisements but `refs/heads/master` and
3112`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3113"have" lines. In order to match refs before stripping, add a `^` in front of
3114the ref name. If you combine `!` and `^`, `!` must be specified first.
3115+
3116Even if you hide refs, a client may still be able to steal the target
3117objects via the techniques described in the "SECURITY" section of the
3118linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3119separate repository.
3120
3121transfer.unpackLimit::
3122        When `fetch.unpackLimit` or `receive.unpackLimit` are
3123        not set, the value of this variable is used instead.
3124        The default value is 100.
3125
3126uploadarchive.allowUnreachable::
3127        If true, allow clients to use `git archive --remote` to request
3128        any tree, whether reachable from the ref tips or not. See the
3129        discussion in the "SECURITY" section of
3130        linkgit:git-upload-archive[1] for more details. Defaults to
3131        `false`.
3132
3133uploadpack.hideRefs::
3134        This variable is the same as `transfer.hideRefs`, but applies
3135        only to `upload-pack` (and so affects only fetches, not pushes).
3136        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3137        also `uploadpack.allowTipSHA1InWant`.
3138
3139uploadpack.allowTipSHA1InWant::
3140        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3141        to accept a fetch request that asks for an object at the tip
3142        of a hidden ref (by default, such a request is rejected).
3143        See also `uploadpack.hideRefs`.  Even if this is false, a client
3144        may be able to steal objects via the techniques described in the
3145        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3146        best to keep private data in a separate repository.
3147
3148uploadpack.allowReachableSHA1InWant::
3149        Allow `upload-pack` to accept a fetch request that asks for an
3150        object that is reachable from any ref tip. However, note that
3151        calculating object reachability is computationally expensive.
3152        Defaults to `false`.  Even if this is false, a client may be able
3153        to steal objects via the techniques described in the "SECURITY"
3154        section of the linkgit:gitnamespaces[7] man page; it's best to
3155        keep private data in a separate repository.
3156
3157uploadpack.allowAnySHA1InWant::
3158        Allow `upload-pack` to accept a fetch request that asks for any
3159        object at all.
3160        Defaults to `false`.
3161
3162uploadpack.keepAlive::
3163        When `upload-pack` has started `pack-objects`, there may be a
3164        quiet period while `pack-objects` prepares the pack. Normally
3165        it would output progress information, but if `--quiet` was used
3166        for the fetch, `pack-objects` will output nothing at all until
3167        the pack data begins. Some clients and networks may consider
3168        the server to be hung and give up. Setting this option instructs
3169        `upload-pack` to send an empty keepalive packet every
3170        `uploadpack.keepAlive` seconds. Setting this option to 0
3171        disables keepalive packets entirely. The default is 5 seconds.
3172
3173uploadpack.packObjectsHook::
3174        If this option is set, when `upload-pack` would run
3175        `git pack-objects` to create a packfile for a client, it will
3176        run this shell command instead.  The `pack-objects` command and
3177        arguments it _would_ have run (including the `git pack-objects`
3178        at the beginning) are appended to the shell command. The stdin
3179        and stdout of the hook are treated as if `pack-objects` itself
3180        was run. I.e., `upload-pack` will feed input intended for
3181        `pack-objects` to the hook, and expects a completed packfile on
3182        stdout.
3183+
3184Note that this configuration variable is ignored if it is seen in the
3185repository-level config (this is a safety measure against fetching from
3186untrusted repositories).
3187
3188url.<base>.insteadOf::
3189        Any URL that starts with this value will be rewritten to
3190        start, instead, with <base>. In cases where some site serves a
3191        large number of repositories, and serves them with multiple
3192        access methods, and some users need to use different access
3193        methods, this feature allows people to specify any of the
3194        equivalent URLs and have Git automatically rewrite the URL to
3195        the best alternative for the particular user, even for a
3196        never-before-seen repository on the site.  When more than one
3197        insteadOf strings match a given URL, the longest match is used.
3198
3199url.<base>.pushInsteadOf::
3200        Any URL that starts with this value will not be pushed to;
3201        instead, it will be rewritten to start with <base>, and the
3202        resulting URL will be pushed to. In cases where some site serves
3203        a large number of repositories, and serves them with multiple
3204        access methods, some of which do not allow push, this feature
3205        allows people to specify a pull-only URL and have Git
3206        automatically use an appropriate URL to push, even for a
3207        never-before-seen repository on the site.  When more than one
3208        pushInsteadOf strings match a given URL, the longest match is
3209        used.  If a remote has an explicit pushurl, Git will ignore this
3210        setting for that remote.
3211
3212user.email::
3213        Your email address to be recorded in any newly created commits.
3214        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3215        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3216
3217user.name::
3218        Your full name to be recorded in any newly created commits.
3219        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3220        environment variables.  See linkgit:git-commit-tree[1].
3221
3222user.useConfigOnly::
3223        Instruct Git to avoid trying to guess defaults for `user.email`
3224        and `user.name`, and instead retrieve the values only from the
3225        configuration. For example, if you have multiple email addresses
3226        and would like to use a different one for each repository, then
3227        with this configuration option set to `true` in the global config
3228        along with a name, Git will prompt you to set up an email before
3229        making new commits in a newly cloned repository.
3230        Defaults to `false`.
3231
3232user.signingKey::
3233        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3234        key you want it to automatically when creating a signed tag or
3235        commit, you can override the default selection with this variable.
3236        This option is passed unchanged to gpg's --local-user parameter,
3237        so you may specify a key using any method that gpg supports.
3238
3239versionsort.prereleaseSuffix (deprecated)::
3240        Deprecated alias for `versionsort.suffix`.  Ignored if
3241        `versionsort.suffix` is set.
3242
3243versionsort.suffix::
3244        Even when version sort is used in linkgit:git-tag[1], tagnames
3245        with the same base version but different suffixes are still sorted
3246        lexicographically, resulting e.g. in prerelease tags appearing
3247        after the main release (e.g. "1.0-rc1" after "1.0").  This
3248        variable can be specified to determine the sorting order of tags
3249        with different suffixes.
3250+
3251By specifying a single suffix in this variable, any tagname containing
3252that suffix will appear before the corresponding main release.  E.g. if
3253the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3254"1.0".  If specified multiple times, once per suffix, then the order of
3255suffixes in the configuration will determine the sorting order of tagnames
3256with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3257configuration, then all "1.0-preX" tags will be listed before any
3258"1.0-rcX" tags.  The placement of the main release tag relative to tags
3259with various suffixes can be determined by specifying the empty suffix
3260among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3261"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3262are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3263"v4.8-bfsX".
3264+
3265If more than one suffixes match the same tagname, then that tagname will
3266be sorted according to the suffix which starts at the earliest position in
3267the tagname.  If more than one different matching suffixes start at
3268that earliest position, then that tagname will be sorted according to the
3269longest of those suffixes.
3270The sorting order between different suffixes is undefined if they are
3271in multiple config files.
3272
3273web.browser::
3274        Specify a web browser that may be used by some commands.
3275        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3276        may use it.