Documentation / config.txton commit Merge branch 'im/hashcmp-optim' (efa67bf)
   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'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
 591from the original current directory. See linkgit:git-rev-parse[1].
 592
 593am.keepcr::
 594        If true, git-am will call git-mailsplit for patches in mbox format
 595        with parameter '--keep-cr'. In this case git-mailsplit will
 596        not remove `\r` from lines ending with `\r\n`. Can be overridden
 597        by giving '--no-keep-cr' from the command line.
 598        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 599
 600apply.ignorewhitespace::
 601        When set to 'change', tells 'git apply' to ignore changes in
 602        whitespace, in the same way as the '--ignore-space-change'
 603        option.
 604        When set to one of: no, none, never, false tells 'git apply' to
 605        respect all whitespace differences.
 606        See linkgit:git-apply[1].
 607
 608apply.whitespace::
 609        Tells 'git apply' how to handle whitespaces, in the same way
 610        as the '--whitespace' option. See linkgit:git-apply[1].
 611
 612branch.autosetupmerge::
 613        Tells 'git branch' and 'git checkout' to set up new branches
 614        so that linkgit:git-pull[1] will appropriately merge from the
 615        starting point branch. Note that even if this option is not set,
 616        this behavior can be chosen per-branch using the `--track`
 617        and `--no-track` options. The valid settings are: `false` -- no
 618        automatic setup is done; `true` -- automatic setup is done when the
 619        starting point is a remote-tracking branch; `always` --
 620        automatic setup is done when the starting point is either a
 621        local branch or remote-tracking
 622        branch. This option defaults to true.
 623
 624branch.autosetuprebase::
 625        When a new branch is created with 'git branch' or 'git checkout'
 626        that tracks another branch, this variable tells git to set
 627        up pull to rebase instead of merge (see "branch.<name>.rebase").
 628        When `never`, rebase is never automatically set to true.
 629        When `local`, rebase is set to true for tracked branches of
 630        other local branches.
 631        When `remote`, rebase is set to true for tracked branches of
 632        remote-tracking branches.
 633        When `always`, rebase will be set to true for all tracking
 634        branches.
 635        See "branch.autosetupmerge" for details on how to set up a
 636        branch to track another branch.
 637        This option defaults to never.
 638
 639branch.<name>.remote::
 640        When in branch <name>, it tells 'git fetch' and 'git push' which
 641        remote to fetch from/push to.  It defaults to `origin` if no remote is
 642        configured. `origin` is also used if you are not on any branch.
 643
 644branch.<name>.merge::
 645        Defines, together with branch.<name>.remote, the upstream branch
 646        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
 647        branch to merge and can also affect 'git push' (see push.default).
 648        When in branch <name>, it tells 'git fetch' the default
 649        refspec to be marked for merging in FETCH_HEAD. The value is
 650        handled like the remote part of a refspec, and must match a
 651        ref which is fetched from the remote given by
 652        "branch.<name>.remote".
 653        The merge information is used by 'git pull' (which at first calls
 654        'git fetch') to lookup the default branch for merging. Without
 655        this option, 'git pull' defaults to merge the first refspec fetched.
 656        Specify multiple values to get an octopus merge.
 657        If you wish to setup 'git pull' so that it merges into <name> from
 658        another branch in the local repository, you can point
 659        branch.<name>.merge to the desired branch, and use the special setting
 660        `.` (a period) for branch.<name>.remote.
 661
 662branch.<name>.mergeoptions::
 663        Sets default options for merging into branch <name>. The syntax and
 664        supported options are the same as those of linkgit:git-merge[1], but
 665        option values containing whitespace characters are currently not
 666        supported.
 667
 668branch.<name>.rebase::
 669        When true, rebase the branch <name> on top of the fetched branch,
 670        instead of merging the default branch from the default remote when
 671        "git pull" is run.
 672        *NOTE*: this is a possibly dangerous operation; do *not* use
 673        it unless you understand the implications (see linkgit:git-rebase[1]
 674        for details).
 675
 676browser.<tool>.cmd::
 677        Specify the command to invoke the specified browser. The
 678        specified command is evaluated in shell with the URLs passed
 679        as arguments. (See linkgit:git-web--browse[1].)
 680
 681browser.<tool>.path::
 682        Override the path for the given tool that may be used to
 683        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 684        working repository in gitweb (see linkgit:git-instaweb[1]).
 685
 686clean.requireForce::
 687        A boolean to make git-clean do nothing unless given -f
 688        or -n.   Defaults to true.
 689
 690color.branch::
 691        A boolean to enable/disable color in the output of
 692        linkgit:git-branch[1]. May be set to `always`,
 693        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 694        only when the output is to a terminal. Defaults to false.
 695
 696color.branch.<slot>::
 697        Use customized color for branch coloration. `<slot>` is one of
 698        `current` (the current branch), `local` (a local branch),
 699        `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
 700        refs).
 701+
 702The value for these configuration variables is a list of colors (at most
 703two) and attributes (at most one), separated by spaces.  The colors
 704accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 705`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 706`blink` and `reverse`.  The first color given is the foreground; the
 707second is the background.  The position of the attribute, if any,
 708doesn't matter.
 709
 710color.diff::
 711        Whether to use ANSI escape sequences to add color to patches.
 712        If this is set to `always`, linkgit:git-diff[1],
 713        linkgit:git-log[1], and linkgit:git-show[1] will use color
 714        for all patches.  If it is set to `true` or `auto`, those
 715        commands will only use color when output is to the terminal.
 716        Defaults to false.
 717+
 718This does not affect linkgit:git-format-patch[1] nor the
 719'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
 720command line with the `--color[=<when>]` option.
 721
 722color.diff.<slot>::
 723        Use customized color for diff colorization.  `<slot>` specifies
 724        which part of the patch to use the specified color, and is one
 725        of `plain` (context text), `meta` (metainformation), `frag`
 726        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 727        `new` (added lines), `commit` (commit headers), or `whitespace`
 728        (highlighting whitespace errors). The values of these variables may be
 729        specified as in color.branch.<slot>.
 730
 731color.decorate.<slot>::
 732        Use customized color for 'git log --decorate' output.  `<slot>` is one
 733        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
 734        branches, remote-tracking branches, tags, stash and HEAD, respectively.
 735
 736color.grep::
 737        When set to `always`, always highlight matches.  When `false` (or
 738        `never`), never.  When set to `true` or `auto`, use color only
 739        when the output is written to the terminal.  Defaults to `false`.
 740
 741color.grep.<slot>::
 742        Use customized color for grep colorization.  `<slot>` specifies which
 743        part of the line to use the specified color, and is one of
 744+
 745--
 746`context`;;
 747        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
 748`filename`;;
 749        filename prefix (when not using `-h`)
 750`function`;;
 751        function name lines (when using `-p`)
 752`linenumber`;;
 753        line number prefix (when using `-n`)
 754`match`;;
 755        matching text
 756`selected`;;
 757        non-matching text in selected lines
 758`separator`;;
 759        separators between fields on a line (`:`, `-`, and `=`)
 760        and between hunks (`--`)
 761--
 762+
 763The values of these variables may be specified as in color.branch.<slot>.
 764
 765color.interactive::
 766        When set to `always`, always use colors for interactive prompts
 767        and displays (such as those used by "git-add --interactive").
 768        When false (or `never`), never.  When set to `true` or `auto`, use
 769        colors only when the output is to the terminal. Defaults to false.
 770
 771color.interactive.<slot>::
 772        Use customized color for 'git add --interactive'
 773        output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
 774        four distinct types of normal output from interactive
 775        commands.  The values of these variables may be specified as
 776        in color.branch.<slot>.
 777
 778color.pager::
 779        A boolean to enable/disable colored output when the pager is in
 780        use (default is true).
 781
 782color.showbranch::
 783        A boolean to enable/disable color in the output of
 784        linkgit:git-show-branch[1]. May be set to `always`,
 785        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 786        only when the output is to a terminal. Defaults to false.
 787
 788color.status::
 789        A boolean to enable/disable color in the output of
 790        linkgit:git-status[1]. May be set to `always`,
 791        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 792        only when the output is to a terminal. Defaults to false.
 793
 794color.status.<slot>::
 795        Use customized color for status colorization. `<slot>` is
 796        one of `header` (the header text of the status message),
 797        `added` or `updated` (files which are added but not committed),
 798        `changed` (files which are changed but not added in the index),
 799        `untracked` (files which are not tracked by git),
 800        `branch` (the current branch), or
 801        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 802        to red). The values of these variables may be specified as in
 803        color.branch.<slot>.
 804
 805color.ui::
 806        This variable determines the default value for variables such
 807        as `color.diff` and `color.grep` that control the use of color
 808        per command family. Its scope will expand as more commands learn
 809        configuration to set a default for the `--color` option.  Set it
 810        to `always` if you want all output not intended for machine
 811        consumption to use color, to `true` or `auto` if you want such
 812        output to use color when written to the terminal, or to `false` or
 813        `never` if you prefer git commands not to use color unless enabled
 814        explicitly with some other configuration or the `--color` option.
 815
 816commit.status::
 817        A boolean to enable/disable inclusion of status information in the
 818        commit message template when using an editor to prepare the commit
 819        message.  Defaults to true.
 820
 821commit.template::
 822        Specify a file to use as the template for new commit messages.
 823        "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
 824        specified user's home directory.
 825
 826include::diff-config.txt[]
 827
 828difftool.<tool>.path::
 829        Override the path for the given tool.  This is useful in case
 830        your tool is not in the PATH.
 831
 832difftool.<tool>.cmd::
 833        Specify the command to invoke the specified diff tool.
 834        The specified command is evaluated in shell with the following
 835        variables available:  'LOCAL' is set to the name of the temporary
 836        file containing the contents of the diff pre-image and 'REMOTE'
 837        is set to the name of the temporary file containing the contents
 838        of the diff post-image.
 839
 840difftool.prompt::
 841        Prompt before each invocation of the diff tool.
 842
 843diff.wordRegex::
 844        A POSIX Extended Regular Expression used to determine what is a "word"
 845        when performing word-by-word difference calculations.  Character
 846        sequences that match the regular expression are "words", all other
 847        characters are *ignorable* whitespace.
 848
 849fetch.recurseSubmodules::
 850        This option can be either set to a boolean value or to 'on-demand'.
 851        Setting it to a boolean changes the behavior of fetch and pull to
 852        unconditionally recurse into submodules when set to true or to not
 853        recurse at all when set to false. When set to 'on-demand' (the default
 854        value), fetch and pull will only recurse into a populated submodule
 855        when its superproject retrieves a commit that updates the submodule's
 856        reference.
 857
 858fetch.unpackLimit::
 859        If the number of objects fetched over the git native
 860        transfer is below this
 861        limit, then the objects will be unpacked into loose object
 862        files. However if the number of received objects equals or
 863        exceeds this limit then the received pack will be stored as
 864        a pack, after adding any missing delta bases.  Storing the
 865        pack from a push can make the push operation complete faster,
 866        especially on slow filesystems.  If not set, the value of
 867        `transfer.unpackLimit` is used instead.
 868
 869format.attach::
 870        Enable multipart/mixed attachments as the default for
 871        'format-patch'.  The value can also be a double quoted string
 872        which will enable attachments as the default and set the
 873        value as the boundary.  See the --attach option in
 874        linkgit:git-format-patch[1].
 875
 876format.numbered::
 877        A boolean which can enable or disable sequence numbers in patch
 878        subjects.  It defaults to "auto" which enables it only if there
 879        is more than one patch.  It can be enabled or disabled for all
 880        messages by setting it to "true" or "false".  See --numbered
 881        option in linkgit:git-format-patch[1].
 882
 883format.headers::
 884        Additional email headers to include in a patch to be submitted
 885        by mail.  See linkgit:git-format-patch[1].
 886
 887format.to::
 888format.cc::
 889        Additional recipients to include in a patch to be submitted
 890        by mail.  See the --to and --cc options in
 891        linkgit:git-format-patch[1].
 892
 893format.subjectprefix::
 894        The default for format-patch is to output files with the '[PATCH]'
 895        subject prefix. Use this variable to change that prefix.
 896
 897format.signature::
 898        The default for format-patch is to output a signature containing
 899        the git version number. Use this variable to change that default.
 900        Set this variable to the empty string ("") to suppress
 901        signature generation.
 902
 903format.suffix::
 904        The default for format-patch is to output files with the suffix
 905        `.patch`. Use this variable to change that suffix (make sure to
 906        include the dot if you want it).
 907
 908format.pretty::
 909        The default pretty format for log/show/whatchanged command,
 910        See linkgit:git-log[1], linkgit:git-show[1],
 911        linkgit:git-whatchanged[1].
 912
 913format.thread::
 914        The default threading style for 'git format-patch'.  Can be
 915        a boolean value, or `shallow` or `deep`.  `shallow` threading
 916        makes every mail a reply to the head of the series,
 917        where the head is chosen from the cover letter, the
 918        `\--in-reply-to`, and the first patch mail, in this order.
 919        `deep` threading makes every mail a reply to the previous one.
 920        A true boolean value is the same as `shallow`, and a false
 921        value disables threading.
 922
 923format.signoff::
 924    A boolean value which lets you enable the `-s/--signoff` option of
 925    format-patch by default. *Note:* Adding the Signed-off-by: line to a
 926    patch should be a conscious act and means that you certify you have
 927    the rights to submit this work under the same open source license.
 928    Please see the 'SubmittingPatches' document for further discussion.
 929
 930filter.<driver>.clean::
 931        The command which is used to convert the content of a worktree
 932        file to a blob upon checkin.  See linkgit:gitattributes[5] for
 933        details.
 934
 935filter.<driver>.smudge::
 936        The command which is used to convert the content of a blob
 937        object to a worktree file upon checkout.  See
 938        linkgit:gitattributes[5] for details.
 939
 940gc.aggressiveWindow::
 941        The window size parameter used in the delta compression
 942        algorithm used by 'git gc --aggressive'.  This defaults
 943        to 250.
 944
 945gc.auto::
 946        When there are approximately more than this many loose
 947        objects in the repository, `git gc --auto` will pack them.
 948        Some Porcelain commands use this command to perform a
 949        light-weight garbage collection from time to time.  The
 950        default value is 6700.  Setting this to 0 disables it.
 951
 952gc.autopacklimit::
 953        When there are more than this many packs that are not
 954        marked with `*.keep` file in the repository, `git gc
 955        --auto` consolidates them into one larger pack.  The
 956        default value is 50.  Setting this to 0 disables it.
 957
 958gc.packrefs::
 959        Running `git pack-refs` in a repository renders it
 960        unclonable by Git versions prior to 1.5.1.2 over dumb
 961        transports such as HTTP.  This variable determines whether
 962        'git gc' runs `git pack-refs`. This can be set to `notbare`
 963        to enable it within all non-bare repos or it can be set to a
 964        boolean value.  The default is `true`.
 965
 966gc.pruneexpire::
 967        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
 968        Override the grace period with this config variable.  The value
 969        "now" may be used to disable this  grace period and always prune
 970        unreachable objects immediately.
 971
 972gc.reflogexpire::
 973gc.<pattern>.reflogexpire::
 974        'git reflog expire' removes reflog entries older than
 975        this time; defaults to 90 days.  With "<pattern>" (e.g.
 976        "refs/stash") in the middle the setting applies only to
 977        the refs that match the <pattern>.
 978
 979gc.reflogexpireunreachable::
 980gc.<ref>.reflogexpireunreachable::
 981        'git reflog expire' removes reflog entries older than
 982        this time and are not reachable from the current tip;
 983        defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
 984        in the middle, the setting applies only to the refs that
 985        match the <pattern>.
 986
 987gc.rerereresolved::
 988        Records of conflicted merge you resolved earlier are
 989        kept for this many days when 'git rerere gc' is run.
 990        The default is 60 days.  See linkgit:git-rerere[1].
 991
 992gc.rerereunresolved::
 993        Records of conflicted merge you have not resolved are
 994        kept for this many days when 'git rerere gc' is run.
 995        The default is 15 days.  See linkgit:git-rerere[1].
 996
 997gitcvs.commitmsgannotation::
 998        Append this string to each commit message. Set to empty string
 999        to disable this feature. Defaults to "via git-CVS emulator".
