Documentation / config.txton commit Merge branch 'jk/reading-packed-refs' (6cc983d)
   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
 627sequence.editor::
 628        Text editor used by `git rebase -i` for editing the rebase instruction file.
 629        The value is meant to be interpreted by the shell when it is used.
 630        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 631        When not configured the default commit message editor is used instead.
 632
 633core.pager::
 634        Text viewer for use by Git commands (e.g., 'less').  The value
 635        is meant to be interpreted by the shell.  The order of preference
 636        is the `$GIT_PAGER` environment variable, then `core.pager`
 637        configuration, then `$PAGER`, and then the default chosen at
 638        compile time (usually 'less').
 639+
 640When the `LESS` environment variable is unset, Git sets it to `FRX`
 641(if `LESS` environment variable is set, Git does not change it at
 642all).  If you want to selectively override Git's default setting
 643for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
 644be passed to the shell by Git, which will translate the final
 645command to `LESS=FRX less -S`. The environment does not set the
 646`S` option but the command line does, instructing less to truncate
 647long lines. Similarly, setting `core.pager` to `less -+F` will
 648deactivate the `F` option specified by the environment from the
 649command-line, deactivating the "quit if one screen" behavior of
 650`less`.  One can specifically activate some flags for particular
 651commands: for example, setting `pager.blame` to `less -S` enables
 652line truncation only for `git blame`.
 653+
 654Likewise, when the `LV` environment variable is unset, Git sets it
 655to `-c`.  You can override this setting by exporting `LV` with
 656another value or setting `core.pager` to `lv +c`.
 657
 658core.whitespace::
 659        A comma separated list of common whitespace problems to
 660        notice.  'git diff' will use `color.diff.whitespace` to
 661        highlight them, and 'git apply --whitespace=error' will
 662        consider them as errors.  You can prefix `-` to disable
 663        any of them (e.g. `-trailing-space`):
 664+
 665* `blank-at-eol` treats trailing whitespaces at the end of the line
 666  as an error (enabled by default).
 667* `space-before-tab` treats a space character that appears immediately
 668  before a tab character in the initial indent part of the line as an
 669  error (enabled by default).
 670* `indent-with-non-tab` treats a line that is indented with space
 671  characters instead of the equivalent tabs as an error (not enabled by
 672  default).
 673* `tab-in-indent` treats a tab character in the initial indent part of
 674  the line as an error (not enabled by default).
 675* `blank-at-eof` treats blank lines added at the end of file as an error
 676  (enabled by default).
 677* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 678  `blank-at-eof`.
 679* `cr-at-eol` treats a carriage-return at the end of line as
 680  part of the line terminator, i.e. with it, `trailing-space`
 681  does not trigger if the character before such a carriage-return
 682  is not a whitespace (not enabled by default).
 683* `tabwidth=<n>` tells how many character positions a tab occupies; this
 684  is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
 685  errors. The default tab width is 8. Allowed values are 1 to 63.
 686
 687core.fsyncObjectFiles::
 688        This boolean will enable 'fsync()' when writing object files.
 689+
 690This is a total waste of time and effort on a filesystem that orders
 691data writes properly, but can be useful for filesystems that do not use
 692journalling (traditional UNIX filesystems) or that only journal metadata
 693and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 694
 695core.preloadIndex::
 696        Enable parallel index preload for operations like 'git diff'
 697+
 698This can speed up operations like 'git diff' and 'git status' especially
 699on filesystems like NFS that have weak caching semantics and thus
 700relatively high IO latencies.  When enabled, Git will do the
 701index comparison to the filesystem data in parallel, allowing
 702overlapping IO's.  Defaults to true.
 703
 704core.createObject::
 705        You can set this to 'link', in which case a hardlink followed by
 706        a delete of the source are used to make sure that object creation
 707        will not overwrite existing objects.
 708+
 709On some file system/operating system combinations, this is unreliable.
 710Set this config setting to 'rename' there; However, This will remove the
 711check that makes sure that existing object files will not get overwritten.
 712
 713core.notesRef::
 714        When showing commit messages, also show notes which are stored in
 715        the given ref.  The ref must be fully qualified.  If the given
 716        ref does not exist, it is not an error but means that no
 717        notes should be printed.
 718+
 719This setting defaults to "refs/notes/commits", and it can be overridden by
 720the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
 721
 722core.sparseCheckout::
 723        Enable "sparse checkout" feature. See section "Sparse checkout" in
 724        linkgit:git-read-tree[1] for more information.
 725
 726core.abbrev::
 727        Set the length object names are abbreviated to.  If unspecified,
 728        many commands abbreviate to 7 hexdigits, which may not be enough
 729        for abbreviated object names to stay unique for sufficiently long
 730        time.
 731
 732add.ignoreErrors::
 733add.ignore-errors (deprecated)::
 734        Tells 'git add' to continue adding files when some files cannot be
 735        added due to indexing errors. Equivalent to the '--ignore-errors'
 736        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 737        as it does not follow the usual naming convention for configuration
 738        variables.
 739
 740alias.*::
 741        Command aliases for the linkgit:git[1] command wrapper - e.g.
 742        after defining "alias.last = cat-file commit HEAD", the invocation
 743        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 744        confusion and troubles with script usage, aliases that
 745        hide existing Git commands are ignored. Arguments are split by
 746        spaces, the usual shell quoting and escaping is supported.
 747        A quote pair or a backslash can be used to quote them.
 748+
 749If the alias expansion is prefixed with an exclamation point,
 750it will be treated as a shell command.  For example, defining
 751"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 752"git new" is equivalent to running the shell command
 753"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 754executed from the top-level directory of a repository, which may
 755not necessarily be the current directory.
 756'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
 757from the original current directory. See linkgit:git-rev-parse[1].
 758
 759am.keepcr::
 760        If true, git-am will call git-mailsplit for patches in mbox format
 761        with parameter '--keep-cr'. In this case git-mailsplit will
 762        not remove `\r` from lines ending with `\r\n`. Can be overridden
 763        by giving '--no-keep-cr' from the command line.
 764        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 765
 766apply.ignoreWhitespace::
 767        When set to 'change', tells 'git apply' to ignore changes in
 768        whitespace, in the same way as the '--ignore-space-change'
 769        option.
 770        When set to one of: no, none, never, false tells 'git apply' to
 771        respect all whitespace differences.
 772        See linkgit:git-apply[1].
 773
 774apply.whitespace::
 775        Tells 'git apply' how to handle whitespaces, in the same way
 776        as the '--whitespace' option. See linkgit:git-apply[1].
 777
 778branch.autoSetupMerge::
 779        Tells 'git branch' and 'git checkout' to set up new branches
 780        so that linkgit:git-pull[1] will appropriately merge from the
 781        starting point branch. Note that even if this option is not set,
 782        this behavior can be chosen per-branch using the `--track`
 783        and `--no-track` options. The valid settings are: `false` -- no
 784        automatic setup is done; `true` -- automatic setup is done when the
 785        starting point is a remote-tracking branch; `always` --
 786        automatic setup is done when the starting point is either a
 787        local branch or remote-tracking
 788        branch. This option defaults to true.
 789
 790branch.autoSetupRebase::
 791        When a new branch is created with 'git branch' or 'git checkout'
 792        that tracks another branch, this variable tells Git to set
 793        up pull to rebase instead of merge (see "branch.<name>.rebase").
 794        When `never`, rebase is never automatically set to true.
 795        When `local`, rebase is set to true for tracked branches of
 796        other local branches.
 797        When `remote`, rebase is set to true for tracked branches of
 798        remote-tracking branches.
 799        When `always`, rebase will be set to true for all tracking
 800        branches.
 801        See "branch.autoSetupMerge" for details on how to set up a
 802        branch to track another branch.
 803        This option defaults to never.
 804
 805branch.<name>.remote::
 806        When on branch <name>, it tells 'git fetch' and 'git push'
 807        which remote to fetch from/push to.  The remote to push to
 808        may be overridden with `remote.pushDefault` (for all branches).
 809        The remote to push to, for the current branch, may be further
 810        overridden by `branch.<name>.pushRemote`.  If no remote is
 811        configured, or if you are not on any branch, it defaults to
 812        `origin` for fetching and `remote.pushDefault` for pushing.
 813        Additionally, `.` (a period) is the current local repository
 814        (a dot-repository), see `branch.<name>.merge`'s final note below.
 815
 816branch.<name>.pushRemote::
 817        When on branch <name>, it overrides `branch.<name>.remote` for
 818        pushing.  It also overrides `remote.pushDefault` for pushing
 819        from branch <name>.  When you pull from one place (e.g. your
 820        upstream) and push to another place (e.g. your own publishing
 821        repository), you would want to set `remote.pushDefault` to
 822        specify the remote to push to for all branches, and use this
 823        option to override it for a specific branch.
 824
 825branch.<name>.merge::
 826        Defines, together with branch.<name>.remote, the upstream branch
 827        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
 828        branch to merge and can also affect 'git push' (see push.default).
 829        When in branch <name>, it tells 'git fetch' the default
 830        refspec to be marked for merging in FETCH_HEAD. The value is
 831        handled like the remote part of a refspec, and must match a
 832        ref which is fetched from the remote given by
 833        "branch.<name>.remote".
 834        The merge information is used by 'git pull' (which at first calls
 835        'git fetch') to lookup the default branch for merging. Without
 836        this option, 'git pull' defaults to merge the first refspec fetched.
 837        Specify multiple values to get an octopus merge.
 838        If you wish to setup 'git pull' so that it merges into <name> from
 839        another branch in the local repository, you can point
 840        branch.<name>.merge to the desired branch, and use the relative path
 841        setting `.` (a period) for branch.<name>.remote.
 842
 843branch.<name>.mergeOptions::
 844        Sets default options for merging into branch <name>. The syntax and
 845        supported options are the same as those of linkgit:git-merge[1], but
 846        option values containing whitespace characters are currently not
 847        supported.
 848
 849branch.<name>.rebase::
 850        When true, rebase the branch <name> on top of the fetched branch,
 851        instead of merging the default branch from the default remote when
 852        "git pull" is run. See "pull.rebase" for doing this in a non
 853        branch-specific manner.
 854+
 855        When preserve, also pass `--preserve-merges` along to 'git rebase'
 856        so that locally committed merge commits will not be flattened
 857        by running 'git pull'.
 858+
 859*NOTE*: this is a possibly dangerous operation; do *not* use
 860it unless you understand the implications (see linkgit:git-rebase[1]
 861for details).
 862
 863branch.<name>.description::
 864        Branch description, can be edited with
 865        `git branch --edit-description`. Branch description is
 866        automatically added in the format-patch cover letter or
 867        request-pull summary.
 868
 869browser.<tool>.cmd::
 870        Specify the command to invoke the specified browser. The
 871        specified command is evaluated in shell with the URLs passed
 872        as arguments. (See linkgit:git-web{litdd}browse[1].)
 873
 874browser.<tool>.path::
 875        Override the path for the given tool that may be used to
 876        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 877        working repository in gitweb (see linkgit:git-instaweb[1]).
 878
 879clean.requireForce::
 880        A boolean to make git-clean do nothing unless given -f,
 881        -i or -n.   Defaults to true.
 882
 883color.branch::
 884        A boolean to enable/disable color in the output of
 885        linkgit:git-branch[1]. May be set to `always`,
 886        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 887        only when the output is to a terminal. Defaults to false.
 888
 889color.branch.<slot>::
 890        Use customized color for branch coloration. `<slot>` is one of
 891        `current` (the current branch), `local` (a local branch),
 892        `remote` (a remote-tracking branch in refs/remotes/),
 893        `upstream` (upstream tracking branch), `plain` (other
 894        refs).
 895
 896color.diff::
 897        Whether to use ANSI escape sequences to add color to patches.
 898        If this is set to `always`, linkgit:git-diff[1],
 899        linkgit:git-log[1], and linkgit:git-show[1] will use color
 900        for all patches.  If it is set to `true` or `auto`, those
 901        commands will only use color when output is to the terminal.
 902        Defaults to false.
 903+
 904This does not affect linkgit:git-format-patch[1] or the
 905'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
 906command line with the `--color[=<when>]` option.
 907
 908color.diff.<slot>::
 909        Use customized color for diff colorization.  `<slot>` specifies
 910        which part of the patch to use the specified color, and is one
 911        of `plain` (context text), `meta` (metainformation), `frag`
 912        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 913        `new` (added lines), `commit` (commit headers), or `whitespace`
 914        (highlighting whitespace errors).
 915
 916color.decorate.<slot>::
 917        Use customized color for 'git log --decorate' output.  `<slot>` is one
 918        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
 919        branches, remote-tracking branches, tags, stash and HEAD, respectively.
 920
 921color.grep::
 922        When set to `always`, always highlight matches.  When `false` (or
 923        `never`), never.  When set to `true` or `auto`, use color only
 924        when the output is written to the terminal.  Defaults to `false`.
 925
 926color.grep.<slot>::
 927        Use customized color for grep colorization.  `<slot>` specifies which
 928        part of the line to use the specified color, and is one of
 929+
 930--
 931`context`;;
 932        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
 933`filename`;;
 934        filename prefix (when not using `-h`)
 935`function`;;
 936        function name lines (when using `-p`)
 937`linenumber`;;
 938        line number prefix (when using `-n`)
 939`match`;;
 940        matching text (same as setting `matchContext` and `matchSelected`)
 941`matchContext`;;
 942        matching text in context lines
 943`matchSelected`;;
 944        matching text in selected lines
 945`selected`;;
 946        non-matching text in selected lines
 947`separator`;;
 948        separators between fields on a line (`:`, `-`, and `=`)
 949        and between hunks (`--`)
 950--
 951
 952color.interactive::
 953        When set to `always`, always use colors for interactive prompts
 954        and displays (such as those used by "git-add --interactive" and
 955        "git-clean --interactive"). When false (or `never`), never.
 956        When set to `true` or `auto`, use colors only when the output is
 957        to the terminal. Defaults to false.
 958
 959color.interactive.<slot>::
 960        Use customized color for 'git add --interactive' and 'git clean
 961        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
 962        or `error`, for four distinct types of normal output from
 963        interactive commands.
 964
 965color.pager::
 966        A boolean to enable/disable colored output when the pager is in
 967        use (default is true).
 968
 969color.showBranch::
 970        A boolean to enable/disable color in the output of
 971        linkgit:git-show-branch[1]. May be set to `always`,
 972        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 973        only when the output is to a terminal. Defaults to false.
 974
 975color.status::
 976        A boolean to enable/disable color in the output of
 977        linkgit:git-status[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.<slot>::
 982        Use customized color for status colorization. `<slot>` is
 983        one of `header` (the header text of the status message),
 984        `added` or `updated` (files which are added but not committed),
 985        `changed` (files which are changed but not added in the index),
 986        `untracked` (files which are not tracked by Git),
 987        `branch` (the current branch),
 988        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 989        to red), or
 990        `unmerged` (files which have unmerged changes).
 991
 992color.ui::
 993        This variable determines the default value for variables such
 994        as `color.diff` and `color.grep` that control the use of color
 995        per command family. Its scope will expand as more commands learn
 996        configuration to set a default for the `--color` option.  Set it
 997        to `false` or `never` if you prefer Git commands not to use
 998        color unless enabled explicitly with some other configuration
 999        or the `--color` option. Set it to `always` if you want all
