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