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