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