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