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