Documentation / config.txton commit Merge branch 'sb/submodule-merge-in-merge-recursive' (0821b73)
   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; we say then that the variable is
  18multivalued.
  19
  20Syntax
  21~~~~~~
  22
  23The syntax is fairly flexible and permissive; whitespaces are mostly
  24ignored.  The '#' and ';' characters begin comments to the end of line,
  25blank lines are ignored.
  26
  27The file consists of sections and variables.  A section begins with
  28the name of the section in square brackets and continues until the next
  29section begins.  Section names are case-insensitive.  Only alphanumeric
  30characters, `-` and `.` are allowed in section names.  Each variable
  31must belong to some section, which means that there must be a section
  32header before the first setting of a variable.
  33
  34Sections can be further divided into subsections.  To begin a subsection
  35put its name in double quotes, separated by space from the section name,
  36in the section header, like in the example below:
  37
  38--------
  39        [section "subsection"]
  40
  41--------
  42
  43Subsection names are case sensitive and can contain any characters except
  44newline and the null byte. Doublequote `"` and backslash can be included
  45by escaping them as `\"` and `\\`, respectively. Backslashes preceding
  46other characters are dropped when reading; for example, `\t` is read as
  47`t` and `\0` is read as `0` Section headers cannot span multiple lines.
  48Variables may belong directly to a section or to a given subsection. You
  49can have `[section]` if you have `[section "subsection"]`, but you don't
  50need to.
  51
  52There is also a deprecated `[section.subsection]` syntax. With this
  53syntax, the subsection name is converted to lower-case and is also
  54compared case sensitively. These subsection names follow the same
  55restrictions as section names.
  56
  57All the other lines (and the remainder of the line after the section
  58header) are recognized as setting variables, in the form
  59'name = value' (or just 'name', which is a short-hand to say that
  60the variable is the boolean "true").
  61The variable names are case-insensitive, allow only alphanumeric characters
  62and `-`, and must start with an alphabetic character.
  63
  64A line that defines a value can be continued to the next line by
  65ending it with a `\`; the backquote and the end-of-line are
  66stripped.  Leading whitespaces after 'name =', the remainder of the
  67line after the first comment character '#' or ';', and trailing
  68whitespaces of the line are discarded unless they are enclosed in
  69double quotes.  Internal whitespaces within the value are retained
  70verbatim.
  71
  72Inside double quotes, double quote `"` and backslash `\` characters
  73must be escaped: use `\"` for `"` and `\\` for `\`.
  74
  75The following escape sequences (beside `\"` and `\\`) are recognized:
  76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  77and `\b` for backspace (BS).  Other char escape sequences (including octal
  78escape sequences) are invalid.
  79
  80
  81Includes
  82~~~~~~~~
  83
  84The `include` and `includeIf` sections allow you to include config
  85directives from another source. These sections behave identically to
  86each other with the exception that `includeIf` sections may be ignored
  87if their condition does not evaluate to true; see "Conditional includes"
  88below.
  89
  90You can include a config file from another by setting the special
  91`include.path` (or `includeIf.*.path`) variable to the name of the file
  92to be included. The variable takes a pathname as its value, and is
  93subject to tilde expansion. These variables can be given multiple times.
  94
  95The contents of the included file are inserted immediately, as if they
  96had been found at the location of the include directive. If the value of the
  97variable is a relative path, the path is considered to
  98be relative to the configuration file in which the include directive
  99was found.  See below for examples.
 100
 101Conditional includes
 102~~~~~~~~~~~~~~~~~~~~
 103
 104You can include a config file from another conditionally by setting a
 105`includeIf.<condition>.path` variable to the name of the file to be
 106included.
 107
 108The condition starts with a keyword followed by a colon and some data
 109whose format and meaning depends on the keyword. Supported keywords
 110are:
 111
 112`gitdir`::
 113
 114        The data that follows the keyword `gitdir:` is used as a glob
 115        pattern. If the location of the .git directory matches the
 116        pattern, the include condition is met.
 117+
 118The .git location may be auto-discovered, or come from `$GIT_DIR`
 119environment variable. If the repository is auto discovered via a .git
 120file (e.g. from submodules, or a linked worktree), the .git location
 121would be the final location where the .git directory is, not where the
 122.git file is.
 123+
 124The pattern can contain standard globbing wildcards and two additional
 125ones, `**/` and `/**`, that can match multiple path components. Please
 126refer to linkgit:gitignore[5] for details. For convenience:
 127
 128 * If the pattern starts with `~/`, `~` will be substituted with the
 129   content of the environment variable `HOME`.
 130
 131 * If the pattern starts with `./`, it is replaced with the directory
 132   containing the current config file.
 133
 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
 135   will be automatically prepended. For example, the pattern `foo/bar`
 136   becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
 137
 138 * If the pattern ends with `/`, `**` will be automatically added. For
 139   example, the pattern `foo/` becomes `foo/**`. In other words, it
 140   matches "foo" and everything inside, recursively.
 141
 142`gitdir/i`::
 143        This is the same as `gitdir` except that matching is done
 144        case-insensitively (e.g. on case-insensitive file sytems)
 145
 146A few more notes on matching via `gitdir` and `gitdir/i`:
 147
 148 * Symlinks in `$GIT_DIR` are not resolved before matching.
 149
 150 * Both the symlink & realpath versions of paths will be matched
 151   outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
 152   /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
 153   will match.
 154+
 155This was not the case in the initial release of this feature in
 156v2.13.0, which only matched the realpath version. Configuration that
 157wants to be compatible with the initial release of this feature needs
 158to either specify only the realpath version, or both versions.
 159
 160 * Note that "../" is not special and will match literally, which is
 161   unlikely what you want.
 162
 163Example
 164~~~~~~~
 165
 166        # Core variables
 167        [core]
 168                ; Don't trust file modes
 169                filemode = false
 170
 171        # Our diff algorithm
 172        [diff]
 173                external = /usr/local/bin/diff-wrapper
 174                renames = true
 175
 176        [branch "devel"]
 177                remote = origin
 178                merge = refs/heads/devel
 179
 180        # Proxy settings
 181        [core]
 182                gitProxy="ssh" for "kernel.org"
 183                gitProxy=default-proxy ; for the rest
 184
 185        [include]
 186                path = /path/to/foo.inc ; include by absolute path
 187                path = foo.inc ; find "foo.inc" relative to the current file
 188                path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
 189
 190        ; include if $GIT_DIR is /path/to/foo/.git
 191        [includeIf "gitdir:/path/to/foo/.git"]
 192                path = /path/to/foo.inc
 193
 194        ; include for all repositories inside /path/to/group
 195        [includeIf "gitdir:/path/to/group/"]
 196                path = /path/to/foo.inc
 197
 198        ; include for all repositories inside $HOME/to/group
 199        [includeIf "gitdir:~/to/group/"]
 200                path = /path/to/foo.inc
 201
 202        ; relative paths are always relative to the including
 203        ; file (if the condition is true); their location is not
 204        ; affected by the condition
 205        [includeIf "gitdir:/path/to/group/"]
 206                path = foo.inc
 207
 208Values
 209~~~~~~
 210
 211Values of many variables are treated as a simple string, but there
 212are variables that take values of specific types and there are rules
 213as to how to spell them.
 214
 215boolean::
 216
 217       When a variable is said to take a boolean value, many
 218       synonyms are accepted for 'true' and 'false'; these are all
 219       case-insensitive.
 220
 221        true;; Boolean true literals are `yes`, `on`, `true`,
 222                and `1`.  Also, a variable defined without `= <value>`
 223                is taken as true.
 224
 225        false;; Boolean false literals are `no`, `off`, `false`,
 226                `0` and the empty string.
 227+
 228When converting value to the canonical form using `--bool` type
 229specifier, 'git config' will ensure that the output is "true" or
 230"false" (spelled in lowercase).
 231
 232integer::
 233       The value for many variables that specify various sizes can
 234       be suffixed with `k`, `M`,... to mean "scale the number by
 235       1024", "by 1024x1024", etc.
 236
 237color::
 238       The value for a variable that takes a color is a list of
 239       colors (at most two, one for foreground and one for background)
 240       and attributes (as many as you want), separated by spaces.
 241+
 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
 243`blue`, `magenta`, `cyan` and `white`.  The first color given is the
 244foreground; the second is the background.
 245+
 246Colors may also be given as numbers between 0 and 255; these use ANSI
 247256-color mode (but note that not all terminals may support this).  If
 248your terminal supports it, you may also specify 24-bit RGB values as
 249hex, like `#ff0ab3`.
 250+
 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
 252`italic`, and `strike` (for crossed-out or "strikethrough" letters).
 253The position of any attributes with respect to the colors
 254(before, after, or in between), doesn't matter. Specific attributes may
 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
 256`no-ul`, etc).
 257+
 258An empty color string produces no color effect at all. This can be used
 259to avoid coloring specific elements without disabling color entirely.
 260+
 261For git's pre-defined color slots, the attributes are meant to be reset
 262at the beginning of each item in the colored output. So setting
 263`color.decorate.branch` to `black` will paint that branch name in a
 264plain `black`, even if the previous thing on the same output line (e.g.
 265opening parenthesis before the list of branch names in `log --decorate`
 266output) is set to be painted with `bold` or some other attribute.
 267However, custom log formats may do more complicated and layered
 268coloring, and the negated forms may be useful there.
 269
 270pathname::
 271        A variable that takes a pathname value can be given a
 272        string that begins with "`~/`" or "`~user/`", and the usual
 273        tilde expansion happens to such a string: `~/`
 274        is expanded to the value of `$HOME`, and `~user/` to the
 275        specified user's home directory.
 276
 277
 278Variables
 279~~~~~~~~~
 280
 281Note that this list is non-comprehensive and not necessarily complete.
 282For command-specific variables, you will find a more detailed description
 283in the appropriate manual page.
 284
 285Other git-related tools may and do use their own variables.  When
 286inventing new variables for use in your own tool, make sure their
 287names do not conflict with those that are used by Git itself and
 288other popular tools, and describe them in your documentation.
 289
 290
 291advice.*::
 292        These variables control various optional help messages designed to
 293        aid new users. All 'advice.*' variables default to 'true', and you
 294        can tell Git that you do not need help by setting these to 'false':
 295+
 296--
 297        pushUpdateRejected::
 298                Set this variable to 'false' if you want to disable
 299                'pushNonFFCurrent',
 300                'pushNonFFMatching', 'pushAlreadyExists',
 301                'pushFetchFirst', and 'pushNeedsForce'
 302                simultaneously.
 303        pushNonFFCurrent::
 304                Advice shown when linkgit:git-push[1] fails due to a
 305                non-fast-forward update to the current branch.
 306        pushNonFFMatching::
 307                Advice shown when you ran linkgit:git-push[1] and pushed
 308                'matching refs' explicitly (i.e. you used ':', or
 309                specified a refspec that isn't your current branch) and
 310                it resulted in a non-fast-forward error.
 311        pushAlreadyExists::
 312                Shown when linkgit:git-push[1] rejects an update that
 313                does not qualify for fast-forwarding (e.g., a tag.)
 314        pushFetchFirst::
 315                Shown when linkgit:git-push[1] rejects an update that
 316                tries to overwrite a remote ref that points at an
 317                object we do not have.
 318        pushNeedsForce::
 319                Shown when linkgit:git-push[1] rejects an update that
 320                tries to overwrite a remote ref that points at an
 321                object that is not a commit-ish, or make the remote
 322                ref point at an object that is not a commit-ish.
 323        statusHints::
 324                Show directions on how to proceed from the current
 325                state in the output of linkgit:git-status[1], in
 326                the template shown when writing commit messages in
 327                linkgit:git-commit[1], and in the help message shown
 328                by linkgit:git-checkout[1] when switching branch.
 329        statusUoption::
 330                Advise to consider using the `-u` option to linkgit:git-status[1]
 331                when the command takes more than 2 seconds to enumerate untracked
 332                files.
 333        commitBeforeMerge::
 334                Advice shown when linkgit:git-merge[1] refuses to
 335                merge to avoid overwriting local changes.
 336        resolveConflict::
 337                Advice shown by various commands when conflicts
 338                prevent the operation from being performed.
 339        implicitIdentity::
 340                Advice on how to set your identity configuration when
 341                your information is guessed from the system username and
 342                domain name.
 343        detachedHead::
 344                Advice shown when you used linkgit:git-checkout[1] to
 345                move to the detach HEAD state, to instruct how to create
 346                a local branch after the fact.
 347        amWorkDir::
 348                Advice that shows the location of the patch file when
 349                linkgit:git-am[1] fails to apply it.
 350        rmHints::
 351                In case of failure in the output of linkgit:git-rm[1],
 352                show directions on how to proceed from the current state.
 353        addEmbeddedRepo::
 354                Advice on what to do when you've accidentally added one
 355                git repo inside of another.
 356        ignoredHook::
 357                Advice shown if an hook is ignored because the hook is not
 358                set as executable.
 359        waitingForEditor::
 360                Print a message to the terminal whenever Git is waiting for
 361                editor input from the user.
 362--
 363
 364core.fileMode::
 365        Tells Git if the executable bit of files in the working tree
 366        is to be honored.
 367+
 368Some filesystems lose the executable bit when a file that is
 369marked as executable is checked out, or checks out a
 370non-executable file with executable bit on.
 371linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
 372to see if it handles the executable bit correctly
 373and this variable is automatically set as necessary.
 374+
 375A repository, however, may be on a filesystem that handles
 376the filemode correctly, and this variable is set to 'true'
 377when created, but later may be made accessible from another
 378environment that loses the filemode (e.g. exporting ext4 via
 379CIFS mount, visiting a Cygwin created repository with
 380Git for Windows or Eclipse).
 381In such a case it may be necessary to set this variable to 'false'.
 382See linkgit:git-update-index[1].
 383+
 384The default is true (when core.filemode is not specified in the config file).
 385
 386core.hideDotFiles::
 387        (Windows-only) If true, mark newly-created directories and files whose
 388        name starts with a dot as hidden.  If 'dotGitOnly', only the `.git/`
 389        directory is hidden, but no other files starting with a dot.  The
 390        default mode is 'dotGitOnly'.
 391
 392core.ignoreCase::
 393        If true, this option enables various workarounds to enable
 394        Git to work better on filesystems that are not case sensitive,
 395        like FAT. For example, if a directory listing finds
 396        "makefile" when Git expects "Makefile", Git will assume
 397        it is really the same file, and continue to remember it as
 398        "Makefile".
 399+
 400The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 401will probe and set core.ignoreCase true if appropriate when the repository
 402is created.
 403
 404core.precomposeUnicode::
 405        This option is only used by Mac OS implementation of Git.
 406        When core.precomposeUnicode=true, Git reverts the unicode decomposition
 407        of filenames done by Mac OS. This is useful when sharing a repository
 408        between Mac OS and Linux or Windows.
 409        (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
 410        When false, file names are handled fully transparent by Git,
 411        which is backward compatible with older versions of Git.
 412
 413core.protectHFS::
 414        If set to true, do not allow checkout of paths that would
 415        be considered equivalent to `.git` on an HFS+ filesystem.
 416        Defaults to `true` on Mac OS, and `false` elsewhere.
 417
 418core.protectNTFS::
 419        If set to true, do not allow checkout of paths that would
 420        cause problems with the NTFS filesystem, e.g. conflict with
 421        8.3 "short" names.
 422        Defaults to `true` on Windows, and `false` elsewhere.
 423
 424core.fsmonitor::
 425        If set, the value of this variable is used as a command which
 426        will identify all files that may have changed since the
 427        requested date/time. This information is used to speed up git by
 428        avoiding unnecessary processing of files that have not changed.
 429        See the "fsmonitor-watchman" section of linkgit:githooks[5].
 430
 431core.trustctime::
 432        If false, the ctime differences between the index and the
 433        working tree are ignored; useful when the inode change time
 434        is regularly modified by something outside Git (file system
 435        crawlers and some backup systems).
 436        See linkgit:git-update-index[1]. True by default.
 437
 438core.splitIndex::
 439        If true, the split-index feature of the index will be used.
 440        See linkgit:git-update-index[1]. False by default.
 441
 442core.untrackedCache::
 443        Determines what to do about the untracked cache feature of the
 444        index. It will be kept, if this variable is unset or set to
 445        `keep`. It will automatically be added if set to `true`. And
 446        it will automatically be removed, if set to `false`. Before
 447        setting it to `true`, you should check that mtime is working
 448        properly on your system.
 449        See linkgit:git-update-index[1]. `keep` by default.
 450
 451core.checkStat::
 452        Determines which stat fields to match between the index
 453        and work tree. The user can set this to 'default' or
 454        'minimal'. Default (or explicitly 'default'), is to check
 455        all fields, including the sub-second part of mtime and ctime.
 456
 457core.quotePath::
 458        Commands that output paths (e.g. 'ls-files', 'diff'), will
 459        quote "unusual" characters in the pathname by enclosing the
 460        pathname in double-quotes and escaping those characters with
 461        backslashes in the same way C escapes control characters (e.g.
 462        `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
 463        values larger than 0x80 (e.g. octal `\302\265` for "micro" in
 464        UTF-8).  If this variable is set to false, bytes higher than
 465        0x80 are not considered "unusual" any more. Double-quotes,
 466        backslash and control characters are always escaped regardless
 467        of the setting of this variable.  A simple space character is
 468        not considered "unusual".  Many commands can output pathnames
 469        completely verbatim using the `-z` option. The default value
 470        is true.
 471
 472core.eol::
 473        Sets the line ending type to use in the working directory for
 474        files that have the `text` property set when core.autocrlf is false.
 475        Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
 476        native line ending.  The default value is `native`.  See
 477        linkgit:gitattributes[5] for more information on end-of-line
 478        conversion.
 479
 480core.safecrlf::
 481        If true, makes Git check if converting `CRLF` is reversible when
 482        end-of-line conversion is active.  Git will verify if a command
 483        modifies a file in the work tree either directly or indirectly.
 484        For example, committing a file followed by checking out the
 485        same file should yield the original file in the work tree.  If
 486        this is not the case for the current setting of
 487        `core.autocrlf`, Git will reject the file.  The variable can
 488        be set to "warn", in which case Git will only warn about an
 489        irreversible conversion but continue the operation.
 490+
 491CRLF conversion bears a slight chance of corrupting data.
 492When it is enabled, Git will convert CRLF to LF during commit and LF to
 493CRLF during checkout.  A file that contains a mixture of LF and
 494CRLF before the commit cannot be recreated by Git.  For text
 495files this is the right thing to do: it corrects line endings
 496such that we have only LF line endings in the repository.
 497But for binary files that are accidentally classified as text the
 498conversion can corrupt data.
 499+
 500If you recognize such corruption early you can easily fix it by
 501setting the conversion type explicitly in .gitattributes.  Right
 502after committing you still have the original file in your work
 503tree and this file is not yet corrupted.  You can explicitly tell
 504Git that this file is binary and Git will handle the file
 505appropriately.
 506+
 507Unfortunately, the desired effect of cleaning up text files with
 508mixed line endings and the undesired effect of corrupting binary
 509files cannot be distinguished.  In both cases CRLFs are removed
 510in an irreversible way.  For text files this is the right thing
 511to do because CRLFs are line endings, while for binary files
 512converting CRLFs corrupts data.
 513+
 514Note, this safety check does not mean that a checkout will generate a
 515file identical to the original file for a different setting of
 516`core.eol` and `core.autocrlf`, but only for the current one.  For
 517example, a text file with `LF` would be accepted with `core.eol=lf`
 518and could later be checked out with `core.eol=crlf`, in which case the
 519resulting file would contain `CRLF`, although the original file
 520contained `LF`.  However, in both work trees the line endings would be
 521consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 522file with mixed line endings would be reported by the `core.safecrlf`
 523mechanism.
 524
 525core.autocrlf::
 526        Setting this variable to "true" is the same as setting
 527        the `text` attribute to "auto" on all files and core.eol to "crlf".
 528        Set to true if you want to have `CRLF` line endings in your
 529        working directory and the repository has LF line endings.
 530        This variable can be set to 'input',
 531        in which case no output conversion is performed.
 532
 533core.checkRoundtripEncoding::
 534        A comma and/or whitespace separated list of encodings that Git
 535        performs UTF-8 round trip checks on if they are used in an
 536        `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
 537        The default value is `SHIFT-JIS`.
 538
 539core.symlinks::
 540        If false, symbolic links are checked out as small plain files that
 541        contain the link text. linkgit:git-update-index[1] and
 542        linkgit:git-add[1] will not change the recorded type to regular
 543        file. Useful on filesystems like FAT that do not support
 544        symbolic links.
 545+
 546The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 547will probe and set core.symlinks false if appropriate when the repository
 548is created.
 549
 550core.gitProxy::
 551        A "proxy command" to execute (as 'command host port') instead
 552        of establishing direct connection to the remote server when
 553        using the Git protocol for fetching. If the variable value is
 554        in the "COMMAND for DOMAIN" format, the command is applied only
 555        on hostnames ending with the specified domain string. This variable
 556        may be set multiple times and is matched in the given order;
 557        the first match wins.
 558+
 559Can be overridden by the `GIT_PROXY_COMMAND` environment variable
 560(which always applies universally, without the special "for"
 561handling).
 562+
 563The special string `none` can be used as the proxy command to
 564specify that no proxy be used for a given domain pattern.
 565This is useful for excluding servers inside a firewall from
 566proxy use, while defaulting to a common proxy for external domains.
 567
 568core.sshCommand::
 569        If this variable is set, `git fetch` and `git push` will
 570        use the specified command instead of `ssh` when they need to
 571        connect to a remote system. The command is in the same form as
 572        the `GIT_SSH_COMMAND` environment variable and is overridden
 573        when the environment variable is set.
 574
 575core.ignoreStat::
 576        If true, Git will avoid using lstat() calls to detect if files have
 577        changed by setting the "assume-unchanged" bit for those tracked files
 578        which it has updated identically in both the index and working tree.
 579+
 580When files are modified outside of Git, the user will need to stage
 581the modified files explicitly (e.g. see 'Examples' section in
 582linkgit:git-update-index[1]).
 583Git will not normally detect changes to those files.
 584+
 585This is useful on systems where lstat() calls are very slow, such as
 586CIFS/Microsoft Windows.
 587+
 588False by default.
 589
 590core.preferSymlinkRefs::
 591        Instead of the default "symref" format for HEAD
 592        and other symbolic reference files, use symbolic links.
 593        This is sometimes needed to work with old scripts that
 594        expect HEAD to be a symbolic link.
 595
 596core.bare::
 597        If true this repository is assumed to be 'bare' and has no
 598        working directory associated with it.  If this is the case a
 599        number of commands that require a working directory will be
 600        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 601+
 602This setting is automatically guessed by linkgit:git-clone[1] or
 603linkgit:git-init[1] when the repository was created.  By default a
 604repository that ends in "/.git" is assumed to be not bare (bare =
 605false), while all other repositories are assumed to be bare (bare
 606= true).
 607
 608core.worktree::
 609        Set the path to the root of the working tree.
 610        If `GIT_COMMON_DIR` environment variable is set, core.worktree
 611        is ignored and not used for determining the root of working tree.
 612        This can be overridden by the `GIT_WORK_TREE` environment
 613        variable and the `--work-tree` command-line option.
 614        The value can be an absolute path or relative to the path to
 615        the .git directory, which is either specified by --git-dir
 616        or GIT_DIR, or automatically discovered.
 617        If --git-dir or GIT_DIR is specified but none of
 618        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 619        the current working directory is regarded as the top level
 620        of your working tree.
 621+
 622Note that this variable is honored even when set in a configuration
 623file in a ".git" subdirectory of a directory and its value differs
 624from the latter directory (e.g. "/path/to/.git/config" has
 625core.worktree set to "/different/path"), which is most likely a
 626misconfiguration.  Running Git commands in the "/path/to" directory will
 627still use "/different/path" as the root of the work tree and can cause
 628confusion unless you know what you are doing (e.g. you are creating a
 629read-only snapshot of the same index to a location different from the
 630repository's usual working tree).
 631
 632core.logAllRefUpdates::
 633        Enable the reflog. Updates to a ref <ref> is logged to the file
 634        "`$GIT_DIR/logs/<ref>`", by appending the new and old
 635        SHA-1, the date/time and the reason of the update, but
 636        only when the file exists.  If this configuration
 637        variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
 638        file is automatically created for branch heads (i.e. under
 639        `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
 640        note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
 641        If it is set to `always`, then a missing reflog is automatically
 642        created for any ref under `refs/`.
 643+
 644This information can be used to determine what commit
 645was the tip of a branch "2 days ago".
 646+
 647This value is true by default in a repository that has
 648a working directory associated with it, and false by
 649default in a bare repository.
 650
 651core.repositoryFormatVersion::
 652        Internal variable identifying the repository format and layout
 653        version.
 654
 655core.sharedRepository::
 656        When 'group' (or 'true'), the repository is made shareable between
 657        several users in a group (making sure all the files and objects are
 658        group-writable). When 'all' (or 'world' or 'everybody'), the
 659        repository will be readable by all users, additionally to being
 660        group-shareable. When 'umask' (or 'false'), Git will use permissions
 661        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 662        files in the repository will have this mode value. '0xxx' will override
 663        user's umask value (whereas the other options will only override
 664        requested parts of the user's umask value). Examples: '0660' will make
 665        the repo read/write-able for the owner and group, but inaccessible to
 666        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 667        repository that is group-readable but not group-writable.
 668        See linkgit:git-init[1]. False by default.
 669
 670core.warnAmbiguousRefs::
 671        If true, Git will warn you if the ref name you passed it is ambiguous
 672        and might match multiple refs in the repository. True by default.
 673
 674core.compression::
 675        An integer -1..9, indicating a default compression level.
 676        -1 is the zlib default. 0 means no compression,
 677        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 678        If set, this provides a default to other compression variables,
 679        such as `core.looseCompression` and `pack.compression`.
 680
 681core.looseCompression::
 682        An integer -1..9, indicating the compression level for objects that
 683        are not in a pack file. -1 is the zlib default. 0 means no
 684        compression, and 1..9 are various speed/size tradeoffs, 9 being
 685        slowest.  If not set,  defaults to core.compression.  If that is
 686        not set,  defaults to 1 (best speed).
 687
 688core.packedGitWindowSize::
 689        Number of bytes of a pack file to map into memory in a
 690        single mapping operation.  Larger window sizes may allow
 691        your system to process a smaller number of large pack files
 692        more quickly.  Smaller window sizes will negatively affect
 693        performance due to increased calls to the operating system's
 694        memory manager, but may improve performance when accessing
 695        a large number of large pack files.
 696+
 697Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 698MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 699be reasonable for all users/operating systems.  You probably do
 700not need to adjust this value.
 701+
 702Common unit suffixes of 'k', 'm', or 'g' are supported.
 703
 704core.packedGitLimit::
 705        Maximum number of bytes to map simultaneously into memory
 706        from pack files.  If Git needs to access more than this many
 707        bytes at once to complete an operation it will unmap existing
 708        regions to reclaim virtual address space within the process.
 709+
 710Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
 711unlimited) on 64 bit platforms.
 712This should be reasonable for all users/operating systems, except on
 713the largest projects.  You probably do not need to adjust this value.
 714+
 715Common unit suffixes of 'k', 'm', or 'g' are supported.
 716
 717core.deltaBaseCacheLimit::
 718        Maximum number of bytes to reserve for caching base objects
 719        that may be referenced by multiple deltified objects.  By storing the
 720        entire decompressed base objects in a cache Git is able
 721        to avoid unpacking and decompressing frequently used base
 722        objects multiple times.
 723+
 724Default is 96 MiB on all platforms.  This should be reasonable
 725for all users/operating systems, except on the largest projects.
 726You probably do not need to adjust this value.
 727+
 728Common unit suffixes of 'k', 'm', or 'g' are supported.
 729
 730core.bigFileThreshold::
 731        Files larger than this size are stored deflated, without
 732        attempting delta compression.  Storing large files without
 733        delta compression avoids excessive memory usage, at the
 734        slight expense of increased disk usage. Additionally files
 735        larger than this size are always treated as binary.
 736+
 737Default is 512 MiB on all platforms.  This should be reasonable
 738for most projects as source code and other text files can still
 739be delta compressed, but larger binary media files won't be.
 740+
 741Common unit suffixes of 'k', 'm', or 'g' are supported.
 742
 743core.excludesFile::
 744        Specifies the pathname to the file that contains patterns to
 745        describe paths that are not meant to be tracked, in addition
 746        to '.gitignore' (per-directory) and '.git/info/exclude'.
 747        Defaults to `$XDG_CONFIG_HOME/git/ignore`.
 748        If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
 749        is used instead. See linkgit:gitignore[5].
 750
 751core.askPass::
 752        Some commands (e.g. svn and http interfaces) that interactively
 753        ask for a password can be told to use an external program given
 754        via the value of this variable. Can be overridden by the `GIT_ASKPASS`
 755        environment variable. If not set, fall back to the value of the
 756        `SSH_ASKPASS` environment variable or, failing that, a simple password
 757        prompt. The external program shall be given a suitable prompt as
 758        command-line argument and write the password on its STDOUT.
 759
 760core.attributesFile::
 761        In addition to '.gitattributes' (per-directory) and
 762        '.git/info/attributes', Git looks into this file for attributes
 763        (see linkgit:gitattributes[5]). Path expansions are made the same
 764        way as for `core.excludesFile`. Its default value is
 765        `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
 766        set or empty, `$HOME/.config/git/attributes` is used instead.
 767
 768core.hooksPath::
 769        By default Git will look for your hooks in the
 770        '$GIT_DIR/hooks' directory. Set this to different path,
 771        e.g. '/etc/git/hooks', and Git will try to find your hooks in
 772        that directory, e.g. '/etc/git/hooks/pre-receive' instead of
 773        in '$GIT_DIR/hooks/pre-receive'.
 774+
 775The path can be either absolute or relative. A relative path is
 776taken as relative to the directory where the hooks are run (see
 777the "DESCRIPTION" section of linkgit:githooks[5]).
 778+
 779This configuration variable is useful in cases where you'd like to
 780centrally configure your Git hooks instead of configuring them on a
 781per-repository basis, or as a more flexible and centralized
 782alternative to having an `init.templateDir` where you've changed
 783default hooks.
 784
 785core.editor::
 786        Commands such as `commit` and `tag` that let you edit
 787        messages by launching an editor use the value of this
 788        variable when it is set, and the environment variable
 789        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 790
 791core.commentChar::
 792        Commands such as `commit` and `tag` that let you edit
 793        messages consider a line that begins with this character
 794        commented, and removes them after the editor returns
 795        (default '#').
 796+
 797If set to "auto", `git-commit` would select a character that is not
 798the beginning character of any line in existing commit messages.
 799
 800core.filesRefLockTimeout::
 801        The length of time, in milliseconds, to retry when trying to
 802        lock an individual reference. Value 0 means not to retry at
 803        all; -1 means to try indefinitely. Default is 100 (i.e.,
 804        retry for 100ms).
 805
 806core.packedRefsTimeout::
 807        The length of time, in milliseconds, to retry when trying to
 808        lock the `packed-refs` file. Value 0 means not to retry at
 809        all; -1 means to try indefinitely. Default is 1000 (i.e.,
 810        retry for 1 second).
 811
 812sequence.editor::
 813        Text editor used by `git rebase -i` for editing the rebase instruction file.
 814        The value is meant to be interpreted by the shell when it is used.
 815        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 816        When not configured the default commit message editor is used instead.
 817
 818core.pager::
 819        Text viewer for use by Git commands (e.g., 'less').  The value
 820        is meant to be interpreted by the shell.  The order of preference
 821        is the `$GIT_PAGER` environment variable, then `core.pager`
 822        configuration, then `$PAGER`, and then the default chosen at
 823        compile time (usually 'less').
 824+
 825When the `LESS` environment variable is unset, Git sets it to `FRX`
 826(if `LESS` environment variable is set, Git does not change it at
 827all).  If you want to selectively override Git's default setting
 828for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
 829be passed to the shell by Git, which will translate the final
 830command to `LESS=FRX less -S`. The environment does not set the
 831`S` option but the command line does, instructing less to truncate
 832long lines. Similarly, setting `core.pager` to `less -+F` will
 833deactivate the `F` option specified by the environment from the
 834command-line, deactivating the "quit if one screen" behavior of
 835`less`.  One can specifically activate some flags for particular
 836commands: for example, setting `pager.blame` to `less -S` enables
 837line truncation only for `git blame`.
 838+
 839Likewise, when the `LV` environment variable is unset, Git sets it
 840to `-c`.  You can override this setting by exporting `LV` with
 841another value or setting `core.pager` to `lv +c`.
 842
 843core.whitespace::
 844        A comma separated list of common whitespace problems to
 845        notice.  'git diff' will use `color.diff.whitespace` to
 846        highlight them, and 'git apply --whitespace=error' will
 847        consider them as errors.  You can prefix `-` to disable
 848        any of them (e.g. `-trailing-space`):
 849+
 850* `blank-at-eol` treats trailing whitespaces at the end of the line
 851  as an error (enabled by default).
 852* `space-before-tab` treats a space character that appears immediately
 853  before a tab character in the initial indent part of the line as an
 854  error (enabled by default).
 855* `indent-with-non-tab` treats a line that is indented with space
 856  characters instead of the equivalent tabs as an error (not enabled by
 857  default).
 858* `tab-in-indent` treats a tab character in the initial indent part of
 859  the line as an error (not enabled by default).
 860* `blank-at-eof` treats blank lines added at the end of file as an error
 861  (enabled by default).
 862* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 863  `blank-at-eof`.
 864* `cr-at-eol` treats a carriage-return at the end of line as
 865  part of the line terminator, i.e. with it, `trailing-space`
 866  does not trigger if the character before such a carriage-return
 867  is not a whitespace (not enabled by default).
 868* `tabwidth=<n>` tells how many character positions a tab occupies; this
 869  is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
 870  errors. The default tab width is 8. Allowed values are 1 to 63.
 871
 872core.fsyncObjectFiles::
 873        This boolean will enable 'fsync()' when writing object files.
 874+
 875This is a total waste of time and effort on a filesystem that orders
 876data writes properly, but can be useful for filesystems that do not use
 877journalling (traditional UNIX filesystems) or that only journal metadata
 878and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 879
 880core.preloadIndex::
 881        Enable parallel index preload for operations like 'git diff'
 882+
 883This can speed up operations like 'git diff' and 'git status' especially
 884on filesystems like NFS that have weak caching semantics and thus
 885relatively high IO latencies.  When enabled, Git will do the
 886index comparison to the filesystem data in parallel, allowing
 887overlapping IO's.  Defaults to true.
 888
 889core.createObject::
 890        You can set this to 'link', in which case a hardlink followed by
 891        a delete of the source are used to make sure that object creation
 892        will not overwrite existing objects.
 893+
 894On some file system/operating system combinations, this is unreliable.
 895Set this config setting to 'rename' there; However, This will remove the
 896check that makes sure that existing object files will not get overwritten.
 897
 898core.notesRef::
 899        When showing commit messages, also show notes which are stored in
 900        the given ref.  The ref must be fully qualified.  If the given
 901        ref does not exist, it is not an error but means that no
 902        notes should be printed.
 903+
 904This setting defaults to "refs/notes/commits", and it can be overridden by
 905the `GIT_NOTES_REF` environment variable.  See linkgit:git-notes[1].
 906
 907core.commitGraph::
 908        Enable git commit graph feature. Allows reading from the
 909        commit-graph file.
 910
 911core.sparseCheckout::
 912        Enable "sparse checkout" feature. See section "Sparse checkout" in
 913        linkgit:git-read-tree[1] for more information.
 914
 915core.abbrev::
 916        Set the length object names are abbreviated to.  If
 917        unspecified or set to "auto", an appropriate value is
 918        computed based on the approximate number of packed objects
 919        in your repository, which hopefully is enough for
 920        abbreviated object names to stay unique for some time.
 921        The minimum length is 4.
 922
 923add.ignoreErrors::
 924add.ignore-errors (deprecated)::
 925        Tells 'git add' to continue adding files when some files cannot be
 926        added due to indexing errors. Equivalent to the `--ignore-errors`
 927        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 928        as it does not follow the usual naming convention for configuration
 929        variables.
 930
 931alias.*::
 932        Command aliases for the linkgit:git[1] command wrapper - e.g.
 933        after defining "alias.last = cat-file commit HEAD", the invocation
 934        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 935        confusion and troubles with script usage, aliases that
 936        hide existing Git commands are ignored. Arguments are split by
 937        spaces, the usual shell quoting and escaping is supported.
 938        A quote pair or a backslash can be used to quote them.
 939+
 940If the alias expansion is prefixed with an exclamation point,
 941it will be treated as a shell command.  For example, defining
 942"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 943"git new" is equivalent to running the shell command
 944"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 945executed from the top-level directory of a repository, which may
 946not necessarily be the current directory.
 947`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
 948from the original current directory. See linkgit:git-rev-parse[1].
 949
 950am.keepcr::
 951        If true, git-am will call git-mailsplit for patches in mbox format
 952        with parameter `--keep-cr`. In this case git-mailsplit will
 953        not remove `\r` from lines ending with `\r\n`. Can be overridden
 954        by giving `--no-keep-cr` from the command line.
 955        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 956
 957am.threeWay::
 958        By default, `git am` will fail if the patch does not apply cleanly. When
 959        set to true, this setting tells `git am` to fall back on 3-way merge if
 960        the patch records the identity of blobs it is supposed to apply to and
 961        we have those blobs available locally (equivalent to giving the `--3way`
 962        option from the command line). Defaults to `false`.
 963        See linkgit:git-am[1].
 964
 965apply.ignoreWhitespace::
 966        When set to 'change', tells 'git apply' to ignore changes in
 967        whitespace, in the same way as the `--ignore-space-change`
 968        option.
 969        When set to one of: no, none, never, false tells 'git apply' to
 970        respect all whitespace differences.
 971        See linkgit:git-apply[1].
 972
 973apply.whitespace::
 974        Tells 'git apply' how to handle whitespaces, in the same way
 975        as the `--whitespace` option. See linkgit:git-apply[1].
 976
 977blame.showRoot::
 978        Do not treat root commits as boundaries in linkgit:git-blame[1].
 979        This option defaults to false.
 980
 981blame.blankBoundary::
 982        Show blank commit object name for boundary commits in
 983        linkgit:git-blame[1]. This option defaults to false.
 984
 985blame.showEmail::
 986        Show the author email instead of author name in linkgit:git-blame[1].
 987        This option defaults to false.
 988
 989blame.date::
 990        Specifies the format used to output dates in linkgit:git-blame[1].
 991        If unset the iso format is used. For supported values,
 992        see the discussion of the `--date` option at linkgit:git-log[1].
 993
 994branch.autoSetupMerge::
 995        Tells 'git branch' and 'git checkout' to set up new branches
 996        so that linkgit:git-pull[1] will appropriately merge from the
 997        starting point branch. Note that even if this option is not set,
 998        this behavior can be chosen per-branch using the `--track`
 999        and `--no-track` options. The valid settings are: `false` -- no
1000        automatic setup is done; `true` -- automatic setup is done when the
1001        starting point is a remote-tracking branch; `always` --
1002        automatic setup is done when the starting point is either a
1003        local branch or remote-tracking
1004        branch. This option defaults to true.
1005
1006branch.autoSetupRebase::
1007        When a new branch is created with 'git branch' or 'git checkout'
1008        that tracks another branch, this variable tells Git to set
1009        up pull to rebase instead of merge (see "branch.<name>.rebase").
1010        When `never`, rebase is never automatically set to true.
1011        When `local`, rebase is set to true for tracked branches of
1012        other local branches.
1013        When `remote`, rebase is set to true for tracked branches of
1014        remote-tracking branches.
1015        When `always`, rebase will be set to true for all tracking
1016        branches.
1017        See "branch.autoSetupMerge" for details on how to set up a
1018        branch to track another branch.
1019        This option defaults to never.
1020
1021branch.<name>.remote::
1022        When on branch <name>, it tells 'git fetch' and 'git push'
1023        which remote to fetch from/push to.  The remote to push to
1024        may be overridden with `remote.pushDefault` (for all branches).
1025        The remote to push to, for the current branch, may be further
1026        overridden by `branch.<name>.pushRemote`.  If no remote is
1027        configured, or if you are not on any branch, it defaults to
1028        `origin` for fetching and `remote.pushDefault` for pushing.
1029        Additionally, `.` (a period) is the current local repository
1030        (a dot-repository), see `branch.<name>.merge`'s final note below.
1031
1032branch.<name>.pushRemote::
1033        When on branch <name>, it overrides `branch.<name>.remote` for
1034        pushing.  It also overrides `remote.pushDefault` for pushing
1035        from branch <name>.  When you pull from one place (e.g. your
1036        upstream) and push to another place (e.g. your own publishing
1037        repository), you would want to set `remote.pushDefault` to
1038        specify the remote to push to for all branches, and use this
1039        option to override it for a specific branch.
1040
1041branch.<name>.merge::
1042        Defines, together with branch.<name>.remote, the upstream branch
1043        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1044        branch to merge and can also affect 'git push' (see push.default).
1045        When in branch <name>, it tells 'git fetch' the default
1046        refspec to be marked for merging in FETCH_HEAD. The value is
1047        handled like the remote part of a refspec, and must match a
1048        ref which is fetched from the remote given by
1049        "branch.<name>.remote".
1050        The merge information is used by 'git pull' (which at first calls
1051        'git fetch') to lookup the default branch for merging. Without
1052        this option, 'git pull' defaults to merge the first refspec fetched.
1053        Specify multiple values to get an octopus merge.
1054        If you wish to setup 'git pull' so that it merges into <name> from
1055        another branch in the local repository, you can point
1056        branch.<name>.merge to the desired branch, and use the relative path
1057        setting `.` (a period) for branch.<name>.remote.
1058
1059branch.<name>.mergeOptions::
1060        Sets default options for merging into branch <name>. The syntax and
1061        supported options are the same as those of linkgit:git-merge[1], but
1062        option values containing whitespace characters are currently not
1063        supported.
1064
1065branch.<name>.rebase::
1066        When true, rebase the branch <name> on top of the fetched branch,
1067        instead of merging the default branch from the default remote when
1068        "git pull" is run. See "pull.rebase" for doing this in a non
1069        branch-specific manner.
1070+
1071When `merges`, pass the `--rebase-merges` option to 'git rebase'
1072so that the local merge commits are included in the rebase (see
1073linkgit:git-rebase[1] for details).
1074+
1075When preserve, also pass `--preserve-merges` along to 'git rebase'
1076so that locally committed merge commits will not be flattened
1077by running 'git pull'.
1078+
1079When the value is `interactive`, the rebase is run in interactive mode.
1080+
1081*NOTE*: this is a possibly dangerous operation; do *not* use
1082it unless you understand the implications (see linkgit:git-rebase[1]
1083for details).
1084
1085branch.<name>.description::
1086        Branch description, can be edited with
1087        `git branch --edit-description`. Branch description is
1088        automatically added in the format-patch cover letter or
1089        request-pull summary.
1090
1091browser.<tool>.cmd::
1092        Specify the command to invoke the specified browser. The
1093        specified command is evaluated in shell with the URLs passed
1094        as arguments. (See linkgit:git-web{litdd}browse[1].)
1095
1096browser.<tool>.path::
1097        Override the path for the given tool that may be used to
1098        browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1099        working repository in gitweb (see linkgit:git-instaweb[1]).
1100
1101clean.requireForce::
1102        A boolean to make git-clean do nothing unless given -f,
1103        -i or -n.   Defaults to true.
1104
1105color.advice::
1106        A boolean to enable/disable color in hints (e.g. when a push
1107        failed, see `advice.*` for a list).  May be set to `always`,
1108        `false` (or `never`) or `auto` (or `true`), in which case colors
1109        are used only when the error output goes to a terminal. If
1110        unset, then the value of `color.ui` is used (`auto` by default).
1111
1112color.advice.hint::
1113        Use customized color for hints.
1114
1115color.branch::
1116        A boolean to enable/disable color in the output of
1117        linkgit:git-branch[1]. May be set to `always`,
1118        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1119        only when the output is to a terminal. If unset, then the
1120        value of `color.ui` is used (`auto` by default).
1121
1122color.branch.<slot>::
1123        Use customized color for branch coloration. `<slot>` is one of
1124        `current` (the current branch), `local` (a local branch),
1125        `remote` (a remote-tracking branch in refs/remotes/),
1126        `upstream` (upstream tracking branch), `plain` (other
1127        refs).
1128
1129color.diff::
1130        Whether to use ANSI escape sequences to add color to patches.
1131        If this is set to `always`, linkgit:git-diff[1],
1132        linkgit:git-log[1], and linkgit:git-show[1] will use color
1133        for all patches.  If it is set to `true` or `auto`, those
1134        commands will only use color when output is to the terminal.
1135        If unset, then the value of `color.ui` is used (`auto` by
1136        default).
1137+
1138This does not affect linkgit:git-format-patch[1] or the
1139'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
1140command line with the `--color[=<when>]` option.
1141
1142diff.colorMoved::
1143        If set to either a valid `<mode>` or a true value, moved lines
1144        in a diff are colored differently, for details of valid modes
1145        see '--color-moved' in linkgit:git-diff[1]. If simply set to
1146        true the default color mode will be used. When set to false,
1147        moved lines are not colored.
1148
1149color.diff.<slot>::
1150        Use customized color for diff colorization.  `<slot>` specifies
1151        which part of the patch to use the specified color, and is one
1152        of `context` (context text - `plain` is a historical synonym),
1153        `meta` (metainformation), `frag`
1154        (hunk header), 'func' (function in hunk header), `old` (removed lines),
1155        `new` (added lines), `commit` (commit headers), `whitespace`
1156        (highlighting whitespace errors), `oldMoved` (deleted lines),
1157        `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1158        `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1159        and `newMovedAlternativeDimmed` (See the '<mode>'
1160        setting of '--color-moved' in linkgit:git-diff[1] for details).
1161
1162color.decorate.<slot>::
1163        Use customized color for 'git log --decorate' output.  `<slot>` is one
1164        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1165        branches, remote-tracking branches, tags, stash and HEAD, respectively.
1166
1167color.grep::
1168        When set to `always`, always highlight matches.  When `false` (or
1169        `never`), never.  When set to `true` or `auto`, use color only
1170        when the output is written to the terminal.  If unset, then the
1171        value of `color.ui` is used (`auto` by default).
1172
1173color.grep.<slot>::
1174        Use customized color for grep colorization.  `<slot>` specifies which
1175        part of the line to use the specified color, and is one of
1176+
1177--
1178`context`;;
1179        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1180`filename`;;
1181        filename prefix (when not using `-h`)
1182`function`;;
1183        function name lines (when using `-p`)
1184`linenumber`;;
1185        line number prefix (when using `-n`)
1186`match`;;
1187        matching text (same as setting `matchContext` and `matchSelected`)
1188`matchContext`;;
1189        matching text in context lines
1190`matchSelected`;;
1191        matching text in selected lines
1192`selected`;;
1193        non-matching text in selected lines
1194`separator`;;
1195        separators between fields on a line (`:`, `-`, and `=`)
1196        and between hunks (`--`)
1197--
1198
1199color.interactive::
1200        When set to `always`, always use colors for interactive prompts
1201        and displays (such as those used by "git-add --interactive" and
1202        "git-clean --interactive"). When false (or `never`), never.
1203        When set to `true` or `auto`, use colors only when the output is
1204        to the terminal. If unset, then the value of `color.ui` is
1205        used (`auto` by default).
1206
1207color.interactive.<slot>::
1208        Use customized color for 'git add --interactive' and 'git clean
1209        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1210        or `error`, for four distinct types of normal output from
1211        interactive commands.
1212
1213color.pager::
1214        A boolean to enable/disable colored output when the pager is in
1215        use (default is true).
1216
1217color.push::
1218        A boolean to enable/disable color in push errors. May be set to
1219        `always`, `false` (or `never`) or `auto` (or `true`), in which
1220        case colors are used only when the error output goes to a terminal.
1221        If unset, then the value of `color.ui` is used (`auto` by default).
1222
1223color.push.error::
1224        Use customized color for push errors.
1225
1226color.showBranch::
1227        A boolean to enable/disable color in the output of
1228        linkgit:git-show-branch[1]. May be set to `always`,
1229        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1230        only when the output is to a terminal. If unset, then the
1231        value of `color.ui` is used (`auto` by default).
1232
1233color.status::
1234        A boolean to enable/disable color in the output of
1235        linkgit:git-status[1]. May be set to `always`,
1236        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1237        only when the output is to a terminal. If unset, then the
1238        value of `color.ui` is used (`auto` by default).
1239
1240color.status.<slot>::
1241        Use customized color for status colorization. `<slot>` is
1242        one of `header` (the header text of the status message),
1243        `added` or `updated` (files which are added but not committed),
1244        `changed` (files which are changed but not added in the index),
1245        `untracked` (files which are not tracked by Git),
1246        `branch` (the current branch),
1247        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1248        to red),
1249        `localBranch` or `remoteBranch` (the local and remote branch names,
1250        respectively, when branch and tracking information is displayed in the
1251        status short-format), or
1252        `unmerged` (files which have unmerged changes).
1253
1254color.blame.repeatedLines::
1255        Use the customized color for the part of git-blame output that
1256        is repeated meta information per line (such as commit id,
1257        author name, date and timezone). Defaults to cyan.
1258
1259color.blame.highlightRecent::
1260        This can be used to color the metadata of a blame line depending
1261        on age of the line.
1262+
1263This setting should be set to a comma-separated list of color and date settings,
1264starting and ending with a color, the dates should be set from oldest to newest.
1265The metadata will be colored given the colors if the the line was introduced
1266before the given timestamp, overwriting older timestamped colors.
1267+
1268Instead of an absolute timestamp relative timestamps work as well, e.g.
12692.weeks.ago is valid to address anything older than 2 weeks.
1270+
1271It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1272everything older than one year blue, recent changes between one month and
1273one year old are kept white, and lines introduced within the last month are
1274colored red.
1275
1276blame.coloring::
1277        This determines the coloring scheme to be applied to blame
1278        output. It can be 'repeatedLines', 'highlightRecent',
1279        or 'none' which is the default.
1280
1281color.transport::
1282        A boolean to enable/disable color when pushes are rejected. May be
1283        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1284        case colors are used only when the error output goes to a terminal.
1285        If unset, then the value of `color.ui` is used (`auto` by default).
1286
1287color.transport.rejected::
1288        Use customized color when a push was rejected.
1289
1290color.ui::
1291        This variable determines the default value for variables such
1292        as `color.diff` and `color.grep` that control the use of color
1293        per command family. Its scope will expand as more commands learn
1294        configuration to set a default for the `--color` option.  Set it
1295        to `false` or `never` if you prefer Git commands not to use
1296        color unless enabled explicitly with some other configuration
1297        or the `--color` option. Set it to `always` if you want all
1298        output not intended for machine consumption to use color, to
1299        `true` or `auto` (this is the default since Git 1.8.4) if you
1300        want such output to use color when written to the terminal.
1301
1302column.ui::
1303        Specify whether supported commands should output in columns.
1304        This variable consists of a list of tokens separated by spaces
1305        or commas:
1306+
1307These options control when the feature should be enabled
1308(defaults to 'never'):
1309+
1310--
1311`always`;;
1312        always show in columns
1313`never`;;
1314        never show in columns
1315`auto`;;
1316        show in columns if the output is to the terminal
1317--
1318+
1319These options control layout (defaults to 'column').  Setting any
1320of these implies 'always' if none of 'always', 'never', or 'auto' are
1321specified.
1322+
1323--
1324`column`;;
1325        fill columns before rows
1326`row`;;
1327        fill rows before columns
1328`plain`;;
1329        show in one column
1330--
1331+
1332Finally, these options can be combined with a layout option (defaults
1333to 'nodense'):
1334+
1335--
1336`dense`;;
1337        make unequal size columns to utilize more space
1338`nodense`;;
1339        make equal size columns
1340--
1341
1342column.branch::
1343        Specify whether to output branch listing in `git branch` in columns.
1344        See `column.ui` for details.
1345
1346column.clean::
1347        Specify the layout when list items in `git clean -i`, which always
1348        shows files and directories in columns. See `column.ui` for details.
1349
1350column.status::
1351        Specify whether to output untracked files in `git status` in columns.
1352        See `column.ui` for details.
1353
1354column.tag::
1355        Specify whether to output tag listing in `git tag` in columns.
1356        See `column.ui` for details.
1357
1358commit.cleanup::
1359        This setting overrides the default of the `--cleanup` option in
1360        `git commit`. See linkgit:git-commit[1] for details. Changing the
1361        default can be useful when you always want to keep lines that begin
1362        with comment character `#` in your log message, in which case you
1363        would do `git config commit.cleanup whitespace` (note that you will
1364        have to remove the help lines that begin with `#` in the commit log
1365        template yourself, if you do this).
1366
1367commit.gpgSign::
1368
1369        A boolean to specify whether all commits should be GPG signed.
1370        Use of this option when doing operations such as rebase can
1371        result in a large number of commits being signed. It may be
1372        convenient to use an agent to avoid typing your GPG passphrase
1373        several times.
1374
1375commit.status::
1376        A boolean to enable/disable inclusion of status information in the
1377        commit message template when using an editor to prepare the commit
1378        message.  Defaults to true.
1379
1380commit.template::
1381        Specify the pathname of a file to use as the template for
1382        new commit messages.
1383
1384commit.verbose::
1385        A boolean or int to specify the level of verbose with `git commit`.
1386        See linkgit:git-commit[1].
1387
1388credential.helper::
1389        Specify an external helper to be called when a username or
1390        password credential is needed; the helper may consult external
1391        storage to avoid prompting the user for the credentials. Note
1392        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1393        for details.
1394
1395credential.useHttpPath::
1396        When acquiring credentials, consider the "path" component of an http
1397        or https URL to be important. Defaults to false. See
1398        linkgit:gitcredentials[7] for more information.
1399
1400credential.username::
1401        If no username is set for a network authentication, use this username
1402        by default. See credential.<context>.* below, and
1403        linkgit:gitcredentials[7].
1404
1405credential.<url>.*::
1406        Any of the credential.* options above can be applied selectively to
1407        some credentials. For example "credential.https://example.com.username"
1408        would set the default username only for https connections to
1409        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1410        matched.
1411
1412credentialCache.ignoreSIGHUP::
1413        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1414
1415include::diff-config.txt[]
1416
1417difftool.<tool>.path::
1418        Override the path for the given tool.  This is useful in case
1419        your tool is not in the PATH.
1420
1421difftool.<tool>.cmd::
1422        Specify the command to invoke the specified diff tool.
1423        The specified command is evaluated in shell with the following
1424        variables available:  'LOCAL' is set to the name of the temporary
1425        file containing the contents of the diff pre-image and 'REMOTE'
1426        is set to the name of the temporary file containing the contents
1427        of the diff post-image.
1428
1429difftool.prompt::
1430        Prompt before each invocation of the diff tool.
1431
1432fastimport.unpackLimit::
1433        If the number of objects imported by linkgit:git-fast-import[1]
1434        is below this limit, then the objects will be unpacked into
1435        loose object files.  However if the number of imported objects
1436        equals or exceeds this limit then the pack will be stored as a
1437        pack.  Storing the pack from a fast-import can make the import
1438        operation complete faster, especially on slow filesystems.  If
1439        not set, the value of `transfer.unpackLimit` is used instead.
1440
1441fetch.recurseSubmodules::
1442        This option can be either set to a boolean value or to 'on-demand'.
1443        Setting it to a boolean changes the behavior of fetch and pull to
1444        unconditionally recurse into submodules when set to true or to not
1445        recurse at all when set to false. When set to 'on-demand' (the default
1446        value), fetch and pull will only recurse into a populated submodule
1447        when its superproject retrieves a commit that updates the submodule's
1448        reference.
1449
1450fetch.fsckObjects::
1451        If it is set to true, git-fetch-pack will check all fetched
1452        objects. It will abort in the case of a malformed object or a
1453        broken link. The result of an abort are only dangling objects.
1454        Defaults to false. If not set, the value of `transfer.fsckObjects`
1455        is used instead.
1456
1457fetch.unpackLimit::
1458        If the number of objects fetched over the Git native
1459        transfer is below this
1460        limit, then the objects will be unpacked into loose object
1461        files. However if the number of received objects equals or
1462        exceeds this limit then the received pack will be stored as
1463        a pack, after adding any missing delta bases.  Storing the
1464        pack from a push can make the push operation complete faster,
1465        especially on slow filesystems.  If not set, the value of
1466        `transfer.unpackLimit` is used instead.
1467
1468fetch.prune::
1469        If true, fetch will automatically behave as if the `--prune`
1470        option was given on the command line.  See also `remote.<name>.prune`
1471        and the PRUNING section of linkgit:git-fetch[1].
1472
1473fetch.pruneTags::
1474        If true, fetch will automatically behave as if the
1475        `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1476        if not set already. This allows for setting both this option
1477        and `fetch.prune` to maintain a 1=1 mapping to upstream
1478        refs. See also `remote.<name>.pruneTags` and the PRUNING
1479        section of linkgit:git-fetch[1].
1480
1481fetch.output::
1482        Control how ref update status is printed. Valid values are
1483        `full` and `compact`. Default value is `full`. See section
1484        OUTPUT in linkgit:git-fetch[1] for detail.
1485
1486format.attach::
1487        Enable multipart/mixed attachments as the default for
1488        'format-patch'.  The value can also be a double quoted string
1489        which will enable attachments as the default and set the
1490        value as the boundary.  See the --attach option in
1491        linkgit:git-format-patch[1].
1492
1493format.from::
1494        Provides the default value for the `--from` option to format-patch.
1495        Accepts a boolean value, or a name and email address.  If false,
1496        format-patch defaults to `--no-from`, using commit authors directly in
1497        the "From:" field of patch mails.  If true, format-patch defaults to
1498        `--from`, using your committer identity in the "From:" field of patch
1499        mails and including a "From:" field in the body of the patch mail if
1500        different.  If set to a non-boolean value, format-patch uses that
1501        value instead of your committer identity.  Defaults to false.
1502
1503format.numbered::
1504        A boolean which can enable or disable sequence numbers in patch
1505        subjects.  It defaults to "auto" which enables it only if there
1506        is more than one patch.  It can be enabled or disabled for all
1507        messages by setting it to "true" or "false".  See --numbered
1508        option in linkgit:git-format-patch[1].
1509
1510format.headers::
1511        Additional email headers to include in a patch to be submitted
1512        by mail.  See linkgit:git-format-patch[1].
1513
1514format.to::
1515format.cc::
1516        Additional recipients to include in a patch to be submitted
1517        by mail.  See the --to and --cc options in
1518        linkgit:git-format-patch[1].
1519
1520format.subjectPrefix::
1521        The default for format-patch is to output files with the '[PATCH]'
1522        subject prefix. Use this variable to change that prefix.
1523
1524format.signature::
1525        The default for format-patch is to output a signature containing
1526        the Git version number. Use this variable to change that default.
1527        Set this variable to the empty string ("") to suppress
1528        signature generation.
1529
1530format.signatureFile::
1531        Works just like format.signature except the contents of the
1532        file specified by this variable will be used as the signature.
1533
1534format.suffix::
1535        The default for format-patch is to output files with the suffix
1536        `.patch`. Use this variable to change that suffix (make sure to
1537        include the dot if you want it).
1538
1539format.pretty::
1540        The default pretty format for log/show/whatchanged command,
1541        See linkgit:git-log[1], linkgit:git-show[1],
1542        linkgit:git-whatchanged[1].
1543
1544format.thread::
1545        The default threading style for 'git format-patch'.  Can be
1546        a boolean value, or `shallow` or `deep`.  `shallow` threading
1547        makes every mail a reply to the head of the series,
1548        where the head is chosen from the cover letter, the
1549        `--in-reply-to`, and the first patch mail, in this order.
1550        `deep` threading makes every mail a reply to the previous one.
1551        A true boolean value is the same as `shallow`, and a false
1552        value disables threading.
1553
1554format.signOff::
1555        A boolean value which lets you enable the `-s/--signoff` option of
1556        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1557        patch should be a conscious act and means that you certify you have
1558        the rights to submit this work under the same open source license.
1559        Please see the 'SubmittingPatches' document for further discussion.
1560
1561format.coverLetter::
1562        A boolean that controls whether to generate a cover-letter when
1563        format-patch is invoked, but in addition can be set to "auto", to
1564        generate a cover-letter only when there's more than one patch.
1565
1566format.outputDirectory::
1567        Set a custom directory to store the resulting files instead of the
1568        current working directory.
1569
1570format.useAutoBase::
1571        A boolean value which lets you enable the `--base=auto` option of
1572        format-patch by default.
1573
1574filter.<driver>.clean::
1575        The command which is used to convert the content of a worktree
1576        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1577        details.
1578
1579filter.<driver>.smudge::
1580        The command which is used to convert the content of a blob
1581        object to a worktree file upon checkout.  See
1582        linkgit:gitattributes[5] for details.
1583
1584fsck.<msg-id>::
1585        Allows overriding the message type (error, warn or ignore) of a
1586        specific message ID such as `missingEmail`.
1587+
1588For convenience, fsck prefixes the error/warning with the message ID,
1589e.g.  "missingEmail: invalid author/committer line - missing email" means
1590that setting `fsck.missingEmail = ignore` will hide that issue.
1591+
1592This feature is intended to support working with legacy repositories
1593which cannot be repaired without disruptive changes.
1594
1595fsck.skipList::
1596        The path to a sorted list of object names (i.e. one SHA-1 per
1597        line) that are known to be broken in a non-fatal way and should
1598        be ignored. This feature is useful when an established project
1599        should be accepted despite early commits containing errors that
1600        can be safely ignored such as invalid committer email addresses.
1601        Note: corrupt objects cannot be skipped with this setting.
1602
1603gc.aggressiveDepth::
1604        The depth parameter used in the delta compression
1605        algorithm used by 'git gc --aggressive'.  This defaults
1606        to 50.
1607
1608gc.aggressiveWindow::
1609        The window size parameter used in the delta compression
1610        algorithm used by 'git gc --aggressive'.  This defaults
1611        to 250.
1612
1613gc.auto::
1614        When there are approximately more than this many loose
1615        objects in the repository, `git gc --auto` will pack them.
1616        Some Porcelain commands use this command to perform a
1617        light-weight garbage collection from time to time.  The
1618        default value is 6700.  Setting this to 0 disables it.
1619
1620gc.autoPackLimit::
1621        When there are more than this many packs that are not
1622        marked with `*.keep` file in the repository, `git gc
1623        --auto` consolidates them into one larger pack.  The
1624        default value is 50.  Setting this to 0 disables it.
1625
1626gc.autoDetach::
1627        Make `git gc --auto` return immediately and run in background
1628        if the system supports it. Default is true.
1629
1630gc.bigPackThreshold::
1631        If non-zero, all packs larger than this limit are kept when
1632        `git gc` is run. This is very similar to `--keep-base-pack`
1633        except that all packs that meet the threshold are kept, not
1634        just the base pack. Defaults to zero. Common unit suffixes of
1635        'k', 'm', or 'g' are supported.
1636+
1637Note that if the number of kept packs is more than gc.autoPackLimit,
1638this configuration variable is ignored, all packs except the base pack
1639will be repacked. After this the number of packs should go below
1640gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1641
1642gc.logExpiry::
1643        If the file gc.log exists, then `git gc --auto` won't run
1644        unless that file is more than 'gc.logExpiry' old.  Default is
1645        "1.day".  See `gc.pruneExpire` for more ways to specify its
1646        value.
1647
1648gc.packRefs::
1649        Running `git pack-refs` in a repository renders it
1650        unclonable by Git versions prior to 1.5.1.2 over dumb
1651        transports such as HTTP.  This variable determines whether
1652        'git gc' runs `git pack-refs`. This can be set to `notbare`
1653        to enable it within all non-bare repos or it can be set to a
1654        boolean value.  The default is `true`.
1655
1656gc.pruneExpire::
1657        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1658        Override the grace period with this config variable.  The value
1659        "now" may be used to disable this grace period and always prune
1660        unreachable objects immediately, or "never" may be used to
1661        suppress pruning.  This feature helps prevent corruption when
1662        'git gc' runs concurrently with another process writing to the
1663        repository; see the "NOTES" section of linkgit:git-gc[1].
1664
1665gc.worktreePruneExpire::
1666        When 'git gc' is run, it calls
1667        'git worktree prune --expire 3.months.ago'.
1668        This config variable can be used to set a different grace
1669        period. The value "now" may be used to disable the grace
1670        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1671        may be used to suppress pruning.
1672
1673gc.reflogExpire::
1674gc.<pattern>.reflogExpire::
1675        'git reflog expire' removes reflog entries older than
1676        this time; defaults to 90 days. The value "now" expires all
1677        entries immediately, and "never" suppresses expiration
1678        altogether. With "<pattern>" (e.g.
1679        "refs/stash") in the middle the setting applies only to
1680        the refs that match the <pattern>.
1681
1682gc.reflogExpireUnreachable::
1683gc.<pattern>.reflogExpireUnreachable::
1684        'git reflog expire' removes reflog entries older than
1685        this time and are not reachable from the current tip;
1686        defaults to 30 days. The value "now" expires all entries
1687        immediately, and "never" suppresses expiration altogether.
1688        With "<pattern>" (e.g. "refs/stash")
1689        in the middle, the setting applies only to the refs that
1690        match the <pattern>.
1691
1692gc.rerereResolved::
1693        Records of conflicted merge you resolved earlier are
1694        kept for this many days when 'git rerere gc' is run.
1695        You can also use more human-readable "1.month.ago", etc.
1696        The default is 60 days.  See linkgit:git-rerere[1].
1697
1698gc.rerereUnresolved::
1699        Records of conflicted merge you have not resolved are
1700        kept for this many days when 'git rerere gc' is run.
1701        You can also use more human-readable "1.month.ago", etc.
1702        The default is 15 days.  See linkgit:git-rerere[1].
1703
1704gitcvs.commitMsgAnnotation::
1705        Append this string to each commit message. Set to empty string
1706        to disable this feature. Defaults to "via git-CVS emulator".
1707
1708gitcvs.enabled::
1709        Whether the CVS server interface is enabled for this repository.
1710        See linkgit:git-cvsserver[1].
1711
1712gitcvs.logFile::
1713        Path to a log file where the CVS server interface well... logs
1714        various stuff. See linkgit:git-cvsserver[1].
1715
1716gitcvs.usecrlfattr::
1717        If true, the server will look up the end-of-line conversion
1718        attributes for files to determine the `-k` modes to use. If
1719        the attributes force Git to treat a file as text,
1720        the `-k` mode will be left blank so CVS clients will
1721        treat it as text. If they suppress text conversion, the file
1722        will be set with '-kb' mode, which suppresses any newline munging
1723        the client might otherwise do. If the attributes do not allow
1724        the file type to be determined, then `gitcvs.allBinary` is
1725        used. See linkgit:gitattributes[5].
1726
1727gitcvs.allBinary::
1728        This is used if `gitcvs.usecrlfattr` does not resolve
1729        the correct '-kb' mode to use. If true, all
1730        unresolved files are sent to the client in
1731        mode '-kb'. This causes the client to treat them
1732        as binary files, which suppresses any newline munging it
1733        otherwise might do. Alternatively, if it is set to "guess",
1734        then the contents of the file are examined to decide if
1735        it is binary, similar to `core.autocrlf`.
1736
1737gitcvs.dbName::
1738        Database used by git-cvsserver to cache revision information
1739        derived from the Git repository. The exact meaning depends on the
1740        used database driver, for SQLite (which is the default driver) this
1741        is a filename. Supports variable substitution (see
1742        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1743        Default: '%Ggitcvs.%m.sqlite'
1744
1745gitcvs.dbDriver::
1746        Used Perl DBI driver. You can specify any available driver
1747        for this here, but it might not work. git-cvsserver is tested
1748        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1749        reported *not* to work with 'DBD::mysql'. Experimental feature.
1750        May not contain double colons (`:`). Default: 'SQLite'.
1751        See linkgit:git-cvsserver[1].
1752
1753gitcvs.dbUser, gitcvs.dbPass::
1754        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1755        since SQLite has no concept of database users and/or passwords.
1756        'gitcvs.dbUser' supports variable substitution (see
1757        linkgit:git-cvsserver[1] for details).
1758
1759gitcvs.dbTableNamePrefix::
1760        Database table name prefix.  Prepended to the names of any
1761        database tables used, allowing a single database to be used
1762        for several repositories.  Supports variable substitution (see
1763        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1764        characters will be replaced with underscores.
1765
1766All gitcvs variables except for `gitcvs.usecrlfattr` and
1767`gitcvs.allBinary` can also be specified as
1768'gitcvs.<access_method>.<varname>' (where 'access_method'
1769is one of "ext" and "pserver") to make them apply only for the given
1770access method.
1771
1772gitweb.category::
1773gitweb.description::
1774gitweb.owner::
1775gitweb.url::
1776        See linkgit:gitweb[1] for description.
1777
1778gitweb.avatar::
1779gitweb.blame::
1780gitweb.grep::
1781gitweb.highlight::
1782gitweb.patches::
1783gitweb.pickaxe::
1784gitweb.remote_heads::
1785gitweb.showSizes::
1786gitweb.snapshot::
1787        See linkgit:gitweb.conf[5] for description.
1788
1789grep.lineNumber::
1790        If set to true, enable `-n` option by default.
1791
1792grep.patternType::
1793        Set the default matching behavior. Using a value of 'basic', 'extended',
1794        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1795        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1796        value 'default' will return to the default matching behavior.
1797
1798grep.extendedRegexp::
1799        If set to true, enable `--extended-regexp` option by default. This
1800        option is ignored when the `grep.patternType` option is set to a value
1801        other than 'default'.
1802
1803grep.threads::
1804        Number of grep worker threads to use.
1805        See `grep.threads` in linkgit:git-grep[1] for more information.
1806
1807grep.fallbackToNoIndex::
1808        If set to true, fall back to git grep --no-index if git grep
1809        is executed outside of a git repository.  Defaults to false.
1810
1811gpg.program::
1812        Use this custom program instead of "`gpg`" found on `$PATH` when
1813        making or verifying a PGP signature. The program must support the
1814        same command-line interface as GPG, namely, to verify a detached
1815        signature, "`gpg --verify $file - <$signature`" is run, and the
1816        program is expected to signal a good signature by exiting with
1817        code 0, and to generate an ASCII-armored detached signature, the
1818        standard input of "`gpg -bsau $key`" is fed with the contents to be
1819        signed, and the program is expected to send the result to its
1820        standard output.
1821
1822gui.commitMsgWidth::
1823        Defines how wide the commit message window is in the
1824        linkgit:git-gui[1]. "75" is the default.
1825
1826gui.diffContext::
1827        Specifies how many context lines should be used in calls to diff
1828        made by the linkgit:git-gui[1]. The default is "5".
1829
1830gui.displayUntracked::
1831        Determines if linkgit:git-gui[1] shows untracked files
1832        in the file list. The default is "true".
1833
1834gui.encoding::
1835        Specifies the default encoding to use for displaying of
1836        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1837        It can be overridden by setting the 'encoding' attribute
1838        for relevant files (see linkgit:gitattributes[5]).
1839        If this option is not set, the tools default to the
1840        locale encoding.
1841
1842gui.matchTrackingBranch::
1843        Determines if new branches created with linkgit:git-gui[1] should
1844        default to tracking remote branches with matching names or
1845        not. Default: "false".
1846
1847gui.newBranchTemplate::
1848        Is used as suggested name when creating new branches using the
1849        linkgit:git-gui[1].
1850
1851gui.pruneDuringFetch::
1852        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1853        performing a fetch. The default value is "false".
1854
1855gui.trustmtime::
1856        Determines if linkgit:git-gui[1] should trust the file modification
1857        timestamp or not. By default the timestamps are not trusted.
1858
1859gui.spellingDictionary::
1860        Specifies the dictionary used for spell checking commit messages in
1861        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1862        off.
1863
1864gui.fastCopyBlame::
1865        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1866        location detection. It makes blame significantly faster on huge
1867        repositories at the expense of less thorough copy detection.
1868
1869gui.copyBlameThreshold::
1870        Specifies the threshold to use in 'git gui blame' original location
1871        detection, measured in alphanumeric characters. See the
1872        linkgit:git-blame[1] manual for more information on copy detection.
1873
1874gui.blamehistoryctx::
1875        Specifies the radius of history context in days to show in
1876        linkgit:gitk[1] for the selected commit, when the `Show History
1877        Context` menu item is invoked from 'git gui blame'. If this
1878        variable is set to zero, the whole history is shown.
1879
1880guitool.<name>.cmd::
1881        Specifies the shell command line to execute when the corresponding item
1882        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1883        mandatory for every tool. The command is executed from the root of
1884        the working directory, and in the environment it receives the name of
1885        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1886        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1887        the head is detached, 'CUR_BRANCH' is empty).
1888
1889guitool.<name>.needsFile::
1890        Run the tool only if a diff is selected in the GUI. It guarantees
1891        that 'FILENAME' is not empty.
1892
1893guitool.<name>.noConsole::
1894        Run the command silently, without creating a window to display its
1895        output.
1896
1897guitool.<name>.noRescan::
1898        Don't rescan the working directory for changes after the tool
1899        finishes execution.
1900
1901guitool.<name>.confirm::
1902        Show a confirmation dialog before actually running the tool.
1903
1904guitool.<name>.argPrompt::
1905        Request a string argument from the user, and pass it to the tool
1906        through the `ARGS` environment variable. Since requesting an
1907        argument implies confirmation, the 'confirm' option has no effect
1908        if this is enabled. If the option is set to 'true', 'yes', or '1',
1909        the dialog uses a built-in generic prompt; otherwise the exact
1910        value of the variable is used.
1911
1912guitool.<name>.revPrompt::
1913        Request a single valid revision from the user, and set the
1914        `REVISION` environment variable. In other aspects this option
1915        is similar to 'argPrompt', and can be used together with it.
1916
1917guitool.<name>.revUnmerged::
1918        Show only unmerged branches in the 'revPrompt' subdialog.
1919        This is useful for tools similar to merge or rebase, but not
1920        for things like checkout or reset.
1921
1922guitool.<name>.title::
1923        Specifies the title to use for the prompt dialog. The default
1924        is the tool name.
1925
1926guitool.<name>.prompt::
1927        Specifies the general prompt string to display at the top of
1928        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1929        The default value includes the actual command.
1930
1931help.browser::
1932        Specify the browser that will be used to display help in the
1933        'web' format. See linkgit:git-help[1].
1934
1935help.format::
1936        Override the default help format used by linkgit:git-help[1].
1937        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1938        the default. 'web' and 'html' are the same.
1939
1940help.autoCorrect::
1941        Automatically correct and execute mistyped commands after
1942        waiting for the given number of deciseconds (0.1 sec). If more
1943        than one command can be deduced from the entered text, nothing
1944        will be executed.  If the value of this option is negative,
1945        the corrected command will be executed immediately. If the
1946        value is 0 - the command will be just shown but not executed.
1947        This is the default.
1948
1949help.htmlPath::
1950        Specify the path where the HTML documentation resides. File system paths
1951        and URLs are supported. HTML pages will be prefixed with this path when
1952        help is displayed in the 'web' format. This defaults to the documentation
1953        path of your Git installation.
1954
1955http.proxy::
1956        Override the HTTP proxy, normally configured using the 'http_proxy',
1957        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1958        addition to the syntax understood by curl, it is possible to specify a
1959        proxy string with a user name but no password, in which case git will
1960        attempt to acquire one in the same way it does for other credentials. See
1961        linkgit:gitcredentials[7] for more information. The syntax thus is
1962        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1963        on a per-remote basis; see remote.<name>.proxy
1964
1965http.proxyAuthMethod::
1966        Set the method with which to authenticate against the HTTP proxy. This
1967        only takes effect if the configured proxy string contains a user name part
1968        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1969        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1970        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1971        variable.  Possible values are:
1972+
1973--
1974* `anyauth` - Automatically pick a suitable authentication method. It is
1975  assumed that the proxy answers an unauthenticated request with a 407
1976  status code and one or more Proxy-authenticate headers with supported
1977  authentication methods. This is the default.
1978* `basic` - HTTP Basic authentication
1979* `digest` - HTTP Digest authentication; this prevents the password from being
1980  transmitted to the proxy in clear text
1981* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1982  of `curl(1)`)
1983* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1984--
1985
1986http.emptyAuth::
1987        Attempt authentication without seeking a username or password.  This
1988        can be used to attempt GSS-Negotiate authentication without specifying
1989        a username in the URL, as libcurl normally requires a username for
1990        authentication.
1991
1992http.delegation::
1993        Control GSSAPI credential delegation. The delegation is disabled
1994        by default in libcurl since version 7.21.7. Set parameter to tell
1995        the server what it is allowed to delegate when it comes to user
1996        credentials. Used with GSS/kerberos. Possible values are:
1997+
1998--
1999* `none` - Don't allow any delegation.
2000* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2001  Kerberos service ticket, which is a matter of realm policy.
2002* `always` - Unconditionally allow the server to delegate.
2003--
2004
2005
2006http.extraHeader::
2007        Pass an additional HTTP header when communicating with a server.  If
2008        more than one such entry exists, all of them are added as extra
2009        headers.  To allow overriding the settings inherited from the system
2010        config, an empty value will reset the extra headers to the empty list.
2011
2012http.cookieFile::
2013        The pathname of a file containing previously stored cookie lines,
2014        which should be used
2015        in the Git http session, if they match the server. The file format
2016        of the file to read cookies from should be plain HTTP headers or
2017        the Netscape/Mozilla cookie file format (see `curl(1)`).
2018        NOTE that the file specified with http.cookieFile is used only as
2019        input unless http.saveCookies is set.
2020
2021http.saveCookies::
2022        If set, store cookies received during requests to the file specified by
2023        http.cookieFile. Has no effect if http.cookieFile is unset.
2024
2025http.sslVersion::
2026        The SSL version to use when negotiating an SSL connection, if you
2027        want to force the default.  The available and default version
2028        depend on whether libcurl was built against NSS or OpenSSL and the
2029        particular configuration of the crypto library in use. Internally
2030        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2031        documentation for more details on the format of this option and
2032        for the ssl version supported. Actually the possible values of
2033        this option are:
2034
2035        - sslv2
2036        - sslv3
2037        - tlsv1
2038        - tlsv1.0
2039        - tlsv1.1
2040        - tlsv1.2
2041        - tlsv1.3
2042
2043+
2044Can be overridden by the `GIT_SSL_VERSION` environment variable.
2045To force git to use libcurl's default ssl version and ignore any
2046explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2047empty string.
2048
2049http.sslCipherList::
2050  A list of SSL ciphers to use when negotiating an SSL connection.
2051  The available ciphers depend on whether libcurl was built against
2052  NSS or OpenSSL and the particular configuration of the crypto
2053  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2054  option; see the libcurl documentation for more details on the format
2055  of this list.
2056+
2057Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2058To force git to use libcurl's default cipher list and ignore any
2059explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2060empty string.
2061
2062http.sslVerify::
2063        Whether to verify the SSL certificate when fetching or pushing
2064        over HTTPS. Defaults to true. Can be overridden by the
2065        `GIT_SSL_NO_VERIFY` environment variable.
2066
2067http.sslCert::
2068        File containing the SSL certificate when fetching or pushing
2069        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2070        variable.
2071
2072http.sslKey::
2073        File containing the SSL private key when fetching or pushing
2074        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2075        variable.
2076
2077http.sslCertPasswordProtected::
2078        Enable Git's password prompt for the SSL certificate.  Otherwise
2079        OpenSSL will prompt the user, possibly many times, if the
2080        certificate or private key is encrypted.  Can be overridden by the
2081        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2082
2083http.sslCAInfo::
2084        File containing the certificates to verify the peer with when
2085        fetching or pushing over HTTPS. Can be overridden by the
2086        `GIT_SSL_CAINFO` environment variable.
2087
2088http.sslCAPath::
2089        Path containing files with the CA certificates to verify the peer
2090        with when fetching or pushing over HTTPS. Can be overridden
2091        by the `GIT_SSL_CAPATH` environment variable.
2092
2093http.pinnedpubkey::
2094        Public key of the https service. It may either be the filename of
2095        a PEM or DER encoded public key file or a string starting with
2096        'sha256//' followed by the base64 encoded sha256 hash of the
2097        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2098        exit with an error if this option is set but not supported by
2099        cURL.
2100
2101http.sslTry::
2102        Attempt to use AUTH SSL/TLS and encrypted data transfers
2103        when connecting via regular FTP protocol. This might be needed
2104        if the FTP server requires it for security reasons or you wish
2105        to connect securely whenever remote FTP server supports it.
2106        Default is false since it might trigger certificate verification
2107        errors on misconfigured servers.
2108
2109http.maxRequests::
2110        How many HTTP requests to launch in parallel. Can be overridden
2111        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2112
2113http.minSessions::
2114        The number of curl sessions (counted across slots) to be kept across
2115        requests. They will not be ended with curl_easy_cleanup() until
2116        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2117        value will be capped at 1. Defaults to 1.
2118
2119http.postBuffer::
2120        Maximum size in bytes of the buffer used by smart HTTP
2121        transports when POSTing data to the remote system.
2122        For requests larger than this buffer size, HTTP/1.1 and
2123        Transfer-Encoding: chunked is used to avoid creating a
2124        massive pack file locally.  Default is 1 MiB, which is
2125        sufficient for most requests.
2126
2127http.lowSpeedLimit, http.lowSpeedTime::
2128        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2129        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2130        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2131        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2132
2133http.noEPSV::
2134        A boolean which disables using of EPSV ftp command by curl.
2135        This can helpful with some "poor" ftp servers which don't
2136        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2137        environment variable. Default is false (curl will use EPSV).
2138
2139http.userAgent::
2140        The HTTP USER_AGENT string presented to an HTTP server.  The default
2141        value represents the version of the client Git such as git/1.7.1.
2142        This option allows you to override this value to a more common value
2143        such as Mozilla/4.0.  This may be necessary, for instance, if
2144        connecting through a firewall that restricts HTTP connections to a set
2145        of common USER_AGENT strings (but not including those like git/1.7.1).
2146        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2147
2148http.followRedirects::
2149        Whether git should follow HTTP redirects. If set to `true`, git
2150        will transparently follow any redirect issued by a server it
2151        encounters. If set to `false`, git will treat all redirects as
2152        errors. If set to `initial`, git will follow redirects only for
2153        the initial request to a remote, but not for subsequent
2154        follow-up HTTP requests. Since git uses the redirected URL as
2155        the base for the follow-up requests, this is generally
2156        sufficient. The default is `initial`.
2157
2158http.<url>.*::
2159        Any of the http.* options above can be applied selectively to some URLs.
2160        For a config key to match a URL, each element of the config key is
2161        compared to that of the URL, in the following order:
2162+
2163--
2164. Scheme (e.g., `https` in `https://example.com/`). This field
2165  must match exactly between the config key and the URL.
2166
2167. Host/domain name (e.g., `example.com` in `https://example.com/`).
2168  This field must match between the config key and the URL. It is
2169  possible to specify a `*` as part of the host name to match all subdomains
2170  at this level. `https://*.example.com/` for example would match
2171  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2172
2173. Port number (e.g., `8080` in `http://example.com:8080/`).
2174  This field must match exactly between the config key and the URL.
2175  Omitted port numbers are automatically converted to the correct
2176  default for the scheme before matching.
2177
2178. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2179  path field of the config key must match the path field of the URL
2180  either exactly or as a prefix of slash-delimited path elements.  This means
2181  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2182  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2183  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2184  key with just path `foo/`).
2185
2186. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2187  the config key has a user name it must match the user name in the
2188  URL exactly. If the config key does not have a user name, that
2189  config key will match a URL with any user name (including none),
2190  but at a lower precedence than a config key with a user name.
2191--
2192+
2193The list above is ordered by decreasing precedence; a URL that matches
2194a config key's path is preferred to one that matches its user name. For example,
2195if the URL is `https://user@example.com/foo/bar` a config key match of
2196`https://example.com/foo` will be preferred over a config key match of
2197`https://user@example.com`.
2198+
2199All URLs are normalized before attempting any matching (the password part,
2200if embedded in the URL, is always ignored for matching purposes) so that
2201equivalent URLs that are simply spelled differently will match properly.
2202Environment variable settings always override any matches.  The URLs that are
2203matched against are those given directly to Git commands.  This means any URLs
2204visited as a result of a redirection do not participate in matching.
2205
2206ssh.variant::
2207        By default, Git determines the command line arguments to use
2208        based on the basename of the configured SSH command (configured
2209        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2210        the config setting `core.sshCommand`). If the basename is
2211        unrecognized, Git will attempt to detect support of OpenSSH
2212        options by first invoking the configured SSH command with the
2213        `-G` (print configuration) option and will subsequently use
2214        OpenSSH options (if that is successful) or no options besides
2215        the host and remote command (if it fails).
2216+
2217The config variable `ssh.variant` can be set to override this detection.
2218Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2219`tortoiseplink`, `simple` (no options except the host and remote command).
2220The default auto-detection can be explicitly requested using the value
2221`auto`.  Any other value is treated as `ssh`.  This setting can also be
2222overridden via the environment variable `GIT_SSH_VARIANT`.
2223+
2224The current command-line parameters used for each variant are as
2225follows:
2226+
2227--
2228
2229* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2230
2231* `simple` - [username@]host command
2232
2233* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2234
2235* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2236
2237--
2238+
2239Except for the `simple` variant, command-line parameters are likely to
2240change as git gains new features.
2241
2242i18n.commitEncoding::
2243        Character encoding the commit messages are stored in; Git itself
2244        does not care per se, but this information is necessary e.g. when
2245        importing commits from emails or in the gitk graphical history
2246        browser (and possibly at other places in the future or in other
2247        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2248
2249i18n.logOutputEncoding::
2250        Character encoding the commit messages are converted to when
2251        running 'git log' and friends.
2252
2253imap::
2254        The configuration variables in the 'imap' section are described
2255        in linkgit:git-imap-send[1].
2256
2257index.version::
2258        Specify the version with which new index files should be
2259        initialized.  This does not affect existing repositories.
2260
2261init.templateDir::
2262        Specify the directory from which templates will be copied.
2263        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2264
2265instaweb.browser::
2266        Specify the program that will be used to browse your working
2267        repository in gitweb. See linkgit:git-instaweb[1].
2268
2269instaweb.httpd::
2270        The HTTP daemon command-line to start gitweb on your working
2271        repository. See linkgit:git-instaweb[1].
2272
2273instaweb.local::
2274        If true the web server started by linkgit:git-instaweb[1] will
2275        be bound to the local IP (127.0.0.1).
2276
2277instaweb.modulePath::
2278        The default module path for linkgit:git-instaweb[1] to use
2279        instead of /usr/lib/apache2/modules.  Only used if httpd
2280        is Apache.
2281
2282instaweb.port::
2283        The port number to bind the gitweb httpd to. See
2284        linkgit:git-instaweb[1].
2285
2286interactive.singleKey::
2287        In interactive commands, allow the user to provide one-letter
2288        input with a single key (i.e., without hitting enter).
2289        Currently this is used by the `--patch` mode of
2290        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2291        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2292        setting is silently ignored if portable keystroke input
2293        is not available; requires the Perl module Term::ReadKey.
2294
2295interactive.diffFilter::
2296        When an interactive command (such as `git add --patch`) shows
2297        a colorized diff, git will pipe the diff through the shell
2298        command defined by this configuration variable. The command may
2299        mark up the diff further for human consumption, provided that it
2300        retains a one-to-one correspondence with the lines in the
2301        original diff. Defaults to disabled (no filtering).
2302
2303log.abbrevCommit::
2304        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2305        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2306        override this option with `--no-abbrev-commit`.
2307
2308log.date::
2309        Set the default date-time mode for the 'log' command.
2310        Setting a value for log.date is similar to using 'git log''s
2311        `--date` option.  See linkgit:git-log[1] for details.
2312
2313log.decorate::
2314        Print out the ref names of any commits that are shown by the log
2315        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2316        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2317        specified, the full ref name (including prefix) will be printed.
2318        If 'auto' is specified, then if the output is going to a terminal,
2319        the ref names are shown as if 'short' were given, otherwise no ref
2320        names are shown. This is the same as the `--decorate` option
2321        of the `git log`.
2322
2323log.follow::
2324        If `true`, `git log` will act as if the `--follow` option was used when
2325        a single <path> is given.  This has the same limitations as `--follow`,
2326        i.e. it cannot be used to follow multiple files and does not work well
2327        on non-linear history.
2328
2329log.graphColors::
2330        A list of colors, separated by commas, that can be used to draw
2331        history lines in `git log --graph`.
2332
2333log.showRoot::
2334        If true, the initial commit will be shown as a big creation event.
2335        This is equivalent to a diff against an empty tree.
2336        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2337        normally hide the root commit will now show it. True by default.
2338
2339log.showSignature::
2340        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2341        linkgit:git-whatchanged[1] assume `--show-signature`.
2342
2343log.mailmap::
2344        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2345        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2346
2347mailinfo.scissors::
2348        If true, makes linkgit:git-mailinfo[1] (and therefore
2349        linkgit:git-am[1]) act by default as if the --scissors option
2350        was provided on the command-line. When active, this features
2351        removes everything from the message body before a scissors
2352        line (i.e. consisting mainly of ">8", "8<" and "-").
2353
2354mailmap.file::
2355        The location of an augmenting mailmap file. The default
2356        mailmap, located in the root of the repository, is loaded
2357        first, then the mailmap file pointed to by this variable.
2358        The location of the mailmap file may be in a repository
2359        subdirectory, or somewhere outside of the repository itself.
2360        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2361
2362mailmap.blob::
2363        Like `mailmap.file`, but consider the value as a reference to a
2364        blob in the repository. If both `mailmap.file` and
2365        `mailmap.blob` are given, both are parsed, with entries from
2366        `mailmap.file` taking precedence. In a bare repository, this
2367        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2368        defaults to empty.
2369
2370man.viewer::
2371        Specify the programs that may be used to display help in the
2372        'man' format. See linkgit:git-help[1].
2373
2374man.<tool>.cmd::
2375        Specify the command to invoke the specified man viewer. The
2376        specified command is evaluated in shell with the man page
2377        passed as argument. (See linkgit:git-help[1].)
2378
2379man.<tool>.path::
2380        Override the path for the given tool that may be used to
2381        display help in the 'man' format. See linkgit:git-help[1].
2382
2383include::merge-config.txt[]
2384
2385mergetool.<tool>.path::
2386        Override the path for the given tool.  This is useful in case
2387        your tool is not in the PATH.
2388
2389mergetool.<tool>.cmd::
2390        Specify the command to invoke the specified merge tool.  The
2391        specified command is evaluated in shell with the following
2392        variables available: 'BASE' is the name of a temporary file
2393        containing the common base of the files to be merged, if available;
2394        'LOCAL' is the name of a temporary file containing the contents of
2395        the file on the current branch; 'REMOTE' is the name of a temporary
2396        file containing the contents of the file from the branch being
2397        merged; 'MERGED' contains the name of the file to which the merge
2398        tool should write the results of a successful merge.
2399
2400mergetool.<tool>.trustExitCode::
2401        For a custom merge command, specify whether the exit code of
2402        the merge command can be used to determine whether the merge was
2403        successful.  If this is not set to true then the merge target file
2404        timestamp is checked and the merge assumed to have been successful
2405        if the file has been updated, otherwise the user is prompted to
2406        indicate the success of the merge.
2407
2408mergetool.meld.hasOutput::
2409        Older versions of `meld` do not support the `--output` option.
2410        Git will attempt to detect whether `meld` supports `--output`
2411        by inspecting the output of `meld --help`.  Configuring
2412        `mergetool.meld.hasOutput` will make Git skip these checks and
2413        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2414        to `true` tells Git to unconditionally use the `--output` option,
2415        and `false` avoids using `--output`.
2416
2417mergetool.keepBackup::
2418        After performing a merge, the original file with conflict markers
2419        can be saved as a file with a `.orig` extension.  If this variable
2420        is set to `false` then this file is not preserved.  Defaults to
2421        `true` (i.e. keep the backup files).
2422
2423mergetool.keepTemporaries::
2424        When invoking a custom merge tool, Git uses a set of temporary
2425        files to pass to the tool. If the tool returns an error and this
2426        variable is set to `true`, then these temporary files will be
2427        preserved, otherwise they will be removed after the tool has
2428        exited. Defaults to `false`.
2429
2430mergetool.writeToTemp::
2431        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2432        conflicting files in the worktree by default.  Git will attempt
2433        to use a temporary directory for these files when set `true`.
2434        Defaults to `false`.
2435
2436mergetool.prompt::
2437        Prompt before each invocation of the merge resolution program.
2438
2439notes.mergeStrategy::
2440        Which merge strategy to choose by default when resolving notes
2441        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2442        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2443        section of linkgit:git-notes[1] for more information on each strategy.
2444
2445notes.<name>.mergeStrategy::
2446        Which merge strategy to choose when doing a notes merge into
2447        refs/notes/<name>.  This overrides the more general
2448        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2449        linkgit:git-notes[1] for more information on the available strategies.
2450
2451notes.displayRef::
2452        The (fully qualified) refname from which to show notes when
2453        showing commit messages.  The value of this variable can be set
2454        to a glob, in which case notes from all matching refs will be
2455        shown.  You may also specify this configuration variable
2456        several times.  A warning will be issued for refs that do not
2457        exist, but a glob that does not match any refs is silently
2458        ignored.
2459+
2460This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2461environment variable, which must be a colon separated list of refs or
2462globs.
2463+
2464The effective value of "core.notesRef" (possibly overridden by
2465GIT_NOTES_REF) is also implicitly added to the list of refs to be
2466displayed.
2467
2468notes.rewrite.<command>::
2469        When rewriting commits with <command> (currently `amend` or
2470        `rebase`) and this variable is set to `true`, Git
2471        automatically copies your notes from the original to the
2472        rewritten commit.  Defaults to `true`, but see
2473        "notes.rewriteRef" below.
2474
2475notes.rewriteMode::
2476        When copying notes during a rewrite (see the
2477        "notes.rewrite.<command>" option), determines what to do if
2478        the target commit already has a note.  Must be one of
2479        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2480        Defaults to `concatenate`.
2481+
2482This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2483environment variable.
2484
2485notes.rewriteRef::
2486        When copying notes during a rewrite, specifies the (fully
2487        qualified) ref whose notes should be copied.  The ref may be a
2488        glob, in which case notes in all matching refs will be copied.
2489        You may also specify this configuration several times.
2490+
2491Does not have a default value; you must configure this variable to
2492enable note rewriting.  Set it to `refs/notes/commits` to enable
2493rewriting for the default commit notes.
2494+
2495This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2496environment variable, which must be a colon separated list of refs or
2497globs.
2498
2499pack.window::
2500        The size of the window used by linkgit:git-pack-objects[1] when no
2501        window size is given on the command line. Defaults to 10.
2502
2503pack.depth::
2504        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2505        maximum depth is given on the command line. Defaults to 50.
2506        Maximum value is 4095.
2507
2508pack.windowMemory::
2509        The maximum size of memory that is consumed by each thread
2510        in linkgit:git-pack-objects[1] for pack window memory when
2511        no limit is given on the command line.  The value can be
2512        suffixed with "k", "m", or "g".  When left unconfigured (or
2513        set explicitly to 0), there will be no limit.
2514
2515pack.compression::
2516        An integer -1..9, indicating the compression level for objects
2517        in a pack file. -1 is the zlib default. 0 means no
2518        compression, and 1..9 are various speed/size tradeoffs, 9 being
2519        slowest.  If not set,  defaults to core.compression.  If that is
2520        not set,  defaults to -1, the zlib default, which is "a default
2521        compromise between speed and compression (currently equivalent
2522        to level 6)."
2523+
2524Note that changing the compression level will not automatically recompress
2525all existing objects. You can force recompression by passing the -F option
2526to linkgit:git-repack[1].
2527
2528pack.deltaCacheSize::
2529        The maximum memory in bytes used for caching deltas in
2530        linkgit:git-pack-objects[1] before writing them out to a pack.
2531        This cache is used to speed up the writing object phase by not
2532        having to recompute the final delta result once the best match
2533        for all objects is found.  Repacking large repositories on machines
2534        which are tight with memory might be badly impacted by this though,
2535        especially if this cache pushes the system into swapping.
2536        A value of 0 means no limit. The smallest size of 1 byte may be
2537        used to virtually disable this cache. Defaults to 256 MiB.
2538
2539pack.deltaCacheLimit::
2540        The maximum size of a delta, that is cached in
2541        linkgit:git-pack-objects[1]. This cache is used to speed up the
2542        writing object phase by not having to recompute the final delta
2543        result once the best match for all objects is found.
2544        Defaults to 1000. Maximum value is 65535.
2545
2546pack.threads::
2547        Specifies the number of threads to spawn when searching for best
2548        delta matches.  This requires that linkgit:git-pack-objects[1]
2549        be compiled with pthreads otherwise this option is ignored with a
2550        warning. This is meant to reduce packing time on multiprocessor
2551        machines. The required amount of memory for the delta search window
2552        is however multiplied by the number of threads.
2553        Specifying 0 will cause Git to auto-detect the number of CPU's
2554        and set the number of threads accordingly.
2555
2556pack.indexVersion::
2557        Specify the default pack index version.  Valid values are 1 for
2558        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2559        the new pack index with capabilities for packs larger than 4 GB
2560        as well as proper protection against the repacking of corrupted
2561        packs.  Version 2 is the default.  Note that version 2 is enforced
2562        and this config option ignored whenever the corresponding pack is
2563        larger than 2 GB.
2564+
2565If you have an old Git that does not understand the version 2 `*.idx` file,
2566cloning or fetching over a non native protocol (e.g. "http")
2567that will copy both `*.pack` file and corresponding `*.idx` file from the
2568other side may give you a repository that cannot be accessed with your
2569older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2570you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2571the `*.idx` file.
2572
2573pack.packSizeLimit::
2574        The maximum size of a pack.  This setting only affects
2575        packing to a file when repacking, i.e. the git:// protocol
2576        is unaffected.  It can be overridden by the `--max-pack-size`
2577        option of linkgit:git-repack[1].  Reaching this limit results
2578        in the creation of multiple packfiles; which in turn prevents
2579        bitmaps from being created.
2580        The minimum size allowed is limited to 1 MiB.
2581        The default is unlimited.
2582        Common unit suffixes of 'k', 'm', or 'g' are
2583        supported.
2584
2585pack.useBitmaps::
2586        When true, git will use pack bitmaps (if available) when packing
2587        to stdout (e.g., during the server side of a fetch). Defaults to
2588        true. You should not generally need to turn this off unless
2589        you are debugging pack bitmaps.
2590
2591pack.writeBitmaps (deprecated)::
2592        This is a deprecated synonym for `repack.writeBitmaps`.
2593
2594pack.writeBitmapHashCache::
2595        When true, git will include a "hash cache" section in the bitmap
2596        index (if one is written). This cache can be used to feed git's
2597        delta heuristics, potentially leading to better deltas between
2598        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2599        between an older, bitmapped pack and objects that have been
2600        pushed since the last gc). The downside is that it consumes 4
2601        bytes per object of disk space, and that JGit's bitmap
2602        implementation does not understand it, causing it to complain if
2603        Git and JGit are used on the same repository. Defaults to false.
2604
2605pager.<cmd>::
2606        If the value is boolean, turns on or off pagination of the
2607        output of a particular Git subcommand when writing to a tty.
2608        Otherwise, turns on pagination for the subcommand using the
2609        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2610        or `--no-pager` is specified on the command line, it takes
2611        precedence over this option.  To disable pagination for all
2612        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2613
2614pretty.<name>::
2615        Alias for a --pretty= format string, as specified in
2616        linkgit:git-log[1]. Any aliases defined here can be used just
2617        as the built-in pretty formats could. For example,
2618        running `git config pretty.changelog "format:* %H %s"`
2619        would cause the invocation `git log --pretty=changelog`
2620        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2621        Note that an alias with the same name as a built-in format
2622        will be silently ignored.
2623
2624protocol.allow::
2625        If set, provide a user defined default policy for all protocols which
2626        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2627        if unset, known-safe protocols (http, https, git, ssh, file) have a
2628        default policy of `always`, known-dangerous protocols (ext) have a
2629        default policy of `never`, and all other protocols have a default
2630        policy of `user`.  Supported policies:
2631+
2632--
2633
2634* `always` - protocol is always able to be used.
2635
2636* `never` - protocol is never able to be used.
2637
2638* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2639  either unset or has a value of 1.  This policy should be used when you want a
2640  protocol to be directly usable by the user but don't want it used by commands which
2641  execute clone/fetch/push commands without user input, e.g. recursive
2642  submodule initialization.
2643
2644--
2645
2646protocol.<name>.allow::
2647        Set a policy to be used by protocol `<name>` with clone/fetch/push
2648        commands. See `protocol.allow` above for the available policies.
2649+
2650The protocol names currently used by git are:
2651+
2652--
2653  - `file`: any local file-based path (including `file://` URLs,
2654    or local paths)
2655
2656  - `git`: the anonymous git protocol over a direct TCP
2657    connection (or proxy, if configured)
2658
2659  - `ssh`: git over ssh (including `host:path` syntax,
2660    `ssh://`, etc).
2661
2662  - `http`: git over http, both "smart http" and "dumb http".
2663    Note that this does _not_ include `https`; if you want to configure
2664    both, you must do so individually.
2665
2666  - any external helpers are named by their protocol (e.g., use
2667    `hg` to allow the `git-remote-hg` helper)
2668--
2669
2670protocol.version::
2671        Experimental. If set, clients will attempt to communicate with a
2672        server using the specified protocol version.  If unset, no
2673        attempt will be made by the client to communicate using a
2674        particular protocol version, this results in protocol version 0
2675        being used.
2676        Supported versions:
2677+
2678--
2679
2680* `0` - the original wire protocol.
2681
2682* `1` - the original wire protocol with the addition of a version string
2683  in the initial response from the server.
2684
2685--
2686
2687pull.ff::
2688        By default, Git does not create an extra merge commit when merging
2689        a commit that is a descendant of the current commit. Instead, the
2690        tip of the current branch is fast-forwarded. When set to `false`,
2691        this variable tells Git to create an extra merge commit in such
2692        a case (equivalent to giving the `--no-ff` option from the command
2693        line). When set to `only`, only such fast-forward merges are
2694        allowed (equivalent to giving the `--ff-only` option from the
2695        command line). This setting overrides `merge.ff` when pulling.
2696
2697pull.rebase::
2698        When true, rebase branches on top of the fetched branch, instead
2699        of merging the default branch from the default remote when "git
2700        pull" is run. See "branch.<name>.rebase" for setting this on a
2701        per-branch basis.
2702+
2703When `merges`, pass the `--rebase-merges` option to 'git rebase'
2704so that the local merge commits are included in the rebase (see
2705linkgit:git-rebase[1] for details).
2706+
2707When preserve, also pass `--preserve-merges` along to 'git rebase'
2708so that locally committed merge commits will not be flattened
2709by running 'git pull'.
2710+
2711When the value is `interactive`, the rebase is run in interactive mode.
2712+
2713*NOTE*: this is a possibly dangerous operation; do *not* use
2714it unless you understand the implications (see linkgit:git-rebase[1]
2715for details).
2716
2717pull.octopus::
2718        The default merge strategy to use when pulling multiple branches
2719        at once.
2720
2721pull.twohead::
2722        The default merge strategy to use when pulling a single branch.
2723
2724push.default::
2725        Defines the action `git push` should take if no refspec is
2726        explicitly given.  Different values are well-suited for
2727        specific workflows; for instance, in a purely central workflow
2728        (i.e. the fetch source is equal to the push destination),
2729        `upstream` is probably what you want.  Possible values are:
2730+
2731--
2732
2733* `nothing` - do not push anything (error out) unless a refspec is
2734  explicitly given. This is primarily meant for people who want to
2735  avoid mistakes by always being explicit.
2736
2737* `current` - push the current branch to update a branch with the same
2738  name on the receiving end.  Works in both central and non-central
2739  workflows.
2740
2741* `upstream` - push the current branch back to the branch whose
2742  changes are usually integrated into the current branch (which is
2743  called `@{upstream}`).  This mode only makes sense if you are
2744  pushing to the same repository you would normally pull from
2745  (i.e. central workflow).
2746
2747* `tracking` - This is a deprecated synonym for `upstream`.
2748
2749* `simple` - in centralized workflow, work like `upstream` with an
2750  added safety to refuse to push if the upstream branch's name is
2751  different from the local one.
2752+
2753When pushing to a remote that is different from the remote you normally
2754pull from, work as `current`.  This is the safest option and is suited
2755for beginners.
2756+
2757This mode has become the default in Git 2.0.
2758
2759* `matching` - push all branches having the same name on both ends.
2760  This makes the repository you are pushing to remember the set of
2761  branches that will be pushed out (e.g. if you always push 'maint'
2762  and 'master' there and no other branches, the repository you push
2763  to will have these two branches, and your local 'maint' and
2764  'master' will be pushed there).
2765+
2766To use this mode effectively, you have to make sure _all_ the
2767branches you would push out are ready to be pushed out before
2768running 'git push', as the whole point of this mode is to allow you
2769to push all of the branches in one go.  If you usually finish work
2770on only one branch and push out the result, while other branches are
2771unfinished, this mode is not for you.  Also this mode is not
2772suitable for pushing into a shared central repository, as other
2773people may add new branches there, or update the tip of existing
2774branches outside your control.
2775+
2776This used to be the default, but not since Git 2.0 (`simple` is the
2777new default).
2778
2779--
2780
2781push.followTags::
2782        If set to true enable `--follow-tags` option by default.  You
2783        may override this configuration at time of push by specifying
2784        `--no-follow-tags`.
2785
2786push.gpgSign::
2787        May be set to a boolean value, or the string 'if-asked'. A true
2788        value causes all pushes to be GPG signed, as if `--signed` is
2789        passed to linkgit:git-push[1]. The string 'if-asked' causes
2790        pushes to be signed if the server supports it, as if
2791        `--signed=if-asked` is passed to 'git push'. A false value may
2792        override a value from a lower-priority config file. An explicit
2793        command-line flag always overrides this config option.
2794
2795push.pushOption::
2796        When no `--push-option=<option>` argument is given from the
2797        command line, `git push` behaves as if each <value> of
2798        this variable is given as `--push-option=<value>`.
2799+
2800This is a multi-valued variable, and an empty value can be used in a
2801higher priority configuration file (e.g. `.git/config` in a
2802repository) to clear the values inherited from a lower priority
2803configuration files (e.g. `$HOME/.gitconfig`).
2804+
2805--
2806
2807Example:
2808
2809/etc/gitconfig
2810  push.pushoption = a
2811  push.pushoption = b
2812
2813~/.gitconfig
2814  push.pushoption = c
2815
2816repo/.git/config
2817  push.pushoption =
2818  push.pushoption = b
2819
2820This will result in only b (a and c are cleared).
2821
2822--
2823
2824push.recurseSubmodules::
2825        Make sure all submodule commits used by the revisions to be pushed
2826        are available on a remote-tracking branch. If the value is 'check'
2827        then Git will verify that all submodule commits that changed in the
2828        revisions to be pushed are available on at least one remote of the
2829        submodule. If any commits are missing, the push will be aborted and
2830        exit with non-zero status. If the value is 'on-demand' then all
2831        submodules that changed in the revisions to be pushed will be
2832        pushed. If on-demand was not able to push all necessary revisions
2833        it will also be aborted and exit with non-zero status. If the value
2834        is 'no' then default behavior of ignoring submodules when pushing
2835        is retained. You may override this configuration at time of push by
2836        specifying '--recurse-submodules=check|on-demand|no'.
2837
2838include::rebase-config.txt[]
2839
2840receive.advertiseAtomic::
2841        By default, git-receive-pack will advertise the atomic push
2842        capability to its clients. If you don't want to advertise this
2843        capability, set this variable to false.
2844
2845receive.advertisePushOptions::
2846        When set to true, git-receive-pack will advertise the push options
2847        capability to its clients. False by default.
2848
2849receive.autogc::
2850        By default, git-receive-pack will run "git-gc --auto" after
2851        receiving data from git-push and updating refs.  You can stop
2852        it by setting this variable to false.
2853
2854receive.certNonceSeed::
2855        By setting this variable to a string, `git receive-pack`
2856        will accept a `git push --signed` and verifies it by using
2857        a "nonce" protected by HMAC using this string as a secret
2858        key.
2859
2860receive.certNonceSlop::
2861        When a `git push --signed` sent a push certificate with a
2862        "nonce" that was issued by a receive-pack serving the same
2863        repository within this many seconds, export the "nonce"
2864        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2865        hooks (instead of what the receive-pack asked the sending
2866        side to include).  This may allow writing checks in
2867        `pre-receive` and `post-receive` a bit easier.  Instead of
2868        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2869        that records by how many seconds the nonce is stale to
2870        decide if they want to accept the certificate, they only
2871        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2872
2873receive.fsckObjects::
2874        If it is set to true, git-receive-pack will check all received
2875        objects. It will abort in the case of a malformed object or a
2876        broken link. The result of an abort are only dangling objects.
2877        Defaults to false. If not set, the value of `transfer.fsckObjects`
2878        is used instead.
2879
2880receive.fsck.<msg-id>::
2881        When `receive.fsckObjects` is set to true, errors can be switched
2882        to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2883        setting where the `<msg-id>` is the fsck message ID and the value
2884        is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2885        the error/warning with the message ID, e.g. "missingEmail: invalid
2886        author/committer line - missing email" means that setting
2887        `receive.fsck.missingEmail = ignore` will hide that issue.
2888+
2889This feature is intended to support working with legacy repositories
2890which would not pass pushing when `receive.fsckObjects = true`, allowing
2891the host to accept repositories with certain known issues but still catch
2892other issues.
2893
2894receive.fsck.skipList::
2895        The path to a sorted list of object names (i.e. one SHA-1 per
2896        line) that are known to be broken in a non-fatal way and should
2897        be ignored. This feature is useful when an established project
2898        should be accepted despite early commits containing errors that
2899        can be safely ignored such as invalid committer email addresses.
2900        Note: corrupt objects cannot be skipped with this setting.
2901
2902receive.keepAlive::
2903        After receiving the pack from the client, `receive-pack` may
2904        produce no output (if `--quiet` was specified) while processing
2905        the pack, causing some networks to drop the TCP connection.
2906        With this option set, if `receive-pack` does not transmit
2907        any data in this phase for `receive.keepAlive` seconds, it will
2908        send a short keepalive packet.  The default is 5 seconds; set
2909        to 0 to disable keepalives entirely.
2910
2911receive.unpackLimit::
2912        If the number of objects received in a push is below this
2913        limit then the objects will be unpacked into loose object
2914        files. However if the number of received objects equals or
2915        exceeds this limit then the received pack will be stored as
2916        a pack, after adding any missing delta bases.  Storing the
2917        pack from a push can make the push operation complete faster,
2918        especially on slow filesystems.  If not set, the value of
2919        `transfer.unpackLimit` is used instead.
2920
2921receive.maxInputSize::
2922        If the size of the incoming pack stream is larger than this
2923        limit, then git-receive-pack will error out, instead of
2924        accepting the pack file. If not set or set to 0, then the size
2925        is unlimited.
2926
2927receive.denyDeletes::
2928        If set to true, git-receive-pack will deny a ref update that deletes
2929        the ref. Use this to prevent such a ref deletion via a push.
2930
2931receive.denyDeleteCurrent::
2932        If set to true, git-receive-pack will deny a ref update that
2933        deletes the currently checked out branch of a non-bare repository.
2934
2935receive.denyCurrentBranch::
2936        If set to true or "refuse", git-receive-pack will deny a ref update
2937        to the currently checked out branch of a non-bare repository.
2938        Such a push is potentially dangerous because it brings the HEAD
2939        out of sync with the index and working tree. If set to "warn",
2940        print a warning of such a push to stderr, but allow the push to
2941        proceed. If set to false or "ignore", allow such pushes with no
2942        message. Defaults to "refuse".
2943+
2944Another option is "updateInstead" which will update the working
2945tree if pushing into the current branch.  This option is
2946intended for synchronizing working directories when one side is not easily
2947accessible via interactive ssh (e.g. a live web site, hence the requirement
2948that the working directory be clean). This mode also comes in handy when
2949developing inside a VM to test and fix code on different Operating Systems.
2950+
2951By default, "updateInstead" will refuse the push if the working tree or
2952the index have any difference from the HEAD, but the `push-to-checkout`
2953hook can be used to customize this.  See linkgit:githooks[5].
2954
2955receive.denyNonFastForwards::
2956        If set to true, git-receive-pack will deny a ref update which is
2957        not a fast-forward. Use this to prevent such an update via a push,
2958        even if that push is forced. This configuration variable is
2959        set when initializing a shared repository.
2960
2961receive.hideRefs::
2962        This variable is the same as `transfer.hideRefs`, but applies
2963        only to `receive-pack` (and so affects pushes, but not fetches).
2964        An attempt to update or delete a hidden ref by `git push` is
2965        rejected.
2966
2967receive.updateServerInfo::
2968        If set to true, git-receive-pack will run git-update-server-info
2969        after receiving data from git-push and updating refs.
2970
2971receive.shallowUpdate::
2972        If set to true, .git/shallow can be updated when new refs
2973        require new shallow roots. Otherwise those refs are rejected.
2974
2975remote.pushDefault::
2976        The remote to push to by default.  Overrides
2977        `branch.<name>.remote` for all branches, and is overridden by
2978        `branch.<name>.pushRemote` for specific branches.
2979
2980remote.<name>.url::
2981        The URL of a remote repository.  See linkgit:git-fetch[1] or
2982        linkgit:git-push[1].
2983
2984remote.<name>.pushurl::
2985        The push URL of a remote repository.  See linkgit:git-push[1].
2986
2987remote.<name>.proxy::
2988        For remotes that require curl (http, https and ftp), the URL to
2989        the proxy to use for that remote.  Set to the empty string to
2990        disable proxying for that remote.
2991
2992remote.<name>.proxyAuthMethod::
2993        For remotes that require curl (http, https and ftp), the method to use for
2994        authenticating against the proxy in use (probably set in
2995        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2996
2997remote.<name>.fetch::
2998        The default set of "refspec" for linkgit:git-fetch[1]. See
2999        linkgit:git-fetch[1].
3000
3001remote.<name>.push::
3002        The default set of "refspec" for linkgit:git-push[1]. See
3003        linkgit:git-push[1].
3004
3005remote.<name>.mirror::
3006        If true, pushing to this remote will automatically behave
3007        as if the `--mirror` option was given on the command line.
3008
3009remote.<name>.skipDefaultUpdate::
3010        If true, this remote will be skipped by default when updating
3011        using linkgit:git-fetch[1] or the `update` subcommand of
3012        linkgit:git-remote[1].
3013
3014remote.<name>.skipFetchAll::
3015        If true, this remote will be skipped by default when updating
3016        using linkgit:git-fetch[1] or the `update` subcommand of
3017        linkgit:git-remote[1].
3018
3019remote.<name>.receivepack::
3020        The default program to execute on the remote side when pushing.  See
3021        option --receive-pack of linkgit:git-push[1].
3022
3023remote.<name>.uploadpack::
3024        The default program to execute on the remote side when fetching.  See
3025        option --upload-pack of linkgit:git-fetch-pack[1].
3026
3027remote.<name>.tagOpt::
3028        Setting this value to --no-tags disables automatic tag following when
3029        fetching from remote <name>. Setting it to --tags will fetch every
3030        tag from remote <name>, even if they are not reachable from remote
3031        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3032        override this setting. See options --tags and --no-tags of
3033        linkgit:git-fetch[1].
3034
3035remote.<name>.vcs::
3036        Setting this to a value <vcs> will cause Git to interact with
3037        the remote with the git-remote-<vcs> helper.
3038
3039remote.<name>.prune::
3040        When set to true, fetching from this remote by default will also
3041        remove any remote-tracking references that no longer exist on the
3042        remote (as if the `--prune` option was given on the command line).
3043        Overrides `fetch.prune` settings, if any.
3044
3045remote.<name>.pruneTags::
3046        When set to true, fetching from this remote by default will also
3047        remove any local tags that no longer exist on the remote if pruning
3048        is activated in general via `remote.<name>.prune`, `fetch.prune` or
3049        `--prune`. Overrides `fetch.pruneTags` settings, if any.
3050+
3051See also `remote.<name>.prune` and the PRUNING section of
3052linkgit:git-fetch[1].
3053
3054remotes.<group>::
3055        The list of remotes which are fetched by "git remote update
3056        <group>".  See linkgit:git-remote[1].
3057
3058repack.useDeltaBaseOffset::
3059        By default, linkgit:git-repack[1] creates packs that use
3060        delta-base offset. If you need to share your repository with
3061        Git older than version 1.4.4, either directly or via a dumb
3062        protocol such as http, then you need to set this option to
3063        "false" and repack. Access from old Git versions over the
3064        native protocol are unaffected by this option.
3065
3066repack.packKeptObjects::
3067        If set to true, makes `git repack` act as if
3068        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3069        details. Defaults to `false` normally, but `true` if a bitmap
3070        index is being written (either via `--write-bitmap-index` or
3071        `repack.writeBitmaps`).
3072
3073repack.writeBitmaps::
3074        When true, git will write a bitmap index when packing all
3075        objects to disk (e.g., when `git repack -a` is run).  This
3076        index can speed up the "counting objects" phase of subsequent
3077        packs created for clones and fetches, at the cost of some disk
3078        space and extra time spent on the initial repack.  This has
3079        no effect if multiple packfiles are created.
3080        Defaults to false.
3081
3082rerere.autoUpdate::
3083        When set to true, `git-rerere` updates the index with the
3084        resulting contents after it cleanly resolves conflicts using
3085        previously recorded resolution.  Defaults to false.
3086
3087rerere.enabled::
3088        Activate recording of resolved conflicts, so that identical
3089        conflict hunks can be resolved automatically, should they be
3090        encountered again.  By default, linkgit:git-rerere[1] is
3091        enabled if there is an `rr-cache` directory under the
3092        `$GIT_DIR`, e.g. if "rerere" was previously used in the
3093        repository.
3094
3095sendemail.identity::
3096        A configuration identity. When given, causes values in the
3097        'sendemail.<identity>' subsection to take precedence over
3098        values in the 'sendemail' section. The default identity is
3099        the value of `sendemail.identity`.
3100
3101sendemail.smtpEncryption::
3102        See linkgit:git-send-email[1] for description.  Note that this
3103        setting is not subject to the 'identity' mechanism.
3104
3105sendemail.smtpssl (deprecated)::
3106        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3107
3108sendemail.smtpsslcertpath::
3109        Path to ca-certificates (either a directory or a single file).
3110        Set it to an empty string to disable certificate verification.
3111
3112sendemail.<identity>.*::
3113        Identity-specific versions of the 'sendemail.*' parameters
3114        found below, taking precedence over those when this
3115        identity is selected, through either the command-line or
3116        `sendemail.identity`.
3117
3118sendemail.aliasesFile::
3119sendemail.aliasFileType::
3120sendemail.annotate::
3121sendemail.bcc::
3122sendemail.cc::
3123sendemail.ccCmd::
3124sendemail.chainReplyTo::
3125sendemail.confirm::
3126sendemail.envelopeSender::
3127sendemail.from::
3128sendemail.multiEdit::
3129sendemail.signedoffbycc::
3130sendemail.smtpPass::
3131sendemail.suppresscc::
3132sendemail.suppressFrom::
3133sendemail.to::
3134sendemail.tocmd::
3135sendemail.smtpDomain::
3136sendemail.smtpServer::
3137sendemail.smtpServerPort::
3138sendemail.smtpServerOption::
3139sendemail.smtpUser::
3140sendemail.thread::
3141sendemail.transferEncoding::
3142sendemail.validate::
3143sendemail.xmailer::
3144        See linkgit:git-send-email[1] for description.
3145
3146sendemail.signedoffcc (deprecated)::
3147        Deprecated alias for `sendemail.signedoffbycc`.
3148
3149sendemail.smtpBatchSize::
3150        Number of messages to be sent per connection, after that a relogin
3151        will happen.  If the value is 0 or undefined, send all messages in
3152        one connection.
3153        See also the `--batch-size` option of linkgit:git-send-email[1].
3154
3155sendemail.smtpReloginDelay::
3156        Seconds wait before reconnecting to smtp server.
3157        See also the `--relogin-delay` option of linkgit:git-send-email[1].
3158
3159showbranch.default::
3160        The default set of branches for linkgit:git-show-branch[1].
3161        See linkgit:git-show-branch[1].
3162
3163splitIndex.maxPercentChange::
3164        When the split index feature is used, this specifies the
3165        percent of entries the split index can contain compared to the
3166        total number of entries in both the split index and the shared
3167        index before a new shared index is written.
3168        The value should be between 0 and 100. If the value is 0 then
3169        a new shared index is always written, if it is 100 a new
3170        shared index is never written.
3171        By default the value is 20, so a new shared index is written
3172        if the number of entries in the split index would be greater
3173        than 20 percent of the total number of entries.
3174        See linkgit:git-update-index[1].
3175
3176splitIndex.sharedIndexExpire::
3177        When the split index feature is used, shared index files that
3178        were not modified since the time this variable specifies will
3179        be removed when a new shared index file is created. The value
3180        "now" expires all entries immediately, and "never" suppresses
3181        expiration altogether.
3182        The default value is "2.weeks.ago".
3183        Note that a shared index file is considered modified (for the
3184        purpose of expiration) each time a new split-index file is
3185        either created based on it or read from it.
3186        See linkgit:git-update-index[1].
3187
3188status.relativePaths::
3189        By default, linkgit:git-status[1] shows paths relative to the
3190        current directory. Setting this variable to `false` shows paths
3191        relative to the repository root (this was the default for Git
3192        prior to v1.5.4).
3193
3194status.short::
3195        Set to true to enable --short by default in linkgit:git-status[1].
3196        The option --no-short takes precedence over this variable.
3197
3198status.branch::
3199        Set to true to enable --branch by default in linkgit:git-status[1].
3200        The option --no-branch takes precedence over this variable.
3201
3202status.displayCommentPrefix::
3203        If set to true, linkgit:git-status[1] will insert a comment
3204        prefix before each output line (starting with
3205        `core.commentChar`, i.e. `#` by default). This was the
3206        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3207        Defaults to false.
3208
3209status.renameLimit::
3210        The number of files to consider when performing rename detection
3211        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3212        the value of diff.renameLimit.
3213
3214status.renames::
3215        Whether and how Git detects renames in linkgit:git-status[1] and
3216        linkgit:git-commit[1] .  If set to "false", rename detection is
3217        disabled. If set to "true", basic rename detection is enabled.
3218        If set to "copies" or "copy", Git will detect copies, as well.
3219        Defaults to the value of diff.renames.
3220
3221status.showStash::
3222        If set to true, linkgit:git-status[1] will display the number of
3223        entries currently stashed away.
3224        Defaults to false.
3225
3226status.showUntrackedFiles::
3227        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3228        files which are not currently tracked by Git. Directories which
3229        contain only untracked files, are shown with the directory name
3230        only. Showing untracked files means that Git needs to lstat() all
3231        the files in the whole repository, which might be slow on some
3232        systems. So, this variable controls how the commands displays
3233        the untracked files. Possible values are:
3234+
3235--
3236* `no` - Show no untracked files.
3237* `normal` - Show untracked files and directories.
3238* `all` - Show also individual files in untracked directories.
3239--
3240+
3241If this variable is not specified, it defaults to 'normal'.
3242This variable can be overridden with the -u|--untracked-files option
3243of linkgit:git-status[1] and linkgit:git-commit[1].
3244
3245status.submoduleSummary::
3246        Defaults to false.
3247        If this is set to a non zero number or true (identical to -1 or an
3248        unlimited number), the submodule summary will be enabled and a
3249        summary of commits for modified submodules will be shown (see
3250        --summary-limit option of linkgit:git-submodule[1]). Please note
3251        that the summary output command will be suppressed for all
3252        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3253        for those submodules where `submodule.<name>.ignore=all`. The only
3254        exception to that rule is that status and commit will show staged
3255        submodule changes. To
3256        also view the summary for ignored submodules you can either use
3257        the --ignore-submodules=dirty command-line option or the 'git
3258        submodule summary' command, which shows a similar output but does
3259        not honor these settings.
3260
3261stash.showPatch::
3262        If this is set to true, the `git stash show` command without an
3263        option will show the stash entry in patch form.  Defaults to false.
3264        See description of 'show' command in linkgit:git-stash[1].
3265
3266stash.showStat::
3267        If this is set to true, the `git stash show` command without an
3268        option will show diffstat of the stash entry.  Defaults to true.
3269        See description of 'show' command in linkgit:git-stash[1].
3270
3271submodule.<name>.url::
3272        The URL for a submodule. This variable is copied from the .gitmodules
3273        file to the git config via 'git submodule init'. The user can change
3274        the configured URL before obtaining the submodule via 'git submodule
3275        update'. If neither submodule.<name>.active or submodule.active are
3276        set, the presence of this variable is used as a fallback to indicate
3277        whether the submodule is of interest to git commands.
3278        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3279
3280submodule.<name>.update::
3281        The method by which a submodule is updated by 'git submodule update',
3282        which is the only affected command, others such as
3283        'git checkout --recurse-submodules' are unaffected. It exists for
3284        historical reasons, when 'git submodule' was the only command to
3285        interact with submodules; settings like `submodule.active`
3286        and `pull.rebase` are more specific. It is populated by
3287        `git submodule init` from the linkgit:gitmodules[5] file.
3288        See description of 'update' command in linkgit:git-submodule[1].
3289
3290submodule.<name>.branch::
3291        The remote branch name for a submodule, used by `git submodule
3292        update --remote`.  Set this option to override the value found in
3293        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3294        linkgit:gitmodules[5] for details.
3295
3296submodule.<name>.fetchRecurseSubmodules::
3297        This option can be used to control recursive fetching of this
3298        submodule. It can be overridden by using the --[no-]recurse-submodules
3299        command-line option to "git fetch" and "git pull".
3300        This setting will override that from in the linkgit:gitmodules[5]
3301        file.
3302
3303submodule.<name>.ignore::
3304        Defines under what circumstances "git status" and the diff family show
3305        a submodule as modified. When set to "all", it will never be considered
3306        modified (but it will nonetheless show up in the output of status and
3307        commit when it has been staged), "dirty" will ignore all changes
3308        to the submodules work tree and
3309        takes only differences between the HEAD of the submodule and the commit
3310        recorded in the superproject into account. "untracked" will additionally
3311        let submodules with modified tracked files in their work tree show up.
3312        Using "none" (the default when this option is not set) also shows
3313        submodules that have untracked files in their work tree as changed.
3314        This setting overrides any setting made in .gitmodules for this submodule,
3315        both settings can be overridden on the command line by using the
3316        "--ignore-submodules" option. The 'git submodule' commands are not
3317        affected by this setting.
3318
3319submodule.<name>.active::
3320        Boolean value indicating if the submodule is of interest to git
3321        commands.  This config option takes precedence over the
3322        submodule.active config option.
3323
3324submodule.active::
3325        A repeated field which contains a pathspec used to match against a
3326        submodule's path to determine if the submodule is of interest to git
3327        commands.
3328
3329submodule.recurse::
3330        Specifies if commands recurse into submodules by default. This
3331        applies to all commands that have a `--recurse-submodules` option,
3332        except `clone`.
3333        Defaults to false.
3334
3335submodule.fetchJobs::
3336        Specifies how many submodules are fetched/cloned at the same time.
3337        A positive integer allows up to that number of submodules fetched
3338        in parallel. A value of 0 will give some reasonable default.
3339        If unset, it defaults to 1.
3340
3341submodule.alternateLocation::
3342        Specifies how the submodules obtain alternates when submodules are
3343        cloned. Possible values are `no`, `superproject`.
3344        By default `no` is assumed, which doesn't add references. When the
3345        value is set to `superproject` the submodule to be cloned computes
3346        its alternates location relative to the superprojects alternate.
3347
3348submodule.alternateErrorStrategy::
3349        Specifies how to treat errors with the alternates for a submodule
3350        as computed via `submodule.alternateLocation`. Possible values are
3351        `ignore`, `info`, `die`. Default is `die`.
3352
3353tag.forceSignAnnotated::
3354        A boolean to specify whether annotated tags created should be GPG signed.
3355        If `--annotate` is specified on the command line, it takes
3356        precedence over this option.
3357
3358tag.sort::
3359        This variable controls the sort ordering of tags when displayed by
3360        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3361        value of this variable will be used as the default.
3362
3363tar.umask::
3364        This variable can be used to restrict the permission bits of
3365        tar archive entries.  The default is 0002, which turns off the
3366        world write bit.  The special value "user" indicates that the
3367        archiving user's umask will be used instead.  See umask(2) and
3368        linkgit:git-archive[1].
3369
3370transfer.fsckObjects::
3371        When `fetch.fsckObjects` or `receive.fsckObjects` are
3372        not set, the value of this variable is used instead.
3373        Defaults to false.
3374
3375transfer.hideRefs::
3376        String(s) `receive-pack` and `upload-pack` use to decide which
3377        refs to omit from their initial advertisements.  Use more than
3378        one definition to specify multiple prefix strings. A ref that is
3379        under the hierarchies listed in the value of this variable is
3380        excluded, and is hidden when responding to `git push` or `git
3381        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3382        program-specific versions of this config.
3383+
3384You may also include a `!` in front of the ref name to negate the entry,
3385explicitly exposing it, even if an earlier entry marked it as hidden.
3386If you have multiple hideRefs values, later entries override earlier ones
3387(and entries in more-specific config files override less-specific ones).
3388+
3389If a namespace is in use, the namespace prefix is stripped from each
3390reference before it is matched against `transfer.hiderefs` patterns.
3391For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3392the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3393is omitted from the advertisements but `refs/heads/master` and
3394`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3395"have" lines. In order to match refs before stripping, add a `^` in front of
3396the ref name. If you combine `!` and `^`, `!` must be specified first.
3397+
3398Even if you hide refs, a client may still be able to steal the target
3399objects via the techniques described in the "SECURITY" section of the
3400linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3401separate repository.
3402
3403transfer.unpackLimit::
3404        When `fetch.unpackLimit` or `receive.unpackLimit` are
3405        not set, the value of this variable is used instead.
3406        The default value is 100.
3407
3408uploadarchive.allowUnreachable::
3409        If true, allow clients to use `git archive --remote` to request
3410        any tree, whether reachable from the ref tips or not. See the
3411        discussion in the "SECURITY" section of
3412        linkgit:git-upload-archive[1] for more details. Defaults to
3413        `false`.
3414
3415uploadpack.hideRefs::
3416        This variable is the same as `transfer.hideRefs`, but applies
3417        only to `upload-pack` (and so affects only fetches, not pushes).
3418        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3419        also `uploadpack.allowTipSHA1InWant`.
3420
3421uploadpack.allowTipSHA1InWant::
3422        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3423        to accept a fetch request that asks for an object at the tip
3424        of a hidden ref (by default, such a request is rejected).
3425        See also `uploadpack.hideRefs`.  Even if this is false, a client
3426        may be able to steal objects via the techniques described in the
3427        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3428        best to keep private data in a separate repository.
3429
3430uploadpack.allowReachableSHA1InWant::
3431        Allow `upload-pack` to accept a fetch request that asks for an
3432        object that is reachable from any ref tip. However, note that
3433        calculating object reachability is computationally expensive.
3434        Defaults to `false`.  Even if this is false, a client may be able
3435        to steal objects via the techniques described in the "SECURITY"
3436        section of the linkgit:gitnamespaces[7] man page; it's best to
3437        keep private data in a separate repository.
3438
3439uploadpack.allowAnySHA1InWant::
3440        Allow `upload-pack` to accept a fetch request that asks for any
3441        object at all.
3442        Defaults to `false`.
3443
3444uploadpack.keepAlive::
3445        When `upload-pack` has started `pack-objects`, there may be a
3446        quiet period while `pack-objects` prepares the pack. Normally
3447        it would output progress information, but if `--quiet` was used
3448        for the fetch, `pack-objects` will output nothing at all until
3449        the pack data begins. Some clients and networks may consider
3450        the server to be hung and give up. Setting this option instructs
3451        `upload-pack` to send an empty keepalive packet every
3452        `uploadpack.keepAlive` seconds. Setting this option to 0
3453        disables keepalive packets entirely. The default is 5 seconds.
3454
3455uploadpack.packObjectsHook::
3456        If this option is set, when `upload-pack` would run
3457        `git pack-objects` to create a packfile for a client, it will
3458        run this shell command instead.  The `pack-objects` command and
3459        arguments it _would_ have run (including the `git pack-objects`
3460        at the beginning) are appended to the shell command. The stdin
3461        and stdout of the hook are treated as if `pack-objects` itself
3462        was run. I.e., `upload-pack` will feed input intended for
3463        `pack-objects` to the hook, and expects a completed packfile on
3464        stdout.
3465
3466uploadpack.allowFilter::
3467        If this option is set, `upload-pack` will support partial
3468        clone and partial fetch object filtering.
3469+
3470Note that this configuration variable is ignored if it is seen in the
3471repository-level config (this is a safety measure against fetching from
3472untrusted repositories).
3473
3474url.<base>.insteadOf::
3475        Any URL that starts with this value will be rewritten to
3476        start, instead, with <base>. In cases where some site serves a
3477        large number of repositories, and serves them with multiple
3478        access methods, and some users need to use different access
3479        methods, this feature allows people to specify any of the
3480        equivalent URLs and have Git automatically rewrite the URL to
3481        the best alternative for the particular user, even for a
3482        never-before-seen repository on the site.  When more than one
3483        insteadOf strings match a given URL, the longest match is used.
3484+
3485Note that any protocol restrictions will be applied to the rewritten
3486URL. If the rewrite changes the URL to use a custom protocol or remote
3487helper, you may need to adjust the `protocol.*.allow` config to permit
3488the request.  In particular, protocols you expect to use for submodules
3489must be set to `always` rather than the default of `user`. See the
3490description of `protocol.allow` above.
3491
3492url.<base>.pushInsteadOf::
3493        Any URL that starts with this value will not be pushed to;
3494        instead, it will be rewritten to start with <base>, and the
3495        resulting URL will be pushed to. In cases where some site serves
3496        a large number of repositories, and serves them with multiple
3497        access methods, some of which do not allow push, this feature
3498        allows people to specify a pull-only URL and have Git
3499        automatically use an appropriate URL to push, even for a
3500        never-before-seen repository on the site.  When more than one
3501        pushInsteadOf strings match a given URL, the longest match is
3502        used.  If a remote has an explicit pushurl, Git will ignore this
3503        setting for that remote.
3504
3505user.email::
3506        Your email address to be recorded in any newly created commits.
3507        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3508        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3509
3510user.name::
3511        Your full name to be recorded in any newly created commits.
3512        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3513        environment variables.  See linkgit:git-commit-tree[1].
3514
3515user.useConfigOnly::
3516        Instruct Git to avoid trying to guess defaults for `user.email`
3517        and `user.name`, and instead retrieve the values only from the
3518        configuration. For example, if you have multiple email addresses
3519        and would like to use a different one for each repository, then
3520        with this configuration option set to `true` in the global config
3521        along with a name, Git will prompt you to set up an email before
3522        making new commits in a newly cloned repository.
3523        Defaults to `false`.
3524
3525user.signingKey::
3526        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3527        key you want it to automatically when creating a signed tag or
3528        commit, you can override the default selection with this variable.
3529        This option is passed unchanged to gpg's --local-user parameter,
3530        so you may specify a key using any method that gpg supports.
3531
3532versionsort.prereleaseSuffix (deprecated)::
3533        Deprecated alias for `versionsort.suffix`.  Ignored if
3534        `versionsort.suffix` is set.
3535
3536versionsort.suffix::
3537        Even when version sort is used in linkgit:git-tag[1], tagnames
3538        with the same base version but different suffixes are still sorted
3539        lexicographically, resulting e.g. in prerelease tags appearing
3540        after the main release (e.g. "1.0-rc1" after "1.0").  This
3541        variable can be specified to determine the sorting order of tags
3542        with different suffixes.
3543+
3544By specifying a single suffix in this variable, any tagname containing
3545that suffix will appear before the corresponding main release.  E.g. if
3546the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3547"1.0".  If specified multiple times, once per suffix, then the order of
3548suffixes in the configuration will determine the sorting order of tagnames
3549with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3550configuration, then all "1.0-preX" tags will be listed before any
3551"1.0-rcX" tags.  The placement of the main release tag relative to tags
3552with various suffixes can be determined by specifying the empty suffix
3553among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3554"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3555are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3556"v4.8-bfsX".
3557+
3558If more than one suffixes match the same tagname, then that tagname will
3559be sorted according to the suffix which starts at the earliest position in
3560the tagname.  If more than one different matching suffixes start at
3561that earliest position, then that tagname will be sorted according to the
3562longest of those suffixes.
3563The sorting order between different suffixes is undefined if they are
3564in multiple config files.
3565
3566web.browser::
3567        Specify a web browser that may be used by some commands.
3568        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3569        may use it.
3570
3571worktree.guessRemote::
3572        With `add`, if no branch argument, and neither of `-b` nor
3573        `-B` nor `--detach` are given, the command defaults to
3574        creating a new branch from HEAD.  If `worktree.guessRemote` is
3575        set to true, `worktree add` tries to find a remote-tracking
3576        branch whose name uniquely matches the new branch name.  If
3577        such a branch exists, it is checked out and set as "upstream"
3578        for the new branch.  If no such match can be found, it falls
3579        back to creating a new branch from the current HEAD.