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