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