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