Documentation / config.txton commit Reword "detached HEAD" notification (13be3e3)
   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        resolveConflict::
 134                Advices shown by various commands when conflicts
 135                prevent the operation from being performed.
 136                Default: true.
 137        implicitIdentity::
 138                Advice on how to set your identity configuration when
 139                your information is guessed from the system username and
 140                domain name. Default: true.
 141
 142        detachedHead::
 143                Advice shown when you used linkgit::git-checkout[1] to
 144                move to the detach HEAD state, to instruct how to create
 145                a local branch after the fact.  Default: true.
 146--
 147
 148core.fileMode::
 149        If false, the executable bit differences between the index and
 150        the working copy are ignored; useful on broken filesystems like FAT.
 151        See linkgit:git-update-index[1].
 152+
 153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 154will probe and set core.fileMode false if appropriate when the
 155repository is created.
 156
 157core.ignoreCygwinFSTricks::
 158        This option is only used by Cygwin implementation of Git. If false,
 159        the Cygwin stat() and lstat() functions are used. This may be useful
 160        if your repository consists of a few separate directories joined in
 161        one hierarchy using Cygwin mount. If true, Git uses native Win32 API
 162        whenever it is possible and falls back to Cygwin functions only to
 163        handle symbol links. The native mode is more than twice faster than
 164        normal Cygwin l/stat() functions. True by default, unless core.filemode
 165        is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
 166        POSIX emulation is required to support core.filemode.
 167
 168core.ignorecase::
 169        If true, this option enables various workarounds to enable
 170        git to work better on filesystems that are not case sensitive,
 171        like FAT. For example, if a directory listing finds
 172        "makefile" when git expects "Makefile", git will assume
 173        it is really the same file, and continue to remember it as
 174        "Makefile".
 175+
 176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 177will probe and set core.ignorecase true if appropriate when the repository
 178is created.
 179
 180core.trustctime::
 181        If false, the ctime differences between the index and the
 182        working copy are ignored; useful when the inode change time
 183        is regularly modified by something outside Git (file system
 184        crawlers and some backup systems).
 185        See linkgit:git-update-index[1]. True by default.
 186
 187core.quotepath::
 188        The commands that output paths (e.g. 'ls-files',
 189        'diff'), when not given the `-z` option, will quote
 190        "unusual" characters in the pathname by enclosing the
 191        pathname in a double-quote pair and with backslashes the
 192        same way strings in C source code are quoted.  If this
 193        variable is set to false, the bytes higher than 0x80 are
 194        not quoted but output as verbatim.  Note that double
 195        quote, backslash and control characters are always
 196        quoted without `-z` regardless of the setting of this
 197        variable.
 198
 199core.autocrlf::
 200        If true, makes git convert `CRLF` at the end of lines in text files to
 201        `LF` when reading from the filesystem, and convert in reverse when
 202        writing to the filesystem.  The variable can be set to
 203        'input', in which case the conversion happens only while
 204        reading from the filesystem but files are written out with
 205        `LF` at the end of lines.  A file is considered
 206        "text" (i.e. be subjected to the autocrlf mechanism) based on
 207        the file's `crlf` attribute, or if `crlf` is unspecified,
 208        based on the file's contents.  See linkgit:gitattributes[5].
 209
 210core.safecrlf::
 211        If true, makes git check if converting `CRLF` as controlled by
 212        `core.autocrlf` is reversible.  Git will verify if a command
 213        modifies a file in the work tree either directly or indirectly.
 214        For example, committing a file followed by checking out the
 215        same file should yield the original file in the work tree.  If
 216        this is not the case for the current setting of
 217        `core.autocrlf`, git will reject the file.  The variable can
 218        be set to "warn", in which case git will only warn about an
 219        irreversible conversion but continue the operation.
 220+
 221CRLF conversion bears a slight chance of corrupting data.
 222autocrlf=true will convert CRLF to LF during commit and LF to
 223CRLF during checkout.  A file that contains a mixture of LF and
 224CRLF before the commit cannot be recreated by git.  For text
 225files this is the right thing to do: it corrects line endings
 226such that we have only LF line endings in the repository.
 227But for binary files that are accidentally classified as text the
 228conversion can corrupt data.
 229+
 230If you recognize such corruption early you can easily fix it by
 231setting the conversion type explicitly in .gitattributes.  Right
 232after committing you still have the original file in your work
 233tree and this file is not yet corrupted.  You can explicitly tell
 234git that this file is binary and git will handle the file
 235appropriately.
 236+
 237Unfortunately, the desired effect of cleaning up text files with
 238mixed line endings and the undesired effect of corrupting binary
 239files cannot be distinguished.  In both cases CRLFs are removed
 240in an irreversible way.  For text files this is the right thing
 241to do because CRLFs are line endings, while for binary files
 242converting CRLFs corrupts data.
 243+
 244Note, this safety check does not mean that a checkout will generate a
 245file identical to the original file for a different setting of
 246`core.autocrlf`, but only for the current one.  For example, a text
 247file with `LF` would be accepted with `core.autocrlf=input` and could
 248later be checked out with `core.autocrlf=true`, in which case the
 249resulting file would contain `CRLF`, although the original file
 250contained `LF`.  However, in both work trees the line endings would be
 251consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 252file with mixed line endings would be reported by the `core.safecrlf`
 253mechanism.
 254
 255core.symlinks::
 256        If false, symbolic links are checked out as small plain files that
 257        contain the link text. linkgit:git-update-index[1] and
 258        linkgit:git-add[1] will not change the recorded type to regular
 259        file. Useful on filesystems like FAT that do not support
 260        symbolic links.
 261+
 262The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 263will probe and set core.symlinks false if appropriate when the repository
 264is created.
 265
 266core.gitProxy::
 267        A "proxy command" to execute (as 'command host port') instead
 268        of establishing direct connection to the remote server when
 269        using the git protocol for fetching. If the variable value is
 270        in the "COMMAND for DOMAIN" format, the command is applied only
 271        on hostnames ending with the specified domain string. This variable
 272        may be set multiple times and is matched in the given order;
 273        the first match wins.
 274+
 275Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
 276(which always applies universally, without the special "for"
 277handling).
 278+
 279The special string `none` can be used as the proxy command to
 280specify that no proxy be used for a given domain pattern.
 281This is useful for excluding servers inside a firewall from
 282proxy use, while defaulting to a common proxy for external domains.
 283
 284core.ignoreStat::
 285        If true, commands which modify both the working tree and the index
 286        will mark the updated paths with the "assume unchanged" bit in the
 287        index. These marked files are then assumed to stay unchanged in the
 288        working copy, until you mark them otherwise manually - Git will not
 289        detect the file changes by lstat() calls. This is useful on systems
 290        where those are very slow, such as Microsoft Windows.
 291        See linkgit:git-update-index[1].
 292        False by default.
 293
 294core.preferSymlinkRefs::
 295        Instead of the default "symref" format for HEAD
 296        and other symbolic reference files, use symbolic links.
 297        This is sometimes needed to work with old scripts that
 298        expect HEAD to be a symbolic link.
 299
 300core.bare::
 301        If true this repository is assumed to be 'bare' and has no
 302        working directory associated with it.  If this is the case a
 303        number of commands that require a working directory will be
 304        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 305+
 306This setting is automatically guessed by linkgit:git-clone[1] or
 307linkgit:git-init[1] when the repository was created.  By default a
 308repository that ends in "/.git" is assumed to be not bare (bare =
 309false), while all other repositories are assumed to be bare (bare
 310= true).
 311
 312core.worktree::
 313        Set the path to the root of the work tree.
 314        This can be overridden by the GIT_WORK_TREE environment
 315        variable and the '--work-tree' command line option. It can be
 316        an absolute path or a relative path to the .git directory,
 317        either specified by --git-dir or GIT_DIR, or automatically
 318        discovered.
 319        If --git-dir or GIT_DIR are specified but none of
 320        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 321        the current working directory is regarded as the root of the
 322        work tree.
 323+
 324Note that this variable is honored even when set in a configuration
 325file in a ".git" subdirectory of a directory, and its value differs
 326from the latter directory (e.g. "/path/to/.git/config" has
 327core.worktree set to "/different/path"), which is most likely a
 328misconfiguration.  Running git commands in "/path/to" directory will
 329still use "/different/path" as the root of the work tree and can cause
 330great confusion to the users.
 331
 332core.logAllRefUpdates::
 333        Enable the reflog. Updates to a ref <ref> is logged to the file
 334        "$GIT_DIR/logs/<ref>", by appending the new and old
 335        SHA1, the date/time and the reason of the update, but
 336        only when the file exists.  If this configuration
 337        variable is set to true, missing "$GIT_DIR/logs/<ref>"
 338        file is automatically created for branch heads.
 339+
 340This information can be used to determine what commit
 341was the tip of a branch "2 days ago".
 342+
 343This value is true by default in a repository that has
 344a working directory associated with it, and false by
 345default in a bare repository.
 346
 347core.repositoryFormatVersion::
 348        Internal variable identifying the repository format and layout
 349        version.
 350
 351core.sharedRepository::
 352        When 'group' (or 'true'), the repository is made shareable between
 353        several users in a group (making sure all the files and objects are
 354        group-writable). When 'all' (or 'world' or 'everybody'), the
 355        repository will be readable by all users, additionally to being
 356        group-shareable. When 'umask' (or 'false'), git will use permissions
 357        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 358        files in the repository will have this mode value. '0xxx' will override
 359        user's umask value (whereas the other options will only override
 360        requested parts of the user's umask value). Examples: '0660' will make
 361        the repo read/write-able for the owner and group, but inaccessible to
 362        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 363        repository that is group-readable but not group-writable.
 364        See linkgit:git-init[1]. False by default.
 365
 366core.warnAmbiguousRefs::
 367        If true, git will warn you if the ref name you passed it is ambiguous
 368        and might match multiple refs in the .git/refs/ tree. True by default.
 369
 370core.compression::
 371        An integer -1..9, indicating a default compression level.
 372        -1 is the zlib default. 0 means no compression,
 373        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 374        If set, this provides a default to other compression variables,
 375        such as 'core.loosecompression' and 'pack.compression'.
 376
 377core.loosecompression::
 378        An integer -1..9, indicating the compression level for objects that
 379        are not in a pack file. -1 is the zlib default. 0 means no
 380        compression, and 1..9 are various speed/size tradeoffs, 9 being
 381        slowest.  If not set,  defaults to core.compression.  If that is
 382        not set,  defaults to 1 (best speed).
 383
 384core.packedGitWindowSize::
 385        Number of bytes of a pack file to map into memory in a
 386        single mapping operation.  Larger window sizes may allow
 387        your system to process a smaller number of large pack files
 388        more quickly.  Smaller window sizes will negatively affect
 389        performance due to increased calls to the operating system's
 390        memory manager, but may improve performance when accessing
 391        a large number of large pack files.
 392+
 393Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 394MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 395be reasonable for all users/operating systems.  You probably do
 396not need to adjust this value.
 397+
 398Common unit suffixes of 'k', 'm', or 'g' are supported.
 399
 400core.packedGitLimit::
 401        Maximum number of bytes to map simultaneously into memory
 402        from pack files.  If Git needs to access more than this many
 403        bytes at once to complete an operation it will unmap existing
 404        regions to reclaim virtual address space within the process.
 405+
 406Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 407This should be reasonable for all users/operating systems, except on
 408the largest projects.  You probably do not need to adjust this value.
 409+
 410Common unit suffixes of 'k', 'm', or 'g' are supported.
 411
 412core.deltaBaseCacheLimit::
 413        Maximum number of bytes to reserve for caching base objects
 414        that multiple deltafied objects reference.  By storing the
 415        entire decompressed base objects in a cache Git is able
 416        to avoid unpacking and decompressing frequently used base
 417        objects multiple times.
 418+
 419Default is 16 MiB on all platforms.  This should be reasonable
 420for all users/operating systems, except on the largest projects.
 421You probably do not need to adjust this value.
 422+
 423Common unit suffixes of 'k', 'm', or 'g' are supported.
 424
 425core.excludesfile::
 426        In addition to '.gitignore' (per-directory) and
 427        '.git/info/exclude', git looks into this file for patterns
 428        of files which are not meant to be tracked.  "{tilde}/" is expanded
 429        to the value of `$HOME` and "{tilde}user/" to the specified user's
 430        home directory.  See linkgit:gitignore[5].
 431
 432core.editor::
 433        Commands such as `commit` and `tag` that lets you edit
 434        messages by launching an editor uses the value of this
 435        variable when it is set, and the environment variable
 436        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 437
 438core.pager::
 439        The command that git will use to paginate output.  Can
 440        be overridden with the `GIT_PAGER` environment
 441        variable.  Note that git sets the `LESS` environment
 442        variable to `FRSX` if it is unset when it runs the
 443        pager.  One can change these settings by setting the
 444        `LESS` variable to some other value.  Alternately,
 445        these settings can be overridden on a project or
 446        global basis by setting the `core.pager` option.
 447        Setting `core.pager` has no affect on the `LESS`
 448        environment variable behaviour above, so if you want
 449        to override git's default settings this way, you need
 450        to be explicit.  For example, to disable the S option
 451        in a backward compatible manner, set `core.pager`
 452        to `less -+$LESS -FRX`.  This will be passed to the
 453        shell by git, which will translate the final command to
 454        `LESS=FRSX less -+FRSX -FRX`.
 455
 456core.whitespace::
 457        A comma separated list of common whitespace problems to
 458        notice.  'git diff' will use `color.diff.whitespace` to
 459        highlight them, and 'git apply --whitespace=error' will
 460        consider them as errors.  You can prefix `-` to disable
 461        any of them (e.g. `-trailing-space`):
 462+
 463* `blank-at-eol` treats trailing whitespaces at the end of the line
 464  as an error (enabled by default).
 465* `space-before-tab` treats a space character that appears immediately
 466  before a tab character in the initial indent part of the line as an
 467  error (enabled by default).
 468* `indent-with-non-tab` treats a line that is indented with 8 or more
 469  space characters as an error (not enabled by default).
 470* `blank-at-eof` treats blank lines added at the end of file as an error
 471  (enabled by default).
 472* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 473  `blank-at-eof`.
 474* `cr-at-eol` treats a carriage-return at the end of line as
 475  part of the line terminator, i.e. with it, `trailing-space`
 476  does not trigger if the character before such a carriage-return
 477  is not a whitespace (not enabled by default).
 478
 479core.fsyncobjectfiles::
 480        This boolean will enable 'fsync()' when writing object files.
 481+
 482This is a total waste of time and effort on a filesystem that orders
 483data writes properly, but can be useful for filesystems that do not use
 484journalling (traditional UNIX filesystems) or that only journal metadata
 485and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 486
 487core.preloadindex::
 488        Enable parallel index preload for operations like 'git diff'
 489+
 490This can speed up operations like 'git diff' and 'git status' especially
 491on filesystems like NFS that have weak caching semantics and thus
 492relatively high IO latencies.  With this set to 'true', git will do the
 493index comparison to the filesystem data in parallel, allowing
 494overlapping IO's.
 495
 496core.createObject::
 497        You can set this to 'link', in which case a hardlink followed by
 498        a delete of the source are used to make sure that object creation
 499        will not overwrite existing objects.
 500+
 501On some file system/operating system combinations, this is unreliable.
 502Set this config setting to 'rename' there; However, This will remove the
 503check that makes sure that existing object files will not get overwritten.
 504
 505core.notesRef::
 506        When showing commit messages, also show notes which are stored in
 507        the given ref.  This ref is expected to contain files named
 508        after the full SHA-1 of the commit they annotate.
 509+
 510If such a file exists in the given ref, the referenced blob is read, and
 511appended to the commit message, separated by a "Notes:" line.  If the
 512given ref itself does not exist, it is not an error, but means that no
 513notes should be printed.
 514+
 515This setting defaults to "refs/notes/commits", and can be overridden by
 516the `GIT_NOTES_REF` environment variable.
 517
 518core.sparseCheckout::
 519        Enable "sparse checkout" feature. See section "Sparse checkout" in
 520        linkgit:git-read-tree[1] for more information.
 521
 522add.ignore-errors::
 523        Tells 'git add' to continue adding files when some files cannot be
 524        added due to indexing errors. Equivalent to the '--ignore-errors'
 525        option of linkgit:git-add[1].
 526
 527alias.*::
 528        Command aliases for the linkgit:git[1] command wrapper - e.g.
 529        after defining "alias.last = cat-file commit HEAD", the invocation
 530        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 531        confusion and troubles with script usage, aliases that
 532        hide existing git commands are ignored. Arguments are split by
 533        spaces, the usual shell quoting and escaping is supported.
 534        quote pair and a backslash can be used to quote them.
 535+
 536If the alias expansion is prefixed with an exclamation point,
 537it will be treated as a shell command.  For example, defining
 538"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 539"git new" is equivalent to running the shell command
 540"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 541executed from the top-level directory of a repository, which may
 542not necessarily be the current directory.
 543
 544apply.ignorewhitespace::
 545        When set to 'change', tells 'git apply' to ignore changes in
 546        whitespace, in the same way as the '--ignore-space-change'
 547        option.
 548        When set to one of: no, none, never, false tells 'git apply' to
 549        respect all whitespace differences.
 550        See linkgit:git-apply[1].
 551
 552apply.whitespace::
 553        Tells 'git apply' how to handle whitespaces, in the same way
 554        as the '--whitespace' option. See linkgit:git-apply[1].
 555
 556branch.autosetupmerge::
 557        Tells 'git branch' and 'git checkout' to set up new branches
 558        so that linkgit:git-pull[1] will appropriately merge from the
 559        starting point branch. Note that even if this option is not set,
 560        this behavior can be chosen per-branch using the `--track`
 561        and `--no-track` options. The valid settings are: `false` -- no
 562        automatic setup is done; `true` -- automatic setup is done when the
 563        starting point is a remote branch; `always` -- automatic setup is
 564        done when the starting point is either a local branch or remote
 565        branch. This option defaults to true.
 566
 567branch.autosetuprebase::
 568        When a new branch is created with 'git branch' or 'git checkout'
 569        that tracks another branch, this variable tells git to set
 570        up pull to rebase instead of merge (see "branch.<name>.rebase").
 571        When `never`, rebase is never automatically set to true.
 572        When `local`, rebase is set to true for tracked branches of
 573        other local branches.
 574        When `remote`, rebase is set to true for tracked branches of
 575        remote branches.
 576        When `always`, rebase will be set to true for all tracking
 577        branches.
 578        See "branch.autosetupmerge" for details on how to set up a
 579        branch to track another branch.
 580        This option defaults to never.
 581
 582branch.<name>.remote::
 583        When in branch <name>, it tells 'git fetch' and 'git push' which
 584        remote to fetch from/push to.  It defaults to `origin` if no remote is
 585        configured. `origin` is also used if you are not on any branch.
 586
 587branch.<name>.merge::
 588        Defines, together with branch.<name>.remote, the upstream branch
 589        for the given branch. It tells 'git fetch'/'git pull' which
 590        branch to merge and can also affect 'git push' (see push.default).
 591        When in branch <name>, it tells 'git fetch' the default
 592        refspec to be marked for merging in FETCH_HEAD. The value is
 593        handled like the remote part of a refspec, and must match a
 594        ref which is fetched from the remote given by
 595        "branch.<name>.remote".
 596        The merge information is used by 'git pull' (which at first calls
 597        'git fetch') to lookup the default branch for merging. Without
 598        this option, 'git pull' defaults to merge the first refspec fetched.
 599        Specify multiple values to get an octopus merge.
 600        If you wish to setup 'git pull' so that it merges into <name> from
 601        another branch in the local repository, you can point
 602        branch.<name>.merge to the desired branch, and use the special setting
 603        `.` (a period) for branch.<name>.remote.
 604
 605branch.<name>.mergeoptions::
 606        Sets default options for merging into branch <name>. The syntax and
 607        supported options are the same as those of linkgit:git-merge[1], but
 608        option values containing whitespace characters are currently not
 609        supported.
 610
 611branch.<name>.rebase::
 612        When true, rebase the branch <name> on top of the fetched branch,
 613        instead of merging the default branch from the default remote when
 614        "git pull" is run.
 615        *NOTE*: this is a possibly dangerous operation; do *not* use
 616        it unless you understand the implications (see linkgit:git-rebase[1]
 617        for details).
 618
 619browser.<tool>.cmd::
 620        Specify the command to invoke the specified browser. The
 621        specified command is evaluated in shell with the URLs passed
 622        as arguments. (See linkgit:git-web--browse[1].)
 623
 624browser.<tool>.path::
 625        Override the path for the given tool that may be used to
 626        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 627        working repository in gitweb (see linkgit:git-instaweb[1]).
 628
 629clean.requireForce::
 630        A boolean to make git-clean do nothing unless given -f
 631        or -n.   Defaults to true.
 632
 633color.branch::
 634        A boolean to enable/disable color in the output of
 635        linkgit:git-branch[1]. May be set to `always`,
 636        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 637        only when the output is to a terminal. Defaults to false.
 638
 639color.branch.<slot>::
 640        Use customized color for branch coloration. `<slot>` is one of
 641        `current` (the current branch), `local` (a local branch),
 642        `remote` (a tracking branch in refs/remotes/), `plain` (other
 643        refs).
 644+
 645The value for these configuration variables is a list of colors (at most
 646two) and attributes (at most one), separated by spaces.  The colors
 647accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 648`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 649`blink` and `reverse`.  The first color given is the foreground; the
 650second is the background.  The position of the attribute, if any,
 651doesn't matter.
 652
 653color.diff::
 654        When set to `always`, always use colors in patch.
 655        When false (or `never`), never.  When set to `true` or `auto`, use
 656        colors only when the output is to the terminal. Defaults to false.
 657
 658color.diff.<slot>::
 659        Use customized color for diff colorization.  `<slot>` specifies
 660        which part of the patch to use the specified color, and is one
 661        of `plain` (context text), `meta` (metainformation), `frag`
 662        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 663        `new` (added lines), `commit` (commit headers), or `whitespace`
 664        (highlighting whitespace errors). The values of these variables may be
 665        specified as in color.branch.<slot>.
 666
 667color.grep::
 668        When set to `always`, always highlight matches.  When `false` (or
 669        `never`), never.  When set to `true` or `auto`, use color only
 670        when the output is written to the terminal.  Defaults to `false`.
 671
 672color.grep.match::
 673        Use customized color for matches.  The value of this variable
 674        may be specified as in color.branch.<slot>.  It is passed using
 675        the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
 676        calling an external 'grep'.
 677
 678color.interactive::
 679        When set to `always`, always use colors for interactive prompts
 680        and displays (such as those used by "git-add --interactive").
 681        When false (or `never`), never.  When set to `true` or `auto`, use
 682        colors only when the output is to the terminal. Defaults to false.
 683
 684color.interactive.<slot>::
 685        Use customized color for 'git add --interactive'
 686        output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
 687        four distinct types of normal output from interactive
 688        commands.  The values of these variables may be specified as
 689        in color.branch.<slot>.
 690
 691color.pager::
 692        A boolean to enable/disable colored output when the pager is in
 693        use (default is true).
 694
 695color.showbranch::
 696        A boolean to enable/disable color in the output of
 697        linkgit:git-show-branch[1]. May be set to `always`,
 698        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 699        only when the output is to a terminal. Defaults to false.
 700
 701color.status::
 702        A boolean to enable/disable color in the output of
 703        linkgit:git-status[1]. May be set to `always`,
 704        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 705        only when the output is to a terminal. Defaults to false.
 706
 707color.status.<slot>::
 708        Use customized color for status colorization. `<slot>` is
 709        one of `header` (the header text of the status message),
 710        `added` or `updated` (files which are added but not committed),
 711        `changed` (files which are changed but not added in the index),
 712        `untracked` (files which are not tracked by git), or
 713        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 714        to red). The values of these variables may be specified as in
 715        color.branch.<slot>.
 716
 717color.ui::
 718        When set to `always`, always use colors in all git commands which
 719        are capable of colored output. When false (or `never`), never. When
 720        set to `true` or `auto`, use colors only when the output is to the
 721        terminal. When more specific variables of color.* are set, they always
 722        take precedence over this setting. Defaults to false.
 723
 724commit.status::
 725        A boolean to enable/disable inclusion of status information in the
 726        commit message template when using an editor to prepare the commit
 727        message.  Defaults to true.
 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.minSessions::
1154        The number of curl sessions (counted across slots) to be kept across
1155        requests. They will not be ended with curl_easy_cleanup() until
1156        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1157        value will be capped at 1. Defaults to 1.
1158
1159http.postBuffer::
1160        Maximum size in bytes of the buffer used by smart HTTP
1161        transports when POSTing data to the remote system.
1162        For requests larger than this buffer size, HTTP/1.1 and
1163        Transfer-Encoding: chunked is used to avoid creating a
1164        massive pack file locally.  Default is 1 MiB, which is
1165        sufficient for most requests.
1166
1167http.lowSpeedLimit, http.lowSpeedTime::
1168        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1169        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1170        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1171        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1172
1173http.noEPSV::
1174        A boolean which disables using of EPSV ftp command by curl.
1175        This can helpful with some "poor" ftp servers which don't
1176        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1177        environment variable. Default is false (curl will use EPSV).
1178
1179i18n.commitEncoding::
1180        Character encoding the commit messages are stored in; git itself
1181        does not care per se, but this information is necessary e.g. when
1182        importing commits from emails or in the gitk graphical history
1183        browser (and possibly at other places in the future or in other
1184        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1185
1186i18n.logOutputEncoding::
1187        Character encoding the commit messages are converted to when
1188        running 'git log' and friends.
1189
1190imap::
1191        The configuration variables in the 'imap' section are described
1192        in linkgit:git-imap-send[1].
1193
1194instaweb.browser::
1195        Specify the program that will be used to browse your working
1196        repository in gitweb. See linkgit:git-instaweb[1].
1197
1198instaweb.httpd::
1199        The HTTP daemon command-line to start gitweb on your working
1200        repository. See linkgit:git-instaweb[1].
1201
1202instaweb.local::
1203        If true the web server started by linkgit:git-instaweb[1] will
1204        be bound to the local IP (127.0.0.1).
1205
1206instaweb.modulepath::
1207        The module path for an apache httpd used by linkgit:git-instaweb[1].
1208
1209instaweb.port::
1210        The port number to bind the gitweb httpd to. See
1211        linkgit:git-instaweb[1].
1212
1213interactive.singlekey::
1214        In interactive commands, allow the user to provide one-letter
1215        input with a single key (i.e., without hitting enter).
1216        Currently this is used only by the `\--patch` mode of
1217        linkgit:git-add[1].  Note that this setting is silently
1218        ignored if portable keystroke input is not available.
1219
1220log.date::
1221        Set default date-time mode for the log command. Setting log.date
1222        value is similar to using 'git log'\'s --date option. The value is one of the
1223        following alternatives: {relative,local,default,iso,rfc,short}.
1224        See linkgit:git-log[1].
1225
1226log.showroot::
1227        If true, the initial commit will be shown as a big creation event.
1228        This is equivalent to a diff against an empty tree.
1229        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1230        normally hide the root commit will now show it. True by default.
1231
1232mailmap.file::
1233        The location of an augmenting mailmap file. The default
1234        mailmap, located in the root of the repository, is loaded
1235        first, then the mailmap file pointed to by this variable.
1236        The location of the mailmap file may be in a repository
1237        subdirectory, or somewhere outside of the repository itself.
1238        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1239
1240man.viewer::
1241        Specify the programs that may be used to display help in the
1242        'man' format. See linkgit:git-help[1].
1243
1244man.<tool>.cmd::
1245        Specify the command to invoke the specified man viewer. The
1246        specified command is evaluated in shell with the man page
1247        passed as argument. (See linkgit:git-help[1].)
1248
1249man.<tool>.path::
1250        Override the path for the given tool that may be used to
1251        display help in the 'man' format. See linkgit:git-help[1].
1252
1253include::merge-config.txt[]
1254
1255mergetool.<tool>.path::
1256        Override the path for the given tool.  This is useful in case
1257        your tool is not in the PATH.
1258
1259mergetool.<tool>.cmd::
1260        Specify the command to invoke the specified merge tool.  The
1261        specified command is evaluated in shell with the following
1262        variables available: 'BASE' is the name of a temporary file
1263        containing the common base of the files to be merged, if available;
1264        'LOCAL' is the name of a temporary file containing the contents of
1265        the file on the current branch; 'REMOTE' is the name of a temporary
1266        file containing the contents of the file from the branch being
1267        merged; 'MERGED' contains the name of the file to which the merge
1268        tool should write the results of a successful merge.
1269
1270mergetool.<tool>.trustExitCode::
1271        For a custom merge command, specify whether the exit code of
1272        the merge command can be used to determine whether the merge was
1273        successful.  If this is not set to true then the merge target file
1274        timestamp is checked and the merge assumed to have been successful
1275        if the file has been updated, otherwise the user is prompted to
1276        indicate the success of the merge.
1277
1278mergetool.keepBackup::
1279        After performing a merge, the original file with conflict markers
1280        can be saved as a file with a `.orig` extension.  If this variable
1281        is set to `false` then this file is not preserved.  Defaults to
1282        `true` (i.e. keep the backup files).
1283
1284mergetool.keepTemporaries::
1285        When invoking a custom merge tool, git uses a set of temporary
1286        files to pass to the tool. If the tool returns an error and this
1287        variable is set to `true`, then these temporary files will be
1288        preserved, otherwise they will be removed after the tool has
1289        exited. Defaults to `false`.
1290
1291mergetool.prompt::
1292        Prompt before each invocation of the merge resolution program.
1293
1294pack.window::
1295        The size of the window used by linkgit:git-pack-objects[1] when no
1296        window size is given on the command line. Defaults to 10.
1297
1298pack.depth::
1299        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1300        maximum depth is given on the command line. Defaults to 50.
1301
1302pack.windowMemory::
1303        The window memory size limit used by linkgit:git-pack-objects[1]
1304        when no limit is given on the command line.  The value can be
1305        suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1306        limit.
1307
1308pack.compression::
1309        An integer -1..9, indicating the compression level for objects
1310        in a pack file. -1 is the zlib default. 0 means no
1311        compression, and 1..9 are various speed/size tradeoffs, 9 being
1312        slowest.  If not set,  defaults to core.compression.  If that is
1313        not set,  defaults to -1, the zlib default, which is "a default
1314        compromise between speed and compression (currently equivalent
1315        to level 6)."
1316
1317pack.deltaCacheSize::
1318        The maximum memory in bytes used for caching deltas in
1319        linkgit:git-pack-objects[1] before writing them out to a pack.
1320        This cache is used to speed up the writing object phase by not
1321        having to recompute the final delta result once the best match
1322        for all objects is found.  Repacking large repositories on machines
1323        which are tight with memory might be badly impacted by this though,
1324        especially if this cache pushes the system into swapping.
1325        A value of 0 means no limit. The smallest size of 1 byte may be
1326        used to virtually disable this cache. Defaults to 256 MiB.
1327
1328pack.deltaCacheLimit::
1329        The maximum size of a delta, that is cached in
1330        linkgit:git-pack-objects[1]. This cache is used to speed up the
1331        writing object phase by not having to recompute the final delta
1332        result once the best match for all objects is found. Defaults to 1000.
1333
1334pack.threads::
1335        Specifies the number of threads to spawn when searching for best
1336        delta matches.  This requires that linkgit:git-pack-objects[1]
1337        be compiled with pthreads otherwise this option is ignored with a
1338        warning. This is meant to reduce packing time on multiprocessor
1339        machines. The required amount of memory for the delta search window
1340        is however multiplied by the number of threads.
1341        Specifying 0 will cause git to auto-detect the number of CPU's
1342        and set the number of threads accordingly.
1343
1344pack.indexVersion::
1345        Specify the default pack index version.  Valid values are 1 for
1346        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1347        the new pack index with capabilities for packs larger than 4 GB
1348        as well as proper protection against the repacking of corrupted
1349        packs.  Version 2 is the default.  Note that version 2 is enforced
1350        and this config option ignored whenever the corresponding pack is
1351        larger than 2 GB.
1352+
1353If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1354cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1355that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1356other side may give you a repository that cannot be accessed with your
1357older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1358you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1359the `{asterisk}.idx` file.
1360
1361pack.packSizeLimit::
1362        The default maximum size of a pack.  This setting only affects
1363        packing to a file, i.e. the git:// protocol is unaffected.  It
1364        can be overridden by the `\--max-pack-size` option of
1365        linkgit:git-repack[1].
1366
1367pager.<cmd>::
1368        Allows turning on or off pagination of the output of a
1369        particular git subcommand when writing to a tty.  If
1370        `\--paginate` or `\--no-pager` is specified on the command line,
1371        it takes precedence over this option.  To disable pagination for
1372        all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1373
1374pull.octopus::
1375        The default merge strategy to use when pulling multiple branches
1376        at once.
1377
1378pull.twohead::
1379        The default merge strategy to use when pulling a single branch.
1380
1381push.default::
1382        Defines the action git push should take if no refspec is given
1383        on the command line, no refspec is configured in the remote, and
1384        no refspec is implied by any of the options given on the command
1385        line. Possible values are:
1386+
1387* `nothing` do not push anything.
1388* `matching` push all matching branches.
1389  All branches having the same name in both ends are considered to be
1390  matching. This is the default.
1391* `tracking` push the current branch to its upstream branch.
1392* `current` push the current branch to a branch of the same name.
1393
1394rebase.stat::
1395        Whether to show a diffstat of what changed upstream since the last
1396        rebase. False by default.
1397
1398receive.autogc::
1399        By default, git-receive-pack will run "git-gc --auto" after
1400        receiving data from git-push and updating refs.  You can stop
1401        it by setting this variable to false.
1402
1403receive.fsckObjects::
1404        If it is set to true, git-receive-pack will check all received
1405        objects. It will abort in the case of a malformed object or a
1406        broken link. The result of an abort are only dangling objects.
1407        Defaults to false.
1408
1409receive.unpackLimit::
1410        If the number of objects received in a push is below this
1411        limit then the objects will be unpacked into loose object
1412        files. However if the number of received objects equals or
1413        exceeds this limit then the received pack will be stored as
1414        a pack, after adding any missing delta bases.  Storing the
1415        pack from a push can make the push operation complete faster,
1416        especially on slow filesystems.  If not set, the value of
1417        `transfer.unpackLimit` is used instead.
1418
1419receive.denyDeletes::
1420        If set to true, git-receive-pack will deny a ref update that deletes
1421        the ref. Use this to prevent such a ref deletion via a push.
1422
1423receive.denyCurrentBranch::
1424        If set to true or "refuse", receive-pack will deny a ref update
1425        to the currently checked out branch of a non-bare repository.
1426        Such a push is potentially dangerous because it brings the HEAD
1427        out of sync with the index and working tree. If set to "warn",
1428        print a warning of such a push to stderr, but allow the push to
1429        proceed. If set to false or "ignore", allow such pushes with no
1430        message. Defaults to "warn".
1431
1432receive.denyNonFastForwards::
1433        If set to true, git-receive-pack will deny a ref update which is
1434        not a fast-forward. Use this to prevent such an update via a push,
1435        even if that push is forced. This configuration variable is
1436        set when initializing a shared repository.
1437
1438receive.updateserverinfo::
1439        If set to true, git-receive-pack will run git-update-server-info
1440        after receiving data from git-push and updating refs.
1441
1442remote.<name>.url::
1443        The URL of a remote repository.  See linkgit:git-fetch[1] or
1444        linkgit:git-push[1].
1445
1446remote.<name>.pushurl::
1447        The push URL of a remote repository.  See linkgit:git-push[1].
1448
1449remote.<name>.proxy::
1450        For remotes that require curl (http, https and ftp), the URL to
1451        the proxy to use for that remote.  Set to the empty string to
1452        disable proxying for that remote.
1453
1454remote.<name>.fetch::
1455        The default set of "refspec" for linkgit:git-fetch[1]. See
1456        linkgit:git-fetch[1].
1457
1458remote.<name>.push::
1459        The default set of "refspec" for linkgit:git-push[1]. See
1460        linkgit:git-push[1].
1461
1462remote.<name>.mirror::
1463        If true, pushing to this remote will automatically behave
1464        as if the `\--mirror` option was given on the command line.
1465
1466remote.<name>.skipDefaultUpdate::
1467        If true, this remote will be skipped by default when updating
1468        using linkgit:git-fetch[1] or the `update` subcommand of
1469        linkgit:git-remote[1].
1470
1471remote.<name>.skipFetchAll::
1472        If true, this remote will be skipped by default when updating
1473        using linkgit:git-fetch[1] or the `update` subcommand of
1474        linkgit:git-remote[1].
1475
1476remote.<name>.receivepack::
1477        The default program to execute on the remote side when pushing.  See
1478        option \--receive-pack of linkgit:git-push[1].
1479
1480remote.<name>.uploadpack::
1481        The default program to execute on the remote side when fetching.  See
1482        option \--upload-pack of linkgit:git-fetch-pack[1].
1483
1484remote.<name>.tagopt::
1485        Setting this value to \--no-tags disables automatic tag following when
1486        fetching from remote <name>
1487
1488remote.<name>.vcs::
1489        Setting this to a value <vcs> will cause git to interact with
1490        the remote with the git-remote-<vcs> helper.
1491
1492remotes.<group>::
1493        The list of remotes which are fetched by "git remote update
1494        <group>".  See linkgit:git-remote[1].
1495
1496repack.usedeltabaseoffset::
1497        By default, linkgit:git-repack[1] creates packs that use
1498        delta-base offset. If you need to share your repository with
1499        git older than version 1.4.4, either directly or via a dumb
1500        protocol such as http, then you need to set this option to
1501        "false" and repack. Access from old git versions over the
1502        native protocol are unaffected by this option.
1503
1504rerere.autoupdate::
1505        When set to true, `git-rerere` updates the index with the
1506        resulting contents after it cleanly resolves conflicts using
1507        previously recorded resolution.  Defaults to false.
1508
1509rerere.enabled::
1510        Activate recording of resolved conflicts, so that identical
1511        conflict hunks can be resolved automatically, should they
1512        be encountered again.  linkgit:git-rerere[1] command is by
1513        default enabled if you create `rr-cache` directory under
1514        `$GIT_DIR`, but can be disabled by setting this option to false.
1515
1516sendemail.identity::
1517        A configuration identity. When given, causes values in the
1518        'sendemail.<identity>' subsection to take precedence over
1519        values in the 'sendemail' section. The default identity is
1520        the value of 'sendemail.identity'.
1521
1522sendemail.smtpencryption::
1523        See linkgit:git-send-email[1] for description.  Note that this
1524        setting is not subject to the 'identity' mechanism.
1525
1526sendemail.smtpssl::
1527        Deprecated alias for 'sendemail.smtpencryption = ssl'.
1528
1529sendemail.<identity>.*::
1530        Identity-specific versions of the 'sendemail.*' parameters
1531        found below, taking precedence over those when the this
1532        identity is selected, through command-line or
1533        'sendemail.identity'.
1534
1535sendemail.aliasesfile::
1536sendemail.aliasfiletype::
1537sendemail.bcc::
1538sendemail.cc::
1539sendemail.cccmd::
1540sendemail.chainreplyto::
1541sendemail.confirm::
1542sendemail.envelopesender::
1543sendemail.from::
1544sendemail.multiedit::
1545sendemail.signedoffbycc::
1546sendemail.smtppass::
1547sendemail.suppresscc::
1548sendemail.suppressfrom::
1549sendemail.to::
1550sendemail.smtpserver::
1551sendemail.smtpserverport::
1552sendemail.smtpuser::
1553sendemail.thread::
1554sendemail.validate::
1555        See linkgit:git-send-email[1] for description.
1556
1557sendemail.signedoffcc::
1558        Deprecated alias for 'sendemail.signedoffbycc'.
1559
1560showbranch.default::
1561        The default set of branches for linkgit:git-show-branch[1].
1562        See linkgit:git-show-branch[1].
1563
1564status.relativePaths::
1565        By default, linkgit:git-status[1] shows paths relative to the
1566        current directory. Setting this variable to `false` shows paths
1567        relative to the repository root (this was the default for git
1568        prior to v1.5.4).
1569
1570status.showUntrackedFiles::
1571        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1572        files which are not currently tracked by Git. Directories which
1573        contain only untracked files, are shown with the directory name
1574        only. Showing untracked files means that Git needs to lstat() all
1575        all the files in the whole repository, which might be slow on some
1576        systems. So, this variable controls how the commands displays
1577        the untracked files. Possible values are:
1578+
1579--
1580        - 'no'     - Show no untracked files
1581        - 'normal' - Shows untracked files and directories
1582        - 'all'    - Shows also individual files in untracked directories.
1583--
1584+
1585If this variable is not specified, it defaults to 'normal'.
1586This variable can be overridden with the -u|--untracked-files option
1587of linkgit:git-status[1] and linkgit:git-commit[1].
1588
1589tar.umask::
1590        This variable can be used to restrict the permission bits of
1591        tar archive entries.  The default is 0002, which turns off the
1592        world write bit.  The special value "user" indicates that the
1593        archiving user's umask will be used instead.  See umask(2) and
1594        linkgit:git-archive[1].
1595
1596transfer.unpackLimit::
1597        When `fetch.unpackLimit` or `receive.unpackLimit` are
1598        not set, the value of this variable is used instead.
1599        The default value is 100.
1600
1601url.<base>.insteadOf::
1602        Any URL that starts with this value will be rewritten to
1603        start, instead, with <base>. In cases where some site serves a
1604        large number of repositories, and serves them with multiple
1605        access methods, and some users need to use different access
1606        methods, this feature allows people to specify any of the
1607        equivalent URLs and have git automatically rewrite the URL to
1608        the best alternative for the particular user, even for a
1609        never-before-seen repository on the site.  When more than one
1610        insteadOf strings match a given URL, the longest match is used.
1611
1612url.<base>.pushInsteadOf::
1613        Any URL that starts with this value will not be pushed to;
1614        instead, it will be rewritten to start with <base>, and the
1615        resulting URL will be pushed to. In cases where some site serves
1616        a large number of repositories, and serves them with multiple
1617        access methods, some of which do not allow push, this feature
1618        allows people to specify a pull-only URL and have git
1619        automatically use an appropriate URL to push, even for a
1620        never-before-seen repository on the site.  When more than one
1621        pushInsteadOf strings match a given URL, the longest match is
1622        used.  If a remote has an explicit pushurl, git will ignore this
1623        setting for that remote.
1624
1625user.email::
1626        Your email address to be recorded in any newly created commits.
1627        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1628        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1629
1630user.name::
1631        Your full name to be recorded in any newly created commits.
1632        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1633        environment variables.  See linkgit:git-commit-tree[1].
1634
1635user.signingkey::
1636        If linkgit:git-tag[1] is not selecting the key you want it to
1637        automatically when creating a signed tag, you can override the
1638        default selection with this variable.  This option is passed
1639        unchanged to gpg's --local-user parameter, so you may specify a key
1640        using any method that gpg supports.
1641
1642web.browser::
1643        Specify a web browser that may be used by some commands.
1644        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1645        may use it.