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