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