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