Documentation / config.txton commit Merge branch 'tz/exclude-doc-smallfixes' (3c5b6ee)
   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 a 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        and `grafted` for grafted commits.
1167
1168color.grep::
1169        When set to `always`, always highlight matches.  When `false` (or
1170        `never`), never.  When set to `true` or `auto`, use color only
1171        when the output is written to the terminal.  If unset, then the
1172        value of `color.ui` is used (`auto` by default).
1173
1174color.grep.<slot>::
1175        Use customized color for grep colorization.  `<slot>` specifies which
1176        part of the line to use the specified color, and is one of
1177+
1178--
1179`context`;;
1180        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1181`filename`;;
1182        filename prefix (when not using `-h`)
1183`function`;;
1184        function name lines (when using `-p`)
1185`lineNumber`;;
1186        line number prefix (when using `-n`)
1187`column`;;
1188        column number prefix (when using `--column`)
1189`match`;;
1190        matching text (same as setting `matchContext` and `matchSelected`)
1191`matchContext`;;
1192        matching text in context lines
1193`matchSelected`;;
1194        matching text in selected lines
1195`selected`;;
1196        non-matching text in selected lines
1197`separator`;;
1198        separators between fields on a line (`:`, `-`, and `=`)
1199        and between hunks (`--`)
1200--
1201
1202color.interactive::
1203        When set to `always`, always use colors for interactive prompts
1204        and displays (such as those used by "git-add --interactive" and
1205        "git-clean --interactive"). When false (or `never`), never.
1206        When set to `true` or `auto`, use colors only when the output is
1207        to the terminal. If unset, then the value of `color.ui` is
1208        used (`auto` by default).
1209
1210color.interactive.<slot>::
1211        Use customized color for 'git add --interactive' and 'git clean
1212        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1213        or `error`, for four distinct types of normal output from
1214        interactive commands.
1215
1216color.pager::
1217        A boolean to enable/disable colored output when the pager is in
1218        use (default is true).
1219
1220color.push::
1221        A boolean to enable/disable color in push errors. May be set to
1222        `always`, `false` (or `never`) or `auto` (or `true`), in which
1223        case colors are used only when the error output goes to a terminal.
1224        If unset, then the value of `color.ui` is used (`auto` by default).
1225
1226color.push.error::
1227        Use customized color for push errors.
1228
1229color.showBranch::
1230        A boolean to enable/disable color in the output of
1231        linkgit:git-show-branch[1]. May be set to `always`,
1232        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1233        only when the output is to a terminal. If unset, then the
1234        value of `color.ui` is used (`auto` by default).
1235
1236color.status::
1237        A boolean to enable/disable color in the output of
1238        linkgit:git-status[1]. May be set to `always`,
1239        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1240        only when the output is to a terminal. If unset, then the
1241        value of `color.ui` is used (`auto` by default).
1242
1243color.status.<slot>::
1244        Use customized color for status colorization. `<slot>` is
1245        one of `header` (the header text of the status message),
1246        `added` or `updated` (files which are added but not committed),
1247        `changed` (files which are changed but not added in the index),
1248        `untracked` (files which are not tracked by Git),
1249        `branch` (the current branch),
1250        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1251        to red),
1252        `localBranch` or `remoteBranch` (the local and remote branch names,
1253        respectively, when branch and tracking information is displayed in the
1254        status short-format), or
1255        `unmerged` (files which have unmerged changes).
1256
1257color.blame.repeatedLines::
1258        Use the customized color for the part of git-blame output that
1259        is repeated meta information per line (such as commit id,
1260        author name, date and timezone). Defaults to cyan.
1261
1262color.blame.highlightRecent::
1263        This can be used to color the metadata of a blame line depending
1264        on age of the line.
1265+
1266This setting should be set to a comma-separated list of color and date settings,
1267starting and ending with a color, the dates should be set from oldest to newest.
1268The metadata will be colored given the colors if the the line was introduced
1269before the given timestamp, overwriting older timestamped colors.
1270+
1271Instead of an absolute timestamp relative timestamps work as well, e.g.
12722.weeks.ago is valid to address anything older than 2 weeks.
1273+
1274It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1275everything older than one year blue, recent changes between one month and
1276one year old are kept white, and lines introduced within the last month are
1277colored red.
1278
1279blame.coloring::
1280        This determines the coloring scheme to be applied to blame
1281        output. It can be 'repeatedLines', 'highlightRecent',
1282        or 'none' which is the default.
1283
1284color.transport::
1285        A boolean to enable/disable color when pushes are rejected. May be
1286        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1287        case colors are used only when the error output goes to a terminal.
1288        If unset, then the value of `color.ui` is used (`auto` by default).
1289
1290color.transport.rejected::
1291        Use customized color when a push was rejected.
1292
1293color.ui::
1294        This variable determines the default value for variables such
1295        as `color.diff` and `color.grep` that control the use of color
1296        per command family. Its scope will expand as more commands learn
1297        configuration to set a default for the `--color` option.  Set it
1298        to `false` or `never` if you prefer Git commands not to use
1299        color unless enabled explicitly with some other configuration
1300        or the `--color` option. Set it to `always` if you want all
1301        output not intended for machine consumption to use color, to
1302        `true` or `auto` (this is the default since Git 1.8.4) if you
1303        want such output to use color when written to the terminal.
1304
1305column.ui::
1306        Specify whether supported commands should output in columns.
1307        This variable consists of a list of tokens separated by spaces
1308        or commas:
1309+
1310These options control when the feature should be enabled
1311(defaults to 'never'):
1312+
1313--
1314`always`;;
1315        always show in columns
1316`never`;;
1317        never show in columns
1318`auto`;;
1319        show in columns if the output is to the terminal
1320--
1321+
1322These options control layout (defaults to 'column').  Setting any
1323of these implies 'always' if none of 'always', 'never', or 'auto' are
1324specified.
1325+
1326--
1327`column`;;
1328        fill columns before rows
1329`row`;;
1330        fill rows before columns
1331`plain`;;
1332        show in one column
1333--
1334+
1335Finally, these options can be combined with a layout option (defaults
1336to 'nodense'):
1337+
1338--
1339`dense`;;
1340        make unequal size columns to utilize more space
1341`nodense`;;
1342        make equal size columns
1343--
1344
1345column.branch::
1346        Specify whether to output branch listing in `git branch` in columns.
1347        See `column.ui` for details.
1348
1349column.clean::
1350        Specify the layout when list items in `git clean -i`, which always
1351        shows files and directories in columns. See `column.ui` for details.
1352
1353column.status::
1354        Specify whether to output untracked files in `git status` in columns.
1355        See `column.ui` for details.
1356
1357column.tag::
1358        Specify whether to output tag listing in `git tag` in columns.
1359        See `column.ui` for details.
1360
1361commit.cleanup::
1362        This setting overrides the default of the `--cleanup` option in
1363        `git commit`. See linkgit:git-commit[1] for details. Changing the
1364        default can be useful when you always want to keep lines that begin
1365        with comment character `#` in your log message, in which case you
1366        would do `git config commit.cleanup whitespace` (note that you will
1367        have to remove the help lines that begin with `#` in the commit log
1368        template yourself, if you do this).
1369
1370commit.gpgSign::
1371
1372        A boolean to specify whether all commits should be GPG signed.
1373        Use of this option when doing operations such as rebase can
1374        result in a large number of commits being signed. It may be
1375        convenient to use an agent to avoid typing your GPG passphrase
1376        several times.
1377
1378commit.status::
1379        A boolean to enable/disable inclusion of status information in the
1380        commit message template when using an editor to prepare the commit
1381        message.  Defaults to true.
1382
1383commit.template::
1384        Specify the pathname of a file to use as the template for
1385        new commit messages.
1386
1387commit.verbose::
1388        A boolean or int to specify the level of verbose with `git commit`.
1389        See linkgit:git-commit[1].
1390
1391credential.helper::
1392        Specify an external helper to be called when a username or
1393        password credential is needed; the helper may consult external
1394        storage to avoid prompting the user for the credentials. Note
1395        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1396        for details.
1397
1398credential.useHttpPath::
1399        When acquiring credentials, consider the "path" component of an http
1400        or https URL to be important. Defaults to false. See
1401        linkgit:gitcredentials[7] for more information.
1402
1403credential.username::
1404        If no username is set for a network authentication, use this username
1405        by default. See credential.<context>.* below, and
1406        linkgit:gitcredentials[7].
1407
1408credential.<url>.*::
1409        Any of the credential.* options above can be applied selectively to
1410        some credentials. For example "credential.https://example.com.username"
1411        would set the default username only for https connections to
1412        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1413        matched.
1414
1415credentialCache.ignoreSIGHUP::
1416        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1417
1418completion.commands::
1419        This is only used by git-completion.bash to add or remove
1420        commands from the list of completed commands. Normally only
1421        porcelain commands and a few select others are completed. You
1422        can add more commands, separated by space, in this
1423        variable. Prefixing the command with '-' will remove it from
1424        the existing list.
1425
1426include::diff-config.txt[]
1427
1428difftool.<tool>.path::
1429        Override the path for the given tool.  This is useful in case
1430        your tool is not in the PATH.
1431
1432difftool.<tool>.cmd::
1433        Specify the command to invoke the specified diff tool.
1434        The specified command is evaluated in shell with the following
1435        variables available:  'LOCAL' is set to the name of the temporary
1436        file containing the contents of the diff pre-image and 'REMOTE'
1437        is set to the name of the temporary file containing the contents
1438        of the diff post-image.
1439
1440difftool.prompt::
1441        Prompt before each invocation of the diff tool.
1442
1443fastimport.unpackLimit::
1444        If the number of objects imported by linkgit:git-fast-import[1]
1445        is below this limit, then the objects will be unpacked into
1446        loose object files.  However if the number of imported objects
1447        equals or exceeds this limit then the pack will be stored as a
1448        pack.  Storing the pack from a fast-import can make the import
1449        operation complete faster, especially on slow filesystems.  If
1450        not set, the value of `transfer.unpackLimit` is used instead.
1451
1452fetch.recurseSubmodules::
1453        This option can be either set to a boolean value or to 'on-demand'.
1454        Setting it to a boolean changes the behavior of fetch and pull to
1455        unconditionally recurse into submodules when set to true or to not
1456        recurse at all when set to false. When set to 'on-demand' (the default
1457        value), fetch and pull will only recurse into a populated submodule
1458        when its superproject retrieves a commit that updates the submodule's
1459        reference.
1460
1461fetch.fsckObjects::
1462        If it is set to true, git-fetch-pack will check all fetched
1463        objects. It will abort in the case of a malformed object or a
1464        broken link. The result of an abort are only dangling objects.
1465        Defaults to false. If not set, the value of `transfer.fsckObjects`
1466        is used instead.
1467
1468fetch.unpackLimit::
1469        If the number of objects fetched over the Git native
1470        transfer is below this
1471        limit, then the objects will be unpacked into loose object
1472        files. However if the number of received objects equals or
1473        exceeds this limit then the received pack will be stored as
1474        a pack, after adding any missing delta bases.  Storing the
1475        pack from a push can make the push operation complete faster,
1476        especially on slow filesystems.  If not set, the value of
1477        `transfer.unpackLimit` is used instead.
1478
1479fetch.prune::
1480        If true, fetch will automatically behave as if the `--prune`
1481        option was given on the command line.  See also `remote.<name>.prune`
1482        and the PRUNING section of linkgit:git-fetch[1].
1483
1484fetch.pruneTags::
1485        If true, fetch will automatically behave as if the
1486        `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1487        if not set already. This allows for setting both this option
1488        and `fetch.prune` to maintain a 1=1 mapping to upstream
1489        refs. See also `remote.<name>.pruneTags` and the PRUNING
1490        section of linkgit:git-fetch[1].
1491
1492fetch.output::
1493        Control how ref update status is printed. Valid values are
1494        `full` and `compact`. Default value is `full`. See section
1495        OUTPUT in linkgit:git-fetch[1] for detail.
1496
1497format.attach::
1498        Enable multipart/mixed attachments as the default for
1499        'format-patch'.  The value can also be a double quoted string
1500        which will enable attachments as the default and set the
1501        value as the boundary.  See the --attach option in
1502        linkgit:git-format-patch[1].
1503
1504format.from::
1505        Provides the default value for the `--from` option to format-patch.
1506        Accepts a boolean value, or a name and email address.  If false,
1507        format-patch defaults to `--no-from`, using commit authors directly in
1508        the "From:" field of patch mails.  If true, format-patch defaults to
1509        `--from`, using your committer identity in the "From:" field of patch
1510        mails and including a "From:" field in the body of the patch mail if
1511        different.  If set to a non-boolean value, format-patch uses that
1512        value instead of your committer identity.  Defaults to false.
1513
1514format.numbered::
1515        A boolean which can enable or disable sequence numbers in patch
1516        subjects.  It defaults to "auto" which enables it only if there
1517        is more than one patch.  It can be enabled or disabled for all
1518        messages by setting it to "true" or "false".  See --numbered
1519        option in linkgit:git-format-patch[1].
1520
1521format.headers::
1522        Additional email headers to include in a patch to be submitted
1523        by mail.  See linkgit:git-format-patch[1].
1524
1525format.to::
1526format.cc::
1527        Additional recipients to include in a patch to be submitted
1528        by mail.  See the --to and --cc options in
1529        linkgit:git-format-patch[1].
1530
1531format.subjectPrefix::
1532        The default for format-patch is to output files with the '[PATCH]'
1533        subject prefix. Use this variable to change that prefix.
1534
1535format.signature::
1536        The default for format-patch is to output a signature containing
1537        the Git version number. Use this variable to change that default.
1538        Set this variable to the empty string ("") to suppress
1539        signature generation.
1540
1541format.signatureFile::
1542        Works just like format.signature except the contents of the
1543        file specified by this variable will be used as the signature.
1544
1545format.suffix::
1546        The default for format-patch is to output files with the suffix
1547        `.patch`. Use this variable to change that suffix (make sure to
1548        include the dot if you want it).
1549
1550format.pretty::
1551        The default pretty format for log/show/whatchanged command,
1552        See linkgit:git-log[1], linkgit:git-show[1],
1553        linkgit:git-whatchanged[1].
1554
1555format.thread::
1556        The default threading style for 'git format-patch'.  Can be
1557        a boolean value, or `shallow` or `deep`.  `shallow` threading
1558        makes every mail a reply to the head of the series,
1559        where the head is chosen from the cover letter, the
1560        `--in-reply-to`, and the first patch mail, in this order.
1561        `deep` threading makes every mail a reply to the previous one.
1562        A true boolean value is the same as `shallow`, and a false
1563        value disables threading.
1564
1565format.signOff::
1566        A boolean value which lets you enable the `-s/--signoff` option of
1567        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1568        patch should be a conscious act and means that you certify you have
1569        the rights to submit this work under the same open source license.
1570        Please see the 'SubmittingPatches' document for further discussion.
1571
1572format.coverLetter::
1573        A boolean that controls whether to generate a cover-letter when
1574        format-patch is invoked, but in addition can be set to "auto", to
1575        generate a cover-letter only when there's more than one patch.
1576
1577format.outputDirectory::
1578        Set a custom directory to store the resulting files instead of the
1579        current working directory.
1580
1581format.useAutoBase::
1582        A boolean value which lets you enable the `--base=auto` option of
1583        format-patch by default.
1584
1585filter.<driver>.clean::
1586        The command which is used to convert the content of a worktree
1587        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1588        details.
1589
1590filter.<driver>.smudge::
1591        The command which is used to convert the content of a blob
1592        object to a worktree file upon checkout.  See
1593        linkgit:gitattributes[5] for details.
1594
1595fsck.<msg-id>::
1596        Allows overriding the message type (error, warn or ignore) of a
1597        specific message ID such as `missingEmail`.
1598+
1599For convenience, fsck prefixes the error/warning with the message ID,
1600e.g.  "missingEmail: invalid author/committer line - missing email" means
1601that setting `fsck.missingEmail = ignore` will hide that issue.
1602+
1603This feature is intended to support working with legacy repositories
1604which cannot be repaired without disruptive changes.
1605
1606fsck.skipList::
1607        The path to a sorted list of object names (i.e. one SHA-1 per
1608        line) that are known to be broken in a non-fatal way and should
1609        be ignored. This feature is useful when an established project
1610        should be accepted despite early commits containing errors that
1611        can be safely ignored such as invalid committer email addresses.
1612        Note: corrupt objects cannot be skipped with this setting.
1613
1614gc.aggressiveDepth::
1615        The depth parameter used in the delta compression
1616        algorithm used by 'git gc --aggressive'.  This defaults
1617        to 50.
1618
1619gc.aggressiveWindow::
1620        The window size parameter used in the delta compression
1621        algorithm used by 'git gc --aggressive'.  This defaults
1622        to 250.
1623
1624gc.auto::
1625        When there are approximately more than this many loose
1626        objects in the repository, `git gc --auto` will pack them.
1627        Some Porcelain commands use this command to perform a
1628        light-weight garbage collection from time to time.  The
1629        default value is 6700.  Setting this to 0 disables it.
1630
1631gc.autoPackLimit::
1632        When there are more than this many packs that are not
1633        marked with `*.keep` file in the repository, `git gc
1634        --auto` consolidates them into one larger pack.  The
1635        default value is 50.  Setting this to 0 disables it.
1636
1637gc.autoDetach::
1638        Make `git gc --auto` return immediately and run in background
1639        if the system supports it. Default is true.
1640
1641gc.bigPackThreshold::
1642        If non-zero, all packs larger than this limit are kept when
1643        `git gc` is run. This is very similar to `--keep-base-pack`
1644        except that all packs that meet the threshold are kept, not
1645        just the base pack. Defaults to zero. Common unit suffixes of
1646        'k', 'm', or 'g' are supported.
1647+
1648Note that if the number of kept packs is more than gc.autoPackLimit,
1649this configuration variable is ignored, all packs except the base pack
1650will be repacked. After this the number of packs should go below
1651gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1652
1653gc.logExpiry::
1654        If the file gc.log exists, then `git gc --auto` won't run
1655        unless that file is more than 'gc.logExpiry' old.  Default is
1656        "1.day".  See `gc.pruneExpire` for more ways to specify its
1657        value.
1658
1659gc.packRefs::
1660        Running `git pack-refs` in a repository renders it
1661        unclonable by Git versions prior to 1.5.1.2 over dumb
1662        transports such as HTTP.  This variable determines whether
1663        'git gc' runs `git pack-refs`. This can be set to `notbare`
1664        to enable it within all non-bare repos or it can be set to a
1665        boolean value.  The default is `true`.
1666
1667gc.pruneExpire::
1668        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1669        Override the grace period with this config variable.  The value
1670        "now" may be used to disable this grace period and always prune
1671        unreachable objects immediately, or "never" may be used to
1672        suppress pruning.  This feature helps prevent corruption when
1673        'git gc' runs concurrently with another process writing to the
1674        repository; see the "NOTES" section of linkgit:git-gc[1].
1675
1676gc.worktreePruneExpire::
1677        When 'git gc' is run, it calls
1678        'git worktree prune --expire 3.months.ago'.
1679        This config variable can be used to set a different grace
1680        period. The value "now" may be used to disable the grace
1681        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1682        may be used to suppress pruning.
1683
1684gc.reflogExpire::
1685gc.<pattern>.reflogExpire::
1686        'git reflog expire' removes reflog entries older than
1687        this time; defaults to 90 days. The value "now" expires all
1688        entries immediately, and "never" suppresses expiration
1689        altogether. With "<pattern>" (e.g.
1690        "refs/stash") in the middle the setting applies only to
1691        the refs that match the <pattern>.
1692
1693gc.reflogExpireUnreachable::
1694gc.<pattern>.reflogExpireUnreachable::
1695        'git reflog expire' removes reflog entries older than
1696        this time and are not reachable from the current tip;
1697        defaults to 30 days. The value "now" expires all entries
1698        immediately, and "never" suppresses expiration altogether.
1699        With "<pattern>" (e.g. "refs/stash")
1700        in the middle, the setting applies only to the refs that
1701        match the <pattern>.
1702
1703gc.rerereResolved::
1704        Records of conflicted merge you resolved earlier are
1705        kept for this many days when 'git rerere gc' is run.
1706        You can also use more human-readable "1.month.ago", etc.
1707        The default is 60 days.  See linkgit:git-rerere[1].
1708
1709gc.rerereUnresolved::
1710        Records of conflicted merge you have not resolved are
1711        kept for this many days when 'git rerere gc' is run.
1712        You can also use more human-readable "1.month.ago", etc.
1713        The default is 15 days.  See linkgit:git-rerere[1].
1714
1715gitcvs.commitMsgAnnotation::
1716        Append this string to each commit message. Set to empty string
1717        to disable this feature. Defaults to "via git-CVS emulator".
1718
1719gitcvs.enabled::
1720        Whether the CVS server interface is enabled for this repository.
1721        See linkgit:git-cvsserver[1].
1722
1723gitcvs.logFile::
1724        Path to a log file where the CVS server interface well... logs
1725        various stuff. See linkgit:git-cvsserver[1].
1726
1727gitcvs.usecrlfattr::
1728        If true, the server will look up the end-of-line conversion
1729        attributes for files to determine the `-k` modes to use. If
1730        the attributes force Git to treat a file as text,
1731        the `-k` mode will be left blank so CVS clients will
1732        treat it as text. If they suppress text conversion, the file
1733        will be set with '-kb' mode, which suppresses any newline munging
1734        the client might otherwise do. If the attributes do not allow
1735        the file type to be determined, then `gitcvs.allBinary` is
1736        used. See linkgit:gitattributes[5].
1737
1738gitcvs.allBinary::
1739        This is used if `gitcvs.usecrlfattr` does not resolve
1740        the correct '-kb' mode to use. If true, all
1741        unresolved files are sent to the client in
1742        mode '-kb'. This causes the client to treat them
1743        as binary files, which suppresses any newline munging it
1744        otherwise might do. Alternatively, if it is set to "guess",
1745        then the contents of the file are examined to decide if
1746        it is binary, similar to `core.autocrlf`.
1747
1748gitcvs.dbName::
1749        Database used by git-cvsserver to cache revision information
1750        derived from the Git repository. The exact meaning depends on the
1751        used database driver, for SQLite (which is the default driver) this
1752        is a filename. Supports variable substitution (see
1753        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1754        Default: '%Ggitcvs.%m.sqlite'
1755
1756gitcvs.dbDriver::
1757        Used Perl DBI driver. You can specify any available driver
1758        for this here, but it might not work. git-cvsserver is tested
1759        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1760        reported *not* to work with 'DBD::mysql'. Experimental feature.
1761        May not contain double colons (`:`). Default: 'SQLite'.
1762        See linkgit:git-cvsserver[1].
1763
1764gitcvs.dbUser, gitcvs.dbPass::
1765        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1766        since SQLite has no concept of database users and/or passwords.
1767        'gitcvs.dbUser' supports variable substitution (see
1768        linkgit:git-cvsserver[1] for details).
1769
1770gitcvs.dbTableNamePrefix::
1771        Database table name prefix.  Prepended to the names of any
1772        database tables used, allowing a single database to be used
1773        for several repositories.  Supports variable substitution (see
1774        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1775        characters will be replaced with underscores.
1776
1777All gitcvs variables except for `gitcvs.usecrlfattr` and
1778`gitcvs.allBinary` can also be specified as
1779'gitcvs.<access_method>.<varname>' (where 'access_method'
1780is one of "ext" and "pserver") to make them apply only for the given
1781access method.
1782
1783gitweb.category::
1784gitweb.description::
1785gitweb.owner::
1786gitweb.url::
1787        See linkgit:gitweb[1] for description.
1788
1789gitweb.avatar::
1790gitweb.blame::
1791gitweb.grep::
1792gitweb.highlight::
1793gitweb.patches::
1794gitweb.pickaxe::
1795gitweb.remote_heads::
1796gitweb.showSizes::
1797gitweb.snapshot::
1798        See linkgit:gitweb.conf[5] for description.
1799
1800grep.lineNumber::
1801        If set to true, enable `-n` option by default.
1802
1803grep.column::
1804        If set to true, enable the `--column` option by default.
1805
1806grep.patternType::
1807        Set the default matching behavior. Using a value of 'basic', 'extended',
1808        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1809        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1810        value 'default' will return to the default matching behavior.
1811
1812grep.extendedRegexp::
1813        If set to true, enable `--extended-regexp` option by default. This
1814        option is ignored when the `grep.patternType` option is set to a value
1815        other than 'default'.
1816
1817grep.threads::
1818        Number of grep worker threads to use.
1819        See `grep.threads` in linkgit:git-grep[1] for more information.
1820
1821grep.fallbackToNoIndex::
1822        If set to true, fall back to git grep --no-index if git grep
1823        is executed outside of a git repository.  Defaults to false.
1824
1825gpg.program::
1826        Use this custom program instead of "`gpg`" found on `$PATH` when
1827        making or verifying a PGP signature. The program must support the
1828        same command-line interface as GPG, namely, to verify a detached
1829        signature, "`gpg --verify $file - <$signature`" is run, and the
1830        program is expected to signal a good signature by exiting with
1831        code 0, and to generate an ASCII-armored detached signature, the
1832        standard input of "`gpg -bsau $key`" is fed with the contents to be
1833        signed, and the program is expected to send the result to its
1834        standard output.
1835
1836gui.commitMsgWidth::
1837        Defines how wide the commit message window is in the
1838        linkgit:git-gui[1]. "75" is the default.
1839
1840gui.diffContext::
1841        Specifies how many context lines should be used in calls to diff
1842        made by the linkgit:git-gui[1]. The default is "5".
1843
1844gui.displayUntracked::
1845        Determines if linkgit:git-gui[1] shows untracked files
1846        in the file list. The default is "true".
1847
1848gui.encoding::
1849        Specifies the default encoding to use for displaying of
1850        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1851        It can be overridden by setting the 'encoding' attribute
1852        for relevant files (see linkgit:gitattributes[5]).
1853        If this option is not set, the tools default to the
1854        locale encoding.
1855
1856gui.matchTrackingBranch::
1857        Determines if new branches created with linkgit:git-gui[1] should
1858        default to tracking remote branches with matching names or
1859        not. Default: "false".
1860
1861gui.newBranchTemplate::
1862        Is used as suggested name when creating new branches using the
1863        linkgit:git-gui[1].
1864
1865gui.pruneDuringFetch::
1866        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1867        performing a fetch. The default value is "false".
1868
1869gui.trustmtime::
1870        Determines if linkgit:git-gui[1] should trust the file modification
1871        timestamp or not. By default the timestamps are not trusted.
1872
1873gui.spellingDictionary::
1874        Specifies the dictionary used for spell checking commit messages in
1875        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1876        off.
1877
1878gui.fastCopyBlame::
1879        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1880        location detection. It makes blame significantly faster on huge
1881        repositories at the expense of less thorough copy detection.
1882
1883gui.copyBlameThreshold::
1884        Specifies the threshold to use in 'git gui blame' original location
1885        detection, measured in alphanumeric characters. See the
1886        linkgit:git-blame[1] manual for more information on copy detection.
1887
1888gui.blamehistoryctx::
1889        Specifies the radius of history context in days to show in
1890        linkgit:gitk[1] for the selected commit, when the `Show History
1891        Context` menu item is invoked from 'git gui blame'. If this
1892        variable is set to zero, the whole history is shown.
1893
1894guitool.<name>.cmd::
1895        Specifies the shell command line to execute when the corresponding item
1896        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1897        mandatory for every tool. The command is executed from the root of
1898        the working directory, and in the environment it receives the name of
1899        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1900        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1901        the head is detached, 'CUR_BRANCH' is empty).
1902
1903guitool.<name>.needsFile::
1904        Run the tool only if a diff is selected in the GUI. It guarantees
1905        that 'FILENAME' is not empty.
1906
1907guitool.<name>.noConsole::
1908        Run the command silently, without creating a window to display its
1909        output.
1910
1911guitool.<name>.noRescan::
1912        Don't rescan the working directory for changes after the tool
1913        finishes execution.
1914
1915guitool.<name>.confirm::
1916        Show a confirmation dialog before actually running the tool.
1917
1918guitool.<name>.argPrompt::
1919        Request a string argument from the user, and pass it to the tool
1920        through the `ARGS` environment variable. Since requesting an
1921        argument implies confirmation, the 'confirm' option has no effect
1922        if this is enabled. If the option is set to 'true', 'yes', or '1',
1923        the dialog uses a built-in generic prompt; otherwise the exact
1924        value of the variable is used.
1925
1926guitool.<name>.revPrompt::
1927        Request a single valid revision from the user, and set the
1928        `REVISION` environment variable. In other aspects this option
1929        is similar to 'argPrompt', and can be used together with it.
1930
1931guitool.<name>.revUnmerged::
1932        Show only unmerged branches in the 'revPrompt' subdialog.
1933        This is useful for tools similar to merge or rebase, but not
1934        for things like checkout or reset.
1935
1936guitool.<name>.title::
1937        Specifies the title to use for the prompt dialog. The default
1938        is the tool name.
1939
1940guitool.<name>.prompt::
1941        Specifies the general prompt string to display at the top of
1942        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1943        The default value includes the actual command.
1944
1945help.browser::
1946        Specify the browser that will be used to display help in the
1947        'web' format. See linkgit:git-help[1].
1948
1949help.format::
1950        Override the default help format used by linkgit:git-help[1].
1951        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1952        the default. 'web' and 'html' are the same.
1953
1954help.autoCorrect::
1955        Automatically correct and execute mistyped commands after
1956        waiting for the given number of deciseconds (0.1 sec). If more
1957        than one command can be deduced from the entered text, nothing
1958        will be executed.  If the value of this option is negative,
1959        the corrected command will be executed immediately. If the
1960        value is 0 - the command will be just shown but not executed.
1961        This is the default.
1962
1963help.htmlPath::
1964        Specify the path where the HTML documentation resides. File system paths
1965        and URLs are supported. HTML pages will be prefixed with this path when
1966        help is displayed in the 'web' format. This defaults to the documentation
1967        path of your Git installation.
1968
1969http.proxy::
1970        Override the HTTP proxy, normally configured using the 'http_proxy',
1971        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1972        addition to the syntax understood by curl, it is possible to specify a
1973        proxy string with a user name but no password, in which case git will
1974        attempt to acquire one in the same way it does for other credentials. See
1975        linkgit:gitcredentials[7] for more information. The syntax thus is
1976        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1977        on a per-remote basis; see remote.<name>.proxy
1978
1979http.proxyAuthMethod::
1980        Set the method with which to authenticate against the HTTP proxy. This
1981        only takes effect if the configured proxy string contains a user name part
1982        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1983        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1984        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1985        variable.  Possible values are:
1986+
1987--
1988* `anyauth` - Automatically pick a suitable authentication method. It is
1989  assumed that the proxy answers an unauthenticated request with a 407
1990  status code and one or more Proxy-authenticate headers with supported
1991  authentication methods. This is the default.
1992* `basic` - HTTP Basic authentication
1993* `digest` - HTTP Digest authentication; this prevents the password from being
1994  transmitted to the proxy in clear text
1995* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1996  of `curl(1)`)
1997* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1998--
1999
2000http.emptyAuth::
2001        Attempt authentication without seeking a username or password.  This
2002        can be used to attempt GSS-Negotiate authentication without specifying
2003        a username in the URL, as libcurl normally requires a username for
2004        authentication.
2005
2006http.delegation::
2007        Control GSSAPI credential delegation. The delegation is disabled
2008        by default in libcurl since version 7.21.7. Set parameter to tell
2009        the server what it is allowed to delegate when it comes to user
2010        credentials. Used with GSS/kerberos. Possible values are:
2011+
2012--
2013* `none` - Don't allow any delegation.
2014* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2015  Kerberos service ticket, which is a matter of realm policy.
2016* `always` - Unconditionally allow the server to delegate.
2017--
2018
2019
2020http.extraHeader::
2021        Pass an additional HTTP header when communicating with a server.  If
2022        more than one such entry exists, all of them are added as extra
2023        headers.  To allow overriding the settings inherited from the system
2024        config, an empty value will reset the extra headers to the empty list.
2025
2026http.cookieFile::
2027        The pathname of a file containing previously stored cookie lines,
2028        which should be used
2029        in the Git http session, if they match the server. The file format
2030        of the file to read cookies from should be plain HTTP headers or
2031        the Netscape/Mozilla cookie file format (see `curl(1)`).
2032        NOTE that the file specified with http.cookieFile is used only as
2033        input unless http.saveCookies is set.
2034
2035http.saveCookies::
2036        If set, store cookies received during requests to the file specified by
2037        http.cookieFile. Has no effect if http.cookieFile is unset.
2038
2039http.sslVersion::
2040        The SSL version to use when negotiating an SSL connection, if you
2041        want to force the default.  The available and default version
2042        depend on whether libcurl was built against NSS or OpenSSL and the
2043        particular configuration of the crypto library in use. Internally
2044        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2045        documentation for more details on the format of this option and
2046        for the ssl version supported. Actually the possible values of
2047        this option are:
2048
2049        - sslv2
2050        - sslv3
2051        - tlsv1
2052        - tlsv1.0
2053        - tlsv1.1
2054        - tlsv1.2
2055        - tlsv1.3
2056
2057+
2058Can be overridden by the `GIT_SSL_VERSION` environment variable.
2059To force git to use libcurl's default ssl version and ignore any
2060explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2061empty string.
2062
2063http.sslCipherList::
2064  A list of SSL ciphers to use when negotiating an SSL connection.
2065  The available ciphers depend on whether libcurl was built against
2066  NSS or OpenSSL and the particular configuration of the crypto
2067  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2068  option; see the libcurl documentation for more details on the format
2069  of this list.
2070+
2071Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2072To force git to use libcurl's default cipher list and ignore any
2073explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2074empty string.
2075
2076http.sslVerify::
2077        Whether to verify the SSL certificate when fetching or pushing
2078        over HTTPS. Defaults to true. Can be overridden by the
2079        `GIT_SSL_NO_VERIFY` environment variable.
2080
2081http.sslCert::
2082        File containing the SSL certificate when fetching or pushing
2083        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2084        variable.
2085
2086http.sslKey::
2087        File containing the SSL private key when fetching or pushing
2088        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2089        variable.
2090
2091http.sslCertPasswordProtected::
2092        Enable Git's password prompt for the SSL certificate.  Otherwise
2093        OpenSSL will prompt the user, possibly many times, if the
2094        certificate or private key is encrypted.  Can be overridden by the
2095        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2096
2097http.sslCAInfo::
2098        File containing the certificates to verify the peer with when
2099        fetching or pushing over HTTPS. Can be overridden by the
2100        `GIT_SSL_CAINFO` environment variable.
2101
2102http.sslCAPath::
2103        Path containing files with the CA certificates to verify the peer
2104        with when fetching or pushing over HTTPS. Can be overridden
2105        by the `GIT_SSL_CAPATH` environment variable.
2106
2107http.pinnedpubkey::
2108        Public key of the https service. It may either be the filename of
2109        a PEM or DER encoded public key file or a string starting with
2110        'sha256//' followed by the base64 encoded sha256 hash of the
2111        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2112        exit with an error if this option is set but not supported by
2113        cURL.
2114
2115http.sslTry::
2116        Attempt to use AUTH SSL/TLS and encrypted data transfers
2117        when connecting via regular FTP protocol. This might be needed
2118        if the FTP server requires it for security reasons or you wish
2119        to connect securely whenever remote FTP server supports it.
2120        Default is false since it might trigger certificate verification
2121        errors on misconfigured servers.
2122
2123http.maxRequests::
2124        How many HTTP requests to launch in parallel. Can be overridden
2125        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2126
2127http.minSessions::
2128        The number of curl sessions (counted across slots) to be kept across
2129        requests. They will not be ended with curl_easy_cleanup() until
2130        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2131        value will be capped at 1. Defaults to 1.
2132
2133http.postBuffer::
2134        Maximum size in bytes of the buffer used by smart HTTP
2135        transports when POSTing data to the remote system.
2136        For requests larger than this buffer size, HTTP/1.1 and
2137        Transfer-Encoding: chunked is used to avoid creating a
2138        massive pack file locally.  Default is 1 MiB, which is
2139        sufficient for most requests.
2140
2141http.lowSpeedLimit, http.lowSpeedTime::
2142        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2143        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2144        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2145        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2146
2147http.noEPSV::
2148        A boolean which disables using of EPSV ftp command by curl.
2149        This can helpful with some "poor" ftp servers which don't
2150        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2151        environment variable. Default is false (curl will use EPSV).
2152
2153http.userAgent::
2154        The HTTP USER_AGENT string presented to an HTTP server.  The default
2155        value represents the version of the client Git such as git/1.7.1.
2156        This option allows you to override this value to a more common value
2157        such as Mozilla/4.0.  This may be necessary, for instance, if
2158        connecting through a firewall that restricts HTTP connections to a set
2159        of common USER_AGENT strings (but not including those like git/1.7.1).
2160        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2161
2162http.followRedirects::
2163        Whether git should follow HTTP redirects. If set to `true`, git
2164        will transparently follow any redirect issued by a server it
2165        encounters. If set to `false`, git will treat all redirects as
2166        errors. If set to `initial`, git will follow redirects only for
2167        the initial request to a remote, but not for subsequent
2168        follow-up HTTP requests. Since git uses the redirected URL as
2169        the base for the follow-up requests, this is generally
2170        sufficient. The default is `initial`.
2171
2172http.<url>.*::
2173        Any of the http.* options above can be applied selectively to some URLs.
2174        For a config key to match a URL, each element of the config key is
2175        compared to that of the URL, in the following order:
2176+
2177--
2178. Scheme (e.g., `https` in `https://example.com/`). This field
2179  must match exactly between the config key and the URL.
2180
2181. Host/domain name (e.g., `example.com` in `https://example.com/`).
2182  This field must match between the config key and the URL. It is
2183  possible to specify a `*` as part of the host name to match all subdomains
2184  at this level. `https://*.example.com/` for example would match
2185  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2186
2187. Port number (e.g., `8080` in `http://example.com:8080/`).
2188  This field must match exactly between the config key and the URL.
2189  Omitted port numbers are automatically converted to the correct
2190  default for the scheme before matching.
2191
2192. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2193  path field of the config key must match the path field of the URL
2194  either exactly or as a prefix of slash-delimited path elements.  This means
2195  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2196  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2197  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2198  key with just path `foo/`).
2199
2200. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2201  the config key has a user name it must match the user name in the
2202  URL exactly. If the config key does not have a user name, that
2203  config key will match a URL with any user name (including none),
2204  but at a lower precedence than a config key with a user name.
2205--
2206+
2207The list above is ordered by decreasing precedence; a URL that matches
2208a config key's path is preferred to one that matches its user name. For example,
2209if the URL is `https://user@example.com/foo/bar` a config key match of
2210`https://example.com/foo` will be preferred over a config key match of
2211`https://user@example.com`.
2212+
2213All URLs are normalized before attempting any matching (the password part,
2214if embedded in the URL, is always ignored for matching purposes) so that
2215equivalent URLs that are simply spelled differently will match properly.
2216Environment variable settings always override any matches.  The URLs that are
2217matched against are those given directly to Git commands.  This means any URLs
2218visited as a result of a redirection do not participate in matching.
2219
2220ssh.variant::
2221        By default, Git determines the command line arguments to use
2222        based on the basename of the configured SSH command (configured
2223        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2224        the config setting `core.sshCommand`). If the basename is
2225        unrecognized, Git will attempt to detect support of OpenSSH
2226        options by first invoking the configured SSH command with the
2227        `-G` (print configuration) option and will subsequently use
2228        OpenSSH options (if that is successful) or no options besides
2229        the host and remote command (if it fails).
2230+
2231The config variable `ssh.variant` can be set to override this detection.
2232Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2233`tortoiseplink`, `simple` (no options except the host and remote command).
2234The default auto-detection can be explicitly requested using the value
2235`auto`.  Any other value is treated as `ssh`.  This setting can also be
2236overridden via the environment variable `GIT_SSH_VARIANT`.
2237+
2238The current command-line parameters used for each variant are as
2239follows:
2240+
2241--
2242
2243* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2244
2245* `simple` - [username@]host command
2246
2247* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2248
2249* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2250
2251--
2252+
2253Except for the `simple` variant, command-line parameters are likely to
2254change as git gains new features.
2255
2256i18n.commitEncoding::
2257        Character encoding the commit messages are stored in; Git itself
2258        does not care per se, but this information is necessary e.g. when
2259        importing commits from emails or in the gitk graphical history
2260        browser (and possibly at other places in the future or in other
2261        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2262
2263i18n.logOutputEncoding::
2264        Character encoding the commit messages are converted to when
2265        running 'git log' and friends.
2266
2267imap::
2268        The configuration variables in the 'imap' section are described
2269        in linkgit:git-imap-send[1].
2270
2271index.version::
2272        Specify the version with which new index files should be
2273        initialized.  This does not affect existing repositories.
2274
2275init.templateDir::
2276        Specify the directory from which templates will be copied.
2277        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2278
2279instaweb.browser::
2280        Specify the program that will be used to browse your working
2281        repository in gitweb. See linkgit:git-instaweb[1].
2282
2283instaweb.httpd::
2284        The HTTP daemon command-line to start gitweb on your working
2285        repository. See linkgit:git-instaweb[1].
2286
2287instaweb.local::
2288        If true the web server started by linkgit:git-instaweb[1] will
2289        be bound to the local IP (127.0.0.1).
2290
2291instaweb.modulePath::
2292        The default module path for linkgit:git-instaweb[1] to use
2293        instead of /usr/lib/apache2/modules.  Only used if httpd
2294        is Apache.
2295
2296instaweb.port::
2297        The port number to bind the gitweb httpd to. See
2298        linkgit:git-instaweb[1].
2299
2300interactive.singleKey::
2301        In interactive commands, allow the user to provide one-letter
2302        input with a single key (i.e., without hitting enter).
2303        Currently this is used by the `--patch` mode of
2304        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2305        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2306        setting is silently ignored if portable keystroke input
2307        is not available; requires the Perl module Term::ReadKey.
2308
2309interactive.diffFilter::
2310        When an interactive command (such as `git add --patch`) shows
2311        a colorized diff, git will pipe the diff through the shell
2312        command defined by this configuration variable. The command may
2313        mark up the diff further for human consumption, provided that it
2314        retains a one-to-one correspondence with the lines in the
2315        original diff. Defaults to disabled (no filtering).
2316
2317log.abbrevCommit::
2318        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2319        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2320        override this option with `--no-abbrev-commit`.
2321
2322log.date::
2323        Set the default date-time mode for the 'log' command.
2324        Setting a value for log.date is similar to using 'git log''s
2325        `--date` option.  See linkgit:git-log[1] for details.
2326
2327log.decorate::
2328        Print out the ref names of any commits that are shown by the log
2329        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2330        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2331        specified, the full ref name (including prefix) will be printed.
2332        If 'auto' is specified, then if the output is going to a terminal,
2333        the ref names are shown as if 'short' were given, otherwise no ref
2334        names are shown. This is the same as the `--decorate` option
2335        of the `git log`.
2336
2337log.follow::
2338        If `true`, `git log` will act as if the `--follow` option was used when
2339        a single <path> is given.  This has the same limitations as `--follow`,
2340        i.e. it cannot be used to follow multiple files and does not work well
2341        on non-linear history.
2342
2343log.graphColors::
2344        A list of colors, separated by commas, that can be used to draw
2345        history lines in `git log --graph`.
2346
2347log.showRoot::
2348        If true, the initial commit will be shown as a big creation event.
2349        This is equivalent to a diff against an empty tree.
2350        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2351        normally hide the root commit will now show it. True by default.
2352
2353log.showSignature::
2354        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2355        linkgit:git-whatchanged[1] assume `--show-signature`.
2356
2357log.mailmap::
2358        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2359        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2360
2361mailinfo.scissors::
2362        If true, makes linkgit:git-mailinfo[1] (and therefore
2363        linkgit:git-am[1]) act by default as if the --scissors option
2364        was provided on the command-line. When active, this features
2365        removes everything from the message body before a scissors
2366        line (i.e. consisting mainly of ">8", "8<" and "-").
2367
2368mailmap.file::
2369        The location of an augmenting mailmap file. The default
2370        mailmap, located in the root of the repository, is loaded
2371        first, then the mailmap file pointed to by this variable.
2372        The location of the mailmap file may be in a repository
2373        subdirectory, or somewhere outside of the repository itself.
2374        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2375
2376mailmap.blob::
2377        Like `mailmap.file`, but consider the value as a reference to a
2378        blob in the repository. If both `mailmap.file` and
2379        `mailmap.blob` are given, both are parsed, with entries from
2380        `mailmap.file` taking precedence. In a bare repository, this
2381        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2382        defaults to empty.
2383
2384man.viewer::
2385        Specify the programs that may be used to display help in the
2386        'man' format. See linkgit:git-help[1].
2387
2388man.<tool>.cmd::
2389        Specify the command to invoke the specified man viewer. The
2390        specified command is evaluated in shell with the man page
2391        passed as argument. (See linkgit:git-help[1].)
2392
2393man.<tool>.path::
2394        Override the path for the given tool that may be used to
2395        display help in the 'man' format. See linkgit:git-help[1].
2396
2397include::merge-config.txt[]
2398
2399mergetool.<tool>.path::
2400        Override the path for the given tool.  This is useful in case
2401        your tool is not in the PATH.
2402
2403mergetool.<tool>.cmd::
2404        Specify the command to invoke the specified merge tool.  The
2405        specified command is evaluated in shell with the following
2406        variables available: 'BASE' is the name of a temporary file
2407        containing the common base of the files to be merged, if available;
2408        'LOCAL' is the name of a temporary file containing the contents of
2409        the file on the current branch; 'REMOTE' is the name of a temporary
2410        file containing the contents of the file from the branch being
2411        merged; 'MERGED' contains the name of the file to which the merge
2412        tool should write the results of a successful merge.
2413
2414mergetool.<tool>.trustExitCode::
2415        For a custom merge command, specify whether the exit code of
2416        the merge command can be used to determine whether the merge was
2417        successful.  If this is not set to true then the merge target file
2418        timestamp is checked and the merge assumed to have been successful
2419        if the file has been updated, otherwise the user is prompted to
2420        indicate the success of the merge.
2421
2422mergetool.meld.hasOutput::
2423        Older versions of `meld` do not support the `--output` option.
2424        Git will attempt to detect whether `meld` supports `--output`
2425        by inspecting the output of `meld --help`.  Configuring
2426        `mergetool.meld.hasOutput` will make Git skip these checks and
2427        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2428        to `true` tells Git to unconditionally use the `--output` option,
2429        and `false` avoids using `--output`.
2430
2431mergetool.keepBackup::
2432        After performing a merge, the original file with conflict markers
2433        can be saved as a file with a `.orig` extension.  If this variable
2434        is set to `false` then this file is not preserved.  Defaults to
2435        `true` (i.e. keep the backup files).
2436
2437mergetool.keepTemporaries::
2438        When invoking a custom merge tool, Git uses a set of temporary
2439        files to pass to the tool. If the tool returns an error and this
2440        variable is set to `true`, then these temporary files will be
2441        preserved, otherwise they will be removed after the tool has
2442        exited. Defaults to `false`.
2443
2444mergetool.writeToTemp::
2445        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2446        conflicting files in the worktree by default.  Git will attempt
2447        to use a temporary directory for these files when set `true`.
2448        Defaults to `false`.
2449
2450mergetool.prompt::
2451        Prompt before each invocation of the merge resolution program.
2452
2453notes.mergeStrategy::
2454        Which merge strategy to choose by default when resolving notes
2455        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2456        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2457        section of linkgit:git-notes[1] for more information on each strategy.
2458
2459notes.<name>.mergeStrategy::
2460        Which merge strategy to choose when doing a notes merge into
2461        refs/notes/<name>.  This overrides the more general
2462        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2463        linkgit:git-notes[1] for more information on the available strategies.
2464
2465notes.displayRef::
2466        The (fully qualified) refname from which to show notes when
2467        showing commit messages.  The value of this variable can be set
2468        to a glob, in which case notes from all matching refs will be
2469        shown.  You may also specify this configuration variable
2470        several times.  A warning will be issued for refs that do not
2471        exist, but a glob that does not match any refs is silently
2472        ignored.
2473+
2474This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2475environment variable, which must be a colon separated list of refs or
2476globs.
2477+
2478The effective value of "core.notesRef" (possibly overridden by
2479GIT_NOTES_REF) is also implicitly added to the list of refs to be
2480displayed.
2481
2482notes.rewrite.<command>::
2483        When rewriting commits with <command> (currently `amend` or
2484        `rebase`) and this variable is set to `true`, Git
2485        automatically copies your notes from the original to the
2486        rewritten commit.  Defaults to `true`, but see
2487        "notes.rewriteRef" below.
2488
2489notes.rewriteMode::
2490        When copying notes during a rewrite (see the
2491        "notes.rewrite.<command>" option), determines what to do if
2492        the target commit already has a note.  Must be one of
2493        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2494        Defaults to `concatenate`.
2495+
2496This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2497environment variable.
2498
2499notes.rewriteRef::
2500        When copying notes during a rewrite, specifies the (fully
2501        qualified) ref whose notes should be copied.  The ref may be a
2502        glob, in which case notes in all matching refs will be copied.
2503        You may also specify this configuration several times.
2504+
2505Does not have a default value; you must configure this variable to
2506enable note rewriting.  Set it to `refs/notes/commits` to enable
2507rewriting for the default commit notes.
2508+
2509This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2510environment variable, which must be a colon separated list of refs or
2511globs.
2512
2513pack.window::
2514        The size of the window used by linkgit:git-pack-objects[1] when no
2515        window size is given on the command line. Defaults to 10.
2516
2517pack.depth::
2518        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2519        maximum depth is given on the command line. Defaults to 50.
2520        Maximum value is 4095.
2521
2522pack.windowMemory::
2523        The maximum size of memory that is consumed by each thread
2524        in linkgit:git-pack-objects[1] for pack window memory when
2525        no limit is given on the command line.  The value can be
2526        suffixed with "k", "m", or "g".  When left unconfigured (or
2527        set explicitly to 0), there will be no limit.
2528
2529pack.compression::
2530        An integer -1..9, indicating the compression level for objects
2531        in a pack file. -1 is the zlib default. 0 means no
2532        compression, and 1..9 are various speed/size tradeoffs, 9 being
2533        slowest.  If not set,  defaults to core.compression.  If that is
2534        not set,  defaults to -1, the zlib default, which is "a default
2535        compromise between speed and compression (currently equivalent
2536        to level 6)."
2537+
2538Note that changing the compression level will not automatically recompress
2539all existing objects. You can force recompression by passing the -F option
2540to linkgit:git-repack[1].
2541
2542pack.deltaCacheSize::
2543        The maximum memory in bytes used for caching deltas in
2544        linkgit:git-pack-objects[1] before writing them out to a pack.
2545        This cache is used to speed up the writing object phase by not
2546        having to recompute the final delta result once the best match
2547        for all objects is found.  Repacking large repositories on machines
2548        which are tight with memory might be badly impacted by this though,
2549        especially if this cache pushes the system into swapping.
2550        A value of 0 means no limit. The smallest size of 1 byte may be
2551        used to virtually disable this cache. Defaults to 256 MiB.
2552
2553pack.deltaCacheLimit::
2554        The maximum size of a delta, that is cached in
2555        linkgit:git-pack-objects[1]. This cache is used to speed up the
2556        writing object phase by not having to recompute the final delta
2557        result once the best match for all objects is found.
2558        Defaults to 1000. Maximum value is 65535.
2559
2560pack.threads::
2561        Specifies the number of threads to spawn when searching for best
2562        delta matches.  This requires that linkgit:git-pack-objects[1]
2563        be compiled with pthreads otherwise this option is ignored with a
2564        warning. This is meant to reduce packing time on multiprocessor
2565        machines. The required amount of memory for the delta search window
2566        is however multiplied by the number of threads.
2567        Specifying 0 will cause Git to auto-detect the number of CPU's
2568        and set the number of threads accordingly.
2569
2570pack.indexVersion::
2571        Specify the default pack index version.  Valid values are 1 for
2572        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2573        the new pack index with capabilities for packs larger than 4 GB
2574        as well as proper protection against the repacking of corrupted
2575        packs.  Version 2 is the default.  Note that version 2 is enforced
2576        and this config option ignored whenever the corresponding pack is
2577        larger than 2 GB.
2578+
2579If you have an old Git that does not understand the version 2 `*.idx` file,
2580cloning or fetching over a non native protocol (e.g. "http")
2581that will copy both `*.pack` file and corresponding `*.idx` file from the
2582other side may give you a repository that cannot be accessed with your
2583older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2584you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2585the `*.idx` file.
2586
2587pack.packSizeLimit::
2588        The maximum size of a pack.  This setting only affects
2589        packing to a file when repacking, i.e. the git:// protocol
2590        is unaffected.  It can be overridden by the `--max-pack-size`
2591        option of linkgit:git-repack[1].  Reaching this limit results
2592        in the creation of multiple packfiles; which in turn prevents
2593        bitmaps from being created.
2594        The minimum size allowed is limited to 1 MiB.
2595        The default is unlimited.
2596        Common unit suffixes of 'k', 'm', or 'g' are
2597        supported.
2598
2599pack.useBitmaps::
2600        When true, git will use pack bitmaps (if available) when packing
2601        to stdout (e.g., during the server side of a fetch). Defaults to
2602        true. You should not generally need to turn this off unless
2603        you are debugging pack bitmaps.
2604
2605pack.writeBitmaps (deprecated)::
2606        This is a deprecated synonym for `repack.writeBitmaps`.
2607
2608pack.writeBitmapHashCache::
2609        When true, git will include a "hash cache" section in the bitmap
2610        index (if one is written). This cache can be used to feed git's
2611        delta heuristics, potentially leading to better deltas between
2612        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2613        between an older, bitmapped pack and objects that have been
2614        pushed since the last gc). The downside is that it consumes 4
2615        bytes per object of disk space, and that JGit's bitmap
2616        implementation does not understand it, causing it to complain if
2617        Git and JGit are used on the same repository. Defaults to false.
2618
2619pager.<cmd>::
2620        If the value is boolean, turns on or off pagination of the
2621        output of a particular Git subcommand when writing to a tty.
2622        Otherwise, turns on pagination for the subcommand using the
2623        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2624        or `--no-pager` is specified on the command line, it takes
2625        precedence over this option.  To disable pagination for all
2626        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2627
2628pretty.<name>::
2629        Alias for a --pretty= format string, as specified in
2630        linkgit:git-log[1]. Any aliases defined here can be used just
2631        as the built-in pretty formats could. For example,
2632        running `git config pretty.changelog "format:* %H %s"`
2633        would cause the invocation `git log --pretty=changelog`
2634        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2635        Note that an alias with the same name as a built-in format
2636        will be silently ignored.
2637
2638protocol.allow::
2639        If set, provide a user defined default policy for all protocols which
2640        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2641        if unset, known-safe protocols (http, https, git, ssh, file) have a
2642        default policy of `always`, known-dangerous protocols (ext) have a
2643        default policy of `never`, and all other protocols have a default
2644        policy of `user`.  Supported policies:
2645+
2646--
2647
2648* `always` - protocol is always able to be used.
2649
2650* `never` - protocol is never able to be used.
2651
2652* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2653  either unset or has a value of 1.  This policy should be used when you want a
2654  protocol to be directly usable by the user but don't want it used by commands which
2655  execute clone/fetch/push commands without user input, e.g. recursive
2656  submodule initialization.
2657
2658--
2659
2660protocol.<name>.allow::
2661        Set a policy to be used by protocol `<name>` with clone/fetch/push
2662        commands. See `protocol.allow` above for the available policies.
2663+
2664The protocol names currently used by git are:
2665+
2666--
2667  - `file`: any local file-based path (including `file://` URLs,
2668    or local paths)
2669
2670  - `git`: the anonymous git protocol over a direct TCP
2671    connection (or proxy, if configured)
2672
2673  - `ssh`: git over ssh (including `host:path` syntax,
2674    `ssh://`, etc).
2675
2676  - `http`: git over http, both "smart http" and "dumb http".
2677    Note that this does _not_ include `https`; if you want to configure
2678    both, you must do so individually.
2679
2680  - any external helpers are named by their protocol (e.g., use
2681    `hg` to allow the `git-remote-hg` helper)
2682--
2683
2684protocol.version::
2685        Experimental. If set, clients will attempt to communicate with a
2686        server using the specified protocol version.  If unset, no
2687        attempt will be made by the client to communicate using a
2688        particular protocol version, this results in protocol version 0
2689        being used.
2690        Supported versions:
2691+
2692--
2693
2694* `0` - the original wire protocol.
2695
2696* `1` - the original wire protocol with the addition of a version string
2697  in the initial response from the server.
2698
2699--
2700
2701pull.ff::
2702        By default, Git does not create an extra merge commit when merging
2703        a commit that is a descendant of the current commit. Instead, the
2704        tip of the current branch is fast-forwarded. When set to `false`,
2705        this variable tells Git to create an extra merge commit in such
2706        a case (equivalent to giving the `--no-ff` option from the command
2707        line). When set to `only`, only such fast-forward merges are
2708        allowed (equivalent to giving the `--ff-only` option from the
2709        command line). This setting overrides `merge.ff` when pulling.
2710
2711pull.rebase::
2712        When true, rebase branches on top of the fetched branch, instead
2713        of merging the default branch from the default remote when "git
2714        pull" is run. See "branch.<name>.rebase" for setting this on a
2715        per-branch basis.
2716+
2717When `merges`, pass the `--rebase-merges` option to 'git rebase'
2718so that the local merge commits are included in the rebase (see
2719linkgit:git-rebase[1] for details).
2720+
2721When preserve, also pass `--preserve-merges` along to 'git rebase'
2722so that locally committed merge commits will not be flattened
2723by running 'git pull'.
2724+
2725When the value is `interactive`, the rebase is run in interactive mode.
2726+
2727*NOTE*: this is a possibly dangerous operation; do *not* use
2728it unless you understand the implications (see linkgit:git-rebase[1]
2729for details).
2730
2731pull.octopus::
2732        The default merge strategy to use when pulling multiple branches
2733        at once.
2734
2735pull.twohead::
2736        The default merge strategy to use when pulling a single branch.
2737
2738push.default::
2739        Defines the action `git push` should take if no refspec is
2740        explicitly given.  Different values are well-suited for
2741        specific workflows; for instance, in a purely central workflow
2742        (i.e. the fetch source is equal to the push destination),
2743        `upstream` is probably what you want.  Possible values are:
2744+
2745--
2746
2747* `nothing` - do not push anything (error out) unless a refspec is
2748  explicitly given. This is primarily meant for people who want to
2749  avoid mistakes by always being explicit.
2750
2751* `current` - push the current branch to update a branch with the same
2752  name on the receiving end.  Works in both central and non-central
2753  workflows.
2754
2755* `upstream` - push the current branch back to the branch whose
2756  changes are usually integrated into the current branch (which is
2757  called `@{upstream}`).  This mode only makes sense if you are
2758  pushing to the same repository you would normally pull from
2759  (i.e. central workflow).
2760
2761* `tracking` - This is a deprecated synonym for `upstream`.
2762
2763* `simple` - in centralized workflow, work like `upstream` with an
2764  added safety to refuse to push if the upstream branch's name is
2765  different from the local one.
2766+
2767When pushing to a remote that is different from the remote you normally
2768pull from, work as `current`.  This is the safest option and is suited
2769for beginners.
2770+
2771This mode has become the default in Git 2.0.
2772
2773* `matching` - push all branches having the same name on both ends.
2774  This makes the repository you are pushing to remember the set of
2775  branches that will be pushed out (e.g. if you always push 'maint'
2776  and 'master' there and no other branches, the repository you push
2777  to will have these two branches, and your local 'maint' and
2778  'master' will be pushed there).
2779+
2780To use this mode effectively, you have to make sure _all_ the
2781branches you would push out are ready to be pushed out before
2782running 'git push', as the whole point of this mode is to allow you
2783to push all of the branches in one go.  If you usually finish work
2784on only one branch and push out the result, while other branches are
2785unfinished, this mode is not for you.  Also this mode is not
2786suitable for pushing into a shared central repository, as other
2787people may add new branches there, or update the tip of existing
2788branches outside your control.
2789+
2790This used to be the default, but not since Git 2.0 (`simple` is the
2791new default).
2792
2793--
2794
2795push.followTags::
2796        If set to true enable `--follow-tags` option by default.  You
2797        may override this configuration at time of push by specifying
2798        `--no-follow-tags`.
2799
2800push.gpgSign::
2801        May be set to a boolean value, or the string 'if-asked'. A true
2802        value causes all pushes to be GPG signed, as if `--signed` is
2803        passed to linkgit:git-push[1]. The string 'if-asked' causes
2804        pushes to be signed if the server supports it, as if
2805        `--signed=if-asked` is passed to 'git push'. A false value may
2806        override a value from a lower-priority config file. An explicit
2807        command-line flag always overrides this config option.
2808
2809push.pushOption::
2810        When no `--push-option=<option>` argument is given from the
2811        command line, `git push` behaves as if each <value> of
2812        this variable is given as `--push-option=<value>`.
2813+
2814This is a multi-valued variable, and an empty value can be used in a
2815higher priority configuration file (e.g. `.git/config` in a
2816repository) to clear the values inherited from a lower priority
2817configuration files (e.g. `$HOME/.gitconfig`).
2818+
2819--
2820
2821Example:
2822
2823/etc/gitconfig
2824  push.pushoption = a
2825  push.pushoption = b
2826
2827~/.gitconfig
2828  push.pushoption = c
2829
2830repo/.git/config
2831  push.pushoption =
2832  push.pushoption = b
2833
2834This will result in only b (a and c are cleared).
2835
2836--
2837
2838push.recurseSubmodules::
2839        Make sure all submodule commits used by the revisions to be pushed
2840        are available on a remote-tracking branch. If the value is 'check'
2841        then Git will verify that all submodule commits that changed in the
2842        revisions to be pushed are available on at least one remote of the
2843        submodule. If any commits are missing, the push will be aborted and
2844        exit with non-zero status. If the value is 'on-demand' then all
2845        submodules that changed in the revisions to be pushed will be
2846        pushed. If on-demand was not able to push all necessary revisions
2847        it will also be aborted and exit with non-zero status. If the value
2848        is 'no' then default behavior of ignoring submodules when pushing
2849        is retained. You may override this configuration at time of push by
2850        specifying '--recurse-submodules=check|on-demand|no'.
2851
2852include::rebase-config.txt[]
2853
2854receive.advertiseAtomic::
2855        By default, git-receive-pack will advertise the atomic push
2856        capability to its clients. If you don't want to advertise this
2857        capability, set this variable to false.
2858
2859receive.advertisePushOptions::
2860        When set to true, git-receive-pack will advertise the push options
2861        capability to its clients. False by default.
2862
2863receive.autogc::
2864        By default, git-receive-pack will run "git-gc --auto" after
2865        receiving data from git-push and updating refs.  You can stop
2866        it by setting this variable to false.
2867
2868receive.certNonceSeed::
2869        By setting this variable to a string, `git receive-pack`
2870        will accept a `git push --signed` and verifies it by using
2871        a "nonce" protected by HMAC using this string as a secret
2872        key.
2873
2874receive.certNonceSlop::
2875        When a `git push --signed` sent a push certificate with a
2876        "nonce" that was issued by a receive-pack serving the same
2877        repository within this many seconds, export the "nonce"
2878        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2879        hooks (instead of what the receive-pack asked the sending
2880        side to include).  This may allow writing checks in
2881        `pre-receive` and `post-receive` a bit easier.  Instead of
2882        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2883        that records by how many seconds the nonce is stale to
2884        decide if they want to accept the certificate, they only
2885        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2886
2887receive.fsckObjects::
2888        If it is set to true, git-receive-pack will check all received
2889        objects. It will abort in the case of a malformed object or a
2890        broken link. The result of an abort are only dangling objects.
2891        Defaults to false. If not set, the value of `transfer.fsckObjects`
2892        is used instead.
2893
2894receive.fsck.<msg-id>::
2895        When `receive.fsckObjects` is set to true, errors can be switched
2896        to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2897        setting where the `<msg-id>` is the fsck message ID and the value
2898        is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2899        the error/warning with the message ID, e.g. "missingEmail: invalid
2900        author/committer line - missing email" means that setting
2901        `receive.fsck.missingEmail = ignore` will hide that issue.
2902+
2903This feature is intended to support working with legacy repositories
2904which would not pass pushing when `receive.fsckObjects = true`, allowing
2905the host to accept repositories with certain known issues but still catch
2906other issues.
2907
2908receive.fsck.skipList::
2909        The path to a sorted list of object names (i.e. one SHA-1 per
2910        line) that are known to be broken in a non-fatal way and should
2911        be ignored. This feature is useful when an established project
2912        should be accepted despite early commits containing errors that
2913        can be safely ignored such as invalid committer email addresses.
2914        Note: corrupt objects cannot be skipped with this setting.
2915
2916receive.keepAlive::
2917        After receiving the pack from the client, `receive-pack` may
2918        produce no output (if `--quiet` was specified) while processing
2919        the pack, causing some networks to drop the TCP connection.
2920        With this option set, if `receive-pack` does not transmit
2921        any data in this phase for `receive.keepAlive` seconds, it will
2922        send a short keepalive packet.  The default is 5 seconds; set
2923        to 0 to disable keepalives entirely.
2924
2925receive.unpackLimit::
2926        If the number of objects received in a push is below this
2927        limit then the objects will be unpacked into loose object
2928        files. However if the number of received objects equals or
2929        exceeds this limit then the received pack will be stored as
2930        a pack, after adding any missing delta bases.  Storing the
2931        pack from a push can make the push operation complete faster,
2932        especially on slow filesystems.  If not set, the value of
2933        `transfer.unpackLimit` is used instead.
2934
2935receive.maxInputSize::
2936        If the size of the incoming pack stream is larger than this
2937        limit, then git-receive-pack will error out, instead of
2938        accepting the pack file. If not set or set to 0, then the size
2939        is unlimited.
2940
2941receive.denyDeletes::
2942        If set to true, git-receive-pack will deny a ref update that deletes
2943        the ref. Use this to prevent such a ref deletion via a push.
2944
2945receive.denyDeleteCurrent::
2946        If set to true, git-receive-pack will deny a ref update that
2947        deletes the currently checked out branch of a non-bare repository.
2948
2949receive.denyCurrentBranch::
2950        If set to true or "refuse", git-receive-pack will deny a ref update
2951        to the currently checked out branch of a non-bare repository.
2952        Such a push is potentially dangerous because it brings the HEAD
2953        out of sync with the index and working tree. If set to "warn",
2954        print a warning of such a push to stderr, but allow the push to
2955        proceed. If set to false or "ignore", allow such pushes with no
2956        message. Defaults to "refuse".
2957+
2958Another option is "updateInstead" which will update the working
2959tree if pushing into the current branch.  This option is
2960intended for synchronizing working directories when one side is not easily
2961accessible via interactive ssh (e.g. a live web site, hence the requirement
2962that the working directory be clean). This mode also comes in handy when
2963developing inside a VM to test and fix code on different Operating Systems.
2964+
2965By default, "updateInstead" will refuse the push if the working tree or
2966the index have any difference from the HEAD, but the `push-to-checkout`
2967hook can be used to customize this.  See linkgit:githooks[5].
2968
2969receive.denyNonFastForwards::
2970        If set to true, git-receive-pack will deny a ref update which is
2971        not a fast-forward. Use this to prevent such an update via a push,
2972        even if that push is forced. This configuration variable is
2973        set when initializing a shared repository.
2974
2975receive.hideRefs::
2976        This variable is the same as `transfer.hideRefs`, but applies
2977        only to `receive-pack` (and so affects pushes, but not fetches).
2978        An attempt to update or delete a hidden ref by `git push` is
2979        rejected.
2980
2981receive.updateServerInfo::
2982        If set to true, git-receive-pack will run git-update-server-info
2983        after receiving data from git-push and updating refs.
2984
2985receive.shallowUpdate::
2986        If set to true, .git/shallow can be updated when new refs
2987        require new shallow roots. Otherwise those refs are rejected.
2988
2989remote.pushDefault::
2990        The remote to push to by default.  Overrides
2991        `branch.<name>.remote` for all branches, and is overridden by
2992        `branch.<name>.pushRemote` for specific branches.
2993
2994remote.<name>.url::
2995        The URL of a remote repository.  See linkgit:git-fetch[1] or
2996        linkgit:git-push[1].
2997
2998remote.<name>.pushurl::
2999        The push URL of a remote repository.  See linkgit:git-push[1].
3000
3001remote.<name>.proxy::
3002        For remotes that require curl (http, https and ftp), the URL to
3003        the proxy to use for that remote.  Set to the empty string to
3004        disable proxying for that remote.
3005
3006remote.<name>.proxyAuthMethod::
3007        For remotes that require curl (http, https and ftp), the method to use for
3008        authenticating against the proxy in use (probably set in
3009        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3010
3011remote.<name>.fetch::
3012        The default set of "refspec" for linkgit:git-fetch[1]. See
3013        linkgit:git-fetch[1].
3014
3015remote.<name>.push::
3016        The default set of "refspec" for linkgit:git-push[1]. See
3017        linkgit:git-push[1].
3018
3019remote.<name>.mirror::
3020        If true, pushing to this remote will automatically behave
3021        as if the `--mirror` option was given on the command line.
3022
3023remote.<name>.skipDefaultUpdate::
3024        If true, this remote will be skipped by default when updating
3025        using linkgit:git-fetch[1] or the `update` subcommand of
3026        linkgit:git-remote[1].
3027
3028remote.<name>.skipFetchAll::
3029        If true, this remote will be skipped by default when updating
3030        using linkgit:git-fetch[1] or the `update` subcommand of
3031        linkgit:git-remote[1].
3032
3033remote.<name>.receivepack::
3034        The default program to execute on the remote side when pushing.  See
3035        option --receive-pack of linkgit:git-push[1].
3036
3037remote.<name>.uploadpack::
3038        The default program to execute on the remote side when fetching.  See
3039        option --upload-pack of linkgit:git-fetch-pack[1].
3040
3041remote.<name>.tagOpt::
3042        Setting this value to --no-tags disables automatic tag following when
3043        fetching from remote <name>. Setting it to --tags will fetch every
3044        tag from remote <name>, even if they are not reachable from remote
3045        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3046        override this setting. See options --tags and --no-tags of
3047        linkgit:git-fetch[1].
3048
3049remote.<name>.vcs::
3050        Setting this to a value <vcs> will cause Git to interact with
3051        the remote with the git-remote-<vcs> helper.
3052
3053remote.<name>.prune::
3054        When set to true, fetching from this remote by default will also
3055        remove any remote-tracking references that no longer exist on the
3056        remote (as if the `--prune` option was given on the command line).
3057        Overrides `fetch.prune` settings, if any.
3058
3059remote.<name>.pruneTags::
3060        When set to true, fetching from this remote by default will also
3061        remove any local tags that no longer exist on the remote if pruning
3062        is activated in general via `remote.<name>.prune`, `fetch.prune` or
3063        `--prune`. Overrides `fetch.pruneTags` settings, if any.
3064+
3065See also `remote.<name>.prune` and the PRUNING section of
3066linkgit:git-fetch[1].
3067
3068remotes.<group>::
3069        The list of remotes which are fetched by "git remote update
3070        <group>".  See linkgit:git-remote[1].
3071
3072repack.useDeltaBaseOffset::
3073        By default, linkgit:git-repack[1] creates packs that use
3074        delta-base offset. If you need to share your repository with
3075        Git older than version 1.4.4, either directly or via a dumb
3076        protocol such as http, then you need to set this option to
3077        "false" and repack. Access from old Git versions over the
3078        native protocol are unaffected by this option.
3079
3080repack.packKeptObjects::
3081        If set to true, makes `git repack` act as if
3082        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3083        details. Defaults to `false` normally, but `true` if a bitmap
3084        index is being written (either via `--write-bitmap-index` or
3085        `repack.writeBitmaps`).
3086
3087repack.writeBitmaps::
3088        When true, git will write a bitmap index when packing all
3089        objects to disk (e.g., when `git repack -a` is run).  This
3090        index can speed up the "counting objects" phase of subsequent
3091        packs created for clones and fetches, at the cost of some disk
3092        space and extra time spent on the initial repack.  This has
3093        no effect if multiple packfiles are created.
3094        Defaults to false.
3095
3096rerere.autoUpdate::
3097        When set to true, `git-rerere` updates the index with the
3098        resulting contents after it cleanly resolves conflicts using
3099        previously recorded resolution.  Defaults to false.
3100
3101rerere.enabled::
3102        Activate recording of resolved conflicts, so that identical
3103        conflict hunks can be resolved automatically, should they be
3104        encountered again.  By default, linkgit:git-rerere[1] is
3105        enabled if there is an `rr-cache` directory under the
3106        `$GIT_DIR`, e.g. if "rerere" was previously used in the
3107        repository.
3108
3109sendemail.identity::
3110        A configuration identity. When given, causes values in the
3111        'sendemail.<identity>' subsection to take precedence over
3112        values in the 'sendemail' section. The default identity is
3113        the value of `sendemail.identity`.
3114
3115sendemail.smtpEncryption::
3116        See linkgit:git-send-email[1] for description.  Note that this
3117        setting is not subject to the 'identity' mechanism.
3118
3119sendemail.smtpssl (deprecated)::
3120        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3121
3122sendemail.smtpsslcertpath::
3123        Path to ca-certificates (either a directory or a single file).
3124        Set it to an empty string to disable certificate verification.
3125
3126sendemail.<identity>.*::
3127        Identity-specific versions of the 'sendemail.*' parameters
3128        found below, taking precedence over those when this
3129        identity is selected, through either the command-line or
3130        `sendemail.identity`.
3131
3132sendemail.aliasesFile::
3133sendemail.aliasFileType::
3134sendemail.annotate::
3135sendemail.bcc::
3136sendemail.cc::
3137sendemail.ccCmd::
3138sendemail.chainReplyTo::
3139sendemail.confirm::
3140sendemail.envelopeSender::
3141sendemail.from::
3142sendemail.multiEdit::
3143sendemail.signedoffbycc::
3144sendemail.smtpPass::
3145sendemail.suppresscc::
3146sendemail.suppressFrom::
3147sendemail.to::
3148sendemail.tocmd::
3149sendemail.smtpDomain::
3150sendemail.smtpServer::
3151sendemail.smtpServerPort::
3152sendemail.smtpServerOption::
3153sendemail.smtpUser::
3154sendemail.thread::
3155sendemail.transferEncoding::
3156sendemail.validate::
3157sendemail.xmailer::
3158        See linkgit:git-send-email[1] for description.
3159
3160sendemail.signedoffcc (deprecated)::
3161        Deprecated alias for `sendemail.signedoffbycc`.
3162
3163sendemail.smtpBatchSize::
3164        Number of messages to be sent per connection, after that a relogin
3165        will happen.  If the value is 0 or undefined, send all messages in
3166        one connection.
3167        See also the `--batch-size` option of linkgit:git-send-email[1].
3168
3169sendemail.smtpReloginDelay::
3170        Seconds wait before reconnecting to smtp server.
3171        See also the `--relogin-delay` option of linkgit:git-send-email[1].
3172
3173showbranch.default::
3174        The default set of branches for linkgit:git-show-branch[1].
3175        See linkgit:git-show-branch[1].
3176
3177splitIndex.maxPercentChange::
3178        When the split index feature is used, this specifies the
3179        percent of entries the split index can contain compared to the
3180        total number of entries in both the split index and the shared
3181        index before a new shared index is written.
3182        The value should be between 0 and 100. If the value is 0 then
3183        a new shared index is always written, if it is 100 a new
3184        shared index is never written.
3185        By default the value is 20, so a new shared index is written
3186        if the number of entries in the split index would be greater
3187        than 20 percent of the total number of entries.
3188        See linkgit:git-update-index[1].
3189
3190splitIndex.sharedIndexExpire::
3191        When the split index feature is used, shared index files that
3192        were not modified since the time this variable specifies will
3193        be removed when a new shared index file is created. The value
3194        "now" expires all entries immediately, and "never" suppresses
3195        expiration altogether.
3196        The default value is "2.weeks.ago".
3197        Note that a shared index file is considered modified (for the
3198        purpose of expiration) each time a new split-index file is
3199        either created based on it or read from it.
3200        See linkgit:git-update-index[1].
3201
3202status.relativePaths::
3203        By default, linkgit:git-status[1] shows paths relative to the
3204        current directory. Setting this variable to `false` shows paths
3205        relative to the repository root (this was the default for Git
3206        prior to v1.5.4).
3207
3208status.short::
3209        Set to true to enable --short by default in linkgit:git-status[1].
3210        The option --no-short takes precedence over this variable.
3211
3212status.branch::
3213        Set to true to enable --branch by default in linkgit:git-status[1].
3214        The option --no-branch takes precedence over this variable.
3215
3216status.displayCommentPrefix::
3217        If set to true, linkgit:git-status[1] will insert a comment
3218        prefix before each output line (starting with
3219        `core.commentChar`, i.e. `#` by default). This was the
3220        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3221        Defaults to false.
3222
3223status.renameLimit::
3224        The number of files to consider when performing rename detection
3225        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3226        the value of diff.renameLimit.
3227
3228status.renames::
3229        Whether and how Git detects renames in linkgit:git-status[1] and
3230        linkgit:git-commit[1] .  If set to "false", rename detection is
3231        disabled. If set to "true", basic rename detection is enabled.
3232        If set to "copies" or "copy", Git will detect copies, as well.
3233        Defaults to the value of diff.renames.
3234
3235status.showStash::
3236        If set to true, linkgit:git-status[1] will display the number of
3237        entries currently stashed away.
3238        Defaults to false.
3239
3240status.showUntrackedFiles::
3241        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3242        files which are not currently tracked by Git. Directories which
3243        contain only untracked files, are shown with the directory name
3244        only. Showing untracked files means that Git needs to lstat() all
3245        the files in the whole repository, which might be slow on some
3246        systems. So, this variable controls how the commands displays
3247        the untracked files. Possible values are:
3248+
3249--
3250* `no` - Show no untracked files.
3251* `normal` - Show untracked files and directories.
3252* `all` - Show also individual files in untracked directories.
3253--
3254+
3255If this variable is not specified, it defaults to 'normal'.
3256This variable can be overridden with the -u|--untracked-files option
3257of linkgit:git-status[1] and linkgit:git-commit[1].
3258
3259status.submoduleSummary::
3260        Defaults to false.
3261        If this is set to a non zero number or true (identical to -1 or an
3262        unlimited number), the submodule summary will be enabled and a
3263        summary of commits for modified submodules will be shown (see
3264        --summary-limit option of linkgit:git-submodule[1]). Please note
3265        that the summary output command will be suppressed for all
3266        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3267        for those submodules where `submodule.<name>.ignore=all`. The only
3268        exception to that rule is that status and commit will show staged
3269        submodule changes. To
3270        also view the summary for ignored submodules you can either use
3271        the --ignore-submodules=dirty command-line option or the 'git
3272        submodule summary' command, which shows a similar output but does
3273        not honor these settings.
3274
3275stash.showPatch::
3276        If this is set to true, the `git stash show` command without an
3277        option will show the stash entry in patch form.  Defaults to false.
3278        See description of 'show' command in linkgit:git-stash[1].
3279
3280stash.showStat::
3281        If this is set to true, the `git stash show` command without an
3282        option will show diffstat of the stash entry.  Defaults to true.
3283        See description of 'show' command in linkgit:git-stash[1].
3284
3285submodule.<name>.url::
3286        The URL for a submodule. This variable is copied from the .gitmodules
3287        file to the git config via 'git submodule init'. The user can change
3288        the configured URL before obtaining the submodule via 'git submodule
3289        update'. If neither submodule.<name>.active or submodule.active are
3290        set, the presence of this variable is used as a fallback to indicate
3291        whether the submodule is of interest to git commands.
3292        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3293
3294submodule.<name>.update::
3295        The method by which a submodule is updated by 'git submodule update',
3296        which is the only affected command, others such as
3297        'git checkout --recurse-submodules' are unaffected. It exists for
3298        historical reasons, when 'git submodule' was the only command to
3299        interact with submodules; settings like `submodule.active`
3300        and `pull.rebase` are more specific. It is populated by
3301        `git submodule init` from the linkgit:gitmodules[5] file.
3302        See description of 'update' command in linkgit:git-submodule[1].
3303
3304submodule.<name>.branch::
3305        The remote branch name for a submodule, used by `git submodule
3306        update --remote`.  Set this option to override the value found in
3307        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3308        linkgit:gitmodules[5] for details.
3309
3310submodule.<name>.fetchRecurseSubmodules::
3311        This option can be used to control recursive fetching of this
3312        submodule. It can be overridden by using the --[no-]recurse-submodules
3313        command-line option to "git fetch" and "git pull".
3314        This setting will override that from in the linkgit:gitmodules[5]
3315        file.
3316
3317submodule.<name>.ignore::
3318        Defines under what circumstances "git status" and the diff family show
3319        a submodule as modified. When set to "all", it will never be considered
3320        modified (but it will nonetheless show up in the output of status and
3321        commit when it has been staged), "dirty" will ignore all changes
3322        to the submodules work tree and
3323        takes only differences between the HEAD of the submodule and the commit
3324        recorded in the superproject into account. "untracked" will additionally
3325        let submodules with modified tracked files in their work tree show up.
3326        Using "none" (the default when this option is not set) also shows
3327        submodules that have untracked files in their work tree as changed.
3328        This setting overrides any setting made in .gitmodules for this submodule,
3329        both settings can be overridden on the command line by using the
3330        "--ignore-submodules" option. The 'git submodule' commands are not
3331        affected by this setting.
3332
3333submodule.<name>.active::
3334        Boolean value indicating if the submodule is of interest to git
3335        commands.  This config option takes precedence over the
3336        submodule.active config option. See linkgit:gitsubmodules[7] for
3337        details.
3338
3339submodule.active::
3340        A repeated field which contains a pathspec used to match against a
3341        submodule's path to determine if the submodule is of interest to git
3342        commands. See linkgit:gitsubmodules[7] for details.
3343
3344submodule.recurse::
3345        Specifies if commands recurse into submodules by default. This
3346        applies to all commands that have a `--recurse-submodules` option,
3347        except `clone`.
3348        Defaults to false.
3349
3350submodule.fetchJobs::
3351        Specifies how many submodules are fetched/cloned at the same time.
3352        A positive integer allows up to that number of submodules fetched
3353        in parallel. A value of 0 will give some reasonable default.
3354        If unset, it defaults to 1.
3355
3356submodule.alternateLocation::
3357        Specifies how the submodules obtain alternates when submodules are
3358        cloned. Possible values are `no`, `superproject`.
3359        By default `no` is assumed, which doesn't add references. When the
3360        value is set to `superproject` the submodule to be cloned computes
3361        its alternates location relative to the superprojects alternate.
3362
3363submodule.alternateErrorStrategy::
3364        Specifies how to treat errors with the alternates for a submodule
3365        as computed via `submodule.alternateLocation`. Possible values are
3366        `ignore`, `info`, `die`. Default is `die`.
3367
3368tag.forceSignAnnotated::
3369        A boolean to specify whether annotated tags created should be GPG signed.
3370        If `--annotate` is specified on the command line, it takes
3371        precedence over this option.
3372
3373tag.sort::
3374        This variable controls the sort ordering of tags when displayed by
3375        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3376        value of this variable will be used as the default.
3377
3378tar.umask::
3379        This variable can be used to restrict the permission bits of
3380        tar archive entries.  The default is 0002, which turns off the
3381        world write bit.  The special value "user" indicates that the
3382        archiving user's umask will be used instead.  See umask(2) and
3383        linkgit:git-archive[1].
3384
3385transfer.fsckObjects::
3386        When `fetch.fsckObjects` or `receive.fsckObjects` are
3387        not set, the value of this variable is used instead.
3388        Defaults to false.
3389
3390transfer.hideRefs::
3391        String(s) `receive-pack` and `upload-pack` use to decide which
3392        refs to omit from their initial advertisements.  Use more than
3393        one definition to specify multiple prefix strings. A ref that is
3394        under the hierarchies listed in the value of this variable is
3395        excluded, and is hidden when responding to `git push` or `git
3396        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3397        program-specific versions of this config.
3398+
3399You may also include a `!` in front of the ref name to negate the entry,
3400explicitly exposing it, even if an earlier entry marked it as hidden.
3401If you have multiple hideRefs values, later entries override earlier ones
3402(and entries in more-specific config files override less-specific ones).
3403+
3404If a namespace is in use, the namespace prefix is stripped from each
3405reference before it is matched against `transfer.hiderefs` patterns.
3406For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3407the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3408is omitted from the advertisements but `refs/heads/master` and
3409`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3410"have" lines. In order to match refs before stripping, add a `^` in front of
3411the ref name. If you combine `!` and `^`, `!` must be specified first.
3412+
3413Even if you hide refs, a client may still be able to steal the target
3414objects via the techniques described in the "SECURITY" section of the
3415linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3416separate repository.
3417
3418transfer.unpackLimit::
3419        When `fetch.unpackLimit` or `receive.unpackLimit` are
3420        not set, the value of this variable is used instead.
3421        The default value is 100.
3422
3423uploadarchive.allowUnreachable::
3424        If true, allow clients to use `git archive --remote` to request
3425        any tree, whether reachable from the ref tips or not. See the
3426        discussion in the "SECURITY" section of
3427        linkgit:git-upload-archive[1] for more details. Defaults to
3428        `false`.
3429
3430uploadpack.hideRefs::
3431        This variable is the same as `transfer.hideRefs`, but applies
3432        only to `upload-pack` (and so affects only fetches, not pushes).
3433        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3434        also `uploadpack.allowTipSHA1InWant`.
3435
3436uploadpack.allowTipSHA1InWant::
3437        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3438        to accept a fetch request that asks for an object at the tip
3439        of a hidden ref (by default, such a request is rejected).
3440        See also `uploadpack.hideRefs`.  Even if this is false, a client
3441        may be able to steal objects via the techniques described in the
3442        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3443        best to keep private data in a separate repository.
3444
3445uploadpack.allowReachableSHA1InWant::
3446        Allow `upload-pack` to accept a fetch request that asks for an
3447        object that is reachable from any ref tip. However, note that
3448        calculating object reachability is computationally expensive.
3449        Defaults to `false`.  Even if this is false, a client may be able
3450        to steal objects via the techniques described in the "SECURITY"
3451        section of the linkgit:gitnamespaces[7] man page; it's best to
3452        keep private data in a separate repository.
3453
3454uploadpack.allowAnySHA1InWant::
3455        Allow `upload-pack` to accept a fetch request that asks for any
3456        object at all.
3457        Defaults to `false`.
3458
3459uploadpack.keepAlive::
3460        When `upload-pack` has started `pack-objects`, there may be a
3461        quiet period while `pack-objects` prepares the pack. Normally
3462        it would output progress information, but if `--quiet` was used
3463        for the fetch, `pack-objects` will output nothing at all until
3464        the pack data begins. Some clients and networks may consider
3465        the server to be hung and give up. Setting this option instructs
3466        `upload-pack` to send an empty keepalive packet every
3467        `uploadpack.keepAlive` seconds. Setting this option to 0
3468        disables keepalive packets entirely. The default is 5 seconds.
3469
3470uploadpack.packObjectsHook::
3471        If this option is set, when `upload-pack` would run
3472        `git pack-objects` to create a packfile for a client, it will
3473        run this shell command instead.  The `pack-objects` command and
3474        arguments it _would_ have run (including the `git pack-objects`
3475        at the beginning) are appended to the shell command. The stdin
3476        and stdout of the hook are treated as if `pack-objects` itself
3477        was run. I.e., `upload-pack` will feed input intended for
3478        `pack-objects` to the hook, and expects a completed packfile on
3479        stdout.
3480
3481uploadpack.allowFilter::
3482        If this option is set, `upload-pack` will support partial
3483        clone and partial fetch object filtering.
3484+
3485Note that this configuration variable is ignored if it is seen in the
3486repository-level config (this is a safety measure against fetching from
3487untrusted repositories).
3488
3489url.<base>.insteadOf::
3490        Any URL that starts with this value will be rewritten to
3491        start, instead, with <base>. In cases where some site serves a
3492        large number of repositories, and serves them with multiple
3493        access methods, and some users need to use different access
3494        methods, this feature allows people to specify any of the
3495        equivalent URLs and have Git automatically rewrite the URL to
3496        the best alternative for the particular user, even for a
3497        never-before-seen repository on the site.  When more than one
3498        insteadOf strings match a given URL, the longest match is used.
3499+
3500Note that any protocol restrictions will be applied to the rewritten
3501URL. If the rewrite changes the URL to use a custom protocol or remote
3502helper, you may need to adjust the `protocol.*.allow` config to permit
3503the request.  In particular, protocols you expect to use for submodules
3504must be set to `always` rather than the default of `user`. See the
3505description of `protocol.allow` above.
3506
3507url.<base>.pushInsteadOf::
3508        Any URL that starts with this value will not be pushed to;
3509        instead, it will be rewritten to start with <base>, and the
3510        resulting URL will be pushed to. In cases where some site serves
3511        a large number of repositories, and serves them with multiple
3512        access methods, some of which do not allow push, this feature
3513        allows people to specify a pull-only URL and have Git
3514        automatically use an appropriate URL to push, even for a
3515        never-before-seen repository on the site.  When more than one
3516        pushInsteadOf strings match a given URL, the longest match is
3517        used.  If a remote has an explicit pushurl, Git will ignore this
3518        setting for that remote.
3519
3520user.email::
3521        Your email address to be recorded in any newly created commits.
3522        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3523        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3524
3525user.name::
3526        Your full name to be recorded in any newly created commits.
3527        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3528        environment variables.  See linkgit:git-commit-tree[1].
3529
3530user.useConfigOnly::
3531        Instruct Git to avoid trying to guess defaults for `user.email`
3532        and `user.name`, and instead retrieve the values only from the
3533        configuration. For example, if you have multiple email addresses
3534        and would like to use a different one for each repository, then
3535        with this configuration option set to `true` in the global config
3536        along with a name, Git will prompt you to set up an email before
3537        making new commits in a newly cloned repository.
3538        Defaults to `false`.
3539
3540user.signingKey::
3541        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3542        key you want it to automatically when creating a signed tag or
3543        commit, you can override the default selection with this variable.
3544        This option is passed unchanged to gpg's --local-user parameter,
3545        so you may specify a key using any method that gpg supports.
3546
3547versionsort.prereleaseSuffix (deprecated)::
3548        Deprecated alias for `versionsort.suffix`.  Ignored if
3549        `versionsort.suffix` is set.
3550
3551versionsort.suffix::
3552        Even when version sort is used in linkgit:git-tag[1], tagnames
3553        with the same base version but different suffixes are still sorted
3554        lexicographically, resulting e.g. in prerelease tags appearing
3555        after the main release (e.g. "1.0-rc1" after "1.0").  This
3556        variable can be specified to determine the sorting order of tags
3557        with different suffixes.
3558+
3559By specifying a single suffix in this variable, any tagname containing
3560that suffix will appear before the corresponding main release.  E.g. if
3561the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3562"1.0".  If specified multiple times, once per suffix, then the order of
3563suffixes in the configuration will determine the sorting order of tagnames
3564with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3565configuration, then all "1.0-preX" tags will be listed before any
3566"1.0-rcX" tags.  The placement of the main release tag relative to tags
3567with various suffixes can be determined by specifying the empty suffix
3568among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3569"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3570are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3571"v4.8-bfsX".
3572+
3573If more than one suffixes match the same tagname, then that tagname will
3574be sorted according to the suffix which starts at the earliest position in
3575the tagname.  If more than one different matching suffixes start at
3576that earliest position, then that tagname will be sorted according to the
3577longest of those suffixes.
3578The sorting order between different suffixes is undefined if they are
3579in multiple config files.
3580
3581web.browser::
3582        Specify a web browser that may be used by some commands.
3583        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3584        may use it.
3585
3586worktree.guessRemote::
3587        With `add`, if no branch argument, and neither of `-b` nor
3588        `-B` nor `--detach` are given, the command defaults to
3589        creating a new branch from HEAD.  If `worktree.guessRemote` is
3590        set to true, `worktree add` tries to find a remote-tracking
3591        branch whose name uniquely matches the new branch name.  If
3592        such a branch exists, it is checked out and set as "upstream"
3593        for the new branch.  If no such match can be found, it falls
3594        back to creating a new branch from the current HEAD.