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