Documentation / config.txton commit grep: add a grep.patternType configuration setting (84befcd)
   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, allow only alphanumeric
  16characters and `-`, and must start with an alphabetic character.  Some
  17variables may appear multiple times.
  18
  19Syntax
  20~~~~~~
  21
  22The syntax is fairly flexible and permissive; whitespaces are mostly
  23ignored.  The '#' and ';' characters begin comments to the end of line,
  24blank lines are ignored.
  25
  26The file consists of sections and variables.  A section begins with
  27the name of the section in square brackets and continues until the next
  28section begins.  Section names are not case sensitive.  Only alphanumeric
  29characters, `-` and `.` are allowed in section names.  Each variable
  30must belong to some section, which means that there must be a section
  31header before the first setting of a variable.
  32
  33Sections can be further divided into subsections.  To begin a subsection
  34put its name in double quotes, separated by space from the section name,
  35in the section header, like in the example below:
  36
  37--------
  38        [section "subsection"]
  39
  40--------
  41
  42Subsection names are case sensitive and can contain any characters except
  43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
  44respectively).  Section headers cannot span multiple
  45lines.  Variables may belong directly to a section or to a given subsection.
  46You can have `[section]` if you have `[section "subsection"]`, but you
  47don't need to.
  48
  49There is also a deprecated `[section.subsection]` syntax. With this
  50syntax, the subsection name is converted to lower-case and is also
  51compared case sensitively. These subsection names follow the same
  52restrictions as section names.
  53
  54All the other lines (and the remainder of the line after the section
  55header) are recognized as setting variables, in the form
  56'name = value'.  If there is no equal sign on the line, the entire line
  57is taken as 'name' and the variable is recognized as boolean "true".
  58The variable names are case-insensitive, allow only alphanumeric characters
  59and `-`, and must start with an alphabetic character.  There can be more
  60than one value for a given variable; we say then that the variable is
  61multivalued.
  62
  63Leading and trailing whitespace in a variable value is discarded.
  64Internal whitespace within a variable value is retained verbatim.
  65
  66The values following the equals sign in variable assign are all either
  67a string, an integer, or a boolean.  Boolean values may be given as yes/no,
  681/0, true/false or on/off.  Case is not significant in boolean values, when
  69converting value to the canonical form using '--bool' type specifier;
  70'git config' will ensure that the output is "true" or "false".
  71
  72String values may be entirely or partially enclosed in double quotes.
  73You need to enclose variable values in double quotes if you want to
  74preserve leading or trailing whitespace, or if the variable value contains
  75comment characters (i.e. it contains '#' or ';').
  76Double quote `"` and backslash `\` characters in variable values must
  77be escaped: use `\"` for `"` and `\\` for `\`.
  78
  79The following escape sequences (beside `\"` and `\\`) are recognized:
  80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  81and `\b` for backspace (BS).  No other char escape sequence, nor octal
  82char sequences are valid.
  83
  84Variable values ending in a `\` are continued on the next line in the
  85customary UNIX fashion.
  86
  87Some variables may require a special value format.
  88
  89Includes
  90~~~~~~~~
  91
  92You can include one config file from another by setting the special
  93`include.path` variable to the name of the file to be included. The
  94included file is expanded immediately, as if its contents had been
  95found at the location of the include directive. If the value of the
  96`include.path` variable is a relative path, the path is considered to be
  97relative to the configuration file in which the include directive was
  98found. The value of `include.path` is subject to tilde expansion: `~/`
  99is expanded to the value of `$HOME`, and `~user/` to the specified
 100user's home directory. See below for examples.
 101
 102Example
 103~~~~~~~
 104
 105        # Core variables
 106        [core]
 107                ; Don't trust file modes
 108                filemode = false
 109
 110        # Our diff algorithm
 111        [diff]
 112                external = /usr/local/bin/diff-wrapper
 113                renames = true
 114
 115        [branch "devel"]
 116                remote = origin
 117                merge = refs/heads/devel
 118
 119        # Proxy settings
 120        [core]
 121                gitProxy="ssh" for "kernel.org"
 122                gitProxy=default-proxy ; for the rest
 123
 124        [include]
 125                path = /path/to/foo.inc ; include by absolute path
 126                path = foo ; expand "foo" relative to the current file
 127                path = ~/foo ; expand "foo" in your $HOME directory
 128
 129Variables
 130~~~~~~~~~
 131
 132Note that this list is non-comprehensive and not necessarily complete.
 133For command-specific variables, you will find a more detailed description
 134in the appropriate manual page. You will find a description of non-core
 135porcelain configuration variables in the respective porcelain documentation.
 136
 137advice.*::
 138        These variables control various optional help messages designed to
 139        aid new users. All 'advice.*' variables default to 'true', and you
 140        can tell Git that you do not need help by setting these to 'false':
 141+
 142--
 143        pushNonFastForward::
 144                Set this variable to 'false' if you want to disable
 145                'pushNonFFCurrent', 'pushNonFFDefault', and
 146                'pushNonFFMatching' simultaneously.
 147        pushNonFFCurrent::
 148                Advice shown when linkgit:git-push[1] fails due to a
 149                non-fast-forward update to the current branch.
 150        pushNonFFDefault::
 151                Advice to set 'push.default' to 'upstream' or 'current'
 152                when you ran linkgit:git-push[1] and pushed 'matching
 153                refs' by default (i.e. you did not provide an explicit
 154                refspec, and no 'push.default' configuration was set)
 155                and it resulted in a non-fast-forward error.
 156        pushNonFFMatching::
 157                Advice shown when you ran linkgit:git-push[1] and pushed
 158                'matching refs' explicitly (i.e. you used ':', or
 159                specified a refspec that isn't your current branch) and
 160                it resulted in a non-fast-forward error.
 161        statusHints::
 162                Directions on how to stage/unstage/add shown in the
 163                output of linkgit:git-status[1] and the template shown
 164                when writing commit messages.
 165        commitBeforeMerge::
 166                Advice shown when linkgit:git-merge[1] refuses to
 167                merge to avoid overwriting local changes.
 168        resolveConflict::
 169                Advices shown by various commands when conflicts
 170                prevent the operation from being performed.
 171        implicitIdentity::
 172                Advice on how to set your identity configuration when
 173                your information is guessed from the system username and
 174                domain name.
 175        detachedHead::
 176                Advice shown when you used linkgit:git-checkout[1] to
 177                move to the detach HEAD state, to instruct how to create
 178                a local branch after the fact.
 179        amWorkDir::
 180                Advice that shows the location of the patch file when
 181                linkgit:git-am[1] fails to apply it.
 182--
 183
 184core.fileMode::
 185        If false, the executable bit differences between the index and
 186        the working tree are ignored; useful on broken filesystems like FAT.
 187        See linkgit:git-update-index[1].
 188+
 189The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 190will probe and set core.fileMode false if appropriate when the
 191repository is created.
 192
 193core.ignoreCygwinFSTricks::
 194        This option is only used by Cygwin implementation of Git. If false,
 195        the Cygwin stat() and lstat() functions are used. This may be useful
 196        if your repository consists of a few separate directories joined in
 197        one hierarchy using Cygwin mount. If true, Git uses native Win32 API
 198        whenever it is possible and falls back to Cygwin functions only to
 199        handle symbol links. The native mode is more than twice faster than
 200        normal Cygwin l/stat() functions. True by default, unless core.filemode
 201        is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
 202        POSIX emulation is required to support core.filemode.
 203
 204core.ignorecase::
 205        If true, this option enables various workarounds to enable
 206        git to work better on filesystems that are not case sensitive,
 207        like FAT. For example, if a directory listing finds
 208        "makefile" when git expects "Makefile", git will assume
 209        it is really the same file, and continue to remember it as
 210        "Makefile".
 211+
 212The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 213will probe and set core.ignorecase true if appropriate when the repository
 214is created.
 215
 216core.trustctime::
 217        If false, the ctime differences between the index and the
 218        working tree are ignored; useful when the inode change time
 219        is regularly modified by something outside Git (file system
 220        crawlers and some backup systems).
 221        See linkgit:git-update-index[1]. True by default.
 222
 223core.quotepath::
 224        The commands that output paths (e.g. 'ls-files',
 225        'diff'), when not given the `-z` option, will quote
 226        "unusual" characters in the pathname by enclosing the
 227        pathname in a double-quote pair and with backslashes the
 228        same way strings in C source code are quoted.  If this
 229        variable is set to false, the bytes higher than 0x80 are
 230        not quoted but output as verbatim.  Note that double
 231        quote, backslash and control characters are always
 232        quoted without `-z` regardless of the setting of this
 233        variable.
 234
 235core.eol::
 236        Sets the line ending type to use in the working directory for
 237        files that have the `text` property set.  Alternatives are
 238        'lf', 'crlf' and 'native', which uses the platform's native
 239        line ending.  The default value is `native`.  See
 240        linkgit:gitattributes[5] for more information on end-of-line
 241        conversion.
 242
 243core.safecrlf::
 244        If true, makes git check if converting `CRLF` is reversible when
 245        end-of-line conversion is active.  Git will verify if a command
 246        modifies a file in the work tree either directly or indirectly.
 247        For example, committing a file followed by checking out the
 248        same file should yield the original file in the work tree.  If
 249        this is not the case for the current setting of
 250        `core.autocrlf`, git will reject the file.  The variable can
 251        be set to "warn", in which case git will only warn about an
 252        irreversible conversion but continue the operation.
 253+
 254CRLF conversion bears a slight chance of corrupting data.
 255When it is enabled, git will convert CRLF to LF during commit and LF to
 256CRLF during checkout.  A file that contains a mixture of LF and
 257CRLF before the commit cannot be recreated by git.  For text
 258files this is the right thing to do: it corrects line endings
 259such that we have only LF line endings in the repository.
 260But for binary files that are accidentally classified as text the
 261conversion can corrupt data.
 262+
 263If you recognize such corruption early you can easily fix it by
 264setting the conversion type explicitly in .gitattributes.  Right
 265after committing you still have the original file in your work
 266tree and this file is not yet corrupted.  You can explicitly tell
 267git that this file is binary and git will handle the file
 268appropriately.
 269+
 270Unfortunately, the desired effect of cleaning up text files with
 271mixed line endings and the undesired effect of corrupting binary
 272files cannot be distinguished.  In both cases CRLFs are removed
 273in an irreversible way.  For text files this is the right thing
 274to do because CRLFs are line endings, while for binary files
 275converting CRLFs corrupts data.
 276+
 277Note, this safety check does not mean that a checkout will generate a
 278file identical to the original file for a different setting of
 279`core.eol` and `core.autocrlf`, but only for the current one.  For
 280example, a text file with `LF` would be accepted with `core.eol=lf`
 281and could later be checked out with `core.eol=crlf`, in which case the
 282resulting file would contain `CRLF`, although the original file
 283contained `LF`.  However, in both work trees the line endings would be
 284consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 285file with mixed line endings would be reported by the `core.safecrlf`
 286mechanism.
 287
 288core.autocrlf::
 289        Setting this variable to "true" is almost the same as setting
 290        the `text` attribute to "auto" on all files except that text
 291        files are not guaranteed to be normalized: files that contain
 292        `CRLF` in the repository will not be touched.  Use this
 293        setting if you want to have `CRLF` line endings in your
 294        working directory even though the repository does not have
 295        normalized line endings.  This variable can be set to 'input',
 296        in which case no output conversion is performed.
 297
 298core.symlinks::
 299        If false, symbolic links are checked out as small plain files that
 300        contain the link text. linkgit:git-update-index[1] and
 301        linkgit:git-add[1] will not change the recorded type to regular
 302        file. Useful on filesystems like FAT that do not support
 303        symbolic links.
 304+
 305The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 306will probe and set core.symlinks false if appropriate when the repository
 307is created.
 308
 309core.gitProxy::
 310        A "proxy command" to execute (as 'command host port') instead
 311        of establishing direct connection to the remote server when
 312        using the git protocol for fetching. If the variable value is
 313        in the "COMMAND for DOMAIN" format, the command is applied only
 314        on hostnames ending with the specified domain string. This variable
 315        may be set multiple times and is matched in the given order;
 316        the first match wins.
 317+
 318Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
 319(which always applies universally, without the special "for"
 320handling).
 321+
 322The special string `none` can be used as the proxy command to
 323specify that no proxy be used for a given domain pattern.
 324This is useful for excluding servers inside a firewall from
 325proxy use, while defaulting to a common proxy for external domains.
 326
 327core.ignoreStat::
 328        If true, commands which modify both the working tree and the index
 329        will mark the updated paths with the "assume unchanged" bit in the
 330        index. These marked files are then assumed to stay unchanged in the
 331        working tree, until you mark them otherwise manually - Git will not
 332        detect the file changes by lstat() calls. This is useful on systems
 333        where those are very slow, such as Microsoft Windows.
 334        See linkgit:git-update-index[1].
 335        False by default.
 336
 337core.preferSymlinkRefs::
 338        Instead of the default "symref" format for HEAD
 339        and other symbolic reference files, use symbolic links.
 340        This is sometimes needed to work with old scripts that
 341        expect HEAD to be a symbolic link.
 342
 343core.bare::
 344        If true this repository is assumed to be 'bare' and has no
 345        working directory associated with it.  If this is the case a
 346        number of commands that require a working directory will be
 347        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 348+
 349This setting is automatically guessed by linkgit:git-clone[1] or
 350linkgit:git-init[1] when the repository was created.  By default a
 351repository that ends in "/.git" is assumed to be not bare (bare =
 352false), while all other repositories are assumed to be bare (bare
 353= true).
 354
 355core.worktree::
 356        Set the path to the root of the working tree.
 357        This can be overridden by the GIT_WORK_TREE environment
 358        variable and the '--work-tree' command line option.
 359        The value can be an absolute path or relative to the path to
 360        the .git directory, which is either specified by --git-dir
 361        or GIT_DIR, or automatically discovered.
 362        If --git-dir or GIT_DIR is specified but none of
 363        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 364        the current working directory is regarded as the top level
 365        of your working tree.
 366+
 367Note that this variable is honored even when set in a configuration
 368file in a ".git" subdirectory of a directory and its value differs
 369from the latter directory (e.g. "/path/to/.git/config" has
 370core.worktree set to "/different/path"), which is most likely a
 371misconfiguration.  Running git commands in the "/path/to" directory will
 372still use "/different/path" as the root of the work tree and can cause
 373confusion unless you know what you are doing (e.g. you are creating a
 374read-only snapshot of the same index to a location different from the
 375repository's usual working tree).
 376
 377core.logAllRefUpdates::
 378        Enable the reflog. Updates to a ref <ref> is logged to the file
 379        "$GIT_DIR/logs/<ref>", by appending the new and old
 380        SHA1, the date/time and the reason of the update, but
 381        only when the file exists.  If this configuration
 382        variable is set to true, missing "$GIT_DIR/logs/<ref>"
 383        file is automatically created for branch heads (i.e. under
 384        refs/heads/), remote refs (i.e. under refs/remotes/),
 385        note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
 386+
 387This information can be used to determine what commit
 388was the tip of a branch "2 days ago".
 389+
 390This value is true by default in a repository that has
 391a working directory associated with it, and false by
 392default in a bare repository.
 393
 394core.repositoryFormatVersion::
 395        Internal variable identifying the repository format and layout
 396        version.
 397
 398core.sharedRepository::
 399        When 'group' (or 'true'), the repository is made shareable between
 400        several users in a group (making sure all the files and objects are
 401        group-writable). When 'all' (or 'world' or 'everybody'), the
 402        repository will be readable by all users, additionally to being
 403        group-shareable. When 'umask' (or 'false'), git will use permissions
 404        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 405        files in the repository will have this mode value. '0xxx' will override
 406        user's umask value (whereas the other options will only override
 407        requested parts of the user's umask value). Examples: '0660' will make
 408        the repo read/write-able for the owner and group, but inaccessible to
 409        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 410        repository that is group-readable but not group-writable.
 411        See linkgit:git-init[1]. False by default.
 412
 413core.warnAmbiguousRefs::
 414        If true, git will warn you if the ref name you passed it is ambiguous
 415        and might match multiple refs in the .git/refs/ tree. True by default.
 416
 417core.compression::
 418        An integer -1..9, indicating a default compression level.
 419        -1 is the zlib default. 0 means no compression,
 420        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 421        If set, this provides a default to other compression variables,
 422        such as 'core.loosecompression' and 'pack.compression'.
 423
 424core.loosecompression::
 425        An integer -1..9, indicating the compression level for objects that
 426        are not in a pack file. -1 is the zlib default. 0 means no
 427        compression, and 1..9 are various speed/size tradeoffs, 9 being
 428        slowest.  If not set,  defaults to core.compression.  If that is
 429        not set,  defaults to 1 (best speed).
 430
 431core.packedGitWindowSize::
 432        Number of bytes of a pack file to map into memory in a
 433        single mapping operation.  Larger window sizes may allow
 434        your system to process a smaller number of large pack files
 435        more quickly.  Smaller window sizes will negatively affect
 436        performance due to increased calls to the operating system's
 437        memory manager, but may improve performance when accessing
 438        a large number of large pack files.
 439+
 440Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 441MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 442be reasonable for all users/operating systems.  You probably do
 443not need to adjust this value.
 444+
 445Common unit suffixes of 'k', 'm', or 'g' are supported.
 446
 447core.packedGitLimit::
 448        Maximum number of bytes to map simultaneously into memory
 449        from pack files.  If Git needs to access more than this many
 450        bytes at once to complete an operation it will unmap existing
 451        regions to reclaim virtual address space within the process.
 452+
 453Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 454This should be reasonable for all users/operating systems, except on
 455the largest projects.  You probably do not need to adjust this value.
 456+
 457Common unit suffixes of 'k', 'm', or 'g' are supported.
 458
 459core.deltaBaseCacheLimit::
 460        Maximum number of bytes to reserve for caching base objects
 461        that may be referenced by multiple deltified objects.  By storing the
 462        entire decompressed base objects in a cache Git is able
 463        to avoid unpacking and decompressing frequently used base
 464        objects multiple times.
 465+
 466Default is 16 MiB on all platforms.  This should be reasonable
 467for all users/operating systems, except on the largest projects.
 468You probably do not need to adjust this value.
 469+
 470Common unit suffixes of 'k', 'm', or 'g' are supported.
 471
 472core.bigFileThreshold::
 473        Files larger than this size are stored deflated, without
 474        attempting delta compression.  Storing large files without
 475        delta compression avoids excessive memory usage, at the
 476        slight expense of increased disk usage.
 477+
 478Default is 512 MiB on all platforms.  This should be reasonable
 479for most projects as source code and other text files can still
 480be delta compressed, but larger binary media files won't be.
 481+
 482Common unit suffixes of 'k', 'm', or 'g' are supported.
 483
 484core.excludesfile::
 485        In addition to '.gitignore' (per-directory) and
 486        '.git/info/exclude', git looks into this file for patterns
 487        of files which are not meant to be tracked.  "`~/`" is expanded
 488        to the value of `$HOME` and "`~user/`" to the specified user's
 489        home directory.  See linkgit:gitignore[5].
 490
 491core.askpass::
 492        Some commands (e.g. svn and http interfaces) that interactively
 493        ask for a password can be told to use an external program given
 494        via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
 495        environment variable. If not set, fall back to the value of the
 496        'SSH_ASKPASS' environment variable or, failing that, a simple password
 497        prompt. The external program shall be given a suitable prompt as
 498        command line argument and write the password on its STDOUT.
 499
 500core.attributesfile::
 501        In addition to '.gitattributes' (per-directory) and
 502        '.git/info/attributes', git looks into this file for attributes
 503        (see linkgit:gitattributes[5]). Path expansions are made the same
 504        way as for `core.excludesfile`.
 505
 506core.editor::
 507        Commands such as `commit` and `tag` that lets you edit
 508        messages by launching an editor uses the value of this
 509        variable when it is set, and the environment variable
 510        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 511
 512sequence.editor::
 513        Text editor used by `git rebase -i` for editing the rebase insn file.
 514        The value is meant to be interpreted by the shell when it is used.
 515        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 516        When not configured the default commit message editor is used instead.
 517
 518core.pager::
 519        The command that git will use to paginate output.  Can
 520        be overridden with the `GIT_PAGER` environment
 521        variable.  Note that git sets the `LESS` environment
 522        variable to `FRSX` if it is unset when it runs the
 523        pager.  One can change these settings by setting the
 524        `LESS` variable to some other value.  Alternately,
 525        these settings can be overridden on a project or
 526        global basis by setting the `core.pager` option.
 527        Setting `core.pager` has no affect on the `LESS`
 528        environment variable behaviour above, so if you want
 529        to override git's default settings this way, you need
 530        to be explicit.  For example, to disable the S option
 531        in a backward compatible manner, set `core.pager`
 532        to `less -+$LESS -FRX`.  This will be passed to the
 533        shell by git, which will translate the final command to
 534        `LESS=FRSX less -+FRSX -FRX`.
 535
 536core.whitespace::
 537        A comma separated list of common whitespace problems to
 538        notice.  'git diff' will use `color.diff.whitespace` to
 539        highlight them, and 'git apply --whitespace=error' will
 540        consider them as errors.  You can prefix `-` to disable
 541        any of them (e.g. `-trailing-space`):
 542+
 543* `blank-at-eol` treats trailing whitespaces at the end of the line
 544  as an error (enabled by default).
 545* `space-before-tab` treats a space character that appears immediately
 546  before a tab character in the initial indent part of the line as an
 547  error (enabled by default).
 548* `indent-with-non-tab` treats a line that is indented with 8 or more
 549  space characters as an error (not enabled by default).
 550* `tab-in-indent` treats a tab character in the initial indent part of
 551  the line as an error (not enabled by default).
 552* `blank-at-eof` treats blank lines added at the end of file as an error
 553  (enabled by default).
 554* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 555  `blank-at-eof`.
 556* `cr-at-eol` treats a carriage-return at the end of line as
 557  part of the line terminator, i.e. with it, `trailing-space`
 558  does not trigger if the character before such a carriage-return
 559  is not a whitespace (not enabled by default).
 560* `tabwidth=<n>` tells how many character positions a tab occupies; this
 561  is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
 562  errors. The default tab width is 8. Allowed values are 1 to 63.
 563
 564core.fsyncobjectfiles::
 565        This boolean will enable 'fsync()' when writing object files.
 566+
 567This is a total waste of time and effort on a filesystem that orders
 568data writes properly, but can be useful for filesystems that do not use
 569journalling (traditional UNIX filesystems) or that only journal metadata
 570and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 571
 572core.preloadindex::
 573        Enable parallel index preload for operations like 'git diff'
 574+
 575This can speed up operations like 'git diff' and 'git status' especially
 576on filesystems like NFS that have weak caching semantics and thus
 577relatively high IO latencies.  With this set to 'true', git will do the
 578index comparison to the filesystem data in parallel, allowing
 579overlapping IO's.
 580
 581core.createObject::
 582        You can set this to 'link', in which case a hardlink followed by
 583        a delete of the source are used to make sure that object creation
 584        will not overwrite existing objects.
 585+
 586On some file system/operating system combinations, this is unreliable.
 587Set this config setting to 'rename' there; However, This will remove the
 588check that makes sure that existing object files will not get overwritten.
 589
 590core.notesRef::
 591        When showing commit messages, also show notes which are stored in
 592        the given ref.  The ref must be fully qualified.  If the given
 593        ref does not exist, it is not an error but means that no
 594        notes should be printed.
 595+
 596This setting defaults to "refs/notes/commits", and it can be overridden by
 597the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
 598
 599core.sparseCheckout::
 600        Enable "sparse checkout" feature. See section "Sparse checkout" in
 601        linkgit:git-read-tree[1] for more information.
 602
 603core.abbrev::
 604        Set the length object names are abbreviated to.  If unspecified,
 605        many commands abbreviate to 7 hexdigits, which may not be enough
 606        for abbreviated object names to stay unique for sufficiently long
 607        time.
 608
 609add.ignore-errors::
 610add.ignoreErrors::
 611        Tells 'git add' to continue adding files when some files cannot be
 612        added due to indexing errors. Equivalent to the '--ignore-errors'
 613        option of linkgit:git-add[1].  Older versions of git accept only
 614        `add.ignore-errors`, which does not follow the usual naming
 615        convention for configuration variables.  Newer versions of git
 616        honor `add.ignoreErrors` as well.
 617
 618alias.*::
 619        Command aliases for the linkgit:git[1] command wrapper - e.g.
 620        after defining "alias.last = cat-file commit HEAD", the invocation
 621        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 622        confusion and troubles with script usage, aliases that
 623        hide existing git commands are ignored. Arguments are split by
 624        spaces, the usual shell quoting and escaping is supported.
 625        quote pair and a backslash can be used to quote them.
 626+
 627If the alias expansion is prefixed with an exclamation point,
 628it will be treated as a shell command.  For example, defining
 629"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 630"git new" is equivalent to running the shell command
 631"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 632executed from the top-level directory of a repository, which may
 633not necessarily be the current directory.
 634'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
 635from the original current directory. See linkgit:git-rev-parse[1].
 636
 637am.keepcr::
 638        If true, git-am will call git-mailsplit for patches in mbox format
 639        with parameter '--keep-cr'. In this case git-mailsplit will
 640        not remove `\r` from lines ending with `\r\n`. Can be overridden
 641        by giving '--no-keep-cr' from the command line.
 642        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 643
 644apply.ignorewhitespace::
 645        When set to 'change', tells 'git apply' to ignore changes in
 646        whitespace, in the same way as the '--ignore-space-change'
 647        option.
 648        When set to one of: no, none, never, false tells 'git apply' to
 649        respect all whitespace differences.
 650        See linkgit:git-apply[1].
 651
 652apply.whitespace::
 653        Tells 'git apply' how to handle whitespaces, in the same way
 654        as the '--whitespace' option. See linkgit:git-apply[1].
 655
 656branch.autosetupmerge::
 657        Tells 'git branch' and 'git checkout' to set up new branches
 658        so that linkgit:git-pull[1] will appropriately merge from the
 659        starting point branch. Note that even if this option is not set,
 660        this behavior can be chosen per-branch using the `--track`
 661        and `--no-track` options. The valid settings are: `false` -- no
 662        automatic setup is done; `true` -- automatic setup is done when the
 663        starting point is a remote-tracking branch; `always` --
 664        automatic setup is done when the starting point is either a
 665        local branch or remote-tracking
 666        branch. This option defaults to true.
 667
 668branch.autosetuprebase::
 669        When a new branch is created with 'git branch' or 'git checkout'
 670        that tracks another branch, this variable tells git to set
 671        up pull to rebase instead of merge (see "branch.<name>.rebase").
 672        When `never`, rebase is never automatically set to true.
 673        When `local`, rebase is set to true for tracked branches of
 674        other local branches.
 675        When `remote`, rebase is set to true for tracked branches of
 676        remote-tracking branches.
 677        When `always`, rebase will be set to true for all tracking
 678        branches.
 679        See "branch.autosetupmerge" for details on how to set up a
 680        branch to track another branch.
 681        This option defaults to never.
 682
 683branch.<name>.remote::
 684        When in branch <name>, it tells 'git fetch' and 'git push' which
 685        remote to fetch from/push to.  It defaults to `origin` if no remote is
 686        configured. `origin` is also used if you are not on any branch.
 687
 688branch.<name>.merge::
 689        Defines, together with branch.<name>.remote, the upstream branch
 690        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
 691        branch to merge and can also affect 'git push' (see push.default).
 692        When in branch <name>, it tells 'git fetch' the default
 693        refspec to be marked for merging in FETCH_HEAD. The value is
 694        handled like the remote part of a refspec, and must match a
 695        ref which is fetched from the remote given by
 696        "branch.<name>.remote".
 697        The merge information is used by 'git pull' (which at first calls
 698        'git fetch') to lookup the default branch for merging. Without
 699        this option, 'git pull' defaults to merge the first refspec fetched.
 700        Specify multiple values to get an octopus merge.
 701        If you wish to setup 'git pull' so that it merges into <name> from
 702        another branch in the local repository, you can point
 703        branch.<name>.merge to the desired branch, and use the special setting
 704        `.` (a period) for branch.<name>.remote.
 705
 706branch.<name>.mergeoptions::
 707        Sets default options for merging into branch <name>. The syntax and
 708        supported options are the same as those of linkgit:git-merge[1], but
 709        option values containing whitespace characters are currently not
 710        supported.
 711
 712branch.<name>.rebase::
 713        When true, rebase the branch <name> on top of the fetched branch,
 714        instead of merging the default branch from the default remote when
 715        "git pull" is run. See "pull.rebase" for doing this in a non
 716        branch-specific manner.
 717+
 718*NOTE*: this is a possibly dangerous operation; do *not* use
 719it unless you understand the implications (see linkgit:git-rebase[1]
 720for details).
 721
 722browser.<tool>.cmd::
 723        Specify the command to invoke the specified browser. The
 724        specified command is evaluated in shell with the URLs passed
 725        as arguments. (See linkgit:git-web{litdd}browse[1].)
 726
 727browser.<tool>.path::
 728        Override the path for the given tool that may be used to
 729        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 730        working repository in gitweb (see linkgit:git-instaweb[1]).
 731
 732clean.requireForce::
 733        A boolean to make git-clean do nothing unless given -f
 734        or -n.   Defaults to true.
 735
 736color.branch::
 737        A boolean to enable/disable color in the output of
 738        linkgit:git-branch[1]. May be set to `always`,
 739        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 740        only when the output is to a terminal. Defaults to false.
 741
 742color.branch.<slot>::
 743        Use customized color for branch coloration. `<slot>` is one of
 744        `current` (the current branch), `local` (a local branch),
 745        `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
 746        refs).
 747+
 748The value for these configuration variables is a list of colors (at most
 749two) and attributes (at most one), separated by spaces.  The colors
 750accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 751`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 752`blink` and `reverse`.  The first color given is the foreground; the
 753second is the background.  The position of the attribute, if any,
 754doesn't matter.
 755
 756color.diff::
 757        Whether to use ANSI escape sequences to add color to patches.
 758        If this is set to `always`, linkgit:git-diff[1],
 759        linkgit:git-log[1], and linkgit:git-show[1] will use color
 760        for all patches.  If it is set to `true` or `auto`, those
 761        commands will only use color when output is to the terminal.
 762        Defaults to false.
 763+
 764This does not affect linkgit:git-format-patch[1] nor the
 765'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
 766command line with the `--color[=<when>]` option.
 767
 768color.diff.<slot>::
 769        Use customized color for diff colorization.  `<slot>` specifies
 770        which part of the patch to use the specified color, and is one
 771        of `plain` (context text), `meta` (metainformation), `frag`
 772        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 773        `new` (added lines), `commit` (commit headers), or `whitespace`
 774        (highlighting whitespace errors). The values of these variables may be
 775        specified as in color.branch.<slot>.
 776
 777color.decorate.<slot>::
 778        Use customized color for 'git log --decorate' output.  `<slot>` is one
 779        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
 780        branches, remote-tracking branches, tags, stash and HEAD, respectively.
 781
 782color.grep::
 783        When set to `always`, always highlight matches.  When `false` (or
 784        `never`), never.  When set to `true` or `auto`, use color only
 785        when the output is written to the terminal.  Defaults to `false`.
 786
 787color.grep.<slot>::
 788        Use customized color for grep colorization.  `<slot>` specifies which
 789        part of the line to use the specified color, and is one of
 790+
 791--
 792`context`;;
 793        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
 794`filename`;;
 795        filename prefix (when not using `-h`)
 796`function`;;
 797        function name lines (when using `-p`)
 798`linenumber`;;
 799        line number prefix (when using `-n`)
 800`match`;;
 801        matching text
 802`selected`;;
 803        non-matching text in selected lines
 804`separator`;;
 805        separators between fields on a line (`:`, `-`, and `=`)
 806        and between hunks (`--`)
 807--
 808+
 809The values of these variables may be specified as in color.branch.<slot>.
 810
 811color.interactive::
 812        When set to `always`, always use colors for interactive prompts
 813        and displays (such as those used by "git-add --interactive").
 814        When false (or `never`), never.  When set to `true` or `auto`, use
 815        colors only when the output is to the terminal. Defaults to false.
 816
 817color.interactive.<slot>::
 818        Use customized color for 'git add --interactive'
 819        output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
 820        four distinct types of normal output from interactive
 821        commands.  The values of these variables may be specified as
 822        in color.branch.<slot>.
 823
 824color.pager::
 825        A boolean to enable/disable colored output when the pager is in
 826        use (default is true).
 827
 828color.showbranch::
 829        A boolean to enable/disable color in the output of
 830        linkgit:git-show-branch[1]. May be set to `always`,
 831        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 832        only when the output is to a terminal. Defaults to false.
 833
 834color.status::
 835        A boolean to enable/disable color in the output of
 836        linkgit:git-status[1]. May be set to `always`,
 837        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 838        only when the output is to a terminal. Defaults to false.
 839
 840color.status.<slot>::
 841        Use customized color for status colorization. `<slot>` is
 842        one of `header` (the header text of the status message),
 843        `added` or `updated` (files which are added but not committed),
 844        `changed` (files which are changed but not added in the index),
 845        `untracked` (files which are not tracked by git),
 846        `branch` (the current branch), or
 847        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 848        to red). The values of these variables may be specified as in
 849        color.branch.<slot>.
 850
 851color.ui::
 852        This variable determines the default value for variables such
 853        as `color.diff` and `color.grep` that control the use of color
 854        per command family. Its scope will expand as more commands learn
 855        configuration to set a default for the `--color` option.  Set it
 856        to `always` if you want all output not intended for machine
 857        consumption to use color, to `true` or `auto` if you want such
 858        output to use color when written to the terminal, or to `false` or
 859        `never` if you prefer git commands not to use color unless enabled
 860        explicitly with some other configuration or the `--color` option.
 861
 862column.ui::
 863        Specify whether supported commands should output in columns.
 864        This variable consists of a list of tokens separated by spaces
 865        or commas:
 866+
 867--
 868`always`;;
 869        always show in columns
 870`never`;;
 871        never show in columns
 872`auto`;;
 873        show in columns if the output is to the terminal
 874`column`;;
 875        fill columns before rows (default)
 876`row`;;
 877        fill rows before columns
 878`plain`;;
 879        show in one column
 880`dense`;;
 881        make unequal size columns to utilize more space
 882`nodense`;;
 883        make equal size columns
 884--
 885+
 886        This option defaults to 'never'.
 887
 888column.branch::
 889        Specify whether to output branch listing in `git branch` in columns.
 890        See `column.ui` for details.
 891
 892column.status::
 893        Specify whether to output untracked files in `git status` in columns.
 894        See `column.ui` for details.
 895
 896column.tag::
 897        Specify whether to output tag listing in `git tag` in columns.
 898        See `column.ui` for details.
 899
 900commit.status::
 901        A boolean to enable/disable inclusion of status information in the
 902        commit message template when using an editor to prepare the commit
 903        message.  Defaults to true.
 904
 905commit.template::
 906        Specify a file to use as the template for new commit messages.
 907        "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
 908        specified user's home directory.
 909
 910credential.helper::
 911        Specify an external helper to be called when a username or
 912        password credential is needed; the helper may consult external
 913        storage to avoid prompting the user for the credentials. See
 914        linkgit:gitcredentials[7] for details.
 915
 916credential.useHttpPath::
 917        When acquiring credentials, consider the "path" component of an http
 918        or https URL to be important. Defaults to false. See
 919        linkgit:gitcredentials[7] for more information.
 920
 921credential.username::
 922        If no username is set for a network authentication, use this username
 923        by default. See credential.<context>.* below, and
 924        linkgit:gitcredentials[7].
 925
 926credential.<url>.*::
 927        Any of the credential.* options above can be applied selectively to
 928        some credentials. For example "credential.https://example.com.username"
 929        would set the default username only for https connections to
 930        example.com. See linkgit:gitcredentials[7] for details on how URLs are
 931        matched.
 932
 933include::diff-config.txt[]
 934
 935difftool.<tool>.path::
 936        Override the path for the given tool.  This is useful in case
 937        your tool is not in the PATH.
 938
 939difftool.<tool>.cmd::
 940        Specify the command to invoke the specified diff tool.
 941        The specified command is evaluated in shell with the following
 942        variables available:  'LOCAL' is set to the name of the temporary
 943        file containing the contents of the diff pre-image and 'REMOTE'
 944        is set to the name of the temporary file containing the contents
 945        of the diff post-image.
 946
 947difftool.prompt::
 948        Prompt before each invocation of the diff tool.
 949
 950diff.wordRegex::
 951        A POSIX Extended Regular Expression used to determine what is a "word"
 952        when performing word-by-word difference calculations.  Character
 953        sequences that match the regular expression are "words", all other
 954        characters are *ignorable* whitespace.
 955
 956fetch.recurseSubmodules::
 957        This option can be either set to a boolean value or to 'on-demand'.
 958        Setting it to a boolean changes the behavior of fetch and pull to
 959        unconditionally recurse into submodules when set to true or to not
 960        recurse at all when set to false. When set to 'on-demand' (the default
 961        value), fetch and pull will only recurse into a populated submodule
 962        when its superproject retrieves a commit that updates the submodule's
 963        reference.
 964
 965fetch.fsckObjects::
 966        If it is set to true, git-fetch-pack will check all fetched
 967        objects. It will abort in the case of a malformed object or a
 968        broken link. The result of an abort are only dangling objects.
 969        Defaults to false. If not set, the value of `transfer.fsckObjects`
 970        is used instead.
 971
 972fetch.unpackLimit::
 973        If the number of objects fetched over the git native
 974        transfer is below this
 975        limit, then the objects will be unpacked into loose object
 976        files. However if the number of received objects equals or
 977        exceeds this limit then the received pack will be stored as
 978        a pack, after adding any missing delta bases.  Storing the
 979        pack from a push can make the push operation complete faster,
 980        especially on slow filesystems.  If not set, the value of
 981        `transfer.unpackLimit` is used instead.
 982
 983format.attach::
 984        Enable multipart/mixed attachments as the default for
 985        'format-patch'.  The value can also be a double quoted string
 986        which will enable attachments as the default and set the
 987        value as the boundary.  See the --attach option in
 988        linkgit:git-format-patch[1].
 989
 990format.numbered::
 991        A boolean which can enable or disable sequence numbers in patch
 992        subjects.  It defaults to "auto" which enables it only if there
 993        is more than one patch.  It can be enabled or disabled for all
 994        messages by setting it to "true" or "false".  See --numbered
 995        option in linkgit:git-format-patch[1].
 996
 997format.headers::
 998        Additional email headers to include in a patch to be submitted
 999        by mail.  See linkgit:git-format-patch[1].
1000
1001format.to::
1002format.cc::
1003        Additional recipients to include in a patch to be submitted
1004        by mail.  See the --to and --cc options in
1005        linkgit:git-format-patch[1].
1006
1007format.subjectprefix::
1008        The default for format-patch is to output files with the '[PATCH]'
1009        subject prefix. Use this variable to change that prefix.
1010
1011format.signature::
1012        The default for format-patch is to output a signature containing
1013        the git version number. Use this variable to change that default.
1014        Set this variable to the empty string ("") to suppress
1015        signature generation.
1016
1017format.suffix::
1018        The default for format-patch is to output files with the suffix
1019        `.patch`. Use this variable to change that suffix (make sure to
1020        include the dot if you want it).
1021
1022format.pretty::
1023        The default pretty format for log/show/whatchanged command,
1024        See linkgit:git-log[1], linkgit:git-show[1],
1025        linkgit:git-whatchanged[1].
1026
1027format.thread::
1028        The default threading style for 'git format-patch'.  Can be
1029        a boolean value, or `shallow` or `deep`.  `shallow` threading
1030        makes every mail a reply to the head of the series,
1031        where the head is chosen from the cover letter, the
1032        `--in-reply-to`, and the first patch mail, in this order.
1033        `deep` threading makes every mail a reply to the previous one.
1034        A true boolean value is the same as `shallow`, and a false
1035        value disables threading.
1036
1037format.signoff::
1038    A boolean value which lets you enable the `-s/--signoff` option of
1039    format-patch by default. *Note:* Adding the Signed-off-by: line to a
1040    patch should be a conscious act and means that you certify you have
1041    the rights to submit this work under the same open source license.
1042    Please see the 'SubmittingPatches' document for further discussion.
1043
1044filter.<driver>.clean::
1045        The command which is used to convert the content of a worktree
1046        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1047        details.
1048
1049filter.<driver>.smudge::
1050        The command which is used to convert the content of a blob
1051        object to a worktree file upon checkout.  See
1052        linkgit:gitattributes[5] for details.
1053
1054gc.aggressiveWindow::
1055        The window size parameter used in the delta compression
1056        algorithm used by 'git gc --aggressive'.  This defaults
1057        to 250.
1058
1059gc.auto::
1060        When there are approximately more than this many loose
1061        objects in the repository, `git gc --auto` will pack them.
1062        Some Porcelain commands use this command to perform a
1063        light-weight garbage collection from time to time.  The
1064        default value is 6700.  Setting this to 0 disables it.
1065
1066gc.autopacklimit::
1067        When there are more than this many packs that are not
1068        marked with `*.keep` file in the repository, `git gc
1069        --auto` consolidates them into one larger pack.  The
1070        default value is 50.  Setting this to 0 disables it.
1071
1072gc.packrefs::
1073        Running `git pack-refs` in a repository renders it
1074        unclonable by Git versions prior to 1.5.1.2 over dumb
1075        transports such as HTTP.  This variable determines whether
1076        'git gc' runs `git pack-refs`. This can be set to `notbare`
1077        to enable it within all non-bare repos or it can be set to a
1078        boolean value.  The default is `true`.
1079
1080gc.pruneexpire::
1081        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1082        Override the grace period with this config variable.  The value
1083        "now" may be used to disable this  grace period and always prune
1084        unreachable objects immediately.
1085
1086gc.reflogexpire::
1087gc.<pattern>.reflogexpire::
1088        'git reflog expire' removes reflog entries older than
1089        this time; defaults to 90 days.  With "<pattern>" (e.g.
1090        "refs/stash") in the middle the setting applies only to
1091        the refs that match the <pattern>.
1092
1093gc.reflogexpireunreachable::
1094gc.<ref>.reflogexpireunreachable::
1095        'git reflog expire' removes reflog entries older than
1096        this time and are not reachable from the current tip;
1097        defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1098        in the middle, the setting applies only to the refs that
1099        match the <pattern>.
1100
1101gc.rerereresolved::
1102        Records of conflicted merge you resolved earlier are
1103        kept for this many days when 'git rerere gc' is run.
1104        The default is 60 days.  See linkgit:git-rerere[1].
1105
1106gc.rerereunresolved::
1107        Records of conflicted merge you have not resolved are
1108        kept for this many days when 'git rerere gc' is run.
1109        The default is 15 days.  See linkgit:git-rerere[1].
1110
1111gitcvs.commitmsgannotation::
1112        Append this string to each commit message. Set to empty string
1113        to disable this feature. Defaults to "via git-CVS emulator".
1114
1115gitcvs.enabled::
1116        Whether the CVS server interface is enabled for this repository.
1117        See linkgit:git-cvsserver[1].
1118
1119gitcvs.logfile::
1120        Path to a log file where the CVS server interface well... logs
1121        various stuff. See linkgit:git-cvsserver[1].
1122
1123gitcvs.usecrlfattr::
1124        If true, the server will look up the end-of-line conversion
1125        attributes for files to determine the '-k' modes to use. If
1126        the attributes force git to treat a file as text,
1127        the '-k' mode will be left blank so CVS clients will
1128        treat it as text. If they suppress text conversion, the file
1129        will be set with '-kb' mode, which suppresses any newline munging
1130        the client might otherwise do. If the attributes do not allow
1131        the file type to be determined, then 'gitcvs.allbinary' is
1132        used. See linkgit:gitattributes[5].
1133
1134gitcvs.allbinary::
1135        This is used if 'gitcvs.usecrlfattr' does not resolve
1136        the correct '-kb' mode to use. If true, all
1137        unresolved files are sent to the client in
1138        mode '-kb'. This causes the client to treat them
1139        as binary files, which suppresses any newline munging it
1140        otherwise might do. Alternatively, if it is set to "guess",
1141        then the contents of the file are examined to decide if
1142        it is binary, similar to 'core.autocrlf'.
1143
1144gitcvs.dbname::
1145        Database used by git-cvsserver to cache revision information
1146        derived from the git repository. The exact meaning depends on the
1147        used database driver, for SQLite (which is the default driver) this
1148        is a filename. Supports variable substitution (see
1149        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1150        Default: '%Ggitcvs.%m.sqlite'
1151
1152gitcvs.dbdriver::
1153        Used Perl DBI driver. You can specify any available driver
1154        for this here, but it might not work. git-cvsserver is tested
1155        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1156        reported *not* to work with 'DBD::mysql'. Experimental feature.
1157        May not contain double colons (`:`). Default: 'SQLite'.
1158        See linkgit:git-cvsserver[1].
1159
1160gitcvs.dbuser, gitcvs.dbpass::
1161        Database user and password. Only useful if setting 'gitcvs.dbdriver',
1162        since SQLite has no concept of database users and/or passwords.
1163        'gitcvs.dbuser' supports variable substitution (see
1164        linkgit:git-cvsserver[1] for details).
1165
1166gitcvs.dbTableNamePrefix::
1167        Database table name prefix.  Prepended to the names of any
1168        database tables used, allowing a single database to be used
1169        for several repositories.  Supports variable substitution (see
1170        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1171        characters will be replaced with underscores.
1172
1173All gitcvs variables except for 'gitcvs.usecrlfattr' and
1174'gitcvs.allbinary' can also be specified as
1175'gitcvs.<access_method>.<varname>' (where 'access_method'
1176is one of "ext" and "pserver") to make them apply only for the given
1177access method.
1178
1179gitweb.category::
1180gitweb.description::
1181gitweb.owner::
1182gitweb.url::
1183        See linkgit:gitweb[1] for description.
1184
1185gitweb.avatar::
1186gitweb.blame::
1187gitweb.grep::
1188gitweb.highlight::
1189gitweb.patches::
1190gitweb.pickaxe::
1191gitweb.remote_heads::
1192gitweb.showsizes::
1193gitweb.snapshot::
1194        See linkgit:gitweb.conf[5] for description.
1195
1196grep.lineNumber::
1197        If set to true, enable '-n' option by default.
1198
1199grep.patternType::
1200        Set the default matching behavior. Using a value of 'basic', 'extended',
1201        'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1202        '--fixed-strings', or '--perl-regexp' option accordingly, while the
1203        value 'default' will return to the default matching behavior.
1204
1205grep.extendedRegexp::
1206        If set to true, enable '--extended-regexp' option by default. This
1207        option is ignored when the 'grep.patternType' option is set to a value
1208        other than 'default'.
1209
1210gpg.program::
1211        Use this custom program instead of "gpg" found on $PATH when
1212        making or verifying a PGP signature. The program must support the
1213        same command line interface as GPG, namely, to verify a detached
1214        signature, "gpg --verify $file - <$signature" is run, and the
1215        program is expected to signal a good signature by exiting with
1216        code 0, and to generate an ascii-armored detached signature, the
1217        standard input of "gpg -bsau $key" is fed with the contents to be
1218        signed, and the program is expected to send the result to its
1219        standard output.
1220
1221gui.commitmsgwidth::
1222        Defines how wide the commit message window is in the
1223        linkgit:git-gui[1]. "75" is the default.
1224
1225gui.diffcontext::
1226        Specifies how many context lines should be used in calls to diff
1227        made by the linkgit:git-gui[1]. The default is "5".
1228
1229gui.encoding::
1230        Specifies the default encoding to use for displaying of
1231        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1232        It can be overridden by setting the 'encoding' attribute
1233        for relevant files (see linkgit:gitattributes[5]).
1234        If this option is not set, the tools default to the
1235        locale encoding.
1236
1237gui.matchtrackingbranch::
1238        Determines if new branches created with linkgit:git-gui[1] should
1239        default to tracking remote branches with matching names or
1240        not. Default: "false".
1241
1242gui.newbranchtemplate::
1243        Is used as suggested name when creating new branches using the
1244        linkgit:git-gui[1].
1245
1246gui.pruneduringfetch::
1247        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1248        performing a fetch. The default value is "false".
1249
1250gui.trustmtime::
1251        Determines if linkgit:git-gui[1] should trust the file modification
1252        timestamp or not. By default the timestamps are not trusted.
1253
1254gui.spellingdictionary::
1255        Specifies the dictionary used for spell checking commit messages in
1256        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1257        off.
1258
1259gui.fastcopyblame::
1260        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1261        location detection. It makes blame significantly faster on huge
1262        repositories at the expense of less thorough copy detection.
1263
1264gui.copyblamethreshold::
1265        Specifies the threshold to use in 'git gui blame' original location
1266        detection, measured in alphanumeric characters. See the
1267        linkgit:git-blame[1] manual for more information on copy detection.
1268
1269gui.blamehistoryctx::
1270        Specifies the radius of history context in days to show in
1271        linkgit:gitk[1] for the selected commit, when the `Show History
1272        Context` menu item is invoked from 'git gui blame'. If this
1273        variable is set to zero, the whole history is shown.
1274
1275guitool.<name>.cmd::
1276        Specifies the shell command line to execute when the corresponding item
1277        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1278        mandatory for every tool. The command is executed from the root of
1279        the working directory, and in the environment it receives the name of
1280        the tool as 'GIT_GUITOOL', the name of the currently selected file as
1281        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1282        the head is detached, 'CUR_BRANCH' is empty).
1283
1284guitool.<name>.needsfile::
1285        Run the tool only if a diff is selected in the GUI. It guarantees
1286        that 'FILENAME' is not empty.
1287
1288guitool.<name>.noconsole::
1289        Run the command silently, without creating a window to display its
1290        output.
1291
1292guitool.<name>.norescan::
1293        Don't rescan the working directory for changes after the tool
1294        finishes execution.
1295
1296guitool.<name>.confirm::
1297        Show a confirmation dialog before actually running the tool.
1298
1299guitool.<name>.argprompt::
1300        Request a string argument from the user, and pass it to the tool
1301        through the 'ARGS' environment variable. Since requesting an
1302        argument implies confirmation, the 'confirm' option has no effect
1303        if this is enabled. If the option is set to 'true', 'yes', or '1',
1304        the dialog uses a built-in generic prompt; otherwise the exact
1305        value of the variable is used.
1306
1307guitool.<name>.revprompt::
1308        Request a single valid revision from the user, and set the
1309        'REVISION' environment variable. In other aspects this option
1310        is similar to 'argprompt', and can be used together with it.
1311
1312guitool.<name>.revunmerged::
1313        Show only unmerged branches in the 'revprompt' subdialog.
1314        This is useful for tools similar to merge or rebase, but not
1315        for things like checkout or reset.
1316
1317guitool.<name>.title::
1318        Specifies the title to use for the prompt dialog. The default
1319        is the tool name.
1320
1321guitool.<name>.prompt::
1322        Specifies the general prompt string to display at the top of
1323        the dialog, before subsections for 'argprompt' and 'revprompt'.
1324        The default value includes the actual command.
1325
1326help.browser::
1327        Specify the browser that will be used to display help in the
1328        'web' format. See linkgit:git-help[1].
1329
1330help.format::
1331        Override the default help format used by linkgit:git-help[1].
1332        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1333        the default. 'web' and 'html' are the same.
1334
1335help.autocorrect::
1336        Automatically correct and execute mistyped commands after
1337        waiting for the given number of deciseconds (0.1 sec). If more
1338        than one command can be deduced from the entered text, nothing
1339        will be executed.  If the value of this option is negative,
1340        the corrected command will be executed immediately. If the
1341        value is 0 - the command will be just shown but not executed.
1342        This is the default.
1343
1344http.proxy::
1345        Override the HTTP proxy, normally configured using the 'http_proxy',
1346        'https_proxy', and 'all_proxy' environment variables (see
1347        `curl(1)`).  This can be overridden on a per-remote basis; see
1348        remote.<name>.proxy
1349
1350http.cookiefile::
1351        File containing previously stored cookie lines which should be used
1352        in the git http session, if they match the server. The file format
1353        of the file to read cookies from should be plain HTTP headers or
1354        the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1355        NOTE that the file specified with http.cookiefile is only used as
1356        input. No cookies will be stored in the file.
1357
1358http.sslVerify::
1359        Whether to verify the SSL certificate when fetching or pushing
1360        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1361        variable.
1362
1363http.sslCert::
1364        File containing the SSL certificate when fetching or pushing
1365        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1366        variable.
1367
1368http.sslKey::
1369        File containing the SSL private key when fetching or pushing
1370        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1371        variable.
1372
1373http.sslCertPasswordProtected::
1374        Enable git's password prompt for the SSL certificate.  Otherwise
1375        OpenSSL will prompt the user, possibly many times, if the
1376        certificate or private key is encrypted.  Can be overridden by the
1377        'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1378
1379http.sslCAInfo::
1380        File containing the certificates to verify the peer with when
1381        fetching or pushing over HTTPS. Can be overridden by the
1382        'GIT_SSL_CAINFO' environment variable.
1383
1384http.sslCAPath::
1385        Path containing files with the CA certificates to verify the peer
1386        with when fetching or pushing over HTTPS. Can be overridden
1387        by the 'GIT_SSL_CAPATH' environment variable.
1388
1389http.maxRequests::
1390        How many HTTP requests to launch in parallel. Can be overridden
1391        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1392
1393http.minSessions::
1394        The number of curl sessions (counted across slots) to be kept across
1395        requests. They will not be ended with curl_easy_cleanup() until
1396        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1397        value will be capped at 1. Defaults to 1.
1398
1399http.postBuffer::
1400        Maximum size in bytes of the buffer used by smart HTTP
1401        transports when POSTing data to the remote system.
1402        For requests larger than this buffer size, HTTP/1.1 and
1403        Transfer-Encoding: chunked is used to avoid creating a
1404        massive pack file locally.  Default is 1 MiB, which is
1405        sufficient for most requests.
1406
1407http.lowSpeedLimit, http.lowSpeedTime::
1408        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1409        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1410        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1411        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1412
1413http.noEPSV::
1414        A boolean which disables using of EPSV ftp command by curl.
1415        This can helpful with some "poor" ftp servers which don't
1416        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1417        environment variable. Default is false (curl will use EPSV).
1418
1419http.useragent::
1420        The HTTP USER_AGENT string presented to an HTTP server.  The default
1421        value represents the version of the client git such as git/1.7.1.
1422        This option allows you to override this value to a more common value
1423        such as Mozilla/4.0.  This may be necessary, for instance, if
1424        connecting through a firewall that restricts HTTP connections to a set
1425        of common USER_AGENT strings (but not including those like git/1.7.1).
1426        Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1427
1428i18n.commitEncoding::
1429        Character encoding the commit messages are stored in; git itself
1430        does not care per se, but this information is necessary e.g. when
1431        importing commits from emails or in the gitk graphical history
1432        browser (and possibly at other places in the future or in other
1433        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1434
1435i18n.logOutputEncoding::
1436        Character encoding the commit messages are converted to when
1437        running 'git log' and friends.
1438
1439imap::
1440        The configuration variables in the 'imap' section are described
1441        in linkgit:git-imap-send[1].
1442
1443init.templatedir::
1444        Specify the directory from which templates will be copied.
1445        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1446
1447instaweb.browser::
1448        Specify the program that will be used to browse your working
1449        repository in gitweb. See linkgit:git-instaweb[1].
1450
1451instaweb.httpd::
1452        The HTTP daemon command-line to start gitweb on your working
1453        repository. See linkgit:git-instaweb[1].
1454
1455instaweb.local::
1456        If true the web server started by linkgit:git-instaweb[1] will
1457        be bound to the local IP (127.0.0.1).
1458
1459instaweb.modulepath::
1460        The default module path for linkgit:git-instaweb[1] to use
1461        instead of /usr/lib/apache2/modules.  Only used if httpd
1462        is Apache.
1463
1464instaweb.port::
1465        The port number to bind the gitweb httpd to. See
1466        linkgit:git-instaweb[1].
1467
1468interactive.singlekey::
1469        In interactive commands, allow the user to provide one-letter
1470        input with a single key (i.e., without hitting enter).
1471        Currently this is used by the `--patch` mode of
1472        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1473        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1474        setting is silently ignored if portable keystroke input
1475        is not available.
1476
1477log.abbrevCommit::
1478        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1479        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1480        override this option with `--no-abbrev-commit`.
1481
1482log.date::
1483        Set the default date-time mode for the 'log' command.
1484        Setting a value for log.date is similar to using 'git log''s
1485        `--date` option.  Possible values are `relative`, `local`,
1486        `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1487        for details.
1488
1489log.decorate::
1490        Print out the ref names of any commits that are shown by the log
1491        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1492        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1493        specified, the full ref name (including prefix) will be printed.
1494        This is the same as the log commands '--decorate' option.
1495
1496log.showroot::
1497        If true, the initial commit will be shown as a big creation event.
1498        This is equivalent to a diff against an empty tree.
1499        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1500        normally hide the root commit will now show it. True by default.
1501
1502mailmap.file::
1503        The location of an augmenting mailmap file. The default
1504        mailmap, located in the root of the repository, is loaded
1505        first, then the mailmap file pointed to by this variable.
1506        The location of the mailmap file may be in a repository
1507        subdirectory, or somewhere outside of the repository itself.
1508        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1509
1510man.viewer::
1511        Specify the programs that may be used to display help in the
1512        'man' format. See linkgit:git-help[1].
1513
1514man.<tool>.cmd::
1515        Specify the command to invoke the specified man viewer. The
1516        specified command is evaluated in shell with the man page
1517        passed as argument. (See linkgit:git-help[1].)
1518
1519man.<tool>.path::
1520        Override the path for the given tool that may be used to
1521        display help in the 'man' format. See linkgit:git-help[1].
1522
1523include::merge-config.txt[]
1524
1525mergetool.<tool>.path::
1526        Override the path for the given tool.  This is useful in case
1527        your tool is not in the PATH.
1528
1529mergetool.<tool>.cmd::
1530        Specify the command to invoke the specified merge tool.  The
1531        specified command is evaluated in shell with the following
1532        variables available: 'BASE' is the name of a temporary file
1533        containing the common base of the files to be merged, if available;
1534        'LOCAL' is the name of a temporary file containing the contents of
1535        the file on the current branch; 'REMOTE' is the name of a temporary
1536        file containing the contents of the file from the branch being
1537        merged; 'MERGED' contains the name of the file to which the merge
1538        tool should write the results of a successful merge.
1539
1540mergetool.<tool>.trustExitCode::
1541        For a custom merge command, specify whether the exit code of
1542        the merge command can be used to determine whether the merge was
1543        successful.  If this is not set to true then the merge target file
1544        timestamp is checked and the merge assumed to have been successful
1545        if the file has been updated, otherwise the user is prompted to
1546        indicate the success of the merge.
1547
1548mergetool.keepBackup::
1549        After performing a merge, the original file with conflict markers
1550        can be saved as a file with a `.orig` extension.  If this variable
1551        is set to `false` then this file is not preserved.  Defaults to
1552        `true` (i.e. keep the backup files).
1553
1554mergetool.keepTemporaries::
1555        When invoking a custom merge tool, git uses a set of temporary
1556        files to pass to the tool. If the tool returns an error and this
1557        variable is set to `true`, then these temporary files will be
1558        preserved, otherwise they will be removed after the tool has
1559        exited. Defaults to `false`.
1560
1561mergetool.prompt::
1562        Prompt before each invocation of the merge resolution program.
1563
1564notes.displayRef::
1565        The (fully qualified) refname from which to show notes when
1566        showing commit messages.  The value of this variable can be set
1567        to a glob, in which case notes from all matching refs will be
1568        shown.  You may also specify this configuration variable
1569        several times.  A warning will be issued for refs that do not
1570        exist, but a glob that does not match any refs is silently
1571        ignored.
1572+
1573This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1574environment variable, which must be a colon separated list of refs or
1575globs.
1576+
1577The effective value of "core.notesRef" (possibly overridden by
1578GIT_NOTES_REF) is also implicitly added to the list of refs to be
1579displayed.
1580
1581notes.rewrite.<command>::
1582        When rewriting commits with <command> (currently `amend` or
1583        `rebase`) and this variable is set to `true`, git
1584        automatically copies your notes from the original to the
1585        rewritten commit.  Defaults to `true`, but see
1586        "notes.rewriteRef" below.
1587
1588notes.rewriteMode::
1589        When copying notes during a rewrite (see the
1590        "notes.rewrite.<command>" option), determines what to do if
1591        the target commit already has a note.  Must be one of
1592        `overwrite`, `concatenate`, or `ignore`.  Defaults to
1593        `concatenate`.
1594+
1595This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1596environment variable.
1597
1598notes.rewriteRef::
1599        When copying notes during a rewrite, specifies the (fully
1600        qualified) ref whose notes should be copied.  The ref may be a
1601        glob, in which case notes in all matching refs will be copied.
1602        You may also specify this configuration several times.
1603+
1604Does not have a default value; you must configure this variable to
1605enable note rewriting.  Set it to `refs/notes/commits` to enable
1606rewriting for the default commit notes.
1607+
1608This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1609environment variable, which must be a colon separated list of refs or
1610globs.
1611
1612pack.window::
1613        The size of the window used by linkgit:git-pack-objects[1] when no
1614        window size is given on the command line. Defaults to 10.
1615
1616pack.depth::
1617        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1618        maximum depth is given on the command line. Defaults to 50.
1619
1620pack.windowMemory::
1621        The window memory size limit used by linkgit:git-pack-objects[1]
1622        when no limit is given on the command line.  The value can be
1623        suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1624        limit.
1625
1626pack.compression::
1627        An integer -1..9, indicating the compression level for objects
1628        in a pack file. -1 is the zlib default. 0 means no
1629        compression, and 1..9 are various speed/size tradeoffs, 9 being
1630        slowest.  If not set,  defaults to core.compression.  If that is
1631        not set,  defaults to -1, the zlib default, which is "a default
1632        compromise between speed and compression (currently equivalent
1633        to level 6)."
1634+
1635Note that changing the compression level will not automatically recompress
1636all existing objects. You can force recompression by passing the -F option
1637to linkgit:git-repack[1].
1638
1639pack.deltaCacheSize::
1640        The maximum memory in bytes used for caching deltas in
1641        linkgit:git-pack-objects[1] before writing them out to a pack.
1642        This cache is used to speed up the writing object phase by not
1643        having to recompute the final delta result once the best match
1644        for all objects is found.  Repacking large repositories on machines
1645        which are tight with memory might be badly impacted by this though,
1646        especially if this cache pushes the system into swapping.
1647        A value of 0 means no limit. The smallest size of 1 byte may be
1648        used to virtually disable this cache. Defaults to 256 MiB.
1649
1650pack.deltaCacheLimit::
1651        The maximum size of a delta, that is cached in
1652        linkgit:git-pack-objects[1]. This cache is used to speed up the
1653        writing object phase by not having to recompute the final delta
1654        result once the best match for all objects is found. Defaults to 1000.
1655
1656pack.threads::
1657        Specifies the number of threads to spawn when searching for best
1658        delta matches.  This requires that linkgit:git-pack-objects[1]
1659        be compiled with pthreads otherwise this option is ignored with a
1660        warning. This is meant to reduce packing time on multiprocessor
1661        machines. The required amount of memory for the delta search window
1662        is however multiplied by the number of threads.
1663        Specifying 0 will cause git to auto-detect the number of CPU's
1664        and set the number of threads accordingly.
1665
1666pack.indexVersion::
1667        Specify the default pack index version.  Valid values are 1 for
1668        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1669        the new pack index with capabilities for packs larger than 4 GB
1670        as well as proper protection against the repacking of corrupted
1671        packs.  Version 2 is the default.  Note that version 2 is enforced
1672        and this config option ignored whenever the corresponding pack is
1673        larger than 2 GB.
1674+
1675If you have an old git that does not understand the version 2 `*.idx` file,
1676cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1677that will copy both `*.pack` file and corresponding `*.idx` file from the
1678other side may give you a repository that cannot be accessed with your
1679older version of git. If the `*.pack` file is smaller than 2 GB, however,
1680you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1681the `*.idx` file.
1682
1683pack.packSizeLimit::
1684        The maximum size of a pack.  This setting only affects
1685        packing to a file when repacking, i.e. the git:// protocol
1686        is unaffected.  It can be overridden by the `--max-pack-size`
1687        option of linkgit:git-repack[1]. The minimum size allowed is
1688        limited to 1 MiB. The default is unlimited.
1689        Common unit suffixes of 'k', 'm', or 'g' are
1690        supported.
1691
1692pager.<cmd>::
1693        If the value is boolean, turns on or off pagination of the
1694        output of a particular git subcommand when writing to a tty.
1695        Otherwise, turns on pagination for the subcommand using the
1696        pager specified by the value of `pager.<cmd>`.  If `--paginate`
1697        or `--no-pager` is specified on the command line, it takes
1698        precedence over this option.  To disable pagination for all
1699        commands, set `core.pager` or `GIT_PAGER` to `cat`.
1700
1701pretty.<name>::
1702        Alias for a --pretty= format string, as specified in
1703        linkgit:git-log[1]. Any aliases defined here can be used just
1704        as the built-in pretty formats could. For example,
1705        running `git config pretty.changelog "format:* %H %s"`
1706        would cause the invocation `git log --pretty=changelog`
1707        to be equivalent to running `git log "--pretty=format:* %H %s"`.
1708        Note that an alias with the same name as a built-in format
1709        will be silently ignored.
1710
1711pull.rebase::
1712        When true, rebase branches on top of the fetched branch, instead
1713        of merging the default branch from the default remote when "git
1714        pull" is run. See "branch.<name>.rebase" for setting this on a
1715        per-branch basis.
1716+
1717*NOTE*: this is a possibly dangerous operation; do *not* use
1718it unless you understand the implications (see linkgit:git-rebase[1]
1719for details).
1720
1721pull.octopus::
1722        The default merge strategy to use when pulling multiple branches
1723        at once.
1724
1725pull.twohead::
1726        The default merge strategy to use when pulling a single branch.
1727
1728push.default::
1729        Defines the action git push should take if no refspec is given
1730        on the command line, no refspec is configured in the remote, and
1731        no refspec is implied by any of the options given on the command
1732        line. Possible values are:
1733+
1734* `nothing` - do not push anything.
1735* `matching` - push all branches having the same name in both ends.
1736  This is for those who prepare all the branches into a publishable
1737  shape and then push them out with a single command.  It is not
1738  appropriate for pushing into a repository shared by multiple users,
1739  since locally stalled branches will attempt a non-fast forward push
1740  if other users updated the branch.
1741  +
1742  This is currently the default, but Git 2.0 will change the default
1743  to `simple`.
1744* `upstream` - push the current branch to its upstream branch.
1745  With this, `git push` will update the same remote ref as the one which
1746  is merged by `git pull`, making `push` and `pull` symmetrical.
1747  See "branch.<name>.merge" for how to configure the upstream branch.
1748* `simple` - like `upstream`, but refuses to push if the upstream
1749  branch's name is different from the local one. This is the safest
1750  option and is well-suited for beginners. It will become the default
1751  in Git 2.0.
1752* `current` - push the current branch to a branch of the same name.
1753  +
1754  The `simple`, `current` and `upstream` modes are for those who want to
1755  push out a single branch after finishing work, even when the other
1756  branches are not yet ready to be pushed out. If you are working with
1757  other people to push into the same shared repository, you would want
1758  to use one of these.
1759
1760rebase.stat::
1761        Whether to show a diffstat of what changed upstream since the last
1762        rebase. False by default.
1763
1764rebase.autosquash::
1765        If set to true enable '--autosquash' option by default.
1766
1767receive.autogc::
1768        By default, git-receive-pack will run "git-gc --auto" after
1769        receiving data from git-push and updating refs.  You can stop
1770        it by setting this variable to false.
1771
1772receive.fsckObjects::
1773        If it is set to true, git-receive-pack will check all received
1774        objects. It will abort in the case of a malformed object or a
1775        broken link. The result of an abort are only dangling objects.
1776        Defaults to false. If not set, the value of `transfer.fsckObjects`
1777        is used instead.
1778
1779receive.unpackLimit::
1780        If the number of objects received in a push is below this
1781        limit then the objects will be unpacked into loose object
1782        files. However if the number of received objects equals or
1783        exceeds this limit then the received pack will be stored as
1784        a pack, after adding any missing delta bases.  Storing the
1785        pack from a push can make the push operation complete faster,
1786        especially on slow filesystems.  If not set, the value of
1787        `transfer.unpackLimit` is used instead.
1788
1789receive.denyDeletes::
1790        If set to true, git-receive-pack will deny a ref update that deletes
1791        the ref. Use this to prevent such a ref deletion via a push.
1792
1793receive.denyDeleteCurrent::
1794        If set to true, git-receive-pack will deny a ref update that
1795        deletes the currently checked out branch of a non-bare repository.
1796
1797receive.denyCurrentBranch::
1798        If set to true or "refuse", git-receive-pack will deny a ref update
1799        to the currently checked out branch of a non-bare repository.
1800        Such a push is potentially dangerous because it brings the HEAD
1801        out of sync with the index and working tree. If set to "warn",
1802        print a warning of such a push to stderr, but allow the push to
1803        proceed. If set to false or "ignore", allow such pushes with no
1804        message. Defaults to "refuse".
1805
1806receive.denyNonFastForwards::
1807        If set to true, git-receive-pack will deny a ref update which is
1808        not a fast-forward. Use this to prevent such an update via a push,
1809        even if that push is forced. This configuration variable is
1810        set when initializing a shared repository.
1811
1812receive.updateserverinfo::
1813        If set to true, git-receive-pack will run git-update-server-info
1814        after receiving data from git-push and updating refs.
1815
1816remote.<name>.url::
1817        The URL of a remote repository.  See linkgit:git-fetch[1] or
1818        linkgit:git-push[1].
1819
1820remote.<name>.pushurl::
1821        The push URL of a remote repository.  See linkgit:git-push[1].
1822
1823remote.<name>.proxy::
1824        For remotes that require curl (http, https and ftp), the URL to
1825        the proxy to use for that remote.  Set to the empty string to
1826        disable proxying for that remote.
1827
1828remote.<name>.fetch::
1829        The default set of "refspec" for linkgit:git-fetch[1]. See
1830        linkgit:git-fetch[1].
1831
1832remote.<name>.push::
1833        The default set of "refspec" for linkgit:git-push[1]. See
1834        linkgit:git-push[1].
1835
1836remote.<name>.mirror::
1837        If true, pushing to this remote will automatically behave
1838        as if the `--mirror` option was given on the command line.
1839
1840remote.<name>.skipDefaultUpdate::
1841        If true, this remote will be skipped by default when updating
1842        using linkgit:git-fetch[1] or the `update` subcommand of
1843        linkgit:git-remote[1].
1844
1845remote.<name>.skipFetchAll::
1846        If true, this remote will be skipped by default when updating
1847        using linkgit:git-fetch[1] or the `update` subcommand of
1848        linkgit:git-remote[1].
1849
1850remote.<name>.receivepack::
1851        The default program to execute on the remote side when pushing.  See
1852        option \--receive-pack of linkgit:git-push[1].
1853
1854remote.<name>.uploadpack::
1855        The default program to execute on the remote side when fetching.  See
1856        option \--upload-pack of linkgit:git-fetch-pack[1].
1857
1858remote.<name>.tagopt::
1859        Setting this value to \--no-tags disables automatic tag following when
1860        fetching from remote <name>. Setting it to \--tags will fetch every
1861        tag from remote <name>, even if they are not reachable from remote
1862        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1863        override this setting. See options \--tags and \--no-tags of
1864        linkgit:git-fetch[1].
1865
1866remote.<name>.vcs::
1867        Setting this to a value <vcs> will cause git to interact with
1868        the remote with the git-remote-<vcs> helper.
1869
1870remotes.<group>::
1871        The list of remotes which are fetched by "git remote update
1872        <group>".  See linkgit:git-remote[1].
1873
1874repack.usedeltabaseoffset::
1875        By default, linkgit:git-repack[1] creates packs that use
1876        delta-base offset. If you need to share your repository with
1877        git older than version 1.4.4, either directly or via a dumb
1878        protocol such as http, then you need to set this option to
1879        "false" and repack. Access from old git versions over the
1880        native protocol are unaffected by this option.
1881
1882rerere.autoupdate::
1883        When set to true, `git-rerere` updates the index with the
1884        resulting contents after it cleanly resolves conflicts using
1885        previously recorded resolution.  Defaults to false.
1886
1887rerere.enabled::
1888        Activate recording of resolved conflicts, so that identical
1889        conflict hunks can be resolved automatically, should they be
1890        encountered again.  By default, linkgit:git-rerere[1] is
1891        enabled if there is an `rr-cache` directory under the
1892        `$GIT_DIR`, e.g. if "rerere" was previously used in the
1893        repository.
1894
1895sendemail.identity::
1896        A configuration identity. When given, causes values in the
1897        'sendemail.<identity>' subsection to take precedence over
1898        values in the 'sendemail' section. The default identity is
1899        the value of 'sendemail.identity'.
1900
1901sendemail.smtpencryption::
1902        See linkgit:git-send-email[1] for description.  Note that this
1903        setting is not subject to the 'identity' mechanism.
1904
1905sendemail.smtpssl::
1906        Deprecated alias for 'sendemail.smtpencryption = ssl'.
1907
1908sendemail.<identity>.*::
1909        Identity-specific versions of the 'sendemail.*' parameters
1910        found below, taking precedence over those when the this
1911        identity is selected, through command-line or
1912        'sendemail.identity'.
1913
1914sendemail.aliasesfile::
1915sendemail.aliasfiletype::
1916sendemail.bcc::
1917sendemail.cc::
1918sendemail.cccmd::
1919sendemail.chainreplyto::
1920sendemail.confirm::
1921sendemail.envelopesender::
1922sendemail.from::
1923sendemail.multiedit::
1924sendemail.signedoffbycc::
1925sendemail.smtppass::
1926sendemail.suppresscc::
1927sendemail.suppressfrom::
1928sendemail.to::
1929sendemail.smtpdomain::
1930sendemail.smtpserver::
1931sendemail.smtpserverport::
1932sendemail.smtpserveroption::
1933sendemail.smtpuser::
1934sendemail.thread::
1935sendemail.validate::
1936        See linkgit:git-send-email[1] for description.
1937
1938sendemail.signedoffcc::
1939        Deprecated alias for 'sendemail.signedoffbycc'.
1940
1941showbranch.default::
1942        The default set of branches for linkgit:git-show-branch[1].
1943        See linkgit:git-show-branch[1].
1944
1945status.relativePaths::
1946        By default, linkgit:git-status[1] shows paths relative to the
1947        current directory. Setting this variable to `false` shows paths
1948        relative to the repository root (this was the default for git
1949        prior to v1.5.4).
1950
1951status.showUntrackedFiles::
1952        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1953        files which are not currently tracked by Git. Directories which
1954        contain only untracked files, are shown with the directory name
1955        only. Showing untracked files means that Git needs to lstat() all
1956        all the files in the whole repository, which might be slow on some
1957        systems. So, this variable controls how the commands displays
1958        the untracked files. Possible values are:
1959+
1960--
1961* `no` - Show no untracked files.
1962* `normal` - Show untracked files and directories.
1963* `all` - Show also individual files in untracked directories.
1964--
1965+
1966If this variable is not specified, it defaults to 'normal'.
1967This variable can be overridden with the -u|--untracked-files option
1968of linkgit:git-status[1] and linkgit:git-commit[1].
1969
1970status.submodulesummary::
1971        Defaults to false.
1972        If this is set to a non zero number or true (identical to -1 or an
1973        unlimited number), the submodule summary will be enabled and a
1974        summary of commits for modified submodules will be shown (see
1975        --summary-limit option of linkgit:git-submodule[1]).
1976
1977submodule.<name>.path::
1978submodule.<name>.url::
1979submodule.<name>.update::
1980        The path within this project, URL, and the updating strategy
1981        for a submodule.  These variables are initially populated
1982        by 'git submodule init'; edit them to override the
1983        URL and other values found in the `.gitmodules` file.  See
1984        linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1985
1986submodule.<name>.fetchRecurseSubmodules::
1987        This option can be used to control recursive fetching of this
1988        submodule. It can be overridden by using the --[no-]recurse-submodules
1989        command line option to "git fetch" and "git pull".
1990        This setting will override that from in the linkgit:gitmodules[5]
1991        file.
1992
1993submodule.<name>.ignore::
1994        Defines under what circumstances "git status" and the diff family show
1995        a submodule as modified. When set to "all", it will never be considered
1996        modified, "dirty" will ignore all changes to the submodules work tree and
1997        takes only differences between the HEAD of the submodule and the commit
1998        recorded in the superproject into account. "untracked" will additionally
1999        let submodules with modified tracked files in their work tree show up.
2000        Using "none" (the default when this option is not set) also shows
2001        submodules that have untracked files in their work tree as changed.
2002        This setting overrides any setting made in .gitmodules for this submodule,
2003        both settings can be overridden on the command line by using the
2004        "--ignore-submodules" option.
2005
2006tar.umask::
2007        This variable can be used to restrict the permission bits of
2008        tar archive entries.  The default is 0002, which turns off the
2009        world write bit.  The special value "user" indicates that the
2010        archiving user's umask will be used instead.  See umask(2) and
2011        linkgit:git-archive[1].
2012
2013transfer.fsckObjects::
2014        When `fetch.fsckObjects` or `receive.fsckObjects` are
2015        not set, the value of this variable is used instead.
2016        Defaults to false.
2017
2018transfer.unpackLimit::
2019        When `fetch.unpackLimit` or `receive.unpackLimit` are
2020        not set, the value of this variable is used instead.
2021        The default value is 100.
2022
2023url.<base>.insteadOf::
2024        Any URL that starts with this value will be rewritten to
2025        start, instead, with <base>. In cases where some site serves a
2026        large number of repositories, and serves them with multiple
2027        access methods, and some users need to use different access
2028        methods, this feature allows people to specify any of the
2029        equivalent URLs and have git automatically rewrite the URL to
2030        the best alternative for the particular user, even for a
2031        never-before-seen repository on the site.  When more than one
2032        insteadOf strings match a given URL, the longest match is used.
2033
2034url.<base>.pushInsteadOf::
2035        Any URL that starts with this value will not be pushed to;
2036        instead, it will be rewritten to start with <base>, and the
2037        resulting URL will be pushed to. In cases where some site serves
2038        a large number of repositories, and serves them with multiple
2039        access methods, some of which do not allow push, this feature
2040        allows people to specify a pull-only URL and have git
2041        automatically use an appropriate URL to push, even for a
2042        never-before-seen repository on the site.  When more than one
2043        pushInsteadOf strings match a given URL, the longest match is
2044        used.  If a remote has an explicit pushurl, git will ignore this
2045        setting for that remote.
2046
2047user.email::
2048        Your email address to be recorded in any newly created commits.
2049        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2050        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2051
2052user.name::
2053        Your full name to be recorded in any newly created commits.
2054        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2055        environment variables.  See linkgit:git-commit-tree[1].
2056
2057user.signingkey::
2058        If linkgit:git-tag[1] is not selecting the key you want it to
2059        automatically when creating a signed tag, you can override the
2060        default selection with this variable.  This option is passed
2061        unchanged to gpg's --local-user parameter, so you may specify a key
2062        using any method that gpg supports.
2063
2064web.browser::
2065        Specify a web browser that may be used by some commands.
2066        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2067        may use it.