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