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