1000
1001gitcvs.enabled::
1002        Whether the CVS server interface is enabled for this repository.
1003        See linkgit:git-cvsserver[1].
1004
1005gitcvs.logfile::
1006        Path to a log file where the CVS server interface well... logs
1007        various stuff. See linkgit:git-cvsserver[1].
1008
1009gitcvs.usecrlfattr::
1010        If true, the server will look up the end-of-line conversion
1011        attributes for files to determine the '-k' modes to use. If
1012        the attributes force git to treat a file as text,
1013        the '-k' mode will be left blank so CVS clients will
1014        treat it as text. If they suppress text conversion, the file
1015        will be set with '-kb' mode, which suppresses any newline munging
1016        the client might otherwise do. If the attributes do not allow
1017        the file type to be determined, then 'gitcvs.allbinary' is
1018        used. See linkgit:gitattributes[5].
1019
1020gitcvs.allbinary::
1021        This is used if 'gitcvs.usecrlfattr' does not resolve
1022        the correct '-kb' mode to use. If true, all
1023        unresolved files are sent to the client in
1024        mode '-kb'. This causes the client to treat them
1025        as binary files, which suppresses any newline munging it
1026        otherwise might do. Alternatively, if it is set to "guess",
1027        then the contents of the file are examined to decide if
1028        it is binary, similar to 'core.autocrlf'.
1029
1030gitcvs.dbname::
1031        Database used by git-cvsserver to cache revision information
1032        derived from the git repository. The exact meaning depends on the
1033        used database driver, for SQLite (which is the default driver) this
1034        is a filename. Supports variable substitution (see
1035        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1036        Default: '%Ggitcvs.%m.sqlite'
1037
1038gitcvs.dbdriver::
1039        Used Perl DBI driver. You can specify any available driver
1040        for this here, but it might not work. git-cvsserver is tested
1041        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1042        reported *not* to work with 'DBD::mysql'. Experimental feature.
1043        May not contain double colons (`:`). Default: 'SQLite'.
1044        See linkgit:git-cvsserver[1].
1045
1046gitcvs.dbuser, gitcvs.dbpass::
1047        Database user and password. Only useful if setting 'gitcvs.dbdriver',
1048        since SQLite has no concept of database users and/or passwords.
1049        'gitcvs.dbuser' supports variable substitution (see
1050        linkgit:git-cvsserver[1] for details).
1051
1052gitcvs.dbTableNamePrefix::
1053        Database table name prefix.  Prepended to the names of any
1054        database tables used, allowing a single database to be used
1055        for several repositories.  Supports variable substitution (see
1056        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1057        characters will be replaced with underscores.
1058
1059All gitcvs variables except for 'gitcvs.usecrlfattr' and
1060'gitcvs.allbinary' can also be specified as
1061'gitcvs.<access_method>.<varname>' (where 'access_method'
1062is one of "ext" and "pserver") to make them apply only for the given
1063access method.
1064
1065grep.lineNumber::
1066        If set to true, enable '-n' option by default.
1067
1068grep.extendedRegexp::
1069        If set to true, enable '--extended-regexp' option by default.
1070
1071gui.commitmsgwidth::
1072        Defines how wide the commit message window is in the
1073        linkgit:git-gui[1]. "75" is the default.
1074
1075gui.diffcontext::
1076        Specifies how many context lines should be used in calls to diff
1077        made by the linkgit:git-gui[1]. The default is "5".
1078
1079gui.encoding::
1080        Specifies the default encoding to use for displaying of
1081        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1082        It can be overridden by setting the 'encoding' attribute
1083        for relevant files (see linkgit:gitattributes[5]).
1084        If this option is not set, the tools default to the
1085        locale encoding.
1086
1087gui.matchtrackingbranch::
1088        Determines if new branches created with linkgit:git-gui[1] should
1089        default to tracking remote branches with matching names or
1090        not. Default: "false".
1091
1092gui.newbranchtemplate::
1093        Is used as suggested name when creating new branches using the
1094        linkgit:git-gui[1].
1095
1096gui.pruneduringfetch::
1097        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1098        performing a fetch. The default value is "false".
1099
1100gui.trustmtime::
1101        Determines if linkgit:git-gui[1] should trust the file modification
1102        timestamp or not. By default the timestamps are not trusted.
1103
1104gui.spellingdictionary::
1105        Specifies the dictionary used for spell checking commit messages in
1106        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1107        off.
1108
1109gui.fastcopyblame::
1110        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1111        location detection. It makes blame significantly faster on huge
1112        repositories at the expense of less thorough copy detection.
1113
1114gui.copyblamethreshold::
1115        Specifies the threshold to use in 'git gui blame' original location
1116        detection, measured in alphanumeric characters. See the
1117        linkgit:git-blame[1] manual for more information on copy detection.
1118
1119gui.blamehistoryctx::
1120        Specifies the radius of history context in days to show in
1121        linkgit:gitk[1] for the selected commit, when the `Show History
1122        Context` menu item is invoked from 'git gui blame'. If this
1123        variable is set to zero, the whole history is shown.
1124
1125guitool.<name>.cmd::
1126        Specifies the shell command line to execute when the corresponding item
1127        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1128        mandatory for every tool. The command is executed from the root of
1129        the working directory, and in the environment it receives the name of
1130        the tool as 'GIT_GUITOOL', the name of the currently selected file as
1131        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1132        the head is detached, 'CUR_BRANCH' is empty).
1133
1134guitool.<name>.needsfile::
1135        Run the tool only if a diff is selected in the GUI. It guarantees
1136        that 'FILENAME' is not empty.
1137
1138guitool.<name>.noconsole::
1139        Run the command silently, without creating a window to display its
1140        output.
1141
1142guitool.<name>.norescan::
1143        Don't rescan the working directory for changes after the tool
1144        finishes execution.
1145
1146guitool.<name>.confirm::
1147        Show a confirmation dialog before actually running the tool.
1148
1149guitool.<name>.argprompt::
1150        Request a string argument from the user, and pass it to the tool
1151        through the 'ARGS' environment variable. Since requesting an
1152        argument implies confirmation, the 'confirm' option has no effect
1153        if this is enabled. If the option is set to 'true', 'yes', or '1',
1154        the dialog uses a built-in generic prompt; otherwise the exact
1155        value of the variable is used.
1156
1157guitool.<name>.revprompt::
1158        Request a single valid revision from the user, and set the
1159        'REVISION' environment variable. In other aspects this option
1160        is similar to 'argprompt', and can be used together with it.
1161
1162guitool.<name>.revunmerged::
1163        Show only unmerged branches in the 'revprompt' subdialog.
1164        This is useful for tools similar to merge or rebase, but not
1165        for things like checkout or reset.
1166
1167guitool.<name>.title::
1168        Specifies the title to use for the prompt dialog. The default
1169        is the tool name.
1170
1171guitool.<name>.prompt::
1172        Specifies the general prompt string to display at the top of
1173        the dialog, before subsections for 'argprompt' and 'revprompt'.
1174        The default value includes the actual command.
1175
1176help.browser::
1177        Specify the browser that will be used to display help in the
1178        'web' format. See linkgit:git-help[1].
1179
1180help.format::
1181        Override the default help format used by linkgit:git-help[1].
1182        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1183        the default. 'web' and 'html' are the same.
1184
1185help.autocorrect::
1186        Automatically correct and execute mistyped commands after
1187        waiting for the given number of deciseconds (0.1 sec). If more
1188        than one command can be deduced from the entered text, nothing
1189        will be executed.  If the value of this option is negative,
1190        the corrected command will be executed immediately. If the
1191        value is 0 - the command will be just shown but not executed.
1192        This is the default.
1193
1194http.proxy::
1195        Override the HTTP proxy, normally configured using the 'http_proxy'
1196        environment variable (see linkgit:curl[1]).  This can be overridden
1197        on a per-remote basis; see remote.<name>.proxy
1198
1199http.sslVerify::
1200        Whether to verify the SSL certificate when fetching or pushing
1201        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1202        variable.
1203
1204http.sslCert::
1205        File containing the SSL certificate when fetching or pushing
1206        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1207        variable.
1208
1209http.sslKey::
1210        File containing the SSL private key when fetching or pushing
1211        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1212        variable.
1213
1214http.sslCertPasswordProtected::
1215        Enable git's password prompt for the SSL certificate.  Otherwise
1216        OpenSSL will prompt the user, possibly many times, if the
1217        certificate or private key is encrypted.  Can be overridden by the
1218        'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1219
1220http.sslCAInfo::
1221        File containing the certificates to verify the peer with when
1222        fetching or pushing over HTTPS. Can be overridden by the
1223        'GIT_SSL_CAINFO' environment variable.
1224
1225http.sslCAPath::
1226        Path containing files with the CA certificates to verify the peer
1227        with when fetching or pushing over HTTPS. Can be overridden
1228        by the 'GIT_SSL_CAPATH' environment variable.
1229
1230http.maxRequests::
1231        How many HTTP requests to launch in parallel. Can be overridden
1232        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1233
1234http.minSessions::
1235        The number of curl sessions (counted across slots) to be kept across
1236        requests. They will not be ended with curl_easy_cleanup() until
1237        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1238        value will be capped at 1. Defaults to 1.
1239
1240http.postBuffer::
1241        Maximum size in bytes of the buffer used by smart HTTP
1242        transports when POSTing data to the remote system.
1243        For requests larger than this buffer size, HTTP/1.1 and
1244        Transfer-Encoding: chunked is used to avoid creating a
1245        massive pack file locally.  Default is 1 MiB, which is
1246        sufficient for most requests.
1247
1248http.lowSpeedLimit, http.lowSpeedTime::
1249        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1250        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1251        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1252        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1253
1254http.noEPSV::
1255        A boolean which disables using of EPSV ftp command by curl.
1256        This can helpful with some "poor" ftp servers which don't
1257        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1258        environment variable. Default is false (curl will use EPSV).
1259
1260http.useragent::
1261        The HTTP USER_AGENT string presented to an HTTP server.  The default
1262        value represents the version of the client git such as git/1.7.1.
1263        This option allows you to override this value to a more common value
1264        such as Mozilla/4.0.  This may be necessary, for instance, if
1265        connecting through a firewall that restricts HTTP connections to a set
1266        of common USER_AGENT strings (but not including those like git/1.7.1).
1267        Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1268
1269i18n.commitEncoding::
1270        Character encoding the commit messages are stored in; git itself
1271        does not care per se, but this information is necessary e.g. when
1272        importing commits from emails or in the gitk graphical history
1273        browser (and possibly at other places in the future or in other
1274        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1275
1276i18n.logOutputEncoding::
1277        Character encoding the commit messages are converted to when
1278        running 'git log' and friends.
1279
1280imap::
1281        The configuration variables in the 'imap' section are described
1282        in linkgit:git-imap-send[1].
1283
1284init.templatedir::
1285        Specify the directory from which templates will be copied.
1286        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1287
1288instaweb.browser::
1289        Specify the program that will be used to browse your working
1290        repository in gitweb. See linkgit:git-instaweb[1].
1291
1292instaweb.httpd::
1293        The HTTP daemon command-line to start gitweb on your working
1294        repository. See linkgit:git-instaweb[1].
1295
1296instaweb.local::
1297        If true the web server started by linkgit:git-instaweb[1] will
1298        be bound to the local IP (127.0.0.1).
1299
1300instaweb.modulepath::
1301        The default module path for linkgit:git-instaweb[1] to use
1302        instead of /usr/lib/apache2/modules.  Only used if httpd
1303        is Apache.
1304
1305instaweb.port::
1306        The port number to bind the gitweb httpd to. See
1307        linkgit:git-instaweb[1].
1308
1309interactive.singlekey::
1310        In interactive commands, allow the user to provide one-letter
1311        input with a single key (i.e., without hitting enter).
1312        Currently this is used only by the `\--patch` mode of
1313        linkgit:git-add[1].  Note that this setting is silently
1314        ignored if portable keystroke input is not available.
1315
1316log.date::
1317        Set the default date-time mode for the 'log' command.
1318        Setting a value for log.date is similar to using 'git log''s
1319        `\--date` option.  Possible values are `relative`, `local`,
1320        `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1321        for details.
1322
1323log.decorate::
1324        Print out the ref names of any commits that are shown by the log
1325        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1326        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1327        specified, the full ref name (including prefix) will be printed.
1328        This is the same as the log commands '--decorate' option.
1329
1330log.showroot::
1331        If true, the initial commit will be shown as a big creation event.
1332        This is equivalent to a diff against an empty tree.
1333        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1334        normally hide the root commit will now show it. True by default.
1335
1336mailmap.file::
1337        The location of an augmenting mailmap file. The default
1338        mailmap, located in the root of the repository, is loaded
1339        first, then the mailmap file pointed to by this variable.
1340        The location of the mailmap file may be in a repository
1341        subdirectory, or somewhere outside of the repository itself.
1342        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1343
1344man.viewer::
1345        Specify the programs that may be used to display help in the
1346        'man' format. See linkgit:git-help[1].
1347
1348man.<tool>.cmd::
1349        Specify the command to invoke the specified man viewer. The
1350        specified command is evaluated in shell with the man page
1351        passed as argument. (See linkgit:git-help[1].)
1352
1353man.<tool>.path::
1354        Override the path for the given tool that may be used to
1355        display help in the 'man' format. See linkgit:git-help[1].
1356
1357include::merge-config.txt[]
1358
1359mergetool.<tool>.path::
1360        Override the path for the given tool.  This is useful in case
1361        your tool is not in the PATH.
1362
1363mergetool.<tool>.cmd::
1364        Specify the command to invoke the specified merge tool.  The
1365        specified command is evaluated in shell with the following
1366        variables available: 'BASE' is the name of a temporary file
1367        containing the common base of the files to be merged, if available;
1368        'LOCAL' is the name of a temporary file containing the contents of
1369        the file on the current branch; 'REMOTE' is the name of a temporary
1370        file containing the contents of the file from the branch being
1371        merged; 'MERGED' contains the name of the file to which the merge
1372        tool should write the results of a successful merge.
1373
1374mergetool.<tool>.trustExitCode::
1375        For a custom merge command, specify whether the exit code of
1376        the merge command can be used to determine whether the merge was
1377        successful.  If this is not set to true then the merge target file
1378        timestamp is checked and the merge assumed to have been successful
1379        if the file has been updated, otherwise the user is prompted to
1380        indicate the success of the merge.
1381
1382mergetool.keepBackup::
1383        After performing a merge, the original file with conflict markers
1384        can be saved as a file with a `.orig` extension.  If this variable
1385        is set to `false` then this file is not preserved.  Defaults to
1386        `true` (i.e. keep the backup files).
1387
1388mergetool.keepTemporaries::
1389        When invoking a custom merge tool, git uses a set of temporary
1390        files to pass to the tool. If the tool returns an error and this
1391        variable is set to `true`, then these temporary files will be
1392        preserved, otherwise they will be removed after the tool has
1393        exited. Defaults to `false`.
1394
1395mergetool.prompt::
1396        Prompt before each invocation of the merge resolution program.
1397
1398notes.displayRef::
1399        The (fully qualified) refname from which to show notes when
1400        showing commit messages.  The value of this variable can be set
1401        to a glob, in which case notes from all matching refs will be
1402        shown.  You may also specify this configuration variable
1403        several times.  A warning will be issued for refs that do not
1404        exist, but a glob that does not match any refs is silently
1405        ignored.
1406+
1407This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1408environment variable, which must be a colon separated list of refs or
1409globs.
1410+
1411The effective value of "core.notesRef" (possibly overridden by
1412GIT_NOTES_REF) is also implicitly added to the list of refs to be
1413displayed.
1414
1415notes.rewrite.<command>::
1416        When rewriting commits with <command> (currently `amend` or
1417        `rebase`) and this variable is set to `true`, git
1418        automatically copies your notes from the original to the
1419        rewritten commit.  Defaults to `true`, but see
1420        "notes.rewriteRef" below.
1421
1422notes.rewriteMode::
1423        When copying notes during a rewrite (see the
1424        "notes.rewrite.<command>" option), determines what to do if
1425        the target commit already has a note.  Must be one of
1426        `overwrite`, `concatenate`, or `ignore`.  Defaults to
1427        `concatenate`.
1428+
1429This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1430environment variable.
1431
1432notes.rewriteRef::
1433        When copying notes during a rewrite, specifies the (fully
1434        qualified) ref whose notes should be copied.  The ref may be a
1435        glob, in which case notes in all matching refs will be copied.
1436        You may also specify this configuration several times.
1437+
1438Does not have a default value; you must configure this variable to
1439enable note rewriting.
1440+
1441This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1442environment variable, which must be a colon separated list of refs or
1443globs.
1444
1445pack.window::
1446        The size of the window used by linkgit:git-pack-objects[1] when no
1447        window size is given on the command line. Defaults to 10.
1448
1449pack.depth::
1450        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1451        maximum depth is given on the command line. Defaults to 50.
1452
1453pack.windowMemory::
1454        The window memory size limit used by linkgit:git-pack-objects[1]
1455        when no limit is given on the command line.  The value can be
1456        suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1457        limit.
1458
1459pack.compression::
1460        An integer -1..9, indicating the compression level for objects
1461        in a pack file. -1 is the zlib default. 0 means no
1462        compression, and 1..9 are various speed/size tradeoffs, 9 being
1463        slowest.  If not set,  defaults to core.compression.  If that is
1464        not set,  defaults to -1, the zlib default, which is "a default
1465        compromise between speed and compression (currently equivalent
1466        to level 6)."
1467+
1468Note that changing the compression level will not automatically recompress
1469all existing objects. You can force recompression by passing the -F option
1470to linkgit:git-repack[1].
1471
1472pack.deltaCacheSize::
1473        The maximum memory in bytes used for caching deltas in
1474        linkgit:git-pack-objects[1] before writing them out to a pack.
1475        This cache is used to speed up the writing object phase by not
1476        having to recompute the final delta result once the best match
1477        for all objects is found.  Repacking large repositories on machines
1478        which are tight with memory might be badly impacted by this though,
1479        especially if this cache pushes the system into swapping.
1480        A value of 0 means no limit. The smallest size of 1 byte may be
1481        used to virtually disable this cache. Defaults to 256 MiB.
1482
1483pack.deltaCacheLimit::
1484        The maximum size of a delta, that is cached in
1485        linkgit:git-pack-objects[1]. This cache is used to speed up the
1486        writing object phase by not having to recompute the final delta
1487        result once the best match for all objects is found. Defaults to 1000.
1488
1489pack.threads::
1490        Specifies the number of threads to spawn when searching for best
1491        delta matches.  This requires that linkgit:git-pack-objects[1]
1492        be compiled with pthreads otherwise this option is ignored with a
1493        warning. This is meant to reduce packing time on multiprocessor
1494        machines. The required amount of memory for the delta search window
1495        is however multiplied by the number of threads.
1496        Specifying 0 will cause git to auto-detect the number of CPU's
1497        and set the number of threads accordingly.
1498
1499pack.indexVersion::
1500        Specify the default pack index version.  Valid values are 1 for
1501        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1502        the new pack index with capabilities for packs larger than 4 GB
1503        as well as proper protection against the repacking of corrupted
1504        packs.  Version 2 is the default.  Note that version 2 is enforced
1505        and this config option ignored whenever the corresponding pack is
1506        larger than 2 GB.
1507+
1508If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1509cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1510that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1511other side may give you a repository that cannot be accessed with your
1512older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1513you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1514the `{asterisk}.idx` file.
1515
1516pack.packSizeLimit::
1517        The maximum size of a pack.  This setting only affects
1518        packing to a file when repacking, i.e. the git:// protocol
1519        is unaffected.  It can be overridden by the `\--max-pack-size`
1520        option of linkgit:git-repack[1]. The minimum size allowed is
1521        limited to 1 MiB. The default is unlimited.
1522        Common unit suffixes of 'k', 'm', or 'g' are
1523        supported.
1524
1525pager.<cmd>::
1526        If the value is boolean, turns on or off pagination of the
1527        output of a particular git subcommand when writing to a tty.
1528        Otherwise, turns on pagination for the subcommand using the
1529        pager specified by the value of `pager.<cmd>`.  If `\--paginate`
1530        or `\--no-pager` is specified on the command line, it takes
1531        precedence over this option.  To disable pagination for all
1532        commands, set `core.pager` or `GIT_PAGER` to `cat`.
1533
1534pretty.<name>::
1535        Alias for a --pretty= format string, as specified in
1536        linkgit:git-log[1]. Any aliases defined here can be used just
1537        as the built-in pretty formats could. For example,
1538        running `git config pretty.changelog "format:{asterisk} %H %s"`
1539        would cause the invocation `git log --pretty=changelog`
1540        to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1541        Note that an alias with the same name as a built-in format
1542        will be silently ignored.
1543
1544pull.octopus::
1545        The default merge strategy to use when pulling multiple branches
1546        at once.
1547
1548pull.twohead::
1549        The default merge strategy to use when pulling a single branch.
1550
1551push.default::
1552        Defines the action git push should take if no refspec is given
1553        on the command line, no refspec is configured in the remote, and
1554        no refspec is implied by any of the options given on the command
1555        line. Possible values are:
1556+
1557* `nothing` - do not push anything.
1558* `matching` - push all matching branches.
1559  All branches having the same name in both ends are considered to be
1560  matching. This is the default.
1561* `upstream` - push the current branch to its upstream branch.
1562* `tracking` - deprecated synonym for `upstream`.
1563* `current` - push the current branch to a branch of the same name.
1564
1565rebase.stat::
1566        Whether to show a diffstat of what changed upstream since the last
1567        rebase. False by default.
1568
1569rebase.autosquash::
1570        If set to true enable '--autosquash' option by default.
1571
1572receive.autogc::
1573        By default, git-receive-pack will run "git-gc --auto" after
1574        receiving data from git-push and updating refs.  You can stop
1575        it by setting this variable to false.
1576
1577receive.fsckObjects::
1578        If it is set to true, git-receive-pack will check all received
1579        objects. It will abort in the case of a malformed object or a
1580        broken link. The result of an abort are only dangling objects.
1581        Defaults to false.
1582
1583receive.unpackLimit::
1584        If the number of objects received in a push is below this
1585        limit then the objects will be unpacked into loose object
1586        files. However if the number of received objects equals or
1587        exceeds this limit then the received pack will be stored as
1588        a pack, after adding any missing delta bases.  Storing the
1589        pack from a push can make the push operation complete faster,
1590        especially on slow filesystems.  If not set, the value of
1591        `transfer.unpackLimit` is used instead.
1592
1593receive.denyDeletes::
1594        If set to true, git-receive-pack will deny a ref update that deletes
1595        the ref. Use this to prevent such a ref deletion via a push.
1596
1597receive.denyDeleteCurrent::
1598        If set to true, git-receive-pack will deny a ref update that
1599        deletes the currently checked out branch of a non-bare repository.
1600
1601receive.denyCurrentBranch::
1602        If set to true or "refuse", git-receive-pack will deny a ref update
1603        to the currently checked out branch of a non-bare repository.
1604        Such a push is potentially dangerous because it brings the HEAD
1605        out of sync with the index and working tree. If set to "warn",
1606        print a warning of such a push to stderr, but allow the push to
1607        proceed. If set to false or "ignore", allow such pushes with no
1608        message. Defaults to "refuse".
1609
1610receive.denyNonFastForwards::
1611        If set to true, git-receive-pack will deny a ref update which is
1612        not a fast-forward. Use this to prevent such an update via a push,
1613        even if that push is forced. This configuration variable is
1614        set when initializing a shared repository.
1615
1616receive.updateserverinfo::
1617        If set to true, git-receive-pack will run git-update-server-info
1618        after receiving data from git-push and updating refs.
1619
1620remote.<name>.url::
1621        The URL of a remote repository.  See linkgit:git-fetch[1] or
1622        linkgit:git-push[1].
1623
1624remote.<name>.pushurl::
1625        The push URL of a remote repository.  See linkgit:git-push[1].
1626
1627remote.<name>.proxy::
1628        For remotes that require curl (http, https and ftp), the URL to
1629        the proxy to use for that remote.  Set to the empty string to
1630        disable proxying for that remote.
1631
1632remote.<name>.fetch::
1633        The default set of "refspec" for linkgit:git-fetch[1]. See
1634        linkgit:git-fetch[1].
1635
1636remote.<name>.push::
1637        The default set of "refspec" for linkgit:git-push[1]. See
1638        linkgit:git-push[1].
1639
1640remote.<name>.mirror::
1641        If true, pushing to this remote will automatically behave
1642        as if the `\--mirror` option was given on the command line.
1643
1644remote.<name>.skipDefaultUpdate::
1645        If true, this remote will be skipped by default when updating
1646        using linkgit:git-fetch[1] or the `update` subcommand of
1647        linkgit:git-remote[1].
1648
1649remote.<name>.skipFetchAll::
1650        If true, this remote will be skipped by default when updating
1651        using linkgit:git-fetch[1] or the `update` subcommand of
1652        linkgit:git-remote[1].
1653
1654remote.<name>.receivepack::
1655        The default program to execute on the remote side when pushing.  See
1656        option \--receive-pack of linkgit:git-push[1].
1657
1658remote.<name>.uploadpack::
1659        The default program to execute on the remote side when fetching.  See
1660        option \--upload-pack of linkgit:git-fetch-pack[1].
1661
1662remote.<name>.tagopt::
1663        Setting this value to \--no-tags disables automatic tag following when
1664        fetching from remote <name>. Setting it to \--tags will fetch every
1665        tag from remote <name>, even if they are not reachable from remote
1666        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1667        override this setting. See options \--tags and \--no-tags of
1668        linkgit:git-fetch[1].
1669
1670remote.<name>.vcs::
1671        Setting this to a value <vcs> will cause git to interact with
1672        the remote with the git-remote-<vcs> helper.
1673
1674remotes.<group>::
1675        The list of remotes which are fetched by "git remote update
1676        <group>".  See linkgit:git-remote[1].
1677
1678repack.usedeltabaseoffset::
1679        By default, linkgit:git-repack[1] creates packs that use
1680        delta-base offset. If you need to share your repository with
1681        git older than version 1.4.4, either directly or via a dumb
1682        protocol such as http, then you need to set this option to
1683        "false" and repack. Access from old git versions over the
1684        native protocol are unaffected by this option.
1685
1686rerere.autoupdate::
1687        When set to true, `git-rerere` updates the index with the
1688        resulting contents after it cleanly resolves conflicts using
1689        previously recorded resolution.  Defaults to false.
1690
1691rerere.enabled::
1692        Activate recording of resolved conflicts, so that identical
1693        conflict hunks can be resolved automatically, should they
1694        be encountered again.  linkgit:git-rerere[1] command is by
1695        default enabled if you create `rr-cache` directory under
1696        `$GIT_DIR`, but can be disabled by setting this option to false.
1697
1698sendemail.identity::
1699        A configuration identity. When given, causes values in the
1700        'sendemail.<identity>' subsection to take precedence over
1701        values in the 'sendemail' section. The default identity is
1702        the value of 'sendemail.identity'.
1703
1704sendemail.smtpencryption::
1705        See linkgit:git-send-email[1] for description.  Note that this
1706        setting is not subject to the 'identity' mechanism.
1707
1708sendemail.smtpssl::
1709        Deprecated alias for 'sendemail.smtpencryption = ssl'.
1710
1711sendemail.<identity>.*::
1712        Identity-specific versions of the 'sendemail.*' parameters
1713        found below, taking precedence over those when the this
1714        identity is selected, through command-line or
1715        'sendemail.identity'.
1716
1717sendemail.aliasesfile::
1718sendemail.aliasfiletype::
1719sendemail.bcc::
1720sendemail.cc::
1721sendemail.cccmd::
1722sendemail.chainreplyto::
1723sendemail.confirm::
1724sendemail.envelopesender::
1725sendemail.from::
1726sendemail.multiedit::
1727sendemail.signedoffbycc::
1728sendemail.smtppass::
1729sendemail.suppresscc::
1730sendemail.suppressfrom::
1731sendemail.to::
1732sendemail.smtpdomain::
1733sendemail.smtpserver::
1734sendemail.smtpserverport::
1735sendemail.smtpserveroption::
1736sendemail.smtpuser::
1737sendemail.thread::
1738sendemail.validate::
1739        See linkgit:git-send-email[1] for description.
1740
1741sendemail.signedoffcc::
1742        Deprecated alias for 'sendemail.signedoffbycc'.
1743
1744showbranch.default::
1745        The default set of branches for linkgit:git-show-branch[1].
1746        See linkgit:git-show-branch[1].
1747
1748status.relativePaths::
1749        By default, linkgit:git-status[1] shows paths relative to the
1750        current directory. Setting this variable to `false` shows paths
1751        relative to the repository root (this was the default for git
1752        prior to v1.5.4).
1753
1754status.showUntrackedFiles::
1755        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1756        files which are not currently tracked by Git. Directories which
1757        contain only untracked files, are shown with the directory name
1758        only. Showing untracked files means that Git needs to lstat() all
1759        all the files in the whole repository, which might be slow on some
1760        systems. So, this variable controls how the commands displays
1761        the untracked files. Possible values are:
1762+
1763--
1764* `no` - Show no untracked files.
1765* `normal` - Show untracked files and directories.
1766* `all` - Show also individual files in untracked directories.
1767--
1768+
1769If this variable is not specified, it defaults to 'normal'.
1770This variable can be overridden with the -u|--untracked-files option
1771of linkgit:git-status[1] and linkgit:git-commit[1].
1772
1773status.submodulesummary::
1774        Defaults to false.
1775        If this is set to a non zero number or true (identical to -1 or an
1776        unlimited number), the submodule summary will be enabled and a
1777        summary of commits for modified submodules will be shown (see
1778        --summary-limit option of linkgit:git-submodule[1]).
1779
1780submodule.<name>.path::
1781submodule.<name>.url::
1782submodule.<name>.update::
1783        The path within this project, URL, and the updating strategy
1784        for a submodule.  These variables are initially populated
1785        by 'git submodule init'; edit them to override the
1786        URL and other values found in the `.gitmodules` file.  See
1787        linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1788
1789submodule.<name>.fetchRecurseSubmodules::
1790        This option can be used to control recursive fetching of this
1791        submodule. It can be overridden by using the --[no-]recurse-submodules
1792        command line option to "git fetch" and "git pull".
1793        This setting will override that from in the linkgit:gitmodules[5]
1794        file.
1795
1796submodule.<name>.ignore::
1797        Defines under what circumstances "git status" and the diff family show
1798        a submodule as modified. When set to "all", it will never be considered
1799        modified, "dirty" will ignore all changes to the submodules work tree and
1800        takes only differences between the HEAD of the submodule and the commit
1801        recorded in the superproject into account. "untracked" will additionally
1802        let submodules with modified tracked files in their work tree show up.
1803        Using "none" (the default when this option is not set) also shows
1804        submodules that have untracked files in their work tree as changed.
1805        This setting overrides any setting made in .gitmodules for this submodule,
1806        both settings can be overridden on the command line by using the
1807        "--ignore-submodules" option.
1808
1809tar.umask::
1810        This variable can be used to restrict the permission bits of
1811        tar archive entries.  The default is 0002, which turns off the
1812        world write bit.  The special value "user" indicates that the
1813        archiving user's umask will be used instead.  See umask(2) and
1814        linkgit:git-archive[1].
1815
1816transfer.unpackLimit::
1817        When `fetch.unpackLimit` or `receive.unpackLimit` are
1818        not set, the value of this variable is used instead.
1819        The default value is 100.
1820
1821url.<base>.insteadOf::
1822        Any URL that starts with this value will be rewritten to
1823        start, instead, with <base>. In cases where some site serves a
1824        large number of repositories, and serves them with multiple
1825        access methods, and some users need to use different access
1826        methods, this feature allows people to specify any of the
1827        equivalent URLs and have git automatically rewrite the URL to
1828        the best alternative for the particular user, even for a
1829        never-before-seen repository on the site.  When more than one
1830        insteadOf strings match a given URL, the longest match is used.
1831
1832url.<base>.pushInsteadOf::
1833        Any URL that starts with this value will not be pushed to;
1834        instead, it will be rewritten to start with <base>, and the
1835        resulting URL will be pushed to. In cases where some site serves
1836        a large number of repositories, and serves them with multiple
1837        access methods, some of which do not allow push, this feature
1838        allows people to specify a pull-only URL and have git
1839        automatically use an appropriate URL to push, even for a
1840        never-before-seen repository on the site.  When more than one
1841        pushInsteadOf strings match a given URL, the longest match is
1842        used.  If a remote has an explicit pushurl, git will ignore this
1843        setting for that remote.
1844
1845user.email::
1846        Your email address to be recorded in any newly created commits.
1847        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1848        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1849
1850user.name::
1851        Your full name to be recorded in any newly created commits.
1852        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1853        environment variables.  See linkgit:git-commit-tree[1].
1854
1855user.signingkey::
1856        If linkgit:git-tag[1] is not selecting the key you want it to
1857        automatically when creating a signed tag, you can override the
1858        default selection with this variable.  This option is passed
1859        unchanged to gpg's --local-user parameter, so you may specify a key
1860        using any method that gpg supports.
1861
1862web.browser::
1863        Specify a web browser that may be used by some commands.
1864        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1865        may use it.