1000        output not intended for machine consumption to use color, to
1001        `true` or `auto` (this is the default since Git 1.8.4) if you
1002        want such output to use color when written to the terminal.
1003
1004column.ui::
1005        Specify whether supported commands should output in columns.
1006        This variable consists of a list of tokens separated by spaces
1007        or commas:
1008+
1009These options control when the feature should be enabled
1010(defaults to 'never'):
1011+
1012--
1013`always`;;
1014        always show in columns
1015`never`;;
1016        never show in columns
1017`auto`;;
1018        show in columns if the output is to the terminal
1019--
1020+
1021These options control layout (defaults to 'column').  Setting any
1022of these implies 'always' if none of 'always', 'never', or 'auto' are
1023specified.
1024+
1025--
1026`column`;;
1027        fill columns before rows
1028`row`;;
1029        fill rows before columns
1030`plain`;;
1031        show in one column
1032--
1033+
1034Finally, these options can be combined with a layout option (defaults
1035to 'nodense'):
1036+
1037--
1038`dense`;;
1039        make unequal size columns to utilize more space
1040`nodense`;;
1041        make equal size columns
1042--
1043
1044column.branch::
1045        Specify whether to output branch listing in `git branch` in columns.
1046        See `column.ui` for details.
1047
1048column.clean::
1049        Specify the layout when list items in `git clean -i`, which always
1050        shows files and directories in columns. See `column.ui` for details.
1051
1052column.status::
1053        Specify whether to output untracked files in `git status` in columns.
1054        See `column.ui` for details.
1055
1056column.tag::
1057        Specify whether to output tag listing in `git tag` in columns.
1058        See `column.ui` for details.
1059
1060commit.cleanup::
1061        This setting overrides the default of the `--cleanup` option in
1062        `git commit`. See linkgit:git-commit[1] for details. Changing the
1063        default can be useful when you always want to keep lines that begin
1064        with comment character `#` in your log message, in which case you
1065        would do `git config commit.cleanup whitespace` (note that you will
1066        have to remove the help lines that begin with `#` in the commit log
1067        template yourself, if you do this).
1068
1069commit.gpgSign::
1070
1071        A boolean to specify whether all commits should be GPG signed.
1072        Use of this option when doing operations such as rebase can
1073        result in a large number of commits being signed. It may be
1074        convenient to use an agent to avoid typing your GPG passphrase
1075        several times.
1076
1077commit.status::
1078        A boolean to enable/disable inclusion of status information in the
1079        commit message template when using an editor to prepare the commit
1080        message.  Defaults to true.
1081
1082commit.template::
1083        Specify a file to use as the template for new commit messages.
1084        "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1085        specified user's home directory.
1086
1087credential.helper::
1088        Specify an external helper to be called when a username or
1089        password credential is needed; the helper may consult external
1090        storage to avoid prompting the user for the credentials. See
1091        linkgit:gitcredentials[7] for details.
1092
1093credential.useHttpPath::
1094        When acquiring credentials, consider the "path" component of an http
1095        or https URL to be important. Defaults to false. See
1096        linkgit:gitcredentials[7] for more information.
1097
1098credential.username::
1099        If no username is set for a network authentication, use this username
1100        by default. See credential.<context>.* below, and
1101        linkgit:gitcredentials[7].
1102
1103credential.<url>.*::
1104        Any of the credential.* options above can be applied selectively to
1105        some credentials. For example "credential.https://example.com.username"
1106        would set the default username only for https connections to
1107        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1108        matched.
1109
1110include::diff-config.txt[]
1111
1112difftool.<tool>.path::
1113        Override the path for the given tool.  This is useful in case
1114        your tool is not in the PATH.
1115
1116difftool.<tool>.cmd::
1117        Specify the command to invoke the specified diff tool.
1118        The specified command is evaluated in shell with the following
1119        variables available:  'LOCAL' is set to the name of the temporary
1120        file containing the contents of the diff pre-image and 'REMOTE'
1121        is set to the name of the temporary file containing the contents
1122        of the diff post-image.
1123
1124difftool.prompt::
1125        Prompt before each invocation of the diff tool.
1126
1127fetch.recurseSubmodules::
1128        This option can be either set to a boolean value or to 'on-demand'.
1129        Setting it to a boolean changes the behavior of fetch and pull to
1130        unconditionally recurse into submodules when set to true or to not
1131        recurse at all when set to false. When set to 'on-demand' (the default
1132        value), fetch and pull will only recurse into a populated submodule
1133        when its superproject retrieves a commit that updates the submodule's
1134        reference.
1135
1136fetch.fsckObjects::
1137        If it is set to true, git-fetch-pack will check all fetched
1138        objects. It will abort in the case of a malformed object or a
1139        broken link. The result of an abort are only dangling objects.
1140        Defaults to false. If not set, the value of `transfer.fsckObjects`
1141        is used instead.
1142
1143fetch.unpackLimit::
1144        If the number of objects fetched over the Git native
1145        transfer is below this
1146        limit, then the objects will be unpacked into loose object
1147        files. However if the number of received objects equals or
1148        exceeds this limit then the received pack will be stored as
1149        a pack, after adding any missing delta bases.  Storing the
1150        pack from a push can make the push operation complete faster,
1151        especially on slow filesystems.  If not set, the value of
1152        `transfer.unpackLimit` is used instead.
1153
1154fetch.prune::
1155        If true, fetch will automatically behave as if the `--prune`
1156        option was given on the command line.  See also `remote.<name>.prune`.
1157
1158format.attach::
1159        Enable multipart/mixed attachments as the default for
1160        'format-patch'.  The value can also be a double quoted string
1161        which will enable attachments as the default and set the
1162        value as the boundary.  See the --attach option in
1163        linkgit:git-format-patch[1].
1164
1165format.numbered::
1166        A boolean which can enable or disable sequence numbers in patch
1167        subjects.  It defaults to "auto" which enables it only if there
1168        is more than one patch.  It can be enabled or disabled for all
1169        messages by setting it to "true" or "false".  See --numbered
1170        option in linkgit:git-format-patch[1].
1171
1172format.headers::
1173        Additional email headers to include in a patch to be submitted
1174        by mail.  See linkgit:git-format-patch[1].
1175
1176format.to::
1177format.cc::
1178        Additional recipients to include in a patch to be submitted
1179        by mail.  See the --to and --cc options in
1180        linkgit:git-format-patch[1].
1181
1182format.subjectPrefix::
1183        The default for format-patch is to output files with the '[PATCH]'
1184        subject prefix. Use this variable to change that prefix.
1185
1186format.signature::
1187        The default for format-patch is to output a signature containing
1188        the Git version number. Use this variable to change that default.
1189        Set this variable to the empty string ("") to suppress
1190        signature generation.
1191
1192format.signatureFile::
1193        Works just like format.signature except the contents of the
1194        file specified by this variable will be used as the signature.
1195
1196format.suffix::
1197        The default for format-patch is to output files with the suffix
1198        `.patch`. Use this variable to change that suffix (make sure to
1199        include the dot if you want it).
1200
1201format.pretty::
1202        The default pretty format for log/show/whatchanged command,
1203        See linkgit:git-log[1], linkgit:git-show[1],
1204        linkgit:git-whatchanged[1].
1205
1206format.thread::
1207        The default threading style for 'git format-patch'.  Can be
1208        a boolean value, or `shallow` or `deep`.  `shallow` threading
1209        makes every mail a reply to the head of the series,
1210        where the head is chosen from the cover letter, the
1211        `--in-reply-to`, and the first patch mail, in this order.
1212        `deep` threading makes every mail a reply to the previous one.
1213        A true boolean value is the same as `shallow`, and a false
1214        value disables threading.
1215
1216format.signOff::
1217        A boolean value which lets you enable the `-s/--signoff` option of
1218        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1219        patch should be a conscious act and means that you certify you have
1220        the rights to submit this work under the same open source license.
1221        Please see the 'SubmittingPatches' document for further discussion.
1222
1223format.coverLetter::
1224        A boolean that controls whether to generate a cover-letter when
1225        format-patch is invoked, but in addition can be set to "auto", to
1226        generate a cover-letter only when there's more than one patch.
1227
1228filter.<driver>.clean::
1229        The command which is used to convert the content of a worktree
1230        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1231        details.
1232
1233filter.<driver>.smudge::
1234        The command which is used to convert the content of a blob
1235        object to a worktree file upon checkout.  See
1236        linkgit:gitattributes[5] for details.
1237
1238gc.aggressiveDepth::
1239        The depth parameter used in the delta compression
1240        algorithm used by 'git gc --aggressive'.  This defaults
1241        to 250.
1242
1243gc.aggressiveWindow::
1244        The window size parameter used in the delta compression
1245        algorithm used by 'git gc --aggressive'.  This defaults
1246        to 250.
1247
1248gc.auto::
1249        When there are approximately more than this many loose
1250        objects in the repository, `git gc --auto` will pack them.
1251        Some Porcelain commands use this command to perform a
1252        light-weight garbage collection from time to time.  The
1253        default value is 6700.  Setting this to 0 disables it.
1254
1255gc.autoPackLimit::
1256        When there are more than this many packs that are not
1257        marked with `*.keep` file in the repository, `git gc
1258        --auto` consolidates them into one larger pack.  The
1259        default value is 50.  Setting this to 0 disables it.
1260
1261gc.autoDetach::
1262        Make `git gc --auto` return immediately and run in background
1263        if the system supports it. Default is true.
1264
1265gc.packRefs::
1266        Running `git pack-refs` in a repository renders it
1267        unclonable by Git versions prior to 1.5.1.2 over dumb
1268        transports such as HTTP.  This variable determines whether
1269        'git gc' runs `git pack-refs`. This can be set to `notbare`
1270        to enable it within all non-bare repos or it can be set to a
1271        boolean value.  The default is `true`.
1272
1273gc.pruneExpire::
1274        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1275        Override the grace period with this config variable.  The value
1276        "now" may be used to disable this  grace period and always prune
1277        unreachable objects immediately.
1278
1279gc.pruneWorktreesExpire::
1280        When 'git gc' is run, it will call
1281        'prune --worktrees --expire 3.months.ago'.
1282        Override the grace period with this config variable. The value
1283        "now" may be used to disable the grace period and prune
1284        $GIT_DIR/worktrees immediately.
1285
1286gc.reflogExpire::
1287gc.<pattern>.reflogExpire::
1288        'git reflog expire' removes reflog entries older than
1289        this time; defaults to 90 days.  With "<pattern>" (e.g.
1290        "refs/stash") in the middle the setting applies only to
1291        the refs that match the <pattern>.
1292
1293gc.reflogExpireUnreachable::
1294gc.<ref>.reflogExpireUnreachable::
1295        'git reflog expire' removes reflog entries older than
1296        this time and are not reachable from the current tip;
1297        defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1298        in the middle, the setting applies only to the refs that
1299        match the <pattern>.
1300
1301gc.rerereResolved::
1302        Records of conflicted merge you resolved earlier are
1303        kept for this many days when 'git rerere gc' is run.
1304        The default is 60 days.  See linkgit:git-rerere[1].
1305
1306gc.rerereUnresolved::
1307        Records of conflicted merge you have not resolved are
1308        kept for this many days when 'git rerere gc' is run.
1309        The default is 15 days.  See linkgit:git-rerere[1].
1310
1311gitcvs.commitMsgAnnotation::
1312        Append this string to each commit message. Set to empty string
1313        to disable this feature. Defaults to "via git-CVS emulator".
1314
1315gitcvs.enabled::
1316        Whether the CVS server interface is enabled for this repository.
1317        See linkgit:git-cvsserver[1].
1318
1319gitcvs.logFile::
1320        Path to a log file where the CVS server interface well... logs
1321        various stuff. See linkgit:git-cvsserver[1].
1322
1323gitcvs.usecrlfattr::
1324        If true, the server will look up the end-of-line conversion
1325        attributes for files to determine the '-k' modes to use. If
1326        the attributes force Git to treat a file as text,
1327        the '-k' mode will be left blank so CVS clients will
1328        treat it as text. If they suppress text conversion, the file
1329        will be set with '-kb' mode, which suppresses any newline munging
1330        the client might otherwise do. If the attributes do not allow
1331        the file type to be determined, then 'gitcvs.allBinary' is
1332        used. See linkgit:gitattributes[5].
1333
1334gitcvs.allBinary::
1335        This is used if 'gitcvs.usecrlfattr' does not resolve
1336        the correct '-kb' mode to use. If true, all
1337        unresolved files are sent to the client in
1338        mode '-kb'. This causes the client to treat them
1339        as binary files, which suppresses any newline munging it
1340        otherwise might do. Alternatively, if it is set to "guess",
1341        then the contents of the file are examined to decide if
1342        it is binary, similar to 'core.autocrlf'.
1343
1344gitcvs.dbName::
1345        Database used by git-cvsserver to cache revision information
1346        derived from the Git repository. The exact meaning depends on the
1347        used database driver, for SQLite (which is the default driver) this
1348        is a filename. Supports variable substitution (see
1349        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1350        Default: '%Ggitcvs.%m.sqlite'
1351
1352gitcvs.dbDriver::
1353        Used Perl DBI driver. You can specify any available driver
1354        for this here, but it might not work. git-cvsserver is tested
1355        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1356        reported *not* to work with 'DBD::mysql'. Experimental feature.
1357        May not contain double colons (`:`). Default: 'SQLite'.
1358        See linkgit:git-cvsserver[1].
1359
1360gitcvs.dbUser, gitcvs.dbPass::
1361        Database user and password. Only useful if setting 'gitcvs.dbDriver',
1362        since SQLite has no concept of database users and/or passwords.
1363        'gitcvs.dbUser' supports variable substitution (see
1364        linkgit:git-cvsserver[1] for details).
1365
1366gitcvs.dbTableNamePrefix::
1367        Database table name prefix.  Prepended to the names of any
1368        database tables used, allowing a single database to be used
1369        for several repositories.  Supports variable substitution (see
1370        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1371        characters will be replaced with underscores.
1372
1373All gitcvs variables except for 'gitcvs.usecrlfattr' and
1374'gitcvs.allBinary' can also be specified as
1375'gitcvs.<access_method>.<varname>' (where 'access_method'
1376is one of "ext" and "pserver") to make them apply only for the given
1377access method.
1378
1379gitweb.category::
1380gitweb.description::
1381gitweb.owner::
1382gitweb.url::
1383        See linkgit:gitweb[1] for description.
1384
1385gitweb.avatar::
1386gitweb.blame::
1387gitweb.grep::
1388gitweb.highlight::
1389gitweb.patches::
1390gitweb.pickaxe::
1391gitweb.remote_heads::
1392gitweb.showSizes::
1393gitweb.snapshot::
1394        See linkgit:gitweb.conf[5] for description.
1395
1396grep.lineNumber::
1397        If set to true, enable '-n' option by default.
1398
1399grep.patternType::
1400        Set the default matching behavior. Using a value of 'basic', 'extended',
1401        'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1402        '--fixed-strings', or '--perl-regexp' option accordingly, while the
1403        value 'default' will return to the default matching behavior.
1404
1405grep.extendedRegexp::
1406        If set to true, enable '--extended-regexp' option by default. This
1407        option is ignored when the 'grep.patternType' option is set to a value
1408        other than 'default'.
1409
1410gpg.program::
1411        Use this custom program instead of "gpg" found on $PATH when
1412        making or verifying a PGP signature. The program must support the
1413        same command-line interface as GPG, namely, to verify a detached
1414        signature, "gpg --verify $file - <$signature" is run, and the
1415        program is expected to signal a good signature by exiting with
1416        code 0, and to generate an ASCII-armored detached signature, the
1417        standard input of "gpg -bsau $key" is fed with the contents to be
1418        signed, and the program is expected to send the result to its
1419        standard output.
1420
1421gui.commitMsgWidth::
1422        Defines how wide the commit message window is in the
1423        linkgit:git-gui[1]. "75" is the default.
1424
1425gui.diffContext::
1426        Specifies how many context lines should be used in calls to diff
1427        made by the linkgit:git-gui[1]. The default is "5".
1428
1429gui.displayUntracked::
1430        Determines if linkgit::git-gui[1] shows untracked files
1431        in the file list. The default is "true".
1432
1433gui.encoding::
1434        Specifies the default encoding to use for displaying of
1435        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1436        It can be overridden by setting the 'encoding' attribute
1437        for relevant files (see linkgit:gitattributes[5]).
1438        If this option is not set, the tools default to the
1439        locale encoding.
1440
1441gui.matchTrackingBranch::
1442        Determines if new branches created with linkgit:git-gui[1] should
1443        default to tracking remote branches with matching names or
1444        not. Default: "false".
1445
1446gui.newBranchTemplate::
1447        Is used as suggested name when creating new branches using the
1448        linkgit:git-gui[1].
1449
1450gui.pruneDuringFetch::
1451        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1452        performing a fetch. The default value is "false".
1453
1454gui.trustmtime::
1455        Determines if linkgit:git-gui[1] should trust the file modification
1456        timestamp or not. By default the timestamps are not trusted.
1457
1458gui.spellingDictionary::
1459        Specifies the dictionary used for spell checking commit messages in
1460        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1461        off.
1462
1463gui.fastCopyBlame::
1464        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1465        location detection. It makes blame significantly faster on huge
1466        repositories at the expense of less thorough copy detection.
1467
1468gui.copyBlameThreshold::
1469        Specifies the threshold to use in 'git gui blame' original location
1470        detection, measured in alphanumeric characters. See the
1471        linkgit:git-blame[1] manual for more information on copy detection.
1472
1473gui.blamehistoryctx::
1474        Specifies the radius of history context in days to show in
1475        linkgit:gitk[1] for the selected commit, when the `Show History
1476        Context` menu item is invoked from 'git gui blame'. If this
1477        variable is set to zero, the whole history is shown.
1478
1479guitool.<name>.cmd::
1480        Specifies the shell command line to execute when the corresponding item
1481        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1482        mandatory for every tool. The command is executed from the root of
1483        the working directory, and in the environment it receives the name of
1484        the tool as 'GIT_GUITOOL', the name of the currently selected file as
1485        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1486        the head is detached, 'CUR_BRANCH' is empty).
1487
1488guitool.<name>.needsFile::
1489        Run the tool only if a diff is selected in the GUI. It guarantees
1490        that 'FILENAME' is not empty.
1491
1492guitool.<name>.noConsole::
1493        Run the command silently, without creating a window to display its
1494        output.
1495
1496guitool.<name>.noRescan::
1497        Don't rescan the working directory for changes after the tool
1498        finishes execution.
1499
1500guitool.<name>.confirm::
1501        Show a confirmation dialog before actually running the tool.
1502
1503guitool.<name>.argPrompt::
1504        Request a string argument from the user, and pass it to the tool
1505        through the 'ARGS' environment variable. Since requesting an
1506        argument implies confirmation, the 'confirm' option has no effect
1507        if this is enabled. If the option is set to 'true', 'yes', or '1',
1508        the dialog uses a built-in generic prompt; otherwise the exact
1509        value of the variable is used.
1510
1511guitool.<name>.revPrompt::
1512        Request a single valid revision from the user, and set the
1513        'REVISION' environment variable. In other aspects this option
1514        is similar to 'argPrompt', and can be used together with it.
1515
1516guitool.<name>.revUnmerged::
1517        Show only unmerged branches in the 'revPrompt' subdialog.
1518        This is useful for tools similar to merge or rebase, but not
1519        for things like checkout or reset.
1520
1521guitool.<name>.title::
1522        Specifies the title to use for the prompt dialog. The default
1523        is the tool name.
1524
1525guitool.<name>.prompt::
1526        Specifies the general prompt string to display at the top of
1527        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1528        The default value includes the actual command.
1529
1530help.browser::
1531        Specify the browser that will be used to display help in the
1532        'web' format. See linkgit:git-help[1].
1533
1534help.format::
1535        Override the default help format used by linkgit:git-help[1].
1536        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1537        the default. 'web' and 'html' are the same.
1538
1539help.autoCorrect::
1540        Automatically correct and execute mistyped commands after
1541        waiting for the given number of deciseconds (0.1 sec). If more
1542        than one command can be deduced from the entered text, nothing
1543        will be executed.  If the value of this option is negative,
1544        the corrected command will be executed immediately. If the
1545        value is 0 - the command will be just shown but not executed.
1546        This is the default.
1547
1548help.htmlPath::
1549        Specify the path where the HTML documentation resides. File system paths
1550        and URLs are supported. HTML pages will be prefixed with this path when
1551        help is displayed in the 'web' format. This defaults to the documentation
1552        path of your Git installation.
1553
1554http.proxy::
1555        Override the HTTP proxy, normally configured using the 'http_proxy',
1556        'https_proxy', and 'all_proxy' environment variables (see
1557        `curl(1)`).  This can be overridden on a per-remote basis; see
1558        remote.<name>.proxy
1559
1560http.cookieFile::
1561        File containing previously stored cookie lines which should be used
1562        in the Git http session, if they match the server. The file format
1563        of the file to read cookies from should be plain HTTP headers or
1564        the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1565        NOTE that the file specified with http.cookieFile is only used as
1566        input unless http.saveCookies is set.
1567
1568http.saveCookies::
1569        If set, store cookies received during requests to the file specified by
1570        http.cookieFile. Has no effect if http.cookieFile is unset.
1571
1572http.sslVerify::
1573        Whether to verify the SSL certificate when fetching or pushing
1574        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1575        variable.
1576
1577http.sslCert::
1578        File containing the SSL certificate when fetching or pushing
1579        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1580        variable.
1581
1582http.sslKey::
1583        File containing the SSL private key when fetching or pushing
1584        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1585        variable.
1586
1587http.sslCertPasswordProtected::
1588        Enable Git's password prompt for the SSL certificate.  Otherwise
1589        OpenSSL will prompt the user, possibly many times, if the
1590        certificate or private key is encrypted.  Can be overridden by the
1591        'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1592
1593http.sslCAInfo::
1594        File containing the certificates to verify the peer with when
1595        fetching or pushing over HTTPS. Can be overridden by the
1596        'GIT_SSL_CAINFO' environment variable.
1597
1598http.sslCAPath::
1599        Path containing files with the CA certificates to verify the peer
1600        with when fetching or pushing over HTTPS. Can be overridden
1601        by the 'GIT_SSL_CAPATH' environment variable.
1602
1603http.sslTry::
1604        Attempt to use AUTH SSL/TLS and encrypted data transfers
1605        when connecting via regular FTP protocol. This might be needed
1606        if the FTP server requires it for security reasons or you wish
1607        to connect securely whenever remote FTP server supports it.
1608        Default is false since it might trigger certificate verification
1609        errors on misconfigured servers.
1610
1611http.maxRequests::
1612        How many HTTP requests to launch in parallel. Can be overridden
1613        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1614
1615http.minSessions::
1616        The number of curl sessions (counted across slots) to be kept across
1617        requests. They will not be ended with curl_easy_cleanup() until
1618        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1619        value will be capped at 1. Defaults to 1.
1620
1621http.postBuffer::
1622        Maximum size in bytes of the buffer used by smart HTTP
1623        transports when POSTing data to the remote system.
1624        For requests larger than this buffer size, HTTP/1.1 and
1625        Transfer-Encoding: chunked is used to avoid creating a
1626        massive pack file locally.  Default is 1 MiB, which is
1627        sufficient for most requests.
1628
1629http.lowSpeedLimit, http.lowSpeedTime::
1630        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1631        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1632        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1633        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1634
1635http.noEPSV::
1636        A boolean which disables using of EPSV ftp command by curl.
1637        This can helpful with some "poor" ftp servers which don't
1638        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1639        environment variable. Default is false (curl will use EPSV).
1640
1641http.userAgent::
1642        The HTTP USER_AGENT string presented to an HTTP server.  The default
1643        value represents the version of the client Git such as git/1.7.1.
1644        This option allows you to override this value to a more common value
1645        such as Mozilla/4.0.  This may be necessary, for instance, if
1646        connecting through a firewall that restricts HTTP connections to a set
1647        of common USER_AGENT strings (but not including those like git/1.7.1).
1648        Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1649
1650http.<url>.*::
1651        Any of the http.* options above can be applied selectively to some URLs.
1652        For a config key to match a URL, each element of the config key is
1653        compared to that of the URL, in the following order:
1654+
1655--
1656. Scheme (e.g., `https` in `https://example.com/`). This field
1657  must match exactly between the config key and the URL.
1658
1659. Host/domain name (e.g., `example.com` in `https://example.com/`).
1660  This field must match exactly between the config key and the URL.
1661
1662. Port number (e.g., `8080` in `http://example.com:8080/`).
1663  This field must match exactly between the config key and the URL.
1664  Omitted port numbers are automatically converted to the correct
1665  default for the scheme before matching.
1666
1667. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1668  path field of the config key must match the path field of the URL
1669  either exactly or as a prefix of slash-delimited path elements.  This means
1670  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1671  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1672  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1673  key with just path `foo/`).
1674
1675. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1676  the config key has a user name it must match the user name in the
1677  URL exactly. If the config key does not have a user name, that
1678  config key will match a URL with any user name (including none),
1679  but at a lower precedence than a config key with a user name.
1680--
1681+
1682The list above is ordered by decreasing precedence; a URL that matches
1683a config key's path is preferred to one that matches its user name. For example,
1684if the URL is `https://user@example.com/foo/bar` a config key match of
1685`https://example.com/foo` will be preferred over a config key match of
1686`https://user@example.com`.
1687+
1688All URLs are normalized before attempting any matching (the password part,
1689if embedded in the URL, is always ignored for matching purposes) so that
1690equivalent URLs that are simply spelled differently will match properly.
1691Environment variable settings always override any matches.  The URLs that are
1692matched against are those given directly to Git commands.  This means any URLs
1693visited as a result of a redirection do not participate in matching.
1694
1695i18n.commitEncoding::
1696        Character encoding the commit messages are stored in; Git itself
1697        does not care per se, but this information is necessary e.g. when
1698        importing commits from emails or in the gitk graphical history
1699        browser (and possibly at other places in the future or in other
1700        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1701
1702i18n.logOutputEncoding::
1703        Character encoding the commit messages are converted to when
1704        running 'git log' and friends.
1705
1706imap::
1707        The configuration variables in the 'imap' section are described
1708        in linkgit:git-imap-send[1].
1709
1710index.version::
1711        Specify the version with which new index files should be
1712        initialized.  This does not affect existing repositories.
1713
1714init.templateDir::
1715        Specify the directory from which templates will be copied.
1716        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1717
1718instaweb.browser::
1719        Specify the program that will be used to browse your working
1720        repository in gitweb. See linkgit:git-instaweb[1].
1721
1722instaweb.httpd::
1723        The HTTP daemon command-line to start gitweb on your working
1724        repository. See linkgit:git-instaweb[1].
1725
1726instaweb.local::
1727        If true the web server started by linkgit:git-instaweb[1] will
1728        be bound to the local IP (127.0.0.1).
1729
1730instaweb.modulePath::
1731        The default module path for linkgit:git-instaweb[1] to use
1732        instead of /usr/lib/apache2/modules.  Only used if httpd
1733        is Apache.
1734
1735instaweb.port::
1736        The port number to bind the gitweb httpd to. See
1737        linkgit:git-instaweb[1].
1738
1739interactive.singleKey::
1740        In interactive commands, allow the user to provide one-letter
1741        input with a single key (i.e., without hitting enter).
1742        Currently this is used by the `--patch` mode of
1743        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1744        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1745        setting is silently ignored if portable keystroke input
1746        is not available; requires the Perl module Term::ReadKey.
1747
1748log.abbrevCommit::
1749        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1750        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1751        override this option with `--no-abbrev-commit`.
1752
1753log.date::
1754        Set the default date-time mode for the 'log' command.
1755        Setting a value for log.date is similar to using 'git log''s
1756        `--date` option.  Possible values are `relative`, `local`,
1757        `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1758        for details.
1759
1760log.decorate::
1761        Print out the ref names of any commits that are shown by the log
1762        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1763        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1764        specified, the full ref name (including prefix) will be printed.
1765        This is the same as the log commands '--decorate' option.
1766
1767log.showRoot::
1768        If true, the initial commit will be shown as a big creation event.
1769        This is equivalent to a diff against an empty tree.
1770        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1771        normally hide the root commit will now show it. True by default.
1772
1773log.mailmap::
1774        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1775        linkgit:git-whatchanged[1] assume `--use-mailmap`.
1776
1777mailinfo.scissors::
1778        If true, makes linkgit:git-mailinfo[1] (and therefore
1779        linkgit:git-am[1]) act by default as if the --scissors option
1780        was provided on the command-line. When active, this features
1781        removes everything from the message body before a scissors
1782        line (i.e. consisting mainly of ">8", "8<" and "-").
1783
1784mailmap.file::
1785        The location of an augmenting mailmap file. The default
1786        mailmap, located in the root of the repository, is loaded
1787        first, then the mailmap file pointed to by this variable.
1788        The location of the mailmap file may be in a repository
1789        subdirectory, or somewhere outside of the repository itself.
1790        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1791
1792mailmap.blob::
1793        Like `mailmap.file`, but consider the value as a reference to a
1794        blob in the repository. If both `mailmap.file` and
1795        `mailmap.blob` are given, both are parsed, with entries from
1796        `mailmap.file` taking precedence. In a bare repository, this
1797        defaults to `HEAD:.mailmap`. In a non-bare repository, it
1798        defaults to empty.
1799
1800man.viewer::
1801        Specify the programs that may be used to display help in the
1802        'man' format. See linkgit:git-help[1].
1803
1804man.<tool>.cmd::
1805        Specify the command to invoke the specified man viewer. The
1806        specified command is evaluated in shell with the man page
1807        passed as argument. (See linkgit:git-help[1].)
1808
1809man.<tool>.path::
1810        Override the path for the given tool that may be used to
1811        display help in the 'man' format. See linkgit:git-help[1].
1812
1813include::merge-config.txt[]
1814
1815mergetool.<tool>.path::
1816        Override the path for the given tool.  This is useful in case
1817        your tool is not in the PATH.
1818
1819mergetool.<tool>.cmd::
1820        Specify the command to invoke the specified merge tool.  The
1821        specified command is evaluated in shell with the following
1822        variables available: 'BASE' is the name of a temporary file
1823        containing the common base of the files to be merged, if available;
1824        'LOCAL' is the name of a temporary file containing the contents of
1825        the file on the current branch; 'REMOTE' is the name of a temporary
1826        file containing the contents of the file from the branch being
1827        merged; 'MERGED' contains the name of the file to which the merge
1828        tool should write the results of a successful merge.
1829
1830mergetool.<tool>.trustExitCode::
1831        For a custom merge command, specify whether the exit code of
1832        the merge command can be used to determine whether the merge was
1833        successful.  If this is not set to true then the merge target file
1834        timestamp is checked and the merge assumed to have been successful
1835        if the file has been updated, otherwise the user is prompted to
1836        indicate the success of the merge.
1837
1838mergetool.meld.hasOutput::
1839        Older versions of `meld` do not support the `--output` option.
1840        Git will attempt to detect whether `meld` supports `--output`
1841        by inspecting the output of `meld --help`.  Configuring
1842        `mergetool.meld.hasOutput` will make Git skip these checks and
1843        use the configured value instead.  Setting `mergetool.meld.hasOutput`
1844        to `true` tells Git to unconditionally use the `--output` option,
1845        and `false` avoids using `--output`.
1846
1847mergetool.keepBackup::
1848        After performing a merge, the original file with conflict markers
1849        can be saved as a file with a `.orig` extension.  If this variable
1850        is set to `false` then this file is not preserved.  Defaults to
1851        `true` (i.e. keep the backup files).
1852
1853mergetool.keepTemporaries::
1854        When invoking a custom merge tool, Git uses a set of temporary
1855        files to pass to the tool. If the tool returns an error and this
1856        variable is set to `true`, then these temporary files will be
1857        preserved, otherwise they will be removed after the tool has
1858        exited. Defaults to `false`.
1859
1860mergetool.writeToTemp::
1861        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1862        conflicting files in the worktree by default.  Git will attempt
1863        to use a temporary directory for these files when set `true`.
1864        Defaults to `false`.
1865
1866mergetool.prompt::
1867        Prompt before each invocation of the merge resolution program.
1868
1869notes.displayRef::
1870        The (fully qualified) refname from which to show notes when
1871        showing commit messages.  The value of this variable can be set
1872        to a glob, in which case notes from all matching refs will be
1873        shown.  You may also specify this configuration variable
1874        several times.  A warning will be issued for refs that do not
1875        exist, but a glob that does not match any refs is silently
1876        ignored.
1877+
1878This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1879environment variable, which must be a colon separated list of refs or
1880globs.
1881+
1882The effective value of "core.notesRef" (possibly overridden by
1883GIT_NOTES_REF) is also implicitly added to the list of refs to be
1884displayed.
1885
1886notes.rewrite.<command>::
1887        When rewriting commits with <command> (currently `amend` or
1888        `rebase`) and this variable is set to `true`, Git
1889        automatically copies your notes from the original to the
1890        rewritten commit.  Defaults to `true`, but see
1891        "notes.rewriteRef" below.
1892
1893notes.rewriteMode::
1894        When copying notes during a rewrite (see the
1895        "notes.rewrite.<command>" option), determines what to do if
1896        the target commit already has a note.  Must be one of
1897        `overwrite`, `concatenate`, or `ignore`.  Defaults to
1898        `concatenate`.
1899+
1900This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1901environment variable.
1902
1903notes.rewriteRef::
1904        When copying notes during a rewrite, specifies the (fully
1905        qualified) ref whose notes should be copied.  The ref may be a
1906        glob, in which case notes in all matching refs will be copied.
1907        You may also specify this configuration several times.
1908+
1909Does not have a default value; you must configure this variable to
1910enable note rewriting.  Set it to `refs/notes/commits` to enable
1911rewriting for the default commit notes.
1912+
1913This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1914environment variable, which must be a colon separated list of refs or
1915globs.
1916
1917pack.window::
1918        The size of the window used by linkgit:git-pack-objects[1] when no
1919        window size is given on the command line. Defaults to 10.
1920
1921pack.depth::
1922        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1923        maximum depth is given on the command line. Defaults to 50.
1924
1925pack.windowMemory::
1926        The maximum size of memory that is consumed by each thread
1927        in linkgit:git-pack-objects[1] for pack window memory when
1928        no limit is given on the command line.  The value can be
1929        suffixed with "k", "m", or "g".  When left unconfigured (or
1930        set explicitly to 0), there will be no limit.
1931
1932pack.compression::
1933        An integer -1..9, indicating the compression level for objects
1934        in a pack file. -1 is the zlib default. 0 means no
1935        compression, and 1..9 are various speed/size tradeoffs, 9 being
1936        slowest.  If not set,  defaults to core.compression.  If that is
1937        not set,  defaults to -1, the zlib default, which is "a default
1938        compromise between speed and compression (currently equivalent
1939        to level 6)."
1940+
1941Note that changing the compression level will not automatically recompress
1942all existing objects. You can force recompression by passing the -F option
1943to linkgit:git-repack[1].
1944
1945pack.deltaCacheSize::
1946        The maximum memory in bytes used for caching deltas in
1947        linkgit:git-pack-objects[1] before writing them out to a pack.
1948        This cache is used to speed up the writing object phase by not
1949        having to recompute the final delta result once the best match
1950        for all objects is found.  Repacking large repositories on machines
1951        which are tight with memory might be badly impacted by this though,
1952        especially if this cache pushes the system into swapping.
1953        A value of 0 means no limit. The smallest size of 1 byte may be
1954        used to virtually disable this cache. Defaults to 256 MiB.
1955
1956pack.deltaCacheLimit::
1957        The maximum size of a delta, that is cached in
1958        linkgit:git-pack-objects[1]. This cache is used to speed up the
1959        writing object phase by not having to recompute the final delta
1960        result once the best match for all objects is found. Defaults to 1000.
1961
1962pack.threads::
1963        Specifies the number of threads to spawn when searching for best
1964        delta matches.  This requires that linkgit:git-pack-objects[1]
1965        be compiled with pthreads otherwise this option is ignored with a
1966        warning. This is meant to reduce packing time on multiprocessor
1967        machines. The required amount of memory for the delta search window
1968        is however multiplied by the number of threads.
1969        Specifying 0 will cause Git to auto-detect the number of CPU's
1970        and set the number of threads accordingly.
1971
1972pack.indexVersion::
1973        Specify the default pack index version.  Valid values are 1 for
1974        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1975        the new pack index with capabilities for packs larger than 4 GB
1976        as well as proper protection against the repacking of corrupted
1977        packs.  Version 2 is the default.  Note that version 2 is enforced
1978        and this config option ignored whenever the corresponding pack is
1979        larger than 2 GB.
1980+
1981If you have an old Git that does not understand the version 2 `*.idx` file,
1982cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1983that will copy both `*.pack` file and corresponding `*.idx` file from the
1984other side may give you a repository that cannot be accessed with your
1985older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1986you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1987the `*.idx` file.
1988
1989pack.packSizeLimit::
1990        The maximum size of a pack.  This setting only affects
1991        packing to a file when repacking, i.e. the git:// protocol
1992        is unaffected.  It can be overridden by the `--max-pack-size`
1993        option of linkgit:git-repack[1]. The minimum size allowed is
1994        limited to 1 MiB. The default is unlimited.
1995        Common unit suffixes of 'k', 'm', or 'g' are
1996        supported.
1997
1998pack.useBitmaps::
1999        When true, git will use pack bitmaps (if available) when packing
2000        to stdout (e.g., during the server side of a fetch). Defaults to
2001        true. You should not generally need to turn this off unless
2002        you are debugging pack bitmaps.
2003
2004pack.writeBitmaps (deprecated)::
2005        This is a deprecated synonym for `repack.writeBitmaps`.
2006
2007pack.writeBitmapHashCache::
2008        When true, git will include a "hash cache" section in the bitmap
2009        index (if one is written). This cache can be used to feed git's
2010        delta heuristics, potentially leading to better deltas between
2011        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2012        between an older, bitmapped pack and objects that have been
2013        pushed since the last gc). The downside is that it consumes 4
2014        bytes per object of disk space, and that JGit's bitmap
2015        implementation does not understand it, causing it to complain if
2016        Git and JGit are used on the same repository. Defaults to false.
2017
2018pager.<cmd>::
2019        If the value is boolean, turns on or off pagination of the
2020        output of a particular Git subcommand when writing to a tty.
2021        Otherwise, turns on pagination for the subcommand using the
2022        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2023        or `--no-pager` is specified on the command line, it takes
2024        precedence over this option.  To disable pagination for all
2025        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2026
2027pretty.<name>::
2028        Alias for a --pretty= format string, as specified in
2029        linkgit:git-log[1]. Any aliases defined here can be used just
2030        as the built-in pretty formats could. For example,
2031        running `git config pretty.changelog "format:* %H %s"`
2032        would cause the invocation `git log --pretty=changelog`
2033        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2034        Note that an alias with the same name as a built-in format
2035        will be silently ignored.
2036
2037pull.ff::
2038        By default, Git does not create an extra merge commit when merging
2039        a commit that is a descendant of the current commit. Instead, the
2040        tip of the current branch is fast-forwarded. When set to `false`,
2041        this variable tells Git to create an extra merge commit in such
2042        a case (equivalent to giving the `--no-ff` option from the command
2043        line). When set to `only`, only such fast-forward merges are
2044        allowed (equivalent to giving the `--ff-only` option from the
2045        command line).
2046
2047pull.rebase::
2048        When true, rebase branches on top of the fetched branch, instead
2049        of merging the default branch from the default remote when "git
2050        pull" is run. See "branch.<name>.rebase" for setting this on a
2051        per-branch basis.
2052+
2053        When preserve, also pass `--preserve-merges` along to 'git rebase'
2054        so that locally committed merge commits will not be flattened
2055        by running 'git pull'.
2056+
2057*NOTE*: this is a possibly dangerous operation; do *not* use
2058it unless you understand the implications (see linkgit:git-rebase[1]
2059for details).
2060
2061pull.octopus::
2062        The default merge strategy to use when pulling multiple branches
2063        at once.
2064
2065pull.twohead::
2066        The default merge strategy to use when pulling a single branch.
2067
2068push.default::
2069        Defines the action `git push` should take if no refspec is
2070        explicitly given.  Different values are well-suited for
2071        specific workflows; for instance, in a purely central workflow
2072        (i.e. the fetch source is equal to the push destination),
2073        `upstream` is probably what you want.  Possible values are:
2074+
2075--
2076
2077* `nothing` - do not push anything (error out) unless a refspec is
2078  explicitly given. This is primarily meant for people who want to
2079  avoid mistakes by always being explicit.
2080
2081* `current` - push the current branch to update a branch with the same
2082  name on the receiving end.  Works in both central and non-central
2083  workflows.
2084
2085* `upstream` - push the current branch back to the branch whose
2086  changes are usually integrated into the current branch (which is
2087  called `@{upstream}`).  This mode only makes sense if you are
2088  pushing to the same repository you would normally pull from
2089  (i.e. central workflow).
2090
2091* `simple` - in centralized workflow, work like `upstream` with an
2092  added safety to refuse to push if the upstream branch's name is
2093  different from the local one.
2094+
2095When pushing to a remote that is different from the remote you normally
2096pull from, work as `current`.  This is the safest option and is suited
2097for beginners.
2098+
2099This mode has become the default in Git 2.0.
2100
2101* `matching` - push all branches having the same name on both ends.
2102  This makes the repository you are pushing to remember the set of
2103  branches that will be pushed out (e.g. if you always push 'maint'
2104  and 'master' there and no other branches, the repository you push
2105  to will have these two branches, and your local 'maint' and
2106  'master' will be pushed there).
2107+
2108To use this mode effectively, you have to make sure _all_ the
2109branches you would push out are ready to be pushed out before
2110running 'git push', as the whole point of this mode is to allow you
2111to push all of the branches in one go.  If you usually finish work
2112on only one branch and push out the result, while other branches are
2113unfinished, this mode is not for you.  Also this mode is not
2114suitable for pushing into a shared central repository, as other
2115people may add new branches there, or update the tip of existing
2116branches outside your control.
2117+
2118This used to be the default, but not since Git 2.0 (`simple` is the
2119new default).
2120
2121--
2122
2123push.followTags::
2124        If set to true enable '--follow-tags' option by default.  You
2125        may override this configuration at time of push by specifying
2126        '--no-follow-tags'.
2127
2128
2129rebase.stat::
2130        Whether to show a diffstat of what changed upstream since the last
2131        rebase. False by default.
2132
2133rebase.autoSquash::
2134        If set to true enable '--autosquash' option by default.
2135
2136rebase.autoStash::
2137        When set to true, automatically create a temporary stash
2138        before the operation begins, and apply it after the operation
2139        ends.  This means that you can run rebase on a dirty worktree.
2140        However, use with care: the final stash application after a
2141        successful rebase might result in non-trivial conflicts.
2142        Defaults to false.
2143
2144receive.advertiseAtomic::
2145        By default, git-receive-pack will advertise the atomic push
2146        capability to its clients. If you don't want to this capability
2147        to be advertised, set this variable to false.
2148
2149receive.autogc::
2150        By default, git-receive-pack will run "git-gc --auto" after
2151        receiving data from git-push and updating refs.  You can stop
2152        it by setting this variable to false.
2153
2154receive.certNonceSeed::
2155        By setting this variable to a string, `git receive-pack`
2156        will accept a `git push --signed` and verifies it by using
2157        a "nonce" protected by HMAC using this string as a secret
2158        key.
2159
2160receive.certNonceSlop::
2161        When a `git push --signed` sent a push certificate with a
2162        "nonce" that was issued by a receive-pack serving the same
2163        repository within this many seconds, export the "nonce"
2164        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2165        hooks (instead of what the receive-pack asked the sending
2166        side to include).  This may allow writing checks in
2167        `pre-receive` and `post-receive` a bit easier.  Instead of
2168        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2169        that records by how many seconds the nonce is stale to
2170        decide if they want to accept the certificate, they only
2171        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2172
2173receive.fsckObjects::
2174        If it is set to true, git-receive-pack will check all received
2175        objects. It will abort in the case of a malformed object or a
2176        broken link. The result of an abort are only dangling objects.
2177        Defaults to false. If not set, the value of `transfer.fsckObjects`
2178        is used instead.
2179
2180receive.unpackLimit::
2181        If the number of objects received in a push is below this
2182        limit then the objects will be unpacked into loose object
2183        files. However if the number of received objects equals or
2184        exceeds this limit then the received pack will be stored as
2185        a pack, after adding any missing delta bases.  Storing the
2186        pack from a push can make the push operation complete faster,
2187        especially on slow filesystems.  If not set, the value of
2188        `transfer.unpackLimit` is used instead.
2189
2190receive.denyDeletes::
2191        If set to true, git-receive-pack will deny a ref update that deletes
2192        the ref. Use this to prevent such a ref deletion via a push.
2193
2194receive.denyDeleteCurrent::
2195        If set to true, git-receive-pack will deny a ref update that
2196        deletes the currently checked out branch of a non-bare repository.
2197
2198receive.denyCurrentBranch::
2199        If set to true or "refuse", git-receive-pack will deny a ref update
2200        to the currently checked out branch of a non-bare repository.
2201        Such a push is potentially dangerous because it brings the HEAD
2202        out of sync with the index and working tree. If set to "warn",
2203        print a warning of such a push to stderr, but allow the push to
2204        proceed. If set to false or "ignore", allow such pushes with no
2205        message. Defaults to "refuse".
2206+
2207Another option is "updateInstead" which will update the working
2208tree if pushing into the current branch.  This option is
2209intended for synchronizing working directories when one side is not easily
2210accessible via interactive ssh (e.g. a live web site, hence the requirement
2211that the working directory be clean). This mode also comes in handy when
2212developing inside a VM to test and fix code on different Operating Systems.
2213+
2214By default, "updateInstead" will refuse the push if the working tree or
2215the index have any difference from the HEAD, but the `push-to-checkout`
2216hook can be used to customize this.  See linkgit:githooks[5].
2217
2218receive.denyNonFastForwards::
2219        If set to true, git-receive-pack will deny a ref update which is
2220        not a fast-forward. Use this to prevent such an update via a push,
2221        even if that push is forced. This configuration variable is
2222        set when initializing a shared repository.
2223
2224receive.hideRefs::
2225        String(s) `receive-pack` uses to decide which refs to omit
2226        from its initial advertisement.  Use more than one
2227        definitions to specify multiple prefix strings. A ref that
2228        are under the hierarchies listed on the value of this
2229        variable is excluded, and is hidden when responding to `git
2230        push`, and an attempt to update or delete a hidden ref by
2231        `git push` is rejected.
2232
2233receive.updateServerInfo::
2234        If set to true, git-receive-pack will run git-update-server-info
2235        after receiving data from git-push and updating refs.
2236
2237receive.shallowUpdate::
2238        If set to true, .git/shallow can be updated when new refs
2239        require new shallow roots. Otherwise those refs are rejected.
2240
2241remote.pushDefault::
2242        The remote to push to by default.  Overrides
2243        `branch.<name>.remote` for all branches, and is overridden by
2244        `branch.<name>.pushRemote` for specific branches.
2245
2246remote.<name>.url::
2247        The URL of a remote repository.  See linkgit:git-fetch[1] or
2248        linkgit:git-push[1].
2249
2250remote.<name>.pushurl::
2251        The push URL of a remote repository.  See linkgit:git-push[1].
2252
2253remote.<name>.proxy::
2254        For remotes that require curl (http, https and ftp), the URL to
2255        the proxy to use for that remote.  Set to the empty string to
2256        disable proxying for that remote.
2257
2258remote.<name>.fetch::
2259        The default set of "refspec" for linkgit:git-fetch[1]. See
2260        linkgit:git-fetch[1].
2261
2262remote.<name>.push::
2263        The default set of "refspec" for linkgit:git-push[1]. See
2264        linkgit:git-push[1].
2265
2266remote.<name>.mirror::
2267        If true, pushing to this remote will automatically behave
2268        as if the `--mirror` option was given on the command line.
2269
2270remote.<name>.skipDefaultUpdate::
2271        If true, this remote will be skipped by default when updating
2272        using linkgit:git-fetch[1] or the `update` subcommand of
2273        linkgit:git-remote[1].
2274
2275remote.<name>.skipFetchAll::
2276        If true, this remote will be skipped by default when updating
2277        using linkgit:git-fetch[1] or the `update` subcommand of
2278        linkgit:git-remote[1].
2279
2280remote.<name>.receivepack::
2281        The default program to execute on the remote side when pushing.  See
2282        option \--receive-pack of linkgit:git-push[1].
2283
2284remote.<name>.uploadpack::
2285        The default program to execute on the remote side when fetching.  See
2286        option \--upload-pack of linkgit:git-fetch-pack[1].
2287
2288remote.<name>.tagOpt::
2289        Setting this value to \--no-tags disables automatic tag following when
2290        fetching from remote <name>. Setting it to \--tags will fetch every
2291        tag from remote <name>, even if they are not reachable from remote
2292        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2293        override this setting. See options \--tags and \--no-tags of
2294        linkgit:git-fetch[1].
2295
2296remote.<name>.vcs::
2297        Setting this to a value <vcs> will cause Git to interact with
2298        the remote with the git-remote-<vcs> helper.
2299
2300remote.<name>.prune::
2301        When set to true, fetching from this remote by default will also
2302        remove any remote-tracking references that no longer exist on the
2303        remote (as if the `--prune` option was given on the command line).
2304        Overrides `fetch.prune` settings, if any.
2305
2306remotes.<group>::
2307        The list of remotes which are fetched by "git remote update
2308        <group>".  See linkgit:git-remote[1].
2309
2310repack.useDeltaBaseOffset::
2311        By default, linkgit:git-repack[1] creates packs that use
2312        delta-base offset. If you need to share your repository with
2313        Git older than version 1.4.4, either directly or via a dumb
2314        protocol such as http, then you need to set this option to
2315        "false" and repack. Access from old Git versions over the
2316        native protocol are unaffected by this option.
2317
2318repack.packKeptObjects::
2319        If set to true, makes `git repack` act as if
2320        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2321        details. Defaults to `false` normally, but `true` if a bitmap
2322        index is being written (either via `--write-bitmap-index` or
2323        `repack.writeBitmaps`).
2324
2325repack.writeBitmaps::
2326        When true, git will write a bitmap index when packing all
2327        objects to disk (e.g., when `git repack -a` is run).  This
2328        index can speed up the "counting objects" phase of subsequent
2329        packs created for clones and fetches, at the cost of some disk
2330        space and extra time spent on the initial repack.  Defaults to
2331        false.
2332
2333rerere.autoUpdate::
2334        When set to true, `git-rerere` updates the index with the
2335        resulting contents after it cleanly resolves conflicts using
2336        previously recorded resolution.  Defaults to false.
2337
2338rerere.enabled::
2339        Activate recording of resolved conflicts, so that identical
2340        conflict hunks can be resolved automatically, should they be
2341        encountered again.  By default, linkgit:git-rerere[1] is
2342        enabled if there is an `rr-cache` directory under the
2343        `$GIT_DIR`, e.g. if "rerere" was previously used in the
2344        repository.
2345
2346sendemail.identity::
2347        A configuration identity. When given, causes values in the
2348        'sendemail.<identity>' subsection to take precedence over
2349        values in the 'sendemail' section. The default identity is
2350        the value of 'sendemail.identity'.
2351
2352sendemail.smtpEncryption::
2353        See linkgit:git-send-email[1] for description.  Note that this
2354        setting is not subject to the 'identity' mechanism.
2355
2356sendemail.smtpssl (deprecated)::
2357        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2358
2359sendemail.smtpsslcertpath::
2360        Path to ca-certificates (either a directory or a single file).
2361        Set it to an empty string to disable certificate verification.
2362
2363sendemail.<identity>.*::
2364        Identity-specific versions of the 'sendemail.*' parameters
2365        found below, taking precedence over those when the this
2366        identity is selected, through command-line or
2367        'sendemail.identity'.
2368
2369sendemail.aliasesFile::
2370sendemail.aliasFileType::
2371sendemail.annotate::
2372sendemail.bcc::
2373sendemail.cc::
2374sendemail.ccCmd::
2375sendemail.chainReplyTo::
2376sendemail.confirm::
2377sendemail.envelopeSender::
2378sendemail.from::
2379sendemail.multiEdit::
2380sendemail.signedoffbycc::
2381sendemail.smtpPass::
2382sendemail.suppresscc::
2383sendemail.suppressFrom::
2384sendemail.to::
2385sendemail.smtpDomain::
2386sendemail.smtpServer::
2387sendemail.smtpServerPort::
2388sendemail.smtpServerOption::
2389sendemail.smtpUser::
2390sendemail.thread::
2391sendemail.transferEncoding::
2392sendemail.validate::
2393sendemail.xmailer::
2394        See linkgit:git-send-email[1] for description.
2395
2396sendemail.signedoffcc (deprecated)::
2397        Deprecated alias for 'sendemail.signedoffbycc'.
2398
2399showbranch.default::
2400        The default set of branches for linkgit:git-show-branch[1].
2401        See linkgit:git-show-branch[1].
2402
2403status.relativePaths::
2404        By default, linkgit:git-status[1] shows paths relative to the
2405        current directory. Setting this variable to `false` shows paths
2406        relative to the repository root (this was the default for Git
2407        prior to v1.5.4).
2408
2409status.short::
2410        Set to true to enable --short by default in linkgit:git-status[1].
2411        The option --no-short takes precedence over this variable.
2412
2413status.branch::
2414        Set to true to enable --branch by default in linkgit:git-status[1].
2415        The option --no-branch takes precedence over this variable.
2416
2417status.displayCommentPrefix::
2418        If set to true, linkgit:git-status[1] will insert a comment
2419        prefix before each output line (starting with
2420        `core.commentChar`, i.e. `#` by default). This was the
2421        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2422        Defaults to false.
2423
2424status.showUntrackedFiles::
2425        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2426        files which are not currently tracked by Git. Directories which
2427        contain only untracked files, are shown with the directory name
2428        only. Showing untracked files means that Git needs to lstat() all
2429        the files in the whole repository, which might be slow on some
2430        systems. So, this variable controls how the commands displays
2431        the untracked files. Possible values are:
2432+
2433--
2434* `no` - Show no untracked files.
2435* `normal` - Show untracked files and directories.
2436* `all` - Show also individual files in untracked directories.
2437--
2438+
2439If this variable is not specified, it defaults to 'normal'.
2440This variable can be overridden with the -u|--untracked-files option
2441of linkgit:git-status[1] and linkgit:git-commit[1].
2442
2443status.submoduleSummary::
2444        Defaults to false.
2445        If this is set to a non zero number or true (identical to -1 or an
2446        unlimited number), the submodule summary will be enabled and a
2447        summary of commits for modified submodules will be shown (see
2448        --summary-limit option of linkgit:git-submodule[1]). Please note
2449        that the summary output command will be suppressed for all
2450        submodules when `diff.ignoreSubmodules` is set to 'all' or only
2451        for those submodules where `submodule.<name>.ignore=all`. The only
2452        exception to that rule is that status and commit will show staged
2453        submodule changes. To
2454        also view the summary for ignored submodules you can either use
2455        the --ignore-submodules=dirty command-line option or the 'git
2456        submodule summary' command, which shows a similar output but does
2457        not honor these settings.
2458
2459submodule.<name>.path::
2460submodule.<name>.url::
2461        The path within this project and URL for a submodule. These
2462        variables are initially populated by 'git submodule init'. See
2463        linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2464        details.
2465
2466submodule.<name>.update::
2467        The default update procedure for a submodule. This variable
2468        is populated by `git submodule init` from the
2469        linkgit:gitmodules[5] file. See description of 'update'
2470        command in linkgit:git-submodule[1].
2471
2472submodule.<name>.branch::
2473        The remote branch name for a submodule, used by `git submodule
2474        update --remote`.  Set this option to override the value found in
2475        the `.gitmodules` file.  See linkgit:git-submodule[1] and
2476        linkgit:gitmodules[5] for details.
2477
2478submodule.<name>.fetchRecurseSubmodules::
2479        This option can be used to control recursive fetching of this
2480        submodule. It can be overridden by using the --[no-]recurse-submodules
2481        command-line option to "git fetch" and "git pull".
2482        This setting will override that from in the linkgit:gitmodules[5]
2483        file.
2484
2485submodule.<name>.ignore::
2486        Defines under what circumstances "git status" and the diff family show
2487        a submodule as modified. When set to "all", it will never be considered
2488        modified (but it will nonetheless show up in the output of status and
2489        commit when it has been staged), "dirty" will ignore all changes
2490        to the submodules work tree and
2491        takes only differences between the HEAD of the submodule and the commit
2492        recorded in the superproject into account. "untracked" will additionally
2493        let submodules with modified tracked files in their work tree show up.
2494        Using "none" (the default when this option is not set) also shows
2495        submodules that have untracked files in their work tree as changed.
2496        This setting overrides any setting made in .gitmodules for this submodule,
2497        both settings can be overridden on the command line by using the
2498        "--ignore-submodules" option. The 'git submodule' commands are not
2499        affected by this setting.
2500
2501tag.sort::
2502        This variable controls the sort ordering of tags when displayed by
2503        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2504        value of this variable will be used as the default.
2505
2506tar.umask::
2507        This variable can be used to restrict the permission bits of
2508        tar archive entries.  The default is 0002, which turns off the
2509        world write bit.  The special value "user" indicates that the
2510        archiving user's umask will be used instead.  See umask(2) and
2511        linkgit:git-archive[1].
2512
2513transfer.fsckObjects::
2514        When `fetch.fsckObjects` or `receive.fsckObjects` are
2515        not set, the value of this variable is used instead.
2516        Defaults to false.
2517
2518transfer.hideRefs::
2519        This variable can be used to set both `receive.hideRefs`
2520        and `uploadpack.hideRefs` at the same time to the same
2521        values.  See entries for these other variables.
2522
2523transfer.unpackLimit::
2524        When `fetch.unpackLimit` or `receive.unpackLimit` are
2525        not set, the value of this variable is used instead.
2526        The default value is 100.
2527
2528uploadarchive.allowUnreachable::
2529        If true, allow clients to use `git archive --remote` to request
2530        any tree, whether reachable from the ref tips or not. See the
2531        discussion in the `SECURITY` section of
2532        linkgit:git-upload-archive[1] for more details. Defaults to
2533        `false`.
2534
2535uploadpack.hideRefs::
2536        String(s) `upload-pack` uses to decide which refs to omit
2537        from its initial advertisement.  Use more than one
2538        definitions to specify multiple prefix strings. A ref that
2539        are under the hierarchies listed on the value of this
2540        variable is excluded, and is hidden from `git ls-remote`,
2541        `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2542        fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2543
2544uploadpack.allowtipsha1inwant::
2545        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2546        to accept a fetch request that asks for an object at the tip
2547        of a hidden ref (by default, such a request is rejected).
2548        see also `uploadpack.hideRefs`.
2549
2550uploadpack.keepAlive::
2551        When `upload-pack` has started `pack-objects`, there may be a
2552        quiet period while `pack-objects` prepares the pack. Normally
2553        it would output progress information, but if `--quiet` was used
2554        for the fetch, `pack-objects` will output nothing at all until
2555        the pack data begins. Some clients and networks may consider
2556        the server to be hung and give up. Setting this option instructs
2557        `upload-pack` to send an empty keepalive packet every
2558        `uploadpack.keepAlive` seconds. Setting this option to 0
2559        disables keepalive packets entirely. The default is 5 seconds.
2560
2561url.<base>.insteadOf::
2562        Any URL that starts with this value will be rewritten to
2563        start, instead, with <base>. In cases where some site serves a
2564        large number of repositories, and serves them with multiple
2565        access methods, and some users need to use different access
2566        methods, this feature allows people to specify any of the
2567        equivalent URLs and have Git automatically rewrite the URL to
2568        the best alternative for the particular user, even for a
2569        never-before-seen repository on the site.  When more than one
2570        insteadOf strings match a given URL, the longest match is used.
2571
2572url.<base>.pushInsteadOf::
2573        Any URL that starts with this value will not be pushed to;
2574        instead, it will be rewritten to start with <base>, and the
2575        resulting URL will be pushed to. In cases where some site serves
2576        a large number of repositories, and serves them with multiple
2577        access methods, some of which do not allow push, this feature
2578        allows people to specify a pull-only URL and have Git
2579        automatically use an appropriate URL to push, even for a
2580        never-before-seen repository on the site.  When more than one
2581        pushInsteadOf strings match a given URL, the longest match is
2582        used.  If a remote has an explicit pushurl, Git will ignore this
2583        setting for that remote.
2584
2585user.email::
2586        Your email address to be recorded in any newly created commits.
2587        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2588        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2589
2590user.name::
2591        Your full name to be recorded in any newly created commits.
2592        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2593        environment variables.  See linkgit:git-commit-tree[1].
2594
2595user.signingKey::
2596        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2597        key you want it to automatically when creating a signed tag or
2598        commit, you can override the default selection with this variable.
2599        This option is passed unchanged to gpg's --local-user parameter,
2600        so you may specify a key using any method that gpg supports.
2601
2602versionsort.prereleaseSuffix::
2603        When version sort is used in linkgit:git-tag[1], prerelease
2604        tags (e.g. "1.0-rc1") may appear after the main release
2605        "1.0". By specifying the suffix "-rc" in this variable,
2606        "1.0-rc1" will appear before "1.0".
2607+
2608This variable can be specified multiple times, once per suffix. The
2609order of suffixes in the config file determines the sorting order
2610(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2611is sorted before 1.0-rcXX). The sorting order between different
2612suffixes is undefined if they are in multiple config files.
2613
2614web.browser::
2615        Specify a web browser that may be used by some commands.
2616        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2617        may use it.