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