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