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