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