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