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