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