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