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