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