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