Documentation / config.txton commit lock_packed_refs(): allow retries when acquiring the packed-refs lock (f4ab4f3)
   1CONFIGURATION FILE
   2------------------
   3
   4The Git configuration file contains a number of variables that affect
   5the Git commands' behavior. The `.git/config` file in each repository
   6is used to store the configuration for that repository, and
   7`$HOME/.gitconfig` is used to store a per-user configuration as
   8fallback values for the `.git/config` file. The file `/etc/gitconfig`
   9can be used to store a system-wide default configuration.
  10
  11The configuration variables are used by both the Git plumbing
  12and the porcelains. The variables are divided into sections, wherein
  13the fully qualified variable name of the variable itself is the last
  14dot-separated segment and the section name is everything before the last
  15dot. The variable names are case-insensitive, allow only alphanumeric
  16characters and `-`, and must start with an alphabetic character.  Some
  17variables may appear multiple times; we say then that the variable is
  18multivalued.
  19
  20Syntax
  21~~~~~~
  22
  23The syntax is fairly flexible and permissive; whitespaces are mostly
  24ignored.  The '#' and ';' characters begin comments to the end of line,
  25blank lines are ignored.
  26
  27The file consists of sections and variables.  A section begins with
  28the name of the section in square brackets and continues until the next
  29section begins.  Section names are case-insensitive.  Only alphanumeric
  30characters, `-` and `.` are allowed in section names.  Each variable
  31must belong to some section, which means that there must be a section
  32header before the first setting of a variable.
  33
  34Sections can be further divided into subsections.  To begin a subsection
  35put its name in double quotes, separated by space from the section name,
  36in the section header, like in the example below:
  37
  38--------
  39        [section "subsection"]
  40
  41--------
  42
  43Subsection names are case sensitive and can contain any characters except
  44newline (doublequote `"` and backslash can be included by escaping them
  45as `\"` and `\\`, respectively).  Section headers cannot span multiple
  46lines.  Variables may belong directly to a section or to a given subsection.
  47You can have `[section]` if you have `[section "subsection"]`, but you
  48don't need to.
  49
  50There is also a deprecated `[section.subsection]` syntax. With this
  51syntax, the subsection name is converted to lower-case and is also
  52compared case sensitively. These subsection names follow the same
  53restrictions as section names.
  54
  55All the other lines (and the remainder of the line after the section
  56header) are recognized as setting variables, in the form
  57'name = value' (or just 'name', which is a short-hand to say that
  58the variable is the boolean "true").
  59The variable names are case-insensitive, allow only alphanumeric characters
  60and `-`, and must start with an alphabetic character.
  61
  62A line that defines a value can be continued to the next line by
  63ending it with a `\`; the backquote and the end-of-line are
  64stripped.  Leading whitespaces after 'name =', the remainder of the
  65line after the first comment character '#' or ';', and trailing
  66whitespaces of the line are discarded unless they are enclosed in
  67double quotes.  Internal whitespaces within the value are retained
  68verbatim.
  69
  70Inside double quotes, double quote `"` and backslash `\` characters
  71must be escaped: use `\"` for `"` and `\\` for `\`.
  72
  73The following escape sequences (beside `\"` and `\\`) are recognized:
  74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  75and `\b` for backspace (BS).  Other char escape sequences (including octal
  76escape sequences) are invalid.
  77
  78
  79Includes
  80~~~~~~~~
  81
  82You can include one config file from another by setting the special
  83`include.path` variable to the name of the file to be included. The
  84included file is expanded immediately, as if its contents had been
  85found at the location of the include directive. If the value of the
  86`include.path` variable is a relative path, the path is considered to be
  87relative to the configuration file in which the include directive was
  88found. The value of `include.path` is subject to tilde expansion: `~/`
  89is expanded to the value of `$HOME`, and `~user/` to the specified
  90user's home directory. See below for examples.
  91
  92Example
  93~~~~~~~
  94
  95        # Core variables
  96        [core]
  97                ; Don't trust file modes
  98                filemode = false
  99
 100        # Our diff algorithm
 101        [diff]
 102                external = /usr/local/bin/diff-wrapper
 103                renames = true
 104
 105        [branch "devel"]
 106                remote = origin
 107                merge = refs/heads/devel
 108
 109        # Proxy settings
 110        [core]
 111                gitProxy="ssh" for "kernel.org"
 112                gitProxy=default-proxy ; for the rest
 113
 114        [include]
 115                path = /path/to/foo.inc ; include by absolute path
 116                path = foo ; expand "foo" relative to the current file
 117                path = ~/foo ; expand "foo" in your $HOME directory
 118
 119
 120Values
 121~~~~~~
 122
 123Values of many variables are treated as a simple string, but there
 124are variables that take values of specific types and there are rules
 125as to how to spell them.
 126
 127boolean::
 128
 129       When a variable is said to take a boolean value, many
 130       synonyms are accepted for 'true' and 'false'; these are all
 131       case-insensitive.
 132
 133       true;; Boolean true can be spelled as `yes`, `on`, `true`,
 134                or `1`.  Also, a variable defined without `= <value>`
 135                is taken as true.
 136
 137       false;; Boolean false can be spelled as `no`, `off`,
 138                `false`, or `0`.
 139+
 140When converting value to the canonical form using '--bool' type
 141specifier; 'git config' will ensure that the output is "true" or
 142"false" (spelled in lowercase).
 143
 144integer::
 145       The value for many variables that specify various sizes can
 146       be suffixed with `k`, `M`,... to mean "scale the number by
 147       1024", "by 1024x1024", etc.
 148
 149color::
 150       The value for a variables that takes a color is a list of
 151       colors (at most two) and attributes (at most one), separated
 152       by spaces.  The colors accepted are `normal`, `black`,
 153       `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
 154       `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
 155       `reverse`.  The first color given is the foreground; the
 156       second is the background.  The position of the attribute, if
 157       any, doesn't matter. Attributes may be turned off specifically
 158       by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
 159+
 160Colors (foreground and background) may also be given as numbers between
 1610 and 255; these use ANSI 256-color mode (but note that not all
 162terminals may support this).  If your terminal supports it, you may also
 163specify 24-bit RGB values as hex, like `#ff0ab3`.
 164+
 165The attributes are meant to be reset at the beginning of each item
 166in the colored output, so setting color.decorate.branch to `black`
 167will paint that branch name in a plain `black`, even if the previous
 168thing on the same output line (e.g. opening parenthesis before the
 169list of branch names in `log --decorate` output) is set to be
 170painted with `bold` or some other attribute.
 171
 172
 173Variables
 174~~~~~~~~~
 175
 176Note that this list is non-comprehensive and not necessarily complete.
 177For command-specific variables, you will find a more detailed description
 178in the appropriate manual page.
 179
 180Other git-related tools may and do use their own variables.  When
 181inventing new variables for use in your own tool, make sure their
 182names do not conflict with those that are used by Git itself and
 183other popular tools, and describe them in your documentation.
 184
 185
 186advice.*::
 187        These variables control various optional help messages designed to
 188        aid new users. All 'advice.*' variables default to 'true', and you
 189        can tell Git that you do not need help by setting these to 'false':
 190+
 191--
 192        pushUpdateRejected::
 193                Set this variable to 'false' if you want to disable
 194                'pushNonFFCurrent',
 195                'pushNonFFMatching', 'pushAlreadyExists',
 196                'pushFetchFirst', and 'pushNeedsForce'
 197                simultaneously.
 198        pushNonFFCurrent::
 199                Advice shown when linkgit:git-push[1] fails due to a
 200                non-fast-forward update to the current branch.
 201        pushNonFFMatching::
 202                Advice shown when you ran linkgit:git-push[1] and pushed
 203                'matching refs' explicitly (i.e. you used ':', or
 204                specified a refspec that isn't your current branch) and
 205                it resulted in a non-fast-forward error.
 206        pushAlreadyExists::
 207                Shown when linkgit:git-push[1] rejects an update that
 208                does not qualify for fast-forwarding (e.g., a tag.)
 209        pushFetchFirst::
 210                Shown when linkgit:git-push[1] rejects an update that
 211                tries to overwrite a remote ref that points at an
 212                object we do not have.
 213        pushNeedsForce::
 214                Shown when linkgit:git-push[1] rejects an update that
 215                tries to overwrite a remote ref that points at an
 216                object that is not a commit-ish, or make the remote
 217                ref point at an object that is not a commit-ish.
 218        statusHints::
 219                Show directions on how to proceed from the current
 220                state in the output of linkgit:git-status[1], in
 221                the template shown when writing commit messages in
 222                linkgit:git-commit[1], and in the help message shown
 223                by linkgit:git-checkout[1] when switching branch.
 224        statusUoption::
 225                Advise to consider using the `-u` option to linkgit:git-status[1]
 226                when the command takes more than 2 seconds to enumerate untracked
 227                files.
 228        commitBeforeMerge::
 229                Advice shown when linkgit:git-merge[1] refuses to
 230                merge to avoid overwriting local changes.
 231        resolveConflict::
 232                Advice shown by various commands when conflicts
 233                prevent the operation from being performed.
 234        implicitIdentity::
 235                Advice on how to set your identity configuration when
 236                your information is guessed from the system username and
 237                domain name.
 238        detachedHead::
 239                Advice shown when you used linkgit:git-checkout[1] to
 240                move to the detach HEAD state, to instruct how to create
 241                a local branch after the fact.
 242        amWorkDir::
 243                Advice that shows the location of the patch file when
 244                linkgit:git-am[1] fails to apply it.
 245        rmHints::
 246                In case of failure in the output of linkgit:git-rm[1],
 247                show directions on how to proceed from the current state.
 248--
 249
 250core.fileMode::
 251        Tells Git if the executable bit of files in the working tree
 252        is to be honored.
 253+
 254Some filesystems lose the executable bit when a file that is
 255marked as executable is checked out, or checks out an
 256non-executable file with executable bit on.
 257linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
 258to see if it handles the executable bit correctly
 259and this variable is automatically set as necessary.
 260+
 261A repository, however, may be on a filesystem that handles
 262the filemode correctly, and this variable is set to 'true'
 263when created, but later may be made accessible from another
 264environment that loses the filemode (e.g. exporting ext4 via
 265CIFS mount, visiting a Cygwin created repository with
 266Git for Windows or Eclipse).
 267In such a case it may be necessary to set this variable to 'false'.
 268See linkgit:git-update-index[1].
 269+
 270The default is true (when core.filemode is not specified in the config file).
 271
 272core.ignoreCase::
 273        If true, this option enables various workarounds to enable
 274        Git to work better on filesystems that are not case sensitive,
 275        like FAT. For example, if a directory listing finds
 276        "makefile" when Git expects "Makefile", Git will assume
 277        it is really the same file, and continue to remember it as
 278        "Makefile".
 279+
 280The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 281will probe and set core.ignoreCase true if appropriate when the repository
 282is created.
 283
 284core.precomposeUnicode::
 285        This option is only used by Mac OS implementation of Git.
 286        When core.precomposeUnicode=true, Git reverts the unicode decomposition
 287        of filenames done by Mac OS. This is useful when sharing a repository
 288        between Mac OS and Linux or Windows.
 289        (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
 290        When false, file names are handled fully transparent by Git,
 291        which is backward compatible with older versions of Git.
 292
 293core.protectHFS::
 294        If set to true, do not allow checkout of paths that would
 295        be considered equivalent to `.git` on an HFS+ filesystem.
 296        Defaults to `true` on Mac OS, and `false` elsewhere.
 297
 298core.protectNTFS::
 299        If set to true, do not allow checkout of paths that would
 300        cause problems with the NTFS filesystem, e.g. conflict with
 301        8.3 "short" names.
 302        Defaults to `true` on Windows, and `false` elsewhere.
 303
 304core.trustctime::
 305        If false, the ctime differences between the index and the
 306        working tree are ignored; useful when the inode change time
 307        is regularly modified by something outside Git (file system
 308        crawlers and some backup systems).
 309        See linkgit:git-update-index[1]. True by default.
 310
 311core.checkStat::
 312        Determines which stat fields to match between the index
 313        and work tree. The user can set this to 'default' or
 314        'minimal'. Default (or explicitly 'default'), is to check
 315        all fields, including the sub-second part of mtime and ctime.
 316
 317core.quotePath::
 318        The commands that output paths (e.g. 'ls-files',
 319        'diff'), when not given the `-z` option, will quote
 320        "unusual" characters in the pathname by enclosing the
 321        pathname in a double-quote pair and with backslashes the
 322        same way strings in C source code are quoted.  If this
 323        variable is set to false, the bytes higher than 0x80 are
 324        not quoted but output as verbatim.  Note that double
 325        quote, backslash and control characters are always
 326        quoted without `-z` regardless of the setting of this
 327        variable.
 328
 329core.eol::
 330        Sets the line ending type to use in the working directory for
 331        files that have the `text` property set.  Alternatives are
 332        'lf', 'crlf' and 'native', which uses the platform's native
 333        line ending.  The default value is `native`.  See
 334        linkgit:gitattributes[5] for more information on end-of-line
 335        conversion.
 336
 337core.safecrlf::
 338        If true, makes Git check if converting `CRLF` is reversible when
 339        end-of-line conversion is active.  Git will verify if a command
 340        modifies a file in the work tree either directly or indirectly.
 341        For example, committing a file followed by checking out the
 342        same file should yield the original file in the work tree.  If
 343        this is not the case for the current setting of
 344        `core.autocrlf`, Git will reject the file.  The variable can
 345        be set to "warn", in which case Git will only warn about an
 346        irreversible conversion but continue the operation.
 347+
 348CRLF conversion bears a slight chance of corrupting data.
 349When it is enabled, Git will convert CRLF to LF during commit and LF to
 350CRLF during checkout.  A file that contains a mixture of LF and
 351CRLF before the commit cannot be recreated by Git.  For text
 352files this is the right thing to do: it corrects line endings
 353such that we have only LF line endings in the repository.
 354But for binary files that are accidentally classified as text the
 355conversion can corrupt data.
 356+
 357If you recognize such corruption early you can easily fix it by
 358setting the conversion type explicitly in .gitattributes.  Right
 359after committing you still have the original file in your work
 360tree and this file is not yet corrupted.  You can explicitly tell
 361Git that this file is binary and Git will handle the file
 362appropriately.
 363+
 364Unfortunately, the desired effect of cleaning up text files with
 365mixed line endings and the undesired effect of corrupting binary
 366files cannot be distinguished.  In both cases CRLFs are removed
 367in an irreversible way.  For text files this is the right thing
 368to do because CRLFs are line endings, while for binary files
 369converting CRLFs corrupts data.
 370+
 371Note, this safety check does not mean that a checkout will generate a
 372file identical to the original file for a different setting of
 373`core.eol` and `core.autocrlf`, but only for the current one.  For
 374example, a text file with `LF` would be accepted with `core.eol=lf`
 375and could later be checked out with `core.eol=crlf`, in which case the
 376resulting file would contain `CRLF`, although the original file
 377contained `LF`.  However, in both work trees the line endings would be
 378consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 379file with mixed line endings would be reported by the `core.safecrlf`
 380mechanism.
 381
 382core.autocrlf::
 383        Setting this variable to "true" is almost the same as setting
 384        the `text` attribute to "auto" on all files except that text
 385        files are not guaranteed to be normalized: files that contain
 386        `CRLF` in the repository will not be touched.  Use this
 387        setting if you want to have `CRLF` line endings in your
 388        working directory even though the repository does not have
 389        normalized line endings.  This variable can be set to 'input',
 390        in which case no output conversion is performed.
 391
 392core.symlinks::
 393        If false, symbolic links are checked out as small plain files that
 394        contain the link text. linkgit:git-update-index[1] and
 395        linkgit:git-add[1] will not change the recorded type to regular
 396        file. Useful on filesystems like FAT that do not support
 397        symbolic links.
 398+
 399The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 400will probe and set core.symlinks false if appropriate when the repository
 401is created.
 402
 403core.gitProxy::
 404        A "proxy command" to execute (as 'command host port') instead
 405        of establishing direct connection to the remote server when
 406        using the Git protocol for fetching. If the variable value is
 407        in the "COMMAND for DOMAIN" format, the command is applied only
 408        on hostnames ending with the specified domain string. This variable
 409        may be set multiple times and is matched in the given order;
 410        the first match wins.
 411+
 412Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
 413(which always applies universally, without the special "for"
 414handling).
 415+
 416The special string `none` can be used as the proxy command to
 417specify that no proxy be used for a given domain pattern.
 418This is useful for excluding servers inside a firewall from
 419proxy use, while defaulting to a common proxy for external domains.
 420
 421core.ignoreStat::
 422        If true, Git will avoid using lstat() calls to detect if files have
 423        changed by setting the "assume-unchanged" bit for those tracked files
 424        which it has updated identically in both the index and working tree.
 425+
 426When files are modified outside of Git, the user will need to stage
 427the modified files explicitly (e.g. see 'Examples' section in
 428linkgit:git-update-index[1]).
 429Git will not normally detect changes to those files.
 430+
 431This is useful on systems where lstat() calls are very slow, such as
 432CIFS/Microsoft Windows.
 433+
 434False by default.
 435
 436core.preferSymlinkRefs::
 437        Instead of the default "symref" format for HEAD
 438        and other symbolic reference files, use symbolic links.
 439        This is sometimes needed to work with old scripts that
 440        expect HEAD to be a symbolic link.
 441
 442core.bare::
 443        If true this repository is assumed to be 'bare' and has no
 444        working directory associated with it.  If this is the case a
 445        number of commands that require a working directory will be
 446        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 447+
 448This setting is automatically guessed by linkgit:git-clone[1] or
 449linkgit:git-init[1] when the repository was created.  By default a
 450repository that ends in "/.git" is assumed to be not bare (bare =
 451false), while all other repositories are assumed to be bare (bare
 452= true).
 453
 454core.worktree::
 455        Set the path to the root of the working tree.
 456        If GIT_COMMON_DIR environment variable is set, core.worktree
 457        is ignored and not used for determining the root of working tree.
 458        This can be overridden by the GIT_WORK_TREE environment
 459        variable and the '--work-tree' command-line option.
 460        The value can be an absolute path or relative to the path to
 461        the .git directory, which is either specified by --git-dir
 462        or GIT_DIR, or automatically discovered.
 463        If --git-dir or GIT_DIR is specified but none of
 464        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 465        the current working directory is regarded as the top level
 466        of your working tree.
 467+
 468Note that this variable is honored even when set in a configuration
 469file in a ".git" subdirectory of a directory and its value differs
 470from the latter directory (e.g. "/path/to/.git/config" has
 471core.worktree set to "/different/path"), which is most likely a
 472misconfiguration.  Running Git commands in the "/path/to" directory will
 473still use "/different/path" as the root of the work tree and can cause
 474confusion unless you know what you are doing (e.g. you are creating a
 475read-only snapshot of the same index to a location different from the
 476repository's usual working tree).
 477
 478core.logAllRefUpdates::
 479        Enable the reflog. Updates to a ref <ref> is logged to the file
 480        "$GIT_DIR/logs/<ref>", by appending the new and old
 481        SHA-1, the date/time and the reason of the update, but
 482        only when the file exists.  If this configuration
 483        variable is set to true, missing "$GIT_DIR/logs/<ref>"
 484        file is automatically created for branch heads (i.e. under
 485        refs/heads/), remote refs (i.e. under refs/remotes/),
 486        note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
 487+
 488This information can be used to determine what commit
 489was the tip of a branch "2 days ago".
 490+
 491This value is true by default in a repository that has
 492a working directory associated with it, and false by
 493default in a bare repository.
 494
 495core.repositoryFormatVersion::
 496        Internal variable identifying the repository format and layout
 497        version.
 498
 499core.sharedRepository::
 500        When 'group' (or 'true'), the repository is made shareable between
 501        several users in a group (making sure all the files and objects are
 502        group-writable). When 'all' (or 'world' or 'everybody'), the
 503        repository will be readable by all users, additionally to being
 504        group-shareable. When 'umask' (or 'false'), Git will use permissions
 505        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 506        files in the repository will have this mode value. '0xxx' will override
 507        user's umask value (whereas the other options will only override
 508        requested parts of the user's umask value). Examples: '0660' will make
 509        the repo read/write-able for the owner and group, but inaccessible to
 510        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 511        repository that is group-readable but not group-writable.
 512        See linkgit:git-init[1]. False by default.
 513
 514core.warnAmbiguousRefs::
 515        If true, Git will warn you if the ref name you passed it is ambiguous
 516        and might match multiple refs in the repository. True by default.
 517
 518core.compression::
 519        An integer -1..9, indicating a default compression level.
 520        -1 is the zlib default. 0 means no compression,
 521        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 522        If set, this provides a default to other compression variables,
 523        such as 'core.looseCompression' and 'pack.compression'.
 524
 525core.looseCompression::
 526        An integer -1..9, indicating the compression level for objects that
 527        are not in a pack file. -1 is the zlib default. 0 means no
 528        compression, and 1..9 are various speed/size tradeoffs, 9 being
 529        slowest.  If not set,  defaults to core.compression.  If that is
 530        not set,  defaults to 1 (best speed).
 531
 532core.packedGitWindowSize::
 533        Number of bytes of a pack file to map into memory in a
 534        single mapping operation.  Larger window sizes may allow
 535        your system to process a smaller number of large pack files
 536        more quickly.  Smaller window sizes will negatively affect
 537        performance due to increased calls to the operating system's
 538        memory manager, but may improve performance when accessing
 539        a large number of large pack files.
 540+
 541Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 542MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 543be reasonable for all users/operating systems.  You probably do
 544not need to adjust this value.
 545+
 546Common unit suffixes of 'k', 'm', or 'g' are supported.
 547
 548core.packedGitLimit::
 549        Maximum number of bytes to map simultaneously into memory
 550        from pack files.  If Git needs to access more than this many
 551        bytes at once to complete an operation it will unmap existing
 552        regions to reclaim virtual address space within the process.
 553+
 554Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 555This should be reasonable for all users/operating systems, except on
 556the largest projects.  You probably do not need to adjust this value.
 557+
 558Common unit suffixes of 'k', 'm', or 'g' are supported.
 559
 560core.deltaBaseCacheLimit::
 561        Maximum number of bytes to reserve for caching base objects
 562        that may be referenced by multiple deltified objects.  By storing the
 563        entire decompressed base objects in a cache Git is able
 564        to avoid unpacking and decompressing frequently used base
 565        objects multiple times.
 566+
 567Default is 96 MiB on all platforms.  This should be reasonable
 568for all users/operating systems, except on the largest projects.
 569You probably do not need to adjust this value.
 570+
 571Common unit suffixes of 'k', 'm', or 'g' are supported.
 572
 573core.bigFileThreshold::
 574        Files larger than this size are stored deflated, without
 575        attempting delta compression.  Storing large files without
 576        delta compression avoids excessive memory usage, at the
 577        slight expense of increased disk usage. Additionally files
 578        larger than this size are always treated as binary.
 579+
 580Default is 512 MiB on all platforms.  This should be reasonable
 581for most projects as source code and other text files can still
 582be delta compressed, but larger binary media files won't be.
 583+
 584Common unit suffixes of 'k', 'm', or 'g' are supported.
 585
 586core.excludesFile::
 587        In addition to '.gitignore' (per-directory) and
 588        '.git/info/exclude', Git looks into this file for patterns
 589        of files which are not meant to be tracked.  "`~/`" is expanded
 590        to the value of `$HOME` and "`~user/`" to the specified user's
 591        home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
 592        If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
 593        is used instead. See linkgit:gitignore[5].
 594
 595core.askPass::
 596        Some commands (e.g. svn and http interfaces) that interactively
 597        ask for a password can be told to use an external program given
 598        via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
 599        environment variable. If not set, fall back to the value of the
 600        'SSH_ASKPASS' environment variable or, failing that, a simple password
 601        prompt. The external program shall be given a suitable prompt as
 602        command-line argument and write the password on its STDOUT.
 603
 604core.attributesFile::
 605        In addition to '.gitattributes' (per-directory) and
 606        '.git/info/attributes', Git looks into this file for attributes
 607        (see linkgit:gitattributes[5]). Path expansions are made the same
 608        way as for `core.excludesFile`. Its default value is
 609        $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
 610        set or empty, $HOME/.config/git/attributes is used instead.
 611
 612core.editor::
 613        Commands such as `commit` and `tag` that lets you edit
 614        messages by launching an editor uses the value of this
 615        variable when it is set, and the environment variable
 616        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 617
 618core.commentChar::
 619        Commands such as `commit` and `tag` that lets you edit
 620        messages consider a line that begins with this character
 621        commented, and removes them after the editor returns
 622        (default '#').
 623+
 624If set to "auto", `git-commit` would select a character that is not
 625the beginning character of any line in existing commit messages.
 626
 627core.packedRefsTimeout::
 628        The length of time, in milliseconds, to retry when trying to
 629        lock the `packed-refs` file. Value 0 means not to retry at
 630        all; -1 means to try indefinitely. Default is 1000 (i.e.,
 631        retry for 1 second).
 632
 633sequence.editor::
 634        Text editor used by `git rebase -i` for editing the rebase instruction file.
 635        The value is meant to be interpreted by the shell when it is used.
 636        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 637        When not configured the default commit message editor is used instead.
 638
 639core.pager::
 640        Text viewer for use by Git commands (e.g., 'less').  The value
 641        is meant to be interpreted by the shell.  The order of preference
 642        is the `$GIT_PAGER` environment variable, then `core.pager`
 643        configuration, then `$PAGER`, and then the default chosen at
 644        compile time (usually 'less').
 645+
 646When the `LESS` environment variable is unset, Git sets it to `FRX`
 647(if `LESS` environment variable is set, Git does not change it at
 648all).  If you want to selectively override Git's default setting
 649for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
 650be passed to the shell by Git, which will translate the final
 651command to `LESS=FRX less -S`. The environment does not set the
 652`S` option but the command line does, instructing less to truncate
 653long lines. Similarly, setting `core.pager` to `less -+F` will
 654deactivate the `F` option specified by the environment from the
 655command-line, deactivating the "quit if one screen" behavior of
 656`less`.  One can specifically activate some flags for particular
 657commands: for example, setting `pager.blame` to `less -S` enables
 658line truncation only for `git blame`.
 659+
 660Likewise, when the `LV` environment variable is unset, Git sets it
 661to `-c`.  You can override this setting by exporting `LV` with
 662another value or setting `core.pager` to `lv +c`.
 663
 664core.whitespace::
 665        A comma separated list of common whitespace problems to
 666        notice.  'git diff' will use `color.diff.whitespace` to
 667        highlight them, and 'git apply --whitespace=error' will
 668        consider them as errors.  You can prefix `-` to disable
 669        any of them (e.g. `-trailing-space`):
 670+
 671* `blank-at-eol` treats trailing whitespaces at the end of the line
 672  as an error (enabled by default).
 673* `space-before-tab` treats a space character that appears immediately
 674  before a tab character in the initial indent part of the line as an
 675  error (enabled by default).
 676* `indent-with-non-tab` treats a line that is indented with space
 677  characters instead of the equivalent tabs as an error (not enabled by
 678  default).
 679* `tab-in-indent` treats a tab character in the initial indent part of
 680  the line as an error (not enabled by default).
 681* `blank-at-eof` treats blank lines added at the end of file as an error
 682  (enabled by default).
 683* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 684  `blank-at-eof`.
 685* `cr-at-eol` treats a carriage-return at the end of line as
 686  part of the line terminator, i.e. with it, `trailing-space`
 687  does not trigger if the character before such a carriage-return
 688  is not a whitespace (not enabled by default).
 689* `tabwidth=<n>` tells how many character positions a tab occupies; this
 690  is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
 691  errors. The default tab width is 8. Allowed values are 1 to 63.
 692
 693core.fsyncObjectFiles::
 694        This boolean will enable 'fsync()' when writing object files.
 695+
 696This is a total waste of time and effort on a filesystem that orders
 697data writes properly, but can be useful for filesystems that do not use
 698journalling (traditional UNIX filesystems) or that only journal metadata
 699and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 700
 701core.preloadIndex::
 702        Enable parallel index preload for operations like 'git diff'
 703+
 704This can speed up operations like 'git diff' and 'git status' especially
 705on filesystems like NFS that have weak caching semantics and thus
 706relatively high IO latencies.  When enabled, Git will do the
 707index comparison to the filesystem data in parallel, allowing
 708overlapping IO's.  Defaults to true.
 709
 710core.createObject::
 711        You can set this to 'link', in which case a hardlink followed by
 712        a delete of the source are used to make sure that object creation
 713        will not overwrite existing objects.
 714+
 715On some file system/operating system combinations, this is unreliable.
 716Set this config setting to 'rename' there; However, This will remove the
 717check that makes sure that existing object files will not get overwritten.
 718
 719core.notesRef::
 720        When showing commit messages, also show notes which are stored in
 721        the given ref.  The ref must be fully qualified.  If the given
 722        ref does not exist, it is not an error but means that no
 723        notes should be printed.
 724+
 725This setting defaults to "refs/notes/commits", and it can be overridden by
 726the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
 727
 728core.sparseCheckout::
 729        Enable "sparse checkout" feature. See section "Sparse checkout" in
 730        linkgit:git-read-tree[1] for more information.
 731
 732core.abbrev::
 733        Set the length object names are abbreviated to.  If unspecified,
 734        many commands abbreviate to 7 hexdigits, which may not be enough
 735        for abbreviated object names to stay unique for sufficiently long
 736        time.
 737
 738add.ignoreErrors::
 739add.ignore-errors (deprecated)::
 740        Tells 'git add' to continue adding files when some files cannot be
 741        added due to indexing errors. Equivalent to the '--ignore-errors'
 742        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 743        as it does not follow the usual naming convention for configuration
 744        variables.
 745
 746alias.*::
 747        Command aliases for the linkgit:git[1] command wrapper - e.g.
 748        after defining "alias.last = cat-file commit HEAD", the invocation
 749        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 750        confusion and troubles with script usage, aliases that
 751        hide existing Git commands are ignored. Arguments are split by
 752        spaces, the usual shell quoting and escaping is supported.
 753        A quote pair or a backslash can be used to quote them.
 754+
 755If the alias expansion is prefixed with an exclamation point,
 756it will be treated as a shell command.  For example, defining
 757"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 758"git new" is equivalent to running the shell command
 759"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 760executed from the top-level directory of a repository, which may
 761not necessarily be the current directory.
 762'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
 763from the original current directory. See linkgit:git-rev-parse[1].
 764
 765am.keepcr::
 766        If true, git-am will call git-mailsplit for patches in mbox format
 767        with parameter '--keep-cr'. In this case git-mailsplit will
 768        not remove `\r` from lines ending with `\r\n`. Can be overridden
 769        by giving '--no-keep-cr' from the command line.
 770        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 771
 772apply.ignoreWhitespace::
 773        When set to 'change', tells 'git apply' to ignore changes in
 774        whitespace, in the same way as the '--ignore-space-change'
 775        option.
 776        When set to one of: no, none, never, false tells 'git apply' to
 777        respect all whitespace differences.
 778        See linkgit:git-apply[1].
 779
 780apply.whitespace::
 781        Tells 'git apply' how to handle whitespaces, in the same way
 782        as the '--whitespace' option. See linkgit:git-apply[1].
 783
 784branch.autoSetupMerge::
 785        Tells 'git branch' and 'git checkout' to set up new branches
 786        so that linkgit:git-pull[1] will appropriately merge from the
 787        starting point branch. Note that even if this option is not set,
 788        this behavior can be chosen per-branch using the `--track`
 789        and `--no-track` options. The valid settings are: `false` -- no
 790        automatic setup is done; `true` -- automatic setup is done when the
 791        starting point is a remote-tracking branch; `always` --
 792        automatic setup is done when the starting point is either a
 793        local branch or remote-tracking
 794        branch. This option defaults to true.
 795
 796branch.autoSetupRebase::
 797        When a new branch is created with 'git branch' or 'git checkout'
 798        that tracks another branch, this variable tells Git to set
 799        up pull to rebase instead of merge (see "branch.<name>.rebase").
 800        When `never`, rebase is never automatically set to true.
 801        When `local`, rebase is set to true for tracked branches of
 802        other local branches.
 803        When `remote`, rebase is set to true for tracked branches of
 804        remote-tracking branches.
 805        When `always`, rebase will be set to true for all tracking
 806        branches.
 807        See "branch.autoSetupMerge" for details on how to set up a
 808        branch to track another branch.
 809        This option defaults to never.
 810
 811branch.<name>.remote::
 812        When on branch <name>, it tells 'git fetch' and 'git push'
 813        which remote to fetch from/push to.  The remote to push to
 814        may be overridden with `remote.pushDefault` (for all branches).
 815        The remote to push to, for the current branch, may be further
 816        overridden by `branch.<name>.pushRemote`.  If no remote is
 817        configured, or if you are not on any branch, it defaults to
 818        `origin` for fetching and `remote.pushDefault` for pushing.
 819        Additionally, `.` (a period) is the current local repository
 820        (a dot-repository), see `branch.<name>.merge`'s final note below.
 821
 822branch.<name>.pushRemote::
 823        When on branch <name>, it overrides `branch.<name>.remote` for
 824        pushing.  It also overrides `remote.pushDefault` for pushing
 825        from branch <name>.  When you pull from one place (e.g. your
 826        upstream) and push to another place (e.g. your own publishing
 827        repository), you would want to set `remote.pushDefault` to
 828        specify the remote to push to for all branches, and use this
 829        option to override it for a specific branch.
 830
 831branch.<name>.merge::
 832        Defines, together with branch.<name>.remote, the upstream branch
 833        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
 834        branch to merge and can also affect 'git push' (see push.default).
 835        When in branch <name>, it tells 'git fetch' the default
 836        refspec to be marked for merging in FETCH_HEAD. The value is
 837        handled like the remote part of a refspec, and must match a
 838        ref which is fetched from the remote given by
 839        "branch.<name>.remote".
 840        The merge information is used by 'git pull' (which at first calls
 841        'git fetch') to lookup the default branch for merging. Without
 842        this option, 'git pull' defaults to merge the first refspec fetched.
 843        Specify multiple values to get an octopus merge.
 844        If you wish to setup 'git pull' so that it merges into <name> from
 845        another branch in the local repository, you can point
 846        branch.<name>.merge to the desired branch, and use the relative path
 847        setting `.` (a period) for branch.<name>.remote.
 848
 849branch.<name>.mergeOptions::
 850        Sets default options for merging into branch <name>. The syntax and
 851        supported options are the same as those of linkgit:git-merge[1], but
 852        option values containing whitespace characters are currently not
 853        supported.
 854
 855branch.<name>.rebase::
 856        When true, rebase the branch <name> on top of the fetched branch,
 857        instead of merging the default branch from the default remote when
 858        "git pull" is run. See "pull.rebase" for doing this in a non
 859        branch-specific manner.
 860+
 861        When preserve, also pass `--preserve-merges` along to 'git rebase'
 862        so that locally committed merge commits will not be flattened
 863        by running 'git pull'.
 864+
 865*NOTE*: this is a possibly dangerous operation; do *not* use
 866it unless you understand the implications (see linkgit:git-rebase[1]
 867for details).
 868
 869branch.<name>.description::
 870        Branch description, can be edited with
 871        `git branch --edit-description`. Branch description is
 872        automatically added in the format-patch cover letter or
 873        request-pull summary.
 874
 875browser.<tool>.cmd::
 876        Specify the command to invoke the specified browser. The
 877        specified command is evaluated in shell with the URLs passed
 878        as arguments. (See linkgit:git-web{litdd}browse[1].)
 879
 880browser.<tool>.path::
 881        Override the path for the given tool that may be used to
 882        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 883        working repository in gitweb (see linkgit:git-instaweb[1]).
 884
 885clean.requireForce::
 886        A boolean to make git-clean do nothing unless given -f,
 887        -i or -n.   Defaults to true.
 888
 889color.branch::
 890        A boolean to enable/disable color in the output of
 891        linkgit:git-branch[1]. May be set to `always`,
 892        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 893        only when the output is to a terminal. Defaults to false.
 894
 895color.branch.<slot>::
 896        Use customized color for branch coloration. `<slot>` is one of
 897        `current` (the current branch), `local` (a local branch),
 898        `remote` (a remote-tracking branch in refs/remotes/),
 899        `upstream` (upstream tracking branch), `plain` (other
 900        refs).
 901
 902color.diff::
 903        Whether to use ANSI escape sequences to add color to patches.
 904        If this is set to `always`, linkgit:git-diff[1],
 905        linkgit:git-log[1], and linkgit:git-show[1] will use color
 906        for all patches.  If it is set to `true` or `auto`, those
 907        commands will only use color when output is to the terminal.
 908        Defaults to false.
 909+
 910This does not affect linkgit:git-format-patch[1] or the
 911'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
 912command line with the `--color[=<when>]` option.
 913
 914color.diff.<slot>::
 915        Use customized color for diff colorization.  `<slot>` specifies
 916        which part of the patch to use the specified color, and is one
 917        of `plain` (context text), `meta` (metainformation), `frag`
 918        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 919        `new` (added lines), `commit` (commit headers), or `whitespace`
 920        (highlighting whitespace errors).
 921
 922color.decorate.<slot>::
 923        Use customized color for 'git log --decorate' output.  `<slot>` is one
 924        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
 925        branches, remote-tracking branches, tags, stash and HEAD, respectively.
 926
 927color.grep::
 928        When set to `always`, always highlight matches.  When `false` (or
 929        `never`), never.  When set to `true` or `auto`, use color only
 930        when the output is written to the terminal.  Defaults to `false`.
 931
 932color.grep.<slot>::
 933        Use customized color for grep colorization.  `<slot>` specifies which
 934        part of the line to use the specified color, and is one of
 935+
 936--
 937`context`;;
 938        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
 939`filename`;;
 940        filename prefix (when not using `-h`)
 941`function`;;
 942        function name lines (when using `-p`)
 943`linenumber`;;
 944        line number prefix (when using `-n`)
 945`match`;;
 946        matching text (same as setting `matchContext` and `matchSelected`)
 947`matchContext`;;
 948        matching text in context lines
 949`matchSelected`;;
 950        matching text in selected lines
 951`selected`;;
 952        non-matching text in selected lines
 953`separator`;;
 954        separators between fields on a line (`:`, `-`, and `=`)
 955        and between hunks (`--`)
 956--
 957
 958color.interactive::
 959        When set to `always`, always use colors for interactive prompts
 960        and displays (such as those used by "git-add --interactive" and
 961        "git-clean --interactive"). When false (or `never`), never.
 962        When set to `true` or `auto`, use colors only when the output is
 963        to the terminal. Defaults to false.
 964
 965color.interactive.<slot>::
 966        Use customized color for 'git add --interactive' and 'git clean
 967        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
 968        or `error`, for four distinct types of normal output from
 969        interactive commands.
 970
 971color.pager::
 972        A boolean to enable/disable colored output when the pager is in
 973        use (default is true).
 974
 975color.showBranch::
 976        A boolean to enable/disable color in the output of
 977        linkgit:git-show-branch[1]. May be set to `always`,
 978        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 979        only when the output is to a terminal. Defaults to false.
 980
 981color.status::
 982        A boolean to enable/disable color in the output of
 983        linkgit:git-status[1]. May be set to `always`,
 984        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 985        only when the output is to a terminal. Defaults to false.
 986
 987color.status.<slot>::
 988        Use customized color for status colorization. `<slot>` is
 989        one of `header` (the header text of the status message),
 990        `added` or `updated` (files which are added but not committed),
 991        `changed` (files which are changed but not added in the index),
 992        `untracked` (files which are not tracked by Git),
 993        `branch` (the current branch),
 994        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 995        to red), or
 996        `unmerged` (files which have unmerged changes).
 997
 998color.ui::
 999        This variable determines the default value for variables such
1000        as `color.diff` and `color.grep` that control the use of color
1001        per command family. Its scope will expand as more commands learn
1002        configuration to set a default for the `--color` option.  Set it
1003        to `false` or `never` if you prefer Git commands not to use
1004        color unless enabled explicitly with some other configuration
1005        or the `--color` option. Set it to `always` if you want all
1006        output not intended for machine consumption to use color, to
1007        `true` or `auto` (this is the default since Git 1.8.4) if you
1008        want such output to use color when written to the terminal.
1009
1010column.ui::
1011        Specify whether supported commands should output in columns.
1012        This variable consists of a list of tokens separated by spaces
1013        or commas:
1014+
1015These options control when the feature should be enabled
1016(defaults to 'never'):
1017+
1018--
1019`always`;;
1020        always show in columns
1021`never`;;
1022        never show in columns
1023`auto`;;
1024        show in columns if the output is to the terminal
1025--
1026+
1027These options control layout (defaults to 'column').  Setting any
1028of these implies 'always' if none of 'always', 'never', or 'auto' are
1029specified.
1030+
1031--
1032`column`;;
1033        fill columns before rows
1034`row`;;
1035        fill rows before columns
1036`plain`;;
1037        show in one column
1038--
1039+
1040Finally, these options can be combined with a layout option (defaults
1041to 'nodense'):
1042+
1043--
1044`dense`;;
1045        make unequal size columns to utilize more space
1046`nodense`;;
1047        make equal size columns
1048--
1049
1050column.branch::
1051        Specify whether to output branch listing in `git branch` in columns.
1052        See `column.ui` for details.
1053
1054column.clean::
1055        Specify the layout when list items in `git clean -i`, which always
1056        shows files and directories in columns. See `column.ui` for details.
1057
1058column.status::
1059        Specify whether to output untracked files in `git status` in columns.
1060        See `column.ui` for details.
1061
1062column.tag::
1063        Specify whether to output tag listing in `git tag` in columns.
1064        See `column.ui` for details.
1065
1066commit.cleanup::
1067        This setting overrides the default of the `--cleanup` option in
1068        `git commit`. See linkgit:git-commit[1] for details. Changing the
1069        default can be useful when you always want to keep lines that begin
1070        with comment character `#` in your log message, in which case you
1071        would do `git config commit.cleanup whitespace` (note that you will
1072        have to remove the help lines that begin with `#` in the commit log
1073        template yourself, if you do this).
1074
1075commit.gpgSign::
1076
1077        A boolean to specify whether all commits should be GPG signed.
1078        Use of this option when doing operations such as rebase can
1079        result in a large number of commits being signed. It may be
1080        convenient to use an agent to avoid typing your GPG passphrase
1081        several times.
1082
1083commit.status::
1084        A boolean to enable/disable inclusion of status information in the
1085        commit message template when using an editor to prepare the commit
1086        message.  Defaults to true.
1087
1088commit.template::
1089        Specify a file to use as the template for new commit messages.
1090        "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1091        specified user's home directory.
1092
1093credential.helper::
1094        Specify an external helper to be called when a username or
1095        password credential is needed; the helper may consult external
1096        storage to avoid prompting the user for the credentials. See
1097        linkgit:gitcredentials[7] for details.
1098
1099credential.useHttpPath::
1100        When acquiring credentials, consider the "path" component of an http
1101        or https URL to be important. Defaults to false. See
1102        linkgit:gitcredentials[7] for more information.
1103
1104credential.username::
1105        If no username is set for a network authentication, use this username
1106        by default. See credential.<context>.* below, and
1107        linkgit:gitcredentials[7].
1108
1109credential.<url>.*::
1110        Any of the credential.* options above can be applied selectively to
1111        some credentials. For example "credential.https://example.com.username"
1112        would set the default username only for https connections to
1113        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1114        matched.
1115
1116include::diff-config.txt[]
1117
1118difftool.<tool>.path::
1119        Override the path for the given tool.  This is useful in case
1120        your tool is not in the PATH.
1121
1122difftool.<tool>.cmd::
1123        Specify the command to invoke the specified diff tool.
1124        The specified command is evaluated in shell with the following
1125        variables available:  'LOCAL' is set to the name of the temporary
1126        file containing the contents of the diff pre-image and 'REMOTE'
1127        is set to the name of the temporary file containing the contents
1128        of the diff post-image.
1129
1130difftool.prompt::
1131        Prompt before each invocation of the diff tool.
1132
1133fetch.recurseSubmodules::
1134        This option can be either set to a boolean value or to 'on-demand'.
1135        Setting it to a boolean changes the behavior of fetch and pull to
1136        unconditionally recurse into submodules when set to true or to not
1137        recurse at all when set to false. When set to 'on-demand' (the default
1138        value), fetch and pull will only recurse into a populated submodule
1139        when its superproject retrieves a commit that updates the submodule's
1140        reference.
1141
1142fetch.fsckObjects::
1143        If it is set to true, git-fetch-pack will check all fetched
1144        objects. It will abort in the case of a malformed object or a
1145        broken link. The result of an abort are only dangling objects.
1146        Defaults to false. If not set, the value of `transfer.fsckObjects`
1147        is used instead.
1148
1149fetch.unpackLimit::
1150        If the number of objects fetched over the Git native
1151        transfer is below this
1152        limit, then the objects will be unpacked into loose object
1153        files. However if the number of received objects equals or
1154        exceeds this limit then the received pack will be stored as
1155        a pack, after adding any missing delta bases.  Storing the
1156        pack from a push can make the push operation complete faster,
1157        especially on slow filesystems.  If not set, the value of
1158        `transfer.unpackLimit` is used instead.
1159
1160fetch.prune::
1161        If true, fetch will automatically behave as if the `--prune`
1162        option was given on the command line.  See also `remote.<name>.prune`.
1163
1164format.attach::
1165        Enable multipart/mixed attachments as the default for
1166        'format-patch'.  The value can also be a double quoted string
1167        which will enable attachments as the default and set the
1168        value as the boundary.  See the --attach option in
1169        linkgit:git-format-patch[1].
1170
1171format.numbered::
1172        A boolean which can enable or disable sequence numbers in patch
1173        subjects.  It defaults to "auto" which enables it only if there
1174        is more than one patch.  It can be enabled or disabled for all
1175        messages by setting it to "true" or "false".  See --numbered
1176        option in linkgit:git-format-patch[1].
1177
1178format.headers::
1179        Additional email headers to include in a patch to be submitted
1180        by mail.  See linkgit:git-format-patch[1].
1181
1182format.to::
1183format.cc::
1184        Additional recipients to include in a patch to be submitted
1185        by mail.  See the --to and --cc options in
1186        linkgit:git-format-patch[1].
1187
1188format.subjectPrefix::
1189        The default for format-patch is to output files with the '[PATCH]'
1190        subject prefix. Use this variable to change that prefix.
1191
1192format.signature::
1193        The default for format-patch is to output a signature containing
1194        the Git version number. Use this variable to change that default.
1195        Set this variable to the empty string ("") to suppress
1196        signature generation.
1197
1198format.signatureFile::
1199        Works just like format.signature except the contents of the
1200        file specified by this variable will be used as the signature.
1201
1202format.suffix::
1203        The default for format-patch is to output files with the suffix
1204        `.patch`. Use this variable to change that suffix (make sure to
1205        include the dot if you want it).
1206
1207format.pretty::
1208        The default pretty format for log/show/whatchanged command,
1209        See linkgit:git-log[1], linkgit:git-show[1],
1210        linkgit:git-whatchanged[1].
1211
1212format.thread::
1213        The default threading style for 'git format-patch'.  Can be
1214        a boolean value, or `shallow` or `deep`.  `shallow` threading
1215        makes every mail a reply to the head of the series,
1216        where the head is chosen from the cover letter, the
1217        `--in-reply-to`, and the first patch mail, in this order.
1218        `deep` threading makes every mail a reply to the previous one.
1219        A true boolean value is the same as `shallow`, and a false
1220        value disables threading.
1221
1222format.signOff::
1223        A boolean value which lets you enable the `-s/--signoff` option of
1224        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1225        patch should be a conscious act and means that you certify you have
1226        the rights to submit this work under the same open source license.
1227        Please see the 'SubmittingPatches' document for further discussion.
1228
1229format.coverLetter::
1230        A boolean that controls whether to generate a cover-letter when
1231        format-patch is invoked, but in addition can be set to "auto", to
1232        generate a cover-letter only when there's more than one patch.
1233
1234filter.<driver>.clean::
1235        The command which is used to convert the content of a worktree
1236        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1237        details.
1238
1239filter.<driver>.smudge::
1240        The command which is used to convert the content of a blob
1241        object to a worktree file upon checkout.  See
1242        linkgit:gitattributes[5] for details.
1243
1244gc.aggressiveDepth::
1245        The depth parameter used in the delta compression
1246        algorithm used by 'git gc --aggressive'.  This defaults
1247        to 250.
1248
1249gc.aggressiveWindow::
1250        The window size parameter used in the delta compression
1251        algorithm used by 'git gc --aggressive'.  This defaults
1252        to 250.
1253
1254gc.auto::
1255        When there are approximately more than this many loose
1256        objects in the repository, `git gc --auto` will pack them.
1257        Some Porcelain commands use this command to perform a
1258        light-weight garbage collection from time to time.  The
1259        default value is 6700.  Setting this to 0 disables it.
1260
1261gc.autoPackLimit::
1262        When there are more than this many packs that are not
1263        marked with `*.keep` file in the repository, `git gc
1264        --auto` consolidates them into one larger pack.  The
1265        default value is 50.  Setting this to 0 disables it.
1266
1267gc.autoDetach::
1268        Make `git gc --auto` return immediately and run in background
1269        if the system supports it. Default is true.
1270
1271gc.packRefs::
1272        Running `git pack-refs` in a repository renders it
1273        unclonable by Git versions prior to 1.5.1.2 over dumb
1274        transports such as HTTP.  This variable determines whether
1275        'git gc' runs `git pack-refs`. This can be set to `notbare`
1276        to enable it within all non-bare repos or it can be set to a
1277        boolean value.  The default is `true`.
1278
1279gc.pruneExpire::
1280        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1281        Override the grace period with this config variable.  The value
1282        "now" may be used to disable this  grace period and always prune
1283        unreachable objects immediately.
1284
1285gc.pruneWorktreesExpire::
1286        When 'git gc' is run, it will call
1287        'prune --worktrees --expire 3.months.ago'.
1288        Override the grace period with this config variable. The value
1289        "now" may be used to disable the grace period and prune
1290        $GIT_DIR/worktrees immediately.
1291
1292gc.reflogExpire::
1293gc.<pattern>.reflogExpire::
1294        'git reflog expire' removes reflog entries older than
1295        this time; defaults to 90 days.  With "<pattern>" (e.g.
1296        "refs/stash") in the middle the setting applies only to
1297        the refs that match the <pattern>.
1298
1299gc.reflogExpireUnreachable::
1300gc.<ref>.reflogExpireUnreachable::
1301        'git reflog expire' removes reflog entries older than
1302        this time and are not reachable from the current tip;
1303        defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1304        in the middle, the setting applies only to the refs that
1305        match the <pattern>.
1306
1307gc.rerereResolved::
1308        Records of conflicted merge you resolved earlier are
1309        kept for this many days when 'git rerere gc' is run.
1310        The default is 60 days.  See linkgit:git-rerere[1].
1311
1312gc.rerereUnresolved::
1313        Records of conflicted merge you have not resolved are
1314        kept for this many days when 'git rerere gc' is run.
1315        The default is 15 days.  See linkgit:git-rerere[1].
1316
1317gitcvs.commitMsgAnnotation::
1318        Append this string to each commit message. Set to empty string
1319        to disable this feature. Defaults to "via git-CVS emulator".
1320
1321gitcvs.enabled::
1322        Whether the CVS server interface is enabled for this repository.
1323        See linkgit:git-cvsserver[1].
1324
1325gitcvs.logFile::
1326        Path to a log file where the CVS server interface well... logs
1327        various stuff. See linkgit:git-cvsserver[1].
1328
1329gitcvs.usecrlfattr::
1330        If true, the server will look up the end-of-line conversion
1331        attributes for files to determine the '-k' modes to use. If
1332        the attributes force Git to treat a file as text,
1333        the '-k' mode will be left blank so CVS clients will
1334        treat it as text. If they suppress text conversion, the file
1335        will be set with '-kb' mode, which suppresses any newline munging
1336        the client might otherwise do. If the attributes do not allow
1337        the file type to be determined, then 'gitcvs.allBinary' is
1338        used. See linkgit:gitattributes[5].
1339
1340gitcvs.allBinary::
1341        This is used if 'gitcvs.usecrlfattr' does not resolve
1342        the correct '-kb' mode to use. If true, all
1343        unresolved files are sent to the client in
1344        mode '-kb'. This causes the client to treat them
1345        as binary files, which suppresses any newline munging it
1346        otherwise might do. Alternatively, if it is set to "guess",
1347        then the contents of the file are examined to decide if
1348        it is binary, similar to 'core.autocrlf'.
1349
1350gitcvs.dbName::
1351        Database used by git-cvsserver to cache revision information
1352        derived from the Git repository. The exact meaning depends on the
1353        used database driver, for SQLite (which is the default driver) this
1354        is a filename. Supports variable substitution (see
1355        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1356        Default: '%Ggitcvs.%m.sqlite'
1357
1358gitcvs.dbDriver::
1359        Used Perl DBI driver. You can specify any available driver
1360        for this here, but it might not work. git-cvsserver is tested
1361        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1362        reported *not* to work with 'DBD::mysql'. Experimental feature.
1363        May not contain double colons (`:`). Default: 'SQLite'.
1364        See linkgit:git-cvsserver[1].
1365
1366gitcvs.dbUser, gitcvs.dbPass::
1367        Database user and password. Only useful if setting 'gitcvs.dbDriver',
1368        since SQLite has no concept of database users and/or passwords.
1369        'gitcvs.dbUser' supports variable substitution (see
1370        linkgit:git-cvsserver[1] for details).
1371
1372gitcvs.dbTableNamePrefix::
1373        Database table name prefix.  Prepended to the names of any
1374        database tables used, allowing a single database to be used
1375        for several repositories.  Supports variable substitution (see
1376        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1377        characters will be replaced with underscores.
1378
1379All gitcvs variables except for 'gitcvs.usecrlfattr' and
1380'gitcvs.allBinary' can also be specified as
1381'gitcvs.<access_method>.<varname>' (where 'access_method'
1382is one of "ext" and "pserver") to make them apply only for the given
1383access method.
1384
1385gitweb.category::
1386gitweb.description::
1387gitweb.owner::
1388gitweb.url::
1389        See linkgit:gitweb[1] for description.
1390
1391gitweb.avatar::
1392gitweb.blame::
1393gitweb.grep::
1394gitweb.highlight::
1395gitweb.patches::
1396gitweb.pickaxe::
1397gitweb.remote_heads::
1398gitweb.showSizes::
1399gitweb.snapshot::
1400        See linkgit:gitweb.conf[5] for description.
1401
1402grep.lineNumber::
1403        If set to true, enable '-n' option by default.
1404
1405grep.patternType::
1406        Set the default matching behavior. Using a value of 'basic', 'extended',
1407        'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1408        '--fixed-strings', or '--perl-regexp' option accordingly, while the
1409        value 'default' will return to the default matching behavior.
1410
1411grep.extendedRegexp::
1412        If set to true, enable '--extended-regexp' option by default. This
1413        option is ignored when the 'grep.patternType' option is set to a value
1414        other than 'default'.
1415
1416gpg.program::
1417        Use this custom program instead of "gpg" found on $PATH when
1418        making or verifying a PGP signature. The program must support the
1419        same command-line interface as GPG, namely, to verify a detached
1420        signature, "gpg --verify $file - <$signature" is run, and the
1421        program is expected to signal a good signature by exiting with
1422        code 0, and to generate an ASCII-armored detached signature, the
1423        standard input of "gpg -bsau $key" is fed with the contents to be
1424        signed, and the program is expected to send the result to its
1425        standard output.
1426
1427gui.commitMsgWidth::
1428        Defines how wide the commit message window is in the
1429        linkgit:git-gui[1]. "75" is the default.
1430
1431gui.diffContext::
1432        Specifies how many context lines should be used in calls to diff
1433        made by the linkgit:git-gui[1]. The default is "5".
1434
1435gui.displayUntracked::
1436        Determines if linkgit::git-gui[1] shows untracked files
1437        in the file list. The default is "true".
1438
1439gui.encoding::
1440        Specifies the default encoding to use for displaying of
1441        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1442        It can be overridden by setting the 'encoding' attribute
1443        for relevant files (see linkgit:gitattributes[5]).
1444        If this option is not set, the tools default to the
1445        locale encoding.
1446
1447gui.matchTrackingBranch::
1448        Determines if new branches created with linkgit:git-gui[1] should
1449        default to tracking remote branches with matching names or
1450        not. Default: "false".
1451
1452gui.newBranchTemplate::
1453        Is used as suggested name when creating new branches using the
1454        linkgit:git-gui[1].
1455
1456gui.pruneDuringFetch::
1457        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1458        performing a fetch. The default value is "false".
1459
1460gui.trustmtime::
1461        Determines if linkgit:git-gui[1] should trust the file modification
1462        timestamp or not. By default the timestamps are not trusted.
1463
1464gui.spellingDictionary::
1465        Specifies the dictionary used for spell checking commit messages in
1466        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1467        off.
1468
1469gui.fastCopyBlame::
1470        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1471        location detection. It makes blame significantly faster on huge
1472        repositories at the expense of less thorough copy detection.
1473
1474gui.copyBlameThreshold::
1475        Specifies the threshold to use in 'git gui blame' original location
1476        detection, measured in alphanumeric characters. See the
1477        linkgit:git-blame[1] manual for more information on copy detection.
1478
1479gui.blamehistoryctx::
1480        Specifies the radius of history context in days to show in
1481        linkgit:gitk[1] for the selected commit, when the `Show History
1482        Context` menu item is invoked from 'git gui blame'. If this
1483        variable is set to zero, the whole history is shown.
1484
1485guitool.<name>.cmd::
1486        Specifies the shell command line to execute when the corresponding item
1487        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1488        mandatory for every tool. The command is executed from the root of
1489        the working directory, and in the environment it receives the name of
1490        the tool as 'GIT_GUITOOL', the name of the currently selected file as
1491        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1492        the head is detached, 'CUR_BRANCH' is empty).
1493
1494guitool.<name>.needsFile::
1495        Run the tool only if a diff is selected in the GUI. It guarantees
1496        that 'FILENAME' is not empty.
1497
1498guitool.<name>.noConsole::
1499        Run the command silently, without creating a window to display its
1500        output.
1501
1502guitool.<name>.noRescan::
1503        Don't rescan the working directory for changes after the tool
1504        finishes execution.
1505
1506guitool.<name>.confirm::
1507        Show a confirmation dialog before actually running the tool.
1508
1509guitool.<name>.argPrompt::
1510        Request a string argument from the user, and pass it to the tool
1511        through the 'ARGS' environment variable. Since requesting an
1512        argument implies confirmation, the 'confirm' option has no effect
1513        if this is enabled. If the option is set to 'true', 'yes', or '1',
1514        the dialog uses a built-in generic prompt; otherwise the exact
1515        value of the variable is used.
1516
1517guitool.<name>.revPrompt::
1518        Request a single valid revision from the user, and set the
1519        'REVISION' environment variable. In other aspects this option
1520        is similar to 'argPrompt', and can be used together with it.
1521
1522guitool.<name>.revUnmerged::
1523        Show only unmerged branches in the 'revPrompt' subdialog.
1524        This is useful for tools similar to merge or rebase, but not
1525        for things like checkout or reset.
1526
1527guitool.<name>.title::
1528        Specifies the title to use for the prompt dialog. The default
1529        is the tool name.
1530
1531guitool.<name>.prompt::
1532        Specifies the general prompt string to display at the top of
1533        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1534        The default value includes the actual command.
1535
1536help.browser::
1537        Specify the browser that will be used to display help in the
1538        'web' format. See linkgit:git-help[1].
1539
1540help.format::
1541        Override the default help format used by linkgit:git-help[1].
1542        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1543        the default. 'web' and 'html' are the same.
1544
1545help.autoCorrect::
1546        Automatically correct and execute mistyped commands after
1547        waiting for the given number of deciseconds (0.1 sec). If more
1548        than one command can be deduced from the entered text, nothing
1549        will be executed.  If the value of this option is negative,
1550        the corrected command will be executed immediately. If the
1551        value is 0 - the command will be just shown but not executed.
1552        This is the default.
1553
1554help.htmlPath::
1555        Specify the path where the HTML documentation resides. File system paths
1556        and URLs are supported. HTML pages will be prefixed with this path when
1557        help is displayed in the 'web' format. This defaults to the documentation
1558        path of your Git installation.
1559
1560http.proxy::
1561        Override the HTTP proxy, normally configured using the 'http_proxy',
1562        'https_proxy', and 'all_proxy' environment variables (see
1563        `curl(1)`).  This can be overridden on a per-remote basis; see
1564        remote.<name>.proxy
1565
1566http.cookieFile::
1567        File containing previously stored cookie lines which should be used
1568        in the Git http session, if they match the server. The file format
1569        of the file to read cookies from should be plain HTTP headers or
1570        the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1571        NOTE that the file specified with http.cookieFile is only used as
1572        input unless http.saveCookies is set.
1573
1574http.saveCookies::
1575        If set, store cookies received during requests to the file specified by
1576        http.cookieFile. Has no effect if http.cookieFile is unset.
1577
1578http.sslVerify::
1579        Whether to verify the SSL certificate when fetching or pushing
1580        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1581        variable.
1582
1583http.sslCert::
1584        File containing the SSL certificate when fetching or pushing
1585        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1586        variable.
1587
1588http.sslKey::
1589        File containing the SSL private key when fetching or pushing
1590        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1591        variable.
1592
1593http.sslCertPasswordProtected::
1594        Enable Git's password prompt for the SSL certificate.  Otherwise
1595        OpenSSL will prompt the user, possibly many times, if the
1596        certificate or private key is encrypted.  Can be overridden by the
1597        'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1598
1599http.sslCAInfo::
1600        File containing the certificates to verify the peer with when
1601        fetching or pushing over HTTPS. Can be overridden by the
1602        'GIT_SSL_CAINFO' environment variable.
1603
1604http.sslCAPath::
1605        Path containing files with the CA certificates to verify the peer
1606        with when fetching or pushing over HTTPS. Can be overridden
1607        by the 'GIT_SSL_CAPATH' environment variable.
1608
1609http.sslTry::
1610        Attempt to use AUTH SSL/TLS and encrypted data transfers
1611        when connecting via regular FTP protocol. This might be needed
1612        if the FTP server requires it for security reasons or you wish
1613        to connect securely whenever remote FTP server supports it.
1614        Default is false since it might trigger certificate verification
1615        errors on misconfigured servers.
1616
1617http.maxRequests::
1618        How many HTTP requests to launch in parallel. Can be overridden
1619        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1620
1621http.minSessions::
1622        The number of curl sessions (counted across slots) to be kept across
1623        requests. They will not be ended with curl_easy_cleanup() until
1624        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1625        value will be capped at 1. Defaults to 1.
1626
1627http.postBuffer::
1628        Maximum size in bytes of the buffer used by smart HTTP
1629        transports when POSTing data to the remote system.
1630        For requests larger than this buffer size, HTTP/1.1 and
1631        Transfer-Encoding: chunked is used to avoid creating a
1632        massive pack file locally.  Default is 1 MiB, which is
1633        sufficient for most requests.
1634
1635http.lowSpeedLimit, http.lowSpeedTime::
1636        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1637        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1638        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1639        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1640
1641http.noEPSV::
1642        A boolean which disables using of EPSV ftp command by curl.
1643        This can helpful with some "poor" ftp servers which don't
1644        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1645        environment variable. Default is false (curl will use EPSV).
1646
1647http.userAgent::
1648        The HTTP USER_AGENT string presented to an HTTP server.  The default
1649        value represents the version of the client Git such as git/1.7.1.
1650        This option allows you to override this value to a more common value
1651        such as Mozilla/4.0.  This may be necessary, for instance, if
1652        connecting through a firewall that restricts HTTP connections to a set
1653        of common USER_AGENT strings (but not including those like git/1.7.1).
1654        Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1655
1656http.<url>.*::
1657        Any of the http.* options above can be applied selectively to some URLs.
1658        For a config key to match a URL, each element of the config key is
1659        compared to that of the URL, in the following order:
1660+
1661--
1662. Scheme (e.g., `https` in `https://example.com/`). This field
1663  must match exactly between the config key and the URL.
1664
1665. Host/domain name (e.g., `example.com` in `https://example.com/`).
1666  This field must match exactly between the config key and the URL.
1667
1668. Port number (e.g., `8080` in `http://example.com:8080/`).
1669  This field must match exactly between the config key and the URL.
1670  Omitted port numbers are automatically converted to the correct
1671  default for the scheme before matching.
1672
1673. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1674  path field of the config key must match the path field of the URL
1675  either exactly or as a prefix of slash-delimited path elements.  This means
1676  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1677  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1678  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1679  key with just path `foo/`).
1680
1681. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1682  the config key has a user name it must match the user name in the
1683  URL exactly. If the config key does not have a user name, that
1684  config key will match a URL with any user name (including none),
1685  but at a lower precedence than a config key with a user name.
1686--
1687+
1688The list above is ordered by decreasing precedence; a URL that matches
1689a config key's path is preferred to one that matches its user name. For example,
1690if the URL is `https://user@example.com/foo/bar` a config key match of
1691`https://example.com/foo` will be preferred over a config key match of
1692`https://user@example.com`.
1693+
1694All URLs are normalized before attempting any matching (the password part,
1695if embedded in the URL, is always ignored for matching purposes) so that
1696equivalent URLs that are simply spelled differently will match properly.
1697Environment variable settings always override any matches.  The URLs that are
1698matched against are those given directly to Git commands.  This means any URLs
1699visited as a result of a redirection do not participate in matching.
1700
1701i18n.commitEncoding::
1702        Character encoding the commit messages are stored in; Git itself
1703        does not care per se, but this information is necessary e.g. when
1704        importing commits from emails or in the gitk graphical history
1705        browser (and possibly at other places in the future or in other
1706        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1707
1708i18n.logOutputEncoding::
1709        Character encoding the commit messages are converted to when
1710        running 'git log' and friends.
1711
1712imap::
1713        The configuration variables in the 'imap' section are described
1714        in linkgit:git-imap-send[1].
1715
1716index.version::
1717        Specify the version with which new index files should be
1718        initialized.  This does not affect existing repositories.
1719
1720init.templateDir::
1721        Specify the directory from which templates will be copied.
1722        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1723
1724instaweb.browser::
1725        Specify the program that will be used to browse your working
1726        repository in gitweb. See linkgit:git-instaweb[1].
1727
1728instaweb.httpd::
1729        The HTTP daemon command-line to start gitweb on your working
1730        repository. See linkgit:git-instaweb[1].
1731
1732instaweb.local::
1733        If true the web server started by linkgit:git-instaweb[1] will
1734        be bound to the local IP (127.0.0.1).
1735
1736instaweb.modulePath::
1737        The default module path for linkgit:git-instaweb[1] to use
1738        instead of /usr/lib/apache2/modules.  Only used if httpd
1739        is Apache.
1740
1741instaweb.port::
1742        The port number to bind the gitweb httpd to. See
1743        linkgit:git-instaweb[1].
1744
1745interactive.singleKey::
1746        In interactive commands, allow the user to provide one-letter
1747        input with a single key (i.e., without hitting enter).
1748        Currently this is used by the `--patch` mode of
1749        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1750        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1751        setting is silently ignored if portable keystroke input
1752        is not available; requires the Perl module Term::ReadKey.
1753
1754log.abbrevCommit::
1755        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1756        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1757        override this option with `--no-abbrev-commit`.
1758
1759log.date::
1760        Set the default date-time mode for the 'log' command.
1761        Setting a value for log.date is similar to using 'git log''s
1762        `--date` option.  Possible values are `relative`, `local`,
1763        `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1764        for details.
1765
1766log.decorate::
1767        Print out the ref names of any commits that are shown by the log
1768        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1769        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1770        specified, the full ref name (including prefix) will be printed.
1771        This is the same as the log commands '--decorate' option.
1772
1773log.showRoot::
1774        If true, the initial commit will be shown as a big creation event.
1775        This is equivalent to a diff against an empty tree.
1776        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1777        normally hide the root commit will now show it. True by default.
1778
1779log.mailmap::
1780        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1781        linkgit:git-whatchanged[1] assume `--use-mailmap`.
1782
1783mailinfo.scissors::
1784        If true, makes linkgit:git-mailinfo[1] (and therefore
1785        linkgit:git-am[1]) act by default as if the --scissors option
1786        was provided on the command-line. When active, this features
1787        removes everything from the message body before a scissors
1788        line (i.e. consisting mainly of ">8", "8<" and "-").
1789
1790mailmap.file::
1791        The location of an augmenting mailmap file. The default
1792        mailmap, located in the root of the repository, is loaded
1793        first, then the mailmap file pointed to by this variable.
1794        The location of the mailmap file may be in a repository
1795        subdirectory, or somewhere outside of the repository itself.
1796        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1797
1798mailmap.blob::
1799        Like `mailmap.file`, but consider the value as a reference to a
1800        blob in the repository. If both `mailmap.file` and
1801        `mailmap.blob` are given, both are parsed, with entries from
1802        `mailmap.file` taking precedence. In a bare repository, this
1803        defaults to `HEAD:.mailmap`. In a non-bare repository, it
1804        defaults to empty.
1805
1806man.viewer::
1807        Specify the programs that may be used to display help in the
1808        'man' format. See linkgit:git-help[1].
1809
1810man.<tool>.cmd::
1811        Specify the command to invoke the specified man viewer. The
1812        specified command is evaluated in shell with the man page
1813        passed as argument. (See linkgit:git-help[1].)
1814
1815man.<tool>.path::
1816        Override the path for the given tool that may be used to
1817        display help in the 'man' format. See linkgit:git-help[1].
1818
1819include::merge-config.txt[]
1820
1821mergetool.<tool>.path::
1822        Override the path for the given tool.  This is useful in case
1823        your tool is not in the PATH.
1824
1825mergetool.<tool>.cmd::
1826        Specify the command to invoke the specified merge tool.  The
1827        specified command is evaluated in shell with the following
1828        variables available: 'BASE' is the name of a temporary file
1829        containing the common base of the files to be merged, if available;
1830        'LOCAL' is the name of a temporary file containing the contents of
1831        the file on the current branch; 'REMOTE' is the name of a temporary
1832        file containing the contents of the file from the branch being
1833        merged; 'MERGED' contains the name of the file to which the merge
1834        tool should write the results of a successful merge.
1835
1836mergetool.<tool>.trustExitCode::
1837        For a custom merge command, specify whether the exit code of
1838        the merge command can be used to determine whether the merge was
1839        successful.  If this is not set to true then the merge target file
1840        timestamp is checked and the merge assumed to have been successful
1841        if the file has been updated, otherwise the user is prompted to
1842        indicate the success of the merge.
1843
1844mergetool.meld.hasOutput::
1845        Older versions of `meld` do not support the `--output` option.
1846        Git will attempt to detect whether `meld` supports `--output`
1847        by inspecting the output of `meld --help`.  Configuring
1848        `mergetool.meld.hasOutput` will make Git skip these checks and
1849        use the configured value instead.  Setting `mergetool.meld.hasOutput`
1850        to `true` tells Git to unconditionally use the `--output` option,
1851        and `false` avoids using `--output`.
1852
1853mergetool.keepBackup::
1854        After performing a merge, the original file with conflict markers
1855        can be saved as a file with a `.orig` extension.  If this variable
1856        is set to `false` then this file is not preserved.  Defaults to
1857        `true` (i.e. keep the backup files).
1858
1859mergetool.keepTemporaries::
1860        When invoking a custom merge tool, Git uses a set of temporary
1861        files to pass to the tool. If the tool returns an error and this
1862        variable is set to `true`, then these temporary files will be
1863        preserved, otherwise they will be removed after the tool has
1864        exited. Defaults to `false`.
1865
1866mergetool.writeToTemp::
1867        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1868        conflicting files in the worktree by default.  Git will attempt
1869        to use a temporary directory for these files when set `true`.
1870        Defaults to `false`.
1871
1872mergetool.prompt::
1873        Prompt before each invocation of the merge resolution program.
1874
1875notes.displayRef::
1876        The (fully qualified) refname from which to show notes when
1877        showing commit messages.  The value of this variable can be set
1878        to a glob, in which case notes from all matching refs will be
1879        shown.  You may also specify this configuration variable
1880        several times.  A warning will be issued for refs that do not
1881        exist, but a glob that does not match any refs is silently
1882        ignored.
1883+
1884This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1885environment variable, which must be a colon separated list of refs or
1886globs.
1887+
1888The effective value of "core.notesRef" (possibly overridden by
1889GIT_NOTES_REF) is also implicitly added to the list of refs to be
1890displayed.
1891
1892notes.rewrite.<command>::
1893        When rewriting commits with <command> (currently `amend` or
1894        `rebase`) and this variable is set to `true`, Git
1895        automatically copies your notes from the original to the
1896        rewritten commit.  Defaults to `true`, but see
1897        "notes.rewriteRef" below.
1898
1899notes.rewriteMode::
1900        When copying notes during a rewrite (see the
1901        "notes.rewrite.<command>" option), determines what to do if
1902        the target commit already has a note.  Must be one of
1903        `overwrite`, `concatenate`, or `ignore`.  Defaults to
1904        `concatenate`.
1905+
1906This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1907environment variable.
1908
1909notes.rewriteRef::
1910        When copying notes during a rewrite, specifies the (fully
1911        qualified) ref whose notes should be copied.  The ref may be a
1912        glob, in which case notes in all matching refs will be copied.
1913        You may also specify this configuration several times.
1914+
1915Does not have a default value; you must configure this variable to
1916enable note rewriting.  Set it to `refs/notes/commits` to enable
1917rewriting for the default commit notes.
1918+
1919This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1920environment variable, which must be a colon separated list of refs or
1921globs.
1922
1923pack.window::
1924        The size of the window used by linkgit:git-pack-objects[1] when no
1925        window size is given on the command line. Defaults to 10.
1926
1927pack.depth::
1928        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1929        maximum depth is given on the command line. Defaults to 50.
1930
1931pack.windowMemory::
1932        The maximum size of memory that is consumed by each thread
1933        in linkgit:git-pack-objects[1] for pack window memory when
1934        no limit is given on the command line.  The value can be
1935        suffixed with "k", "m", or "g".  When left unconfigured (or
1936        set explicitly to 0), there will be no limit.
1937
1938pack.compression::
1939        An integer -1..9, indicating the compression level for objects
1940        in a pack file. -1 is the zlib default. 0 means no
1941        compression, and 1..9 are various speed/size tradeoffs, 9 being
1942        slowest.  If not set,  defaults to core.compression.  If that is
1943        not set,  defaults to -1, the zlib default, which is "a default
1944        compromise between speed and compression (currently equivalent
1945        to level 6)."
1946+
1947Note that changing the compression level will not automatically recompress
1948all existing objects. You can force recompression by passing the -F option
1949to linkgit:git-repack[1].
1950
1951pack.deltaCacheSize::
1952        The maximum memory in bytes used for caching deltas in
1953        linkgit:git-pack-objects[1] before writing them out to a pack.
1954        This cache is used to speed up the writing object phase by not
1955        having to recompute the final delta result once the best match
1956        for all objects is found.  Repacking large repositories on machines
1957        which are tight with memory might be badly impacted by this though,
1958        especially if this cache pushes the system into swapping.
1959        A value of 0 means no limit. The smallest size of 1 byte may be
1960        used to virtually disable this cache. Defaults to 256 MiB.
1961
1962pack.deltaCacheLimit::
1963        The maximum size of a delta, that is cached in
1964        linkgit:git-pack-objects[1]. This cache is used to speed up the
1965        writing object phase by not having to recompute the final delta
1966        result once the best match for all objects is found. Defaults to 1000.
1967
1968pack.threads::
1969        Specifies the number of threads to spawn when searching for best
1970        delta matches.  This requires that linkgit:git-pack-objects[1]
1971        be compiled with pthreads otherwise this option is ignored with a
1972        warning. This is meant to reduce packing time on multiprocessor
1973        machines. The required amount of memory for the delta search window
1974        is however multiplied by the number of threads.
1975        Specifying 0 will cause Git to auto-detect the number of CPU's
1976        and set the number of threads accordingly.
1977
1978pack.indexVersion::
1979        Specify the default pack index version.  Valid values are 1 for
1980        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1981        the new pack index with capabilities for packs larger than 4 GB
1982        as well as proper protection against the repacking of corrupted
1983        packs.  Version 2 is the default.  Note that version 2 is enforced
1984        and this config option ignored whenever the corresponding pack is
1985        larger than 2 GB.
1986+
1987If you have an old Git that does not understand the version 2 `*.idx` file,
1988cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1989that will copy both `*.pack` file and corresponding `*.idx` file from the
1990other side may give you a repository that cannot be accessed with your
1991older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1992you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1993the `*.idx` file.
1994
1995pack.packSizeLimit::
1996        The maximum size of a pack.  This setting only affects
1997        packing to a file when repacking, i.e. the git:// protocol
1998        is unaffected.  It can be overridden by the `--max-pack-size`
1999        option of linkgit:git-repack[1]. The minimum size allowed is
2000        limited to 1 MiB. The default is unlimited.
2001        Common unit suffixes of 'k', 'm', or 'g' are
2002        supported.
2003
2004pack.useBitmaps::
2005        When true, git will use pack bitmaps (if available) when packing
2006        to stdout (e.g., during the server side of a fetch). Defaults to
2007        true. You should not generally need to turn this off unless
2008        you are debugging pack bitmaps.
2009
2010pack.writeBitmaps (deprecated)::
2011        This is a deprecated synonym for `repack.writeBitmaps`.
2012
2013pack.writeBitmapHashCache::
2014        When true, git will include a "hash cache" section in the bitmap
2015        index (if one is written). This cache can be used to feed git's
2016        delta heuristics, potentially leading to better deltas between
2017        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2018        between an older, bitmapped pack and objects that have been
2019        pushed since the last gc). The downside is that it consumes 4
2020        bytes per object of disk space, and that JGit's bitmap
2021        implementation does not understand it, causing it to complain if
2022        Git and JGit are used on the same repository. Defaults to false.
2023
2024pager.<cmd>::
2025        If the value is boolean, turns on or off pagination of the
2026        output of a particular Git subcommand when writing to a tty.
2027        Otherwise, turns on pagination for the subcommand using the
2028        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2029        or `--no-pager` is specified on the command line, it takes
2030        precedence over this option.  To disable pagination for all
2031        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2032
2033pretty.<name>::
2034        Alias for a --pretty= format string, as specified in
2035        linkgit:git-log[1]. Any aliases defined here can be used just
2036        as the built-in pretty formats could. For example,
2037        running `git config pretty.changelog "format:* %H %s"`
2038        would cause the invocation `git log --pretty=changelog`
2039        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2040        Note that an alias with the same name as a built-in format
2041        will be silently ignored.
2042
2043pull.ff::
2044        By default, Git does not create an extra merge commit when merging
2045        a commit that is a descendant of the current commit. Instead, the
2046        tip of the current branch is fast-forwarded. When set to `false`,
2047        this variable tells Git to create an extra merge commit in such
2048        a case (equivalent to giving the `--no-ff` option from the command
2049        line). When set to `only`, only such fast-forward merges are
2050        allowed (equivalent to giving the `--ff-only` option from the
2051        command line).
2052
2053pull.rebase::
2054        When true, rebase branches on top of the fetched branch, instead
2055        of merging the default branch from the default remote when "git
2056        pull" is run. See "branch.<name>.rebase" for setting this on a
2057        per-branch basis.
2058+
2059        When preserve, also pass `--preserve-merges` along to 'git rebase'
2060        so that locally committed merge commits will not be flattened
2061        by running 'git pull'.
2062+
2063*NOTE*: this is a possibly dangerous operation; do *not* use
2064it unless you understand the implications (see linkgit:git-rebase[1]
2065for details).
2066
2067pull.octopus::
2068        The default merge strategy to use when pulling multiple branches
2069        at once.
2070
2071pull.twohead::
2072        The default merge strategy to use when pulling a single branch.
2073
2074push.default::
2075        Defines the action `git push` should take if no refspec is
2076        explicitly given.  Different values are well-suited for
2077        specific workflows; for instance, in a purely central workflow
2078        (i.e. the fetch source is equal to the push destination),
2079        `upstream` is probably what you want.  Possible values are:
2080+
2081--
2082
2083* `nothing` - do not push anything (error out) unless a refspec is
2084  explicitly given. This is primarily meant for people who want to
2085  avoid mistakes by always being explicit.
2086
2087* `current` - push the current branch to update a branch with the same
2088  name on the receiving end.  Works in both central and non-central
2089  workflows.
2090
2091* `upstream` - push the current branch back to the branch whose
2092  changes are usually integrated into the current branch (which is
2093  called `@{upstream}`).  This mode only makes sense if you are
2094  pushing to the same repository you would normally pull from
2095  (i.e. central workflow).
2096
2097* `simple` - in centralized workflow, work like `upstream` with an
2098  added safety to refuse to push if the upstream branch's name is
2099  different from the local one.
2100+
2101When pushing to a remote that is different from the remote you normally
2102pull from, work as `current`.  This is the safest option and is suited
2103for beginners.
2104+
2105This mode has become the default in Git 2.0.
2106
2107* `matching` - push all branches having the same name on both ends.
2108  This makes the repository you are pushing to remember the set of
2109  branches that will be pushed out (e.g. if you always push 'maint'
2110  and 'master' there and no other branches, the repository you push
2111  to will have these two branches, and your local 'maint' and
2112  'master' will be pushed there).
2113+
2114To use this mode effectively, you have to make sure _all_ the
2115branches you would push out are ready to be pushed out before
2116running 'git push', as the whole point of this mode is to allow you
2117to push all of the branches in one go.  If you usually finish work
2118on only one branch and push out the result, while other branches are
2119unfinished, this mode is not for you.  Also this mode is not
2120suitable for pushing into a shared central repository, as other
2121people may add new branches there, or update the tip of existing
2122branches outside your control.
2123+
2124This used to be the default, but not since Git 2.0 (`simple` is the
2125new default).
2126
2127--
2128
2129push.followTags::
2130        If set to true enable '--follow-tags' option by default.  You
2131        may override this configuration at time of push by specifying
2132        '--no-follow-tags'.
2133
2134
2135rebase.stat::
2136        Whether to show a diffstat of what changed upstream since the last
2137        rebase. False by default.
2138
2139rebase.autoSquash::
2140        If set to true enable '--autosquash' option by default.
2141
2142rebase.autoStash::
2143        When set to true, automatically create a temporary stash
2144        before the operation begins, and apply it after the operation
2145        ends.  This means that you can run rebase on a dirty worktree.
2146        However, use with care: the final stash application after a
2147        successful rebase might result in non-trivial conflicts.
2148        Defaults to false.
2149
2150receive.advertiseAtomic::
2151        By default, git-receive-pack will advertise the atomic push
2152        capability to its clients. If you don't want to this capability
2153        to be advertised, set this variable to false.
2154
2155receive.autogc::
2156        By default, git-receive-pack will run "git-gc --auto" after
2157        receiving data from git-push and updating refs.  You can stop
2158        it by setting this variable to false.
2159
2160receive.certNonceSeed::
2161        By setting this variable to a string, `git receive-pack`
2162        will accept a `git push --signed` and verifies it by using
2163        a "nonce" protected by HMAC using this string as a secret
2164        key.
2165
2166receive.certNonceSlop::
2167        When a `git push --signed` sent a push certificate with a
2168        "nonce" that was issued by a receive-pack serving the same
2169        repository within this many seconds, export the "nonce"
2170        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2171        hooks (instead of what the receive-pack asked the sending
2172        side to include).  This may allow writing checks in
2173        `pre-receive` and `post-receive` a bit easier.  Instead of
2174        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2175        that records by how many seconds the nonce is stale to
2176        decide if they want to accept the certificate, they only
2177        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2178
2179receive.fsckObjects::
2180        If it is set to true, git-receive-pack will check all received
2181        objects. It will abort in the case of a malformed object or a
2182        broken link. The result of an abort are only dangling objects.
2183        Defaults to false. If not set, the value of `transfer.fsckObjects`
2184        is used instead.
2185
2186receive.unpackLimit::
2187        If the number of objects received in a push is below this
2188        limit then the objects will be unpacked into loose object
2189        files. However if the number of received objects equals or
2190        exceeds this limit then the received pack will be stored as
2191        a pack, after adding any missing delta bases.  Storing the
2192        pack from a push can make the push operation complete faster,
2193        especially on slow filesystems.  If not set, the value of
2194        `transfer.unpackLimit` is used instead.
2195
2196receive.denyDeletes::
2197        If set to true, git-receive-pack will deny a ref update that deletes
2198        the ref. Use this to prevent such a ref deletion via a push.
2199
2200receive.denyDeleteCurrent::
2201        If set to true, git-receive-pack will deny a ref update that
2202        deletes the currently checked out branch of a non-bare repository.
2203
2204receive.denyCurrentBranch::
2205        If set to true or "refuse", git-receive-pack will deny a ref update
2206        to the currently checked out branch of a non-bare repository.
2207        Such a push is potentially dangerous because it brings the HEAD
2208        out of sync with the index and working tree. If set to "warn",
2209        print a warning of such a push to stderr, but allow the push to
2210        proceed. If set to false or "ignore", allow such pushes with no
2211        message. Defaults to "refuse".
2212+
2213Another option is "updateInstead" which will update the working
2214tree if pushing into the current branch.  This option is
2215intended for synchronizing working directories when one side is not easily
2216accessible via interactive ssh (e.g. a live web site, hence the requirement
2217that the working directory be clean). This mode also comes in handy when
2218developing inside a VM to test and fix code on different Operating Systems.
2219+
2220By default, "updateInstead" will refuse the push if the working tree or
2221the index have any difference from the HEAD, but the `push-to-checkout`
2222hook can be used to customize this.  See linkgit:githooks[5].
2223
2224receive.denyNonFastForwards::
2225        If set to true, git-receive-pack will deny a ref update which is
2226        not a fast-forward. Use this to prevent such an update via a push,
2227        even if that push is forced. This configuration variable is
2228        set when initializing a shared repository.
2229
2230receive.hideRefs::
2231        String(s) `receive-pack` uses to decide which refs to omit
2232        from its initial advertisement.  Use more than one
2233        definitions to specify multiple prefix strings. A ref that
2234        are under the hierarchies listed on the value of this
2235        variable is excluded, and is hidden when responding to `git
2236        push`, and an attempt to update or delete a hidden ref by
2237        `git push` is rejected.
2238
2239receive.updateServerInfo::
2240        If set to true, git-receive-pack will run git-update-server-info
2241        after receiving data from git-push and updating refs.
2242
2243receive.shallowUpdate::
2244        If set to true, .git/shallow can be updated when new refs
2245        require new shallow roots. Otherwise those refs are rejected.
2246
2247remote.pushDefault::
2248        The remote to push to by default.  Overrides
2249        `branch.<name>.remote` for all branches, and is overridden by
2250        `branch.<name>.pushRemote` for specific branches.
2251
2252remote.<name>.url::
2253        The URL of a remote repository.  See linkgit:git-fetch[1] or
2254        linkgit:git-push[1].
2255
2256remote.<name>.pushurl::
2257        The push URL of a remote repository.  See linkgit:git-push[1].
2258
2259remote.<name>.proxy::
2260        For remotes that require curl (http, https and ftp), the URL to
2261        the proxy to use for that remote.  Set to the empty string to
2262        disable proxying for that remote.
2263
2264remote.<name>.fetch::
2265        The default set of "refspec" for linkgit:git-fetch[1]. See
2266        linkgit:git-fetch[1].
2267
2268remote.<name>.push::
2269        The default set of "refspec" for linkgit:git-push[1]. See
2270        linkgit:git-push[1].
2271
2272remote.<name>.mirror::
2273        If true, pushing to this remote will automatically behave
2274        as if the `--mirror` option was given on the command line.
2275
2276remote.<name>.skipDefaultUpdate::
2277        If true, this remote will be skipped by default when updating
2278        using linkgit:git-fetch[1] or the `update` subcommand of
2279        linkgit:git-remote[1].
2280
2281remote.<name>.skipFetchAll::
2282        If true, this remote will be skipped by default when updating
2283        using linkgit:git-fetch[1] or the `update` subcommand of
2284        linkgit:git-remote[1].
2285
2286remote.<name>.receivepack::
2287        The default program to execute on the remote side when pushing.  See
2288        option \--receive-pack of linkgit:git-push[1].
2289
2290remote.<name>.uploadpack::
2291        The default program to execute on the remote side when fetching.  See
2292        option \--upload-pack of linkgit:git-fetch-pack[1].
2293
2294remote.<name>.tagOpt::
2295        Setting this value to \--no-tags disables automatic tag following when
2296        fetching from remote <name>. Setting it to \--tags will fetch every
2297        tag from remote <name>, even if they are not reachable from remote
2298        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2299        override this setting. See options \--tags and \--no-tags of
2300        linkgit:git-fetch[1].
2301
2302remote.<name>.vcs::
2303        Setting this to a value <vcs> will cause Git to interact with
2304        the remote with the git-remote-<vcs> helper.
2305
2306remote.<name>.prune::
2307        When set to true, fetching from this remote by default will also
2308        remove any remote-tracking references that no longer exist on the
2309        remote (as if the `--prune` option was given on the command line).
2310        Overrides `fetch.prune` settings, if any.
2311
2312remotes.<group>::
2313        The list of remotes which are fetched by "git remote update
2314        <group>".  See linkgit:git-remote[1].
2315
2316repack.useDeltaBaseOffset::
2317        By default, linkgit:git-repack[1] creates packs that use
2318        delta-base offset. If you need to share your repository with
2319        Git older than version 1.4.4, either directly or via a dumb
2320        protocol such as http, then you need to set this option to
2321        "false" and repack. Access from old Git versions over the
2322        native protocol are unaffected by this option.
2323
2324repack.packKeptObjects::
2325        If set to true, makes `git repack` act as if
2326        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2327        details. Defaults to `false` normally, but `true` if a bitmap
2328        index is being written (either via `--write-bitmap-index` or
2329        `repack.writeBitmaps`).
2330
2331repack.writeBitmaps::
2332        When true, git will write a bitmap index when packing all
2333        objects to disk (e.g., when `git repack -a` is run).  This
2334        index can speed up the "counting objects" phase of subsequent
2335        packs created for clones and fetches, at the cost of some disk
2336        space and extra time spent on the initial repack.  Defaults to
2337        false.
2338
2339rerere.autoUpdate::
2340        When set to true, `git-rerere` updates the index with the
2341        resulting contents after it cleanly resolves conflicts using
2342        previously recorded resolution.  Defaults to false.
2343
2344rerere.enabled::
2345        Activate recording of resolved conflicts, so that identical
2346        conflict hunks can be resolved automatically, should they be
2347        encountered again.  By default, linkgit:git-rerere[1] is
2348        enabled if there is an `rr-cache` directory under the
2349        `$GIT_DIR`, e.g. if "rerere" was previously used in the
2350        repository.
2351
2352sendemail.identity::
2353        A configuration identity. When given, causes values in the
2354        'sendemail.<identity>' subsection to take precedence over
2355        values in the 'sendemail' section. The default identity is
2356        the value of 'sendemail.identity'.
2357
2358sendemail.smtpEncryption::
2359        See linkgit:git-send-email[1] for description.  Note that this
2360        setting is not subject to the 'identity' mechanism.
2361
2362sendemail.smtpssl (deprecated)::
2363        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2364
2365sendemail.smtpsslcertpath::
2366        Path to ca-certificates (either a directory or a single file).
2367        Set it to an empty string to disable certificate verification.
2368
2369sendemail.<identity>.*::
2370        Identity-specific versions of the 'sendemail.*' parameters
2371        found below, taking precedence over those when the this
2372        identity is selected, through command-line or
2373        'sendemail.identity'.
2374
2375sendemail.aliasesFile::
2376sendemail.aliasFileType::
2377sendemail.annotate::
2378sendemail.bcc::
2379sendemail.cc::
2380sendemail.ccCmd::
2381sendemail.chainReplyTo::
2382sendemail.confirm::
2383sendemail.envelopeSender::
2384sendemail.from::
2385sendemail.multiEdit::
2386sendemail.signedoffbycc::
2387sendemail.smtpPass::
2388sendemail.suppresscc::
2389sendemail.suppressFrom::
2390sendemail.to::
2391sendemail.smtpDomain::
2392sendemail.smtpServer::
2393sendemail.smtpServerPort::
2394sendemail.smtpServerOption::
2395sendemail.smtpUser::
2396sendemail.thread::
2397sendemail.transferEncoding::
2398sendemail.validate::
2399sendemail.xmailer::
2400        See linkgit:git-send-email[1] for description.
2401
2402sendemail.signedoffcc (deprecated)::
2403        Deprecated alias for 'sendemail.signedoffbycc'.
2404
2405showbranch.default::
2406        The default set of branches for linkgit:git-show-branch[1].
2407        See linkgit:git-show-branch[1].
2408
2409status.relativePaths::
2410        By default, linkgit:git-status[1] shows paths relative to the
2411        current directory. Setting this variable to `false` shows paths
2412        relative to the repository root (this was the default for Git
2413        prior to v1.5.4).
2414
2415status.short::
2416        Set to true to enable --short by default in linkgit:git-status[1].
2417        The option --no-short takes precedence over this variable.
2418
2419status.branch::
2420        Set to true to enable --branch by default in linkgit:git-status[1].
2421        The option --no-branch takes precedence over this variable.
2422
2423status.displayCommentPrefix::
2424        If set to true, linkgit:git-status[1] will insert a comment
2425        prefix before each output line (starting with
2426        `core.commentChar`, i.e. `#` by default). This was the
2427        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2428        Defaults to false.
2429
2430status.showUntrackedFiles::
2431        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2432        files which are not currently tracked by Git. Directories which
2433        contain only untracked files, are shown with the directory name
2434        only. Showing untracked files means that Git needs to lstat() all
2435        the files in the whole repository, which might be slow on some
2436        systems. So, this variable controls how the commands displays
2437        the untracked files. Possible values are:
2438+
2439--
2440* `no` - Show no untracked files.
2441* `normal` - Show untracked files and directories.
2442* `all` - Show also individual files in untracked directories.
2443--
2444+
2445If this variable is not specified, it defaults to 'normal'.
2446This variable can be overridden with the -u|--untracked-files option
2447of linkgit:git-status[1] and linkgit:git-commit[1].
2448
2449status.submoduleSummary::
2450        Defaults to false.
2451        If this is set to a non zero number or true (identical to -1 or an
2452        unlimited number), the submodule summary will be enabled and a
2453        summary of commits for modified submodules will be shown (see
2454        --summary-limit option of linkgit:git-submodule[1]). Please note
2455        that the summary output command will be suppressed for all
2456        submodules when `diff.ignoreSubmodules` is set to 'all' or only
2457        for those submodules where `submodule.<name>.ignore=all`. The only
2458        exception to that rule is that status and commit will show staged
2459        submodule changes. To
2460        also view the summary for ignored submodules you can either use
2461        the --ignore-submodules=dirty command-line option or the 'git
2462        submodule summary' command, which shows a similar output but does
2463        not honor these settings.
2464
2465submodule.<name>.path::
2466submodule.<name>.url::
2467        The path within this project and URL for a submodule. These
2468        variables are initially populated by 'git submodule init'. See
2469        linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2470        details.
2471
2472submodule.<name>.update::
2473        The default update procedure for a submodule. This variable
2474        is populated by `git submodule init` from the
2475        linkgit:gitmodules[5] file. See description of 'update'
2476        command in linkgit:git-submodule[1].
2477
2478submodule.<name>.branch::
2479        The remote branch name for a submodule, used by `git submodule
2480        update --remote`.  Set this option to override the value found in
2481        the `.gitmodules` file.  See linkgit:git-submodule[1] and
2482        linkgit:gitmodules[5] for details.
2483
2484submodule.<name>.fetchRecurseSubmodules::
2485        This option can be used to control recursive fetching of this
2486        submodule. It can be overridden by using the --[no-]recurse-submodules
2487        command-line option to "git fetch" and "git pull".
2488        This setting will override that from in the linkgit:gitmodules[5]
2489        file.
2490
2491submodule.<name>.ignore::
2492        Defines under what circumstances "git status" and the diff family show
2493        a submodule as modified. When set to "all", it will never be considered
2494        modified (but it will nonetheless show up in the output of status and
2495        commit when it has been staged), "dirty" will ignore all changes
2496        to the submodules work tree and
2497        takes only differences between the HEAD of the submodule and the commit
2498        recorded in the superproject into account. "untracked" will additionally
2499        let submodules with modified tracked files in their work tree show up.
2500        Using "none" (the default when this option is not set) also shows
2501        submodules that have untracked files in their work tree as changed.
2502        This setting overrides any setting made in .gitmodules for this submodule,
2503        both settings can be overridden on the command line by using the
2504        "--ignore-submodules" option. The 'git submodule' commands are not
2505        affected by this setting.
2506
2507tag.sort::
2508        This variable controls the sort ordering of tags when displayed by
2509        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2510        value of this variable will be used as the default.
2511
2512tar.umask::
2513        This variable can be used to restrict the permission bits of
2514        tar archive entries.  The default is 0002, which turns off the
2515        world write bit.  The special value "user" indicates that the
2516        archiving user's umask will be used instead.  See umask(2) and
2517        linkgit:git-archive[1].
2518
2519transfer.fsckObjects::
2520        When `fetch.fsckObjects` or `receive.fsckObjects` are
2521        not set, the value of this variable is used instead.
2522        Defaults to false.
2523
2524transfer.hideRefs::
2525        This variable can be used to set both `receive.hideRefs`
2526        and `uploadpack.hideRefs` at the same time to the same
2527        values.  See entries for these other variables.
2528
2529transfer.unpackLimit::
2530        When `fetch.unpackLimit` or `receive.unpackLimit` are
2531        not set, the value of this variable is used instead.
2532        The default value is 100.
2533
2534uploadarchive.allowUnreachable::
2535        If true, allow clients to use `git archive --remote` to request
2536        any tree, whether reachable from the ref tips or not. See the
2537        discussion in the `SECURITY` section of
2538        linkgit:git-upload-archive[1] for more details. Defaults to
2539        `false`.
2540
2541uploadpack.hideRefs::
2542        String(s) `upload-pack` uses to decide which refs to omit
2543        from its initial advertisement.  Use more than one
2544        definitions to specify multiple prefix strings. A ref that
2545        are under the hierarchies listed on the value of this
2546        variable is excluded, and is hidden from `git ls-remote`,
2547        `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2548        fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2549
2550uploadpack.allowtipsha1inwant::
2551        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2552        to accept a fetch request that asks for an object at the tip
2553        of a hidden ref (by default, such a request is rejected).
2554        see also `uploadpack.hideRefs`.
2555
2556uploadpack.keepAlive::
2557        When `upload-pack` has started `pack-objects`, there may be a
2558        quiet period while `pack-objects` prepares the pack. Normally
2559        it would output progress information, but if `--quiet` was used
2560        for the fetch, `pack-objects` will output nothing at all until
2561        the pack data begins. Some clients and networks may consider
2562        the server to be hung and give up. Setting this option instructs
2563        `upload-pack` to send an empty keepalive packet every
2564        `uploadpack.keepAlive` seconds. Setting this option to 0
2565        disables keepalive packets entirely. The default is 5 seconds.
2566
2567url.<base>.insteadOf::
2568        Any URL that starts with this value will be rewritten to
2569        start, instead, with <base>. In cases where some site serves a
2570        large number of repositories, and serves them with multiple
2571        access methods, and some users need to use different access
2572        methods, this feature allows people to specify any of the
2573        equivalent URLs and have Git automatically rewrite the URL to
2574        the best alternative for the particular user, even for a
2575        never-before-seen repository on the site.  When more than one
2576        insteadOf strings match a given URL, the longest match is used.
2577
2578url.<base>.pushInsteadOf::
2579        Any URL that starts with this value will not be pushed to;
2580        instead, it will be rewritten to start with <base>, and the
2581        resulting URL will be pushed to. In cases where some site serves
2582        a large number of repositories, and serves them with multiple
2583        access methods, some of which do not allow push, this feature
2584        allows people to specify a pull-only URL and have Git
2585        automatically use an appropriate URL to push, even for a
2586        never-before-seen repository on the site.  When more than one
2587        pushInsteadOf strings match a given URL, the longest match is
2588        used.  If a remote has an explicit pushurl, Git will ignore this
2589        setting for that remote.
2590
2591user.email::
2592        Your email address to be recorded in any newly created commits.
2593        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2594        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2595
2596user.name::
2597        Your full name to be recorded in any newly created commits.
2598        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2599        environment variables.  See linkgit:git-commit-tree[1].
2600
2601user.signingKey::
2602        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2603        key you want it to automatically when creating a signed tag or
2604        commit, you can override the default selection with this variable.
2605        This option is passed unchanged to gpg's --local-user parameter,
2606        so you may specify a key using any method that gpg supports.
2607
2608versionsort.prereleaseSuffix::
2609        When version sort is used in linkgit:git-tag[1], prerelease
2610        tags (e.g. "1.0-rc1") may appear after the main release
2611        "1.0". By specifying the suffix "-rc" in this variable,
2612        "1.0-rc1" will appear before "1.0".
2613+
2614This variable can be specified multiple times, once per suffix. The
2615order of suffixes in the config file determines the sorting order
2616(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2617is sorted before 1.0-rcXX). The sorting order between different
2618suffixes is undefined if they are in multiple config files.
2619
2620web.browser::
2621        Specify a web browser that may be used by some commands.
2622        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2623        may use it.