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