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