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