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