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