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