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