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