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