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