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