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