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