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