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