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