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