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