Documentation / config.txton commit fast-import: always create marks_file directories (580d5f8)
   1CONFIGURATION FILE
   2------------------
   3
   4The git configuration file contains a number of variables that affect
   5the git command's 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 and only alphanumeric
  16characters are allowed. Some variables may appear multiple times.
  17
  18Syntax
  19~~~~~~
  20
  21The syntax is fairly flexible and permissive; whitespaces are mostly
  22ignored.  The '#' and ';' characters begin comments to the end of line,
  23blank lines are ignored.
  24
  25The file consists of sections and variables.  A section begins with
  26the name of the section in square brackets and continues until the next
  27section begins.  Section names are not case sensitive.  Only alphanumeric
  28characters, `-` and `.` are allowed in section names.  Each variable
  29must belong to some section, which means that there must be a section
  30header before the first setting of a variable.
  31
  32Sections can be further divided into subsections.  To begin a subsection
  33put its name in double quotes, separated by space from the section name,
  34in the section header, like in the example below:
  35
  36--------
  37        [section "subsection"]
  38
  39--------
  40
  41Subsection names are case sensitive and can contain any characters except
  42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
  43respectively).  Section headers cannot span multiple
  44lines.  Variables may belong directly to a section or to a given subsection.
  45You can have `[section]` if you have `[section "subsection"]`, but you
  46don't need to.
  47
  48There is also a case insensitive alternative `[section.subsection]` syntax.
  49In this syntax, subsection names follow the same restrictions as for section
  50names.
  51
  52All the other lines (and the remainder of the line after the section
  53header) are recognized as setting variables, in the form
  54'name = value'.  If there is no equal sign on the line, the entire line
  55is taken as 'name' and the variable is recognized as boolean "true".
  56The variable names are case-insensitive and only alphanumeric
  57characters and `-` are allowed.  There can be more than one value
  58for a given variable; we say then that variable is multivalued.
  59
  60Leading and trailing whitespace in a variable value is discarded.
  61Internal whitespace within a variable value is retained verbatim.
  62
  63The values following the equals sign in variable assign are all either
  64a string, an integer, or a boolean.  Boolean values may be given as yes/no,
  650/1, true/false or on/off.  Case is not significant in boolean values, when
  66converting value to the canonical form using '--bool' type specifier;
  67'git config' will ensure that the output is "true" or "false".
  68
  69String values may be entirely or partially enclosed in double quotes.
  70You need to enclose variable values in double quotes if you want to
  71preserve leading or trailing whitespace, or if the variable value contains
  72comment characters (i.e. it contains '#' or ';').
  73Double quote `"` and backslash `\` characters in variable values must
  74be escaped: use `\"` for `"` and `\\` for `\`.
  75
  76The following escape sequences (beside `\"` and `\\`) are recognized:
  77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  78and `\b` for backspace (BS).  No other char escape sequence, nor octal
  79char sequences are valid.
  80
  81Variable values ending in a `\` are continued on the next line in the
  82customary UNIX fashion.
  83
  84Some variables may require a special value format.
  85
  86Example
  87~~~~~~~
  88
  89        # Core variables
  90        [core]
  91                ; Don't trust file modes
  92                filemode = false
  93
  94        # Our diff algorithm
  95        [diff]
  96                external = /usr/local/bin/diff-wrapper
  97                renames = true
  98
  99        [branch "devel"]
 100                remote = origin
 101                merge = refs/heads/devel
 102
 103        # Proxy settings
 104        [core]
 105                gitProxy="ssh" for "kernel.org"
 106                gitProxy=default-proxy ; for the rest
 107
 108Variables
 109~~~~~~~~~
 110
 111Note that this list is non-comprehensive and not necessarily complete.
 112For command-specific variables, you will find a more detailed description
 113in the appropriate manual page. You will find a description of non-core
 114porcelain configuration variables in the respective porcelain documentation.
 115
 116advice.*::
 117        When set to 'true', display the given optional help message.
 118        When set to 'false', do not display. The configuration variables
 119        are:
 120+
 121--
 122        pushNonFastForward::
 123                Advice shown when linkgit:git-push[1] refuses
 124                non-fast-forward refs. Default: true.
 125        statusHints::
 126                Directions on how to stage/unstage/add shown in the
 127                output of linkgit:git-status[1] and the template shown
 128                when writing commit messages. Default: true.
 129        commitBeforeMerge::
 130                Advice shown when linkgit:git-merge[1] refuses to
 131                merge to avoid overwritting local changes.
 132                Default: true.
 133        resolveConflict::
 134                Advices shown by various commands when conflicts
 135                prevent the operation from being performed.
 136                Default: true.
 137        implicitIdentity::
 138                Advice on how to set your identity configuration when
 139                your information is guessed from the system username and
 140                domain name. Default: true.
 141
 142        detachedHead::
 143                Advice shown when you used linkgit::git-checkout[1] to
 144                move to the detach HEAD state, to instruct how to create
 145                a local branch after the fact.  Default: true.
 146--
 147
 148core.fileMode::
 149        If false, the executable bit differences between the index and
 150        the working copy are ignored; useful on broken filesystems like FAT.
 151        See linkgit:git-update-index[1].
 152+
 153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 154will probe and set core.fileMode false if appropriate when the
 155repository is created.
 156
 157core.ignoreCygwinFSTricks::
 158        This option is only used by Cygwin implementation of Git. If false,
 159        the Cygwin stat() and lstat() functions are used. This may be useful
 160        if your repository consists of a few separate directories joined in
 161        one hierarchy using Cygwin mount. If true, Git uses native Win32 API
 162        whenever it is possible and falls back to Cygwin functions only to
 163        handle symbol links. The native mode is more than twice faster than
 164        normal Cygwin l/stat() functions. True by default, unless core.filemode
 165        is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
 166        POSIX emulation is required to support core.filemode.
 167
 168core.ignorecase::
 169        If true, this option enables various workarounds to enable
 170        git to work better on filesystems that are not case sensitive,
 171        like FAT. For example, if a directory listing finds
 172        "makefile" when git expects "Makefile", git will assume
 173        it is really the same file, and continue to remember it as
 174        "Makefile".
 175+
 176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 177will probe and set core.ignorecase true if appropriate when the repository
 178is created.
 179
 180core.trustctime::
 181        If false, the ctime differences between the index and the
 182        working copy are ignored; useful when the inode change time
 183        is regularly modified by something outside Git (file system
 184        crawlers and some backup systems).
 185        See linkgit:git-update-index[1]. True by default.
 186
 187core.quotepath::
 188        The commands that output paths (e.g. 'ls-files',
 189        'diff'), when not given the `-z` option, will quote
 190        "unusual" characters in the pathname by enclosing the
 191        pathname in a double-quote pair and with backslashes the
 192        same way strings in C source code are quoted.  If this
 193        variable is set to false, the bytes higher than 0x80 are
 194        not quoted but output as verbatim.  Note that double
 195        quote, backslash and control characters are always
 196        quoted without `-z` regardless of the setting of this
 197        variable.
 198
 199core.autocrlf::
 200        If true, makes git convert `CRLF` at the end of lines in text files to
 201        `LF` when reading from the filesystem, and convert in reverse when
 202        writing to the filesystem.  The variable can be set to
 203        'input', in which case the conversion happens only while
 204        reading from the filesystem but files are written out with
 205        `LF` at the end of lines.  A file is considered
 206        "text" (i.e. be subjected to the autocrlf mechanism) based on
 207        the file's `crlf` attribute, or if `crlf` is unspecified,
 208        based on the file's contents.  See linkgit:gitattributes[5].
 209
 210core.safecrlf::
 211        If true, makes git check if converting `CRLF` as controlled by
 212        `core.autocrlf` is reversible.  Git will verify if a command
 213        modifies a file in the work tree either directly or indirectly.
 214        For example, committing a file followed by checking out the
 215        same file should yield the original file in the work tree.  If
 216        this is not the case for the current setting of
 217        `core.autocrlf`, git will reject the file.  The variable can
 218        be set to "warn", in which case git will only warn about an
 219        irreversible conversion but continue the operation.
 220+
 221CRLF conversion bears a slight chance of corrupting data.
 222autocrlf=true will convert CRLF to LF during commit and LF to
 223CRLF during checkout.  A file that contains a mixture of LF and
 224CRLF before the commit cannot be recreated by git.  For text
 225files this is the right thing to do: it corrects line endings
 226such that we have only LF line endings in the repository.
 227But for binary files that are accidentally classified as text the
 228conversion can corrupt data.
 229+
 230If you recognize such corruption early you can easily fix it by
 231setting the conversion type explicitly in .gitattributes.  Right
 232after committing you still have the original file in your work
 233tree and this file is not yet corrupted.  You can explicitly tell
 234git that this file is binary and git will handle the file
 235appropriately.
 236+
 237Unfortunately, the desired effect of cleaning up text files with
 238mixed line endings and the undesired effect of corrupting binary
 239files cannot be distinguished.  In both cases CRLFs are removed
 240in an irreversible way.  For text files this is the right thing
 241to do because CRLFs are line endings, while for binary files
 242converting CRLFs corrupts data.
 243+
 244Note, this safety check does not mean that a checkout will generate a
 245file identical to the original file for a different setting of
 246`core.autocrlf`, but only for the current one.  For example, a text
 247file with `LF` would be accepted with `core.autocrlf=input` and could
 248later be checked out with `core.autocrlf=true`, in which case the
 249resulting file would contain `CRLF`, although the original file
 250contained `LF`.  However, in both work trees the line endings would be
 251consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 252file with mixed line endings would be reported by the `core.safecrlf`
 253mechanism.
 254
 255core.symlinks::
 256        If false, symbolic links are checked out as small plain files that
 257        contain the link text. linkgit:git-update-index[1] and
 258        linkgit:git-add[1] will not change the recorded type to regular
 259        file. Useful on filesystems like FAT that do not support
 260        symbolic links.
 261+
 262The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 263will probe and set core.symlinks false if appropriate when the repository
 264is created.
 265
 266core.gitProxy::
 267        A "proxy command" to execute (as 'command host port') instead
 268        of establishing direct connection to the remote server when
 269        using the git protocol for fetching. If the variable value is
 270        in the "COMMAND for DOMAIN" format, the command is applied only
 271        on hostnames ending with the specified domain string. This variable
 272        may be set multiple times and is matched in the given order;
 273        the first match wins.
 274+
 275Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
 276(which always applies universally, without the special "for"
 277handling).
 278+
 279The special string `none` can be used as the proxy command to
 280specify that no proxy be used for a given domain pattern.
 281This is useful for excluding servers inside a firewall from
 282proxy use, while defaulting to a common proxy for external domains.
 283
 284core.ignoreStat::
 285        If true, commands which modify both the working tree and the index
 286        will mark the updated paths with the "assume unchanged" bit in the
 287        index. These marked files are then assumed to stay unchanged in the
 288        working copy, until you mark them otherwise manually - Git will not
 289        detect the file changes by lstat() calls. This is useful on systems
 290        where those are very slow, such as Microsoft Windows.
 291        See linkgit:git-update-index[1].
 292        False by default.
 293
 294core.preferSymlinkRefs::
 295        Instead of the default "symref" format for HEAD
 296        and other symbolic reference files, use symbolic links.
 297        This is sometimes needed to work with old scripts that
 298        expect HEAD to be a symbolic link.
 299
 300core.bare::
 301        If true this repository is assumed to be 'bare' and has no
 302        working directory associated with it.  If this is the case a
 303        number of commands that require a working directory will be
 304        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 305+
 306This setting is automatically guessed by linkgit:git-clone[1] or
 307linkgit:git-init[1] when the repository was created.  By default a
 308repository that ends in "/.git" is assumed to be not bare (bare =
 309false), while all other repositories are assumed to be bare (bare
 310= true).
 311
 312core.worktree::
 313        Set the path to the root of the work tree.
 314        This can be overridden by the GIT_WORK_TREE environment
 315        variable and the '--work-tree' command line option. It can be
 316        an absolute path or a relative path to the .git directory,
 317        either specified by --git-dir or GIT_DIR, or automatically
 318        discovered.
 319        If --git-dir or GIT_DIR are specified but none of
 320        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 321        the current working directory is regarded as the root of the
 322        work tree.
 323+
 324Note that this variable is honored even when set in a configuration
 325file in a ".git" subdirectory of a directory, and its value differs
 326from the latter directory (e.g. "/path/to/.git/config" has
 327core.worktree set to "/different/path"), which is most likely a
 328misconfiguration.  Running git commands in "/path/to" directory will
 329still use "/different/path" as the root of the work tree and can cause
 330great confusion to the users.
 331
 332core.logAllRefUpdates::
 333        Enable the reflog. Updates to a ref <ref> is logged to the file
 334        "$GIT_DIR/logs/<ref>", by appending the new and old
 335        SHA1, the date/time and the reason of the update, but
 336        only when the file exists.  If this configuration
 337        variable is set to true, missing "$GIT_DIR/logs/<ref>"
 338        file is automatically created for branch heads.
 339+
 340This information can be used to determine what commit
 341was the tip of a branch "2 days ago".
 342+
 343This value is true by default in a repository that has
 344a working directory associated with it, and false by
 345default in a bare repository.
 346
 347core.repositoryFormatVersion::
 348        Internal variable identifying the repository format and layout
 349        version.
 350
 351core.sharedRepository::
 352        When 'group' (or 'true'), the repository is made shareable between
 353        several users in a group (making sure all the files and objects are
 354        group-writable). When 'all' (or 'world' or 'everybody'), the
 355        repository will be readable by all users, additionally to being
 356        group-shareable. When 'umask' (or 'false'), git will use permissions
 357        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 358        files in the repository will have this mode value. '0xxx' will override
 359        user's umask value (whereas the other options will only override
 360        requested parts of the user's umask value). Examples: '0660' will make
 361        the repo read/write-able for the owner and group, but inaccessible to
 362        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 363        repository that is group-readable but not group-writable.
 364        See linkgit:git-init[1]. False by default.
 365
 366core.warnAmbiguousRefs::
 367        If true, git will warn you if the ref name you passed it is ambiguous
 368        and might match multiple refs in the .git/refs/ tree. True by default.
 369
 370core.compression::
 371        An integer -1..9, indicating a default compression level.
 372        -1 is the zlib default. 0 means no compression,
 373        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 374        If set, this provides a default to other compression variables,
 375        such as 'core.loosecompression' and 'pack.compression'.
 376
 377core.loosecompression::
 378        An integer -1..9, indicating the compression level for objects that
 379        are not in a pack file. -1 is the zlib default. 0 means no
 380        compression, and 1..9 are various speed/size tradeoffs, 9 being
 381        slowest.  If not set,  defaults to core.compression.  If that is
 382        not set,  defaults to 1 (best speed).
 383
 384core.packedGitWindowSize::
 385        Number of bytes of a pack file to map into memory in a
 386        single mapping operation.  Larger window sizes may allow
 387        your system to process a smaller number of large pack files
 388        more quickly.  Smaller window sizes will negatively affect
 389        performance due to increased calls to the operating system's
 390        memory manager, but may improve performance when accessing
 391        a large number of large pack files.
 392+
 393Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 394MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 395be reasonable for all users/operating systems.  You probably do
 396not need to adjust this value.
 397+
 398Common unit suffixes of 'k', 'm', or 'g' are supported.
 399
 400core.packedGitLimit::
 401        Maximum number of bytes to map simultaneously into memory
 402        from pack files.  If Git needs to access more than this many
 403        bytes at once to complete an operation it will unmap existing
 404        regions to reclaim virtual address space within the process.
 405+
 406Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 407This should be reasonable for all users/operating systems, except on
 408the largest projects.  You probably do not need to adjust this value.
 409+
 410Common unit suffixes of 'k', 'm', or 'g' are supported.
 411
 412core.deltaBaseCacheLimit::
 413        Maximum number of bytes to reserve for caching base objects
 414        that multiple deltafied objects reference.  By storing the
 415        entire decompressed base objects in a cache Git is able
 416        to avoid unpacking and decompressing frequently used base
 417        objects multiple times.
 418+
 419Default is 16 MiB on all platforms.  This should be reasonable
 420for all users/operating systems, except on the largest projects.
 421You probably do not need to adjust this value.
 422+
 423Common unit suffixes of 'k', 'm', or 'g' are supported.
 424
 425core.bigFileThreshold::
 426        Files larger than this size are stored deflated, without
 427        attempting delta compression.  Storing large files without
 428        delta compression avoids excessive memory usage, at the
 429        slight expense of increased disk usage.
 430+
 431Default is 512 MiB on all platforms.  This should be reasonable
 432for most projects as source code and other text files can still
 433be delta compressed, but larger binary media files won't be.
 434+
 435Common unit suffixes of 'k', 'm', or 'g' are supported.
 436+
 437Currently only linkgit:git-fast-import[1] honors this setting.
 438
 439core.excludesfile::
 440        In addition to '.gitignore' (per-directory) and
 441        '.git/info/exclude', git looks into this file for patterns
 442        of files which are not meant to be tracked.  "{tilde}/" is expanded
 443        to the value of `$HOME` and "{tilde}user/" to the specified user's
 444        home directory.  See linkgit:gitignore[5].
 445
 446core.editor::
 447        Commands such as `commit` and `tag` that lets you edit
 448        messages by launching an editor uses the value of this
 449        variable when it is set, and the environment variable
 450        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 451
 452core.pager::
 453        The command that git will use to paginate output.  Can
 454        be overridden with the `GIT_PAGER` environment
 455        variable.  Note that git sets the `LESS` environment
 456        variable to `FRSX` if it is unset when it runs the
 457        pager.  One can change these settings by setting the
 458        `LESS` variable to some other value.  Alternately,
 459        these settings can be overridden on a project or
 460        global basis by setting the `core.pager` option.
 461        Setting `core.pager` has no affect on the `LESS`
 462        environment variable behaviour above, so if you want
 463        to override git's default settings this way, you need
 464        to be explicit.  For example, to disable the S option
 465        in a backward compatible manner, set `core.pager`
 466        to `less -+$LESS -FRX`.  This will be passed to the
 467        shell by git, which will translate the final command to
 468        `LESS=FRSX less -+FRSX -FRX`.
 469
 470core.whitespace::
 471        A comma separated list of common whitespace problems to
 472        notice.  'git diff' will use `color.diff.whitespace` to
 473        highlight them, and 'git apply --whitespace=error' will
 474        consider them as errors.  You can prefix `-` to disable
 475        any of them (e.g. `-trailing-space`):
 476+
 477* `blank-at-eol` treats trailing whitespaces at the end of the line
 478  as an error (enabled by default).
 479* `space-before-tab` treats a space character that appears immediately
 480  before a tab character in the initial indent part of the line as an
 481  error (enabled by default).
 482* `indent-with-non-tab` treats a line that is indented with 8 or more
 483  space characters as an error (not enabled by default).
 484* `blank-at-eof` treats blank lines added at the end of file as an error
 485  (enabled by default).
 486* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 487  `blank-at-eof`.
 488* `cr-at-eol` treats a carriage-return at the end of line as
 489  part of the line terminator, i.e. with it, `trailing-space`
 490  does not trigger if the character before such a carriage-return
 491  is not a whitespace (not enabled by default).
 492
 493core.fsyncobjectfiles::
 494        This boolean will enable 'fsync()' when writing object files.
 495+
 496This is a total waste of time and effort on a filesystem that orders
 497data writes properly, but can be useful for filesystems that do not use
 498journalling (traditional UNIX filesystems) or that only journal metadata
 499and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 500
 501core.preloadindex::
 502        Enable parallel index preload for operations like 'git diff'
 503+
 504This can speed up operations like 'git diff' and 'git status' especially
 505on filesystems like NFS that have weak caching semantics and thus
 506relatively high IO latencies.  With this set to 'true', git will do the
 507index comparison to the filesystem data in parallel, allowing
 508overlapping IO's.
 509
 510core.createObject::
 511        You can set this to 'link', in which case a hardlink followed by
 512        a delete of the source are used to make sure that object creation
 513        will not overwrite existing objects.
 514+
 515On some file system/operating system combinations, this is unreliable.
 516Set this config setting to 'rename' there; However, This will remove the
 517check that makes sure that existing object files will not get overwritten.
 518
 519core.notesRef::
 520        When showing commit messages, also show notes which are stored in
 521        the given ref.  This ref is expected to contain files named
 522        after the full SHA-1 of the commit they annotate.  The ref
 523        must be fully qualified.
 524+
 525If such a file exists in the given ref, the referenced blob is read, and
 526appended to the commit message, separated by a "Notes (<refname>):"
 527line (shortened to "Notes:" in the case of "refs/notes/commits").  If the
 528given ref itself does not exist, it is not an error, but means that no
 529notes should be printed.
 530+
 531This setting defaults to "refs/notes/commits", and can be overridden by
 532the `GIT_NOTES_REF` environment variable.
 533
 534core.sparseCheckout::
 535        Enable "sparse checkout" feature. See section "Sparse checkout" in
 536        linkgit:git-read-tree[1] for more information.
 537
 538add.ignore-errors::
 539        Tells 'git add' to continue adding files when some files cannot be
 540        added due to indexing errors. Equivalent to the '--ignore-errors'
 541        option of linkgit:git-add[1].
 542
 543alias.*::
 544        Command aliases for the linkgit:git[1] command wrapper - e.g.
 545        after defining "alias.last = cat-file commit HEAD", the invocation
 546        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 547        confusion and troubles with script usage, aliases that
 548        hide existing git commands are ignored. Arguments are split by
 549        spaces, the usual shell quoting and escaping is supported.
 550        quote pair and a backslash can be used to quote them.
 551+
 552If the alias expansion is prefixed with an exclamation point,
 553it will be treated as a shell command.  For example, defining
 554"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 555"git new" is equivalent to running the shell command
 556"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 557executed from the top-level directory of a repository, which may
 558not necessarily be the current directory.
 559
 560am.keepcr::
 561        If true, git-am will call git-mailsplit for patches in mbox format
 562        with parameter '--keep-cr'. In this case git-mailsplit will
 563        not remove `\r` from lines ending with `\r\n`. Can be overrriden
 564        by giving '--no-keep-cr' from the command line.
 565        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 566
 567apply.ignorewhitespace::
 568        When set to 'change', tells 'git apply' to ignore changes in
 569        whitespace, in the same way as the '--ignore-space-change'
 570        option.
 571        When set to one of: no, none, never, false tells 'git apply' to
 572        respect all whitespace differences.
 573        See linkgit:git-apply[1].
 574
 575apply.whitespace::
 576        Tells 'git apply' how to handle whitespaces, in the same way
 577        as the '--whitespace' option. See linkgit:git-apply[1].
 578
 579branch.autosetupmerge::
 580        Tells 'git branch' and 'git checkout' to set up new branches
 581        so that linkgit:git-pull[1] will appropriately merge from the
 582        starting point branch. Note that even if this option is not set,
 583        this behavior can be chosen per-branch using the `--track`
 584        and `--no-track` options. The valid settings are: `false` -- no
 585        automatic setup is done; `true` -- automatic setup is done when the
 586        starting point is a remote branch; `always` -- automatic setup is
 587        done when the starting point is either a local branch or remote
 588        branch. This option defaults to true.
 589
 590branch.autosetuprebase::
 591        When a new branch is created with 'git branch' or 'git checkout'
 592        that tracks another branch, this variable tells git to set
 593        up pull to rebase instead of merge (see "branch.<name>.rebase").
 594        When `never`, rebase is never automatically set to true.
 595        When `local`, rebase is set to true for tracked branches of
 596        other local branches.
 597        When `remote`, rebase is set to true for tracked branches of
 598        remote branches.
 599        When `always`, rebase will be set to true for all tracking
 600        branches.
 601        See "branch.autosetupmerge" for details on how to set up a
 602        branch to track another branch.
 603        This option defaults to never.
 604
 605branch.<name>.remote::
 606        When in branch <name>, it tells 'git fetch' and 'git push' which
 607        remote to fetch from/push to.  It defaults to `origin` if no remote is
 608        configured. `origin` is also used if you are not on any branch.
 609
 610branch.<name>.merge::
 611        Defines, together with branch.<name>.remote, the upstream branch
 612        for the given branch. It tells 'git fetch'/'git pull' which
 613        branch to merge and can also affect 'git push' (see push.default).
 614        When in branch <name>, it tells 'git fetch' the default
 615        refspec to be marked for merging in FETCH_HEAD. The value is
 616        handled like the remote part of a refspec, and must match a
 617        ref which is fetched from the remote given by
 618        "branch.<name>.remote".
 619        The merge information is used by 'git pull' (which at first calls
 620        'git fetch') to lookup the default branch for merging. Without
 621        this option, 'git pull' defaults to merge the first refspec fetched.
 622        Specify multiple values to get an octopus merge.
 623        If you wish to setup 'git pull' so that it merges into <name> from
 624        another branch in the local repository, you can point
 625        branch.<name>.merge to the desired branch, and use the special setting
 626        `.` (a period) for branch.<name>.remote.
 627
 628branch.<name>.mergeoptions::
 629        Sets default options for merging into branch <name>. The syntax and
 630        supported options are the same as those of linkgit:git-merge[1], but
 631        option values containing whitespace characters are currently not
 632        supported.
 633
 634branch.<name>.rebase::
 635        When true, rebase the branch <name> on top of the fetched branch,
 636        instead of merging the default branch from the default remote when
 637        "git pull" is run.
 638        *NOTE*: this is a possibly dangerous operation; do *not* use
 639        it unless you understand the implications (see linkgit:git-rebase[1]
 640        for details).
 641
 642browser.<tool>.cmd::
 643        Specify the command to invoke the specified browser. The
 644        specified command is evaluated in shell with the URLs passed
 645        as arguments. (See linkgit:git-web--browse[1].)
 646
 647browser.<tool>.path::
 648        Override the path for the given tool that may be used to
 649        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 650        working repository in gitweb (see linkgit:git-instaweb[1]).
 651
 652clean.requireForce::
 653        A boolean to make git-clean do nothing unless given -f
 654        or -n.   Defaults to true.
 655
 656color.branch::
 657        A boolean to enable/disable color in the output of
 658        linkgit:git-branch[1]. May be set to `always`,
 659        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 660        only when the output is to a terminal. Defaults to false.
 661
 662color.branch.<slot>::
 663        Use customized color for branch coloration. `<slot>` is one of
 664        `current` (the current branch), `local` (a local branch),
 665        `remote` (a tracking branch in refs/remotes/), `plain` (other
 666        refs).
 667+
 668The value for these configuration variables is a list of colors (at most
 669two) and attributes (at most one), separated by spaces.  The colors
 670accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 671`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 672`blink` and `reverse`.  The first color given is the foreground; the
 673second is the background.  The position of the attribute, if any,
 674doesn't matter.
 675
 676color.diff::
 677        When set to `always`, always use colors in patch.
 678        When false (or `never`), never.  When set to `true` or `auto`, use
 679        colors only when the output is to the terminal. Defaults to false.
 680
 681color.diff.<slot>::
 682        Use customized color for diff colorization.  `<slot>` specifies
 683        which part of the patch to use the specified color, and is one
 684        of `plain` (context text), `meta` (metainformation), `frag`
 685        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 686        `new` (added lines), `commit` (commit headers), or `whitespace`
 687        (highlighting whitespace errors). The values of these variables may be
 688        specified as in color.branch.<slot>.
 689
 690color.grep::
 691        When set to `always`, always highlight matches.  When `false` (or
 692        `never`), never.  When set to `true` or `auto`, use color only
 693        when the output is written to the terminal.  Defaults to `false`.
 694
 695color.grep.<slot>::
 696        Use customized color for grep colorization.  `<slot>` specifies which
 697        part of the line to use the specified color, and is one of
 698+
 699--
 700`context`;;
 701        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
 702`filename`;;
 703        filename prefix (when not using `-h`)
 704`function`;;
 705        function name lines (when using `-p`)
 706`linenumber`;;
 707        line number prefix (when using `-n`)
 708`match`;;
 709        matching text
 710`selected`;;
 711        non-matching text in selected lines
 712`separator`;;
 713        separators between fields on a line (`:`, `-`, and `=`)
 714        and between hunks (`--`)
 715--
 716+
 717The values of these variables may be specified as in color.branch.<slot>.
 718
 719color.interactive::
 720        When set to `always`, always use colors for interactive prompts
 721        and displays (such as those used by "git-add --interactive").
 722        When false (or `never`), never.  When set to `true` or `auto`, use
 723        colors only when the output is to the terminal. Defaults to false.
 724
 725color.interactive.<slot>::
 726        Use customized color for 'git add --interactive'
 727        output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
 728        four distinct types of normal output from interactive
 729        commands.  The values of these variables may be specified as
 730        in color.branch.<slot>.
 731
 732color.pager::
 733        A boolean to enable/disable colored output when the pager is in
 734        use (default is true).
 735
 736color.showbranch::
 737        A boolean to enable/disable color in the output of
 738        linkgit:git-show-branch[1]. May be set to `always`,
 739        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 740        only when the output is to a terminal. Defaults to false.
 741
 742color.status::
 743        A boolean to enable/disable color in the output of
 744        linkgit:git-status[1]. May be set to `always`,
 745        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 746        only when the output is to a terminal. Defaults to false.
 747
 748color.status.<slot>::
 749        Use customized color for status colorization. `<slot>` is
 750        one of `header` (the header text of the status message),
 751        `added` or `updated` (files which are added but not committed),
 752        `changed` (files which are changed but not added in the index),
 753        `untracked` (files which are not tracked by git), or
 754        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 755        to red). The values of these variables may be specified as in
 756        color.branch.<slot>.
 757
 758color.ui::
 759        When set to `always`, always use colors in all git commands which
 760        are capable of colored output. When false (or `never`), never. When
 761        set to `true` or `auto`, use colors only when the output is to the
 762        terminal. When more specific variables of color.* are set, they always
 763        take precedence over this setting. Defaults to false.
 764
 765commit.status::
 766        A boolean to enable/disable inclusion of status information in the
 767        commit message template when using an editor to prepare the commit
 768        message.  Defaults to true.
 769
 770commit.template::
 771        Specify a file to use as the template for new commit messages.
 772        "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
 773        specified user's home directory.
 774
 775diff.autorefreshindex::
 776        When using 'git diff' to compare with work tree
 777        files, do not consider stat-only change as changed.
 778        Instead, silently run `git update-index --refresh` to
 779        update the cached stat information for paths whose
 780        contents in the work tree match the contents in the
 781        index.  This option defaults to true.  Note that this
 782        affects only 'git diff' Porcelain, and not lower level
 783        'diff' commands such as 'git diff-files'.
 784
 785diff.external::
 786        If this config variable is set, diff generation is not
 787        performed using the internal diff machinery, but using the
 788        given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
 789        environment variable.  The command is called with parameters
 790        as described under "git Diffs" in linkgit:git[1].  Note: if
 791        you want to use an external diff program only on a subset of
 792        your files, you might want to use linkgit:gitattributes[5] instead.
 793
 794diff.mnemonicprefix::
 795        If set, 'git diff' uses a prefix pair that is different from the
 796        standard "a/" and "b/" depending on what is being compared.  When
 797        this configuration is in effect, reverse diff output also swaps
 798        the order of the prefixes:
 799`git diff`;;
 800        compares the (i)ndex and the (w)ork tree;
 801`git diff HEAD`;;
 802         compares a (c)ommit and the (w)ork tree;
 803`git diff --cached`;;
 804        compares a (c)ommit and the (i)ndex;
 805`git diff HEAD:file1 file2`;;
 806        compares an (o)bject and a (w)ork tree entity;
 807`git diff --no-index a b`;;
 808        compares two non-git things (1) and (2).
 809
 810diff.renameLimit::
 811        The number of files to consider when performing the copy/rename
 812        detection; equivalent to the 'git diff' option '-l'.
 813
 814diff.renames::
 815        Tells git to detect renames.  If set to any boolean value, it
 816        will enable basic rename detection.  If set to "copies" or
 817        "copy", it will detect copies, as well.
 818
 819diff.suppressBlankEmpty::
 820        A boolean to inhibit the standard behavior of printing a space
 821        before each empty output line. Defaults to false.
 822
 823diff.tool::
 824        Controls which diff tool is used.  `diff.tool` overrides
 825        `merge.tool` when used by linkgit:git-difftool[1] and has
 826        the same valid values as `merge.tool` minus "tortoisemerge"
 827        and plus "kompare".
 828
 829difftool.<tool>.path::
 830        Override the path for the given tool.  This is useful in case
 831        your tool is not in the PATH.
 832
 833difftool.<tool>.cmd::
 834        Specify the command to invoke the specified diff tool.
 835        The specified command is evaluated in shell with the following
 836        variables available:  'LOCAL' is set to the name of the temporary
 837        file containing the contents of the diff pre-image and 'REMOTE'
 838        is set to the name of the temporary file containing the contents
 839        of the diff post-image.
 840
 841difftool.prompt::
 842        Prompt before each invocation of the diff tool.
 843
 844diff.wordRegex::
 845        A POSIX Extended Regular Expression used to determine what is a "word"
 846        when performing word-by-word difference calculations.  Character
 847        sequences that match the regular expression are "words", all other
 848        characters are *ignorable* whitespace.
 849
 850fetch.unpackLimit::
 851        If the number of objects fetched over the git native
 852        transfer is below this
 853        limit, then the objects will be unpacked into loose object
 854        files. However if the number of received objects equals or
 855        exceeds this limit then the received pack will be stored as
 856        a pack, after adding any missing delta bases.  Storing the
 857        pack from a push can make the push operation complete faster,
 858        especially on slow filesystems.  If not set, the value of
 859        `transfer.unpackLimit` is used instead.
 860
 861format.attach::
 862        Enable multipart/mixed attachments as the default for
 863        'format-patch'.  The value can also be a double quoted string
 864        which will enable attachments as the default and set the
 865        value as the boundary.  See the --attach option in
 866        linkgit:git-format-patch[1].
 867
 868format.numbered::
 869        A boolean which can enable or disable sequence numbers in patch
 870        subjects.  It defaults to "auto" which enables it only if there
 871        is more than one patch.  It can be enabled or disabled for all
 872        messages by setting it to "true" or "false".  See --numbered
 873        option in linkgit:git-format-patch[1].
 874
 875format.headers::
 876        Additional email headers to include in a patch to be submitted
 877        by mail.  See linkgit:git-format-patch[1].
 878
 879format.cc::
 880        Additional "Cc:" headers to include in a patch to be submitted
 881        by mail.  See the --cc option in linkgit:git-format-patch[1].
 882
 883format.subjectprefix::
 884        The default for format-patch is to output files with the '[PATCH]'
 885        subject prefix. Use this variable to change that prefix.
 886
 887format.suffix::
 888        The default for format-patch is to output files with the suffix
 889        `.patch`. Use this variable to change that suffix (make sure to
 890        include the dot if you want it).
 891
 892format.pretty::
 893        The default pretty format for log/show/whatchanged command,
 894        See linkgit:git-log[1], linkgit:git-show[1],
 895        linkgit:git-whatchanged[1].
 896
 897format.thread::
 898        The default threading style for 'git format-patch'.  Can be
 899        a boolean value, or `shallow` or `deep`.  `shallow` threading
 900        makes every mail a reply to the head of the series,
 901        where the head is chosen from the cover letter, the
 902        `\--in-reply-to`, and the first patch mail, in this order.
 903        `deep` threading makes every mail a reply to the previous one.
 904        A true boolean value is the same as `shallow`, and a false
 905        value disables threading.
 906
 907format.signoff::
 908    A boolean value which lets you enable the `-s/--signoff` option of
 909    format-patch by default. *Note:* Adding the Signed-off-by: line to a
 910    patch should be a conscious act and means that you certify you have
 911    the rights to submit this work under the same open source license.
 912    Please see the 'SubmittingPatches' document for further discussion.
 913
 914gc.aggressiveWindow::
 915        The window size parameter used in the delta compression
 916        algorithm used by 'git gc --aggressive'.  This defaults
 917        to 10.
 918
 919gc.auto::
 920        When there are approximately more than this many loose
 921        objects in the repository, `git gc --auto` will pack them.
 922        Some Porcelain commands use this command to perform a
 923        light-weight garbage collection from time to time.  The
 924        default value is 6700.  Setting this to 0 disables it.
 925
 926gc.autopacklimit::
 927        When there are more than this many packs that are not
 928        marked with `*.keep` file in the repository, `git gc
 929        --auto` consolidates them into one larger pack.  The
 930        default value is 50.  Setting this to 0 disables it.
 931
 932gc.packrefs::
 933        Running `git pack-refs` in a repository renders it
 934        unclonable by Git versions prior to 1.5.1.2 over dumb
 935        transports such as HTTP.  This variable determines whether
 936        'git gc' runs `git pack-refs`. This can be set to `nobare`
 937        to enable it within all non-bare repos or it can be set to a
 938        boolean value.  The default is `true`.
 939
 940gc.pruneexpire::
 941        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
 942        Override the grace period with this config variable.  The value
 943        "now" may be used to disable this  grace period and always prune
 944        unreachable objects immediately.
 945
 946gc.reflogexpire::
 947        'git reflog expire' removes reflog entries older than
 948        this time; defaults to 90 days.
 949
 950gc.reflogexpireunreachable::
 951        'git reflog expire' removes reflog entries older than
 952        this time and are not reachable from the current tip;
 953        defaults to 30 days.
 954
 955gc.rerereresolved::
 956        Records of conflicted merge you resolved earlier are
 957        kept for this many days when 'git rerere gc' is run.
 958        The default is 60 days.  See linkgit:git-rerere[1].
 959
 960gc.rerereunresolved::
 961        Records of conflicted merge you have not resolved are
 962        kept for this many days when 'git rerere gc' is run.
 963        The default is 15 days.  See linkgit:git-rerere[1].
 964
 965gitcvs.commitmsgannotation::
 966        Append this string to each commit message. Set to empty string
 967        to disable this feature. Defaults to "via git-CVS emulator".
 968
 969gitcvs.enabled::
 970        Whether the CVS server interface is enabled for this repository.
 971        See linkgit:git-cvsserver[1].
 972
 973gitcvs.logfile::
 974        Path to a log file where the CVS server interface well... logs
 975        various stuff. See linkgit:git-cvsserver[1].
 976
 977gitcvs.usecrlfattr::
 978        If true, the server will look up the `crlf` attribute for
 979        files to determine the '-k' modes to use. If `crlf` is set,
 980        the '-k' mode will be left blank, so cvs clients will
 981        treat it as text. If `crlf` is explicitly unset, the file
 982        will be set with '-kb' mode, which suppresses any newline munging
 983        the client might otherwise do. If `crlf` is not specified,
 984        then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
 985
 986gitcvs.allbinary::
 987        This is used if 'gitcvs.usecrlfattr' does not resolve
 988        the correct '-kb' mode to use. If true, all
 989        unresolved files are sent to the client in
 990        mode '-kb'. This causes the client to treat them
 991        as binary files, which suppresses any newline munging it
 992        otherwise might do. Alternatively, if it is set to "guess",
 993        then the contents of the file are examined to decide if
 994        it is binary, similar to 'core.autocrlf'.
 995
 996gitcvs.dbname::
 997        Database used by git-cvsserver to cache revision information
 998        derived from the git repository. The exact meaning depends on the
 999        used database driver, for SQLite (which is the default driver) this
1000        is a filename. Supports variable substitution (see
1001        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1002        Default: '%Ggitcvs.%m.sqlite'
1003
1004gitcvs.dbdriver::
1005        Used Perl DBI driver. You can specify any available driver
1006        for this here, but it might not work. git-cvsserver is tested
1007        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1008        reported *not* to work with 'DBD::mysql'. Experimental feature.
1009        May not contain double colons (`:`). Default: 'SQLite'.
1010        See linkgit:git-cvsserver[1].
1011
1012gitcvs.dbuser, gitcvs.dbpass::
1013        Database user and password. Only useful if setting 'gitcvs.dbdriver',
1014        since SQLite has no concept of database users and/or passwords.
1015        'gitcvs.dbuser' supports variable substitution (see
1016        linkgit:git-cvsserver[1] for details).
1017
1018gitcvs.dbTableNamePrefix::
1019        Database table name prefix.  Prepended to the names of any
1020        database tables used, allowing a single database to be used
1021        for several repositories.  Supports variable substitution (see
1022        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1023        characters will be replaced with underscores.
1024
1025All gitcvs variables except for 'gitcvs.usecrlfattr' and
1026'gitcvs.allbinary' can also be specified as
1027'gitcvs.<access_method>.<varname>' (where 'access_method'
1028is one of "ext" and "pserver") to make them apply only for the given
1029access method.
1030
1031gui.commitmsgwidth::
1032        Defines how wide the commit message window is in the
1033        linkgit:git-gui[1]. "75" is the default.
1034
1035gui.diffcontext::
1036        Specifies how many context lines should be used in calls to diff
1037        made by the linkgit:git-gui[1]. The default is "5".
1038
1039gui.encoding::
1040        Specifies the default encoding to use for displaying of
1041        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1042        It can be overridden by setting the 'encoding' attribute
1043        for relevant files (see linkgit:gitattributes[5]).
1044        If this option is not set, the tools default to the
1045        locale encoding.
1046
1047gui.matchtrackingbranch::
1048        Determines if new branches created with linkgit:git-gui[1] should
1049        default to tracking remote branches with matching names or
1050        not. Default: "false".
1051
1052gui.newbranchtemplate::
1053        Is used as suggested name when creating new branches using the
1054        linkgit:git-gui[1].
1055
1056gui.pruneduringfetch::
1057        "true" if linkgit:git-gui[1] should prune tracking branches when
1058        performing a fetch. The default value is "false".
1059
1060gui.trustmtime::
1061        Determines if linkgit:git-gui[1] should trust the file modification
1062        timestamp or not. By default the timestamps are not trusted.
1063
1064gui.spellingdictionary::
1065        Specifies the dictionary used for spell checking commit messages in
1066        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1067        off.
1068
1069gui.fastcopyblame::
1070        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1071        location detection. It makes blame significantly faster on huge
1072        repositories at the expense of less thorough copy detection.
1073
1074gui.copyblamethreshold::
1075        Specifies the threshold to use in 'git gui blame' original location
1076        detection, measured in alphanumeric characters. See the
1077        linkgit:git-blame[1] manual for more information on copy detection.
1078
1079gui.blamehistoryctx::
1080        Specifies the radius of history context in days to show in
1081        linkgit:gitk[1] for the selected commit, when the `Show History
1082        Context` menu item is invoked from 'git gui blame'. If this
1083        variable is set to zero, the whole history is shown.
1084
1085guitool.<name>.cmd::
1086        Specifies the shell command line to execute when the corresponding item
1087        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1088        mandatory for every tool. The command is executed from the root of
1089        the working directory, and in the environment it receives the name of
1090        the tool as 'GIT_GUITOOL', the name of the currently selected file as
1091        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1092        the head is detached, 'CUR_BRANCH' is empty).
1093
1094guitool.<name>.needsfile::
1095        Run the tool only if a diff is selected in the GUI. It guarantees
1096        that 'FILENAME' is not empty.
1097
1098guitool.<name>.noconsole::
1099        Run the command silently, without creating a window to display its
1100        output.
1101
1102guitool.<name>.norescan::
1103        Don't rescan the working directory for changes after the tool
1104        finishes execution.
1105
1106guitool.<name>.confirm::
1107        Show a confirmation dialog before actually running the tool.
1108
1109guitool.<name>.argprompt::
1110        Request a string argument from the user, and pass it to the tool
1111        through the 'ARGS' environment variable. Since requesting an
1112        argument implies confirmation, the 'confirm' option has no effect
1113        if this is enabled. If the option is set to 'true', 'yes', or '1',
1114        the dialog uses a built-in generic prompt; otherwise the exact
1115        value of the variable is used.
1116
1117guitool.<name>.revprompt::
1118        Request a single valid revision from the user, and set the
1119        'REVISION' environment variable. In other aspects this option
1120        is similar to 'argprompt', and can be used together with it.
1121
1122guitool.<name>.revunmerged::
1123        Show only unmerged branches in the 'revprompt' subdialog.
1124        This is useful for tools similar to merge or rebase, but not
1125        for things like checkout or reset.
1126
1127guitool.<name>.title::
1128        Specifies the title to use for the prompt dialog. The default
1129        is the tool name.
1130
1131guitool.<name>.prompt::
1132        Specifies the general prompt string to display at the top of
1133        the dialog, before subsections for 'argprompt' and 'revprompt'.
1134        The default value includes the actual command.
1135
1136help.browser::
1137        Specify the browser that will be used to display help in the
1138        'web' format. See linkgit:git-help[1].
1139
1140help.format::
1141        Override the default help format used by linkgit:git-help[1].
1142        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1143        the default. 'web' and 'html' are the same.
1144
1145help.autocorrect::
1146        Automatically correct and execute mistyped commands after
1147        waiting for the given number of deciseconds (0.1 sec). If more
1148        than one command can be deduced from the entered text, nothing
1149        will be executed.  If the value of this option is negative,
1150        the corrected command will be executed immediately. If the
1151        value is 0 - the command will be just shown but not executed.
1152        This is the default.
1153
1154http.proxy::
1155        Override the HTTP proxy, normally configured using the 'http_proxy'
1156        environment variable (see linkgit:curl[1]).  This can be overridden
1157        on a per-remote basis; see remote.<name>.proxy
1158
1159http.sslVerify::
1160        Whether to verify the SSL certificate when fetching or pushing
1161        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1162        variable.
1163
1164http.sslCert::
1165        File containing the SSL certificate when fetching or pushing
1166        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1167        variable.
1168
1169http.sslKey::
1170        File containing the SSL private key when fetching or pushing
1171        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1172        variable.
1173
1174http.sslCertPasswordProtected::
1175        Enable git's password prompt for the SSL certificate.  Otherwise
1176        OpenSSL will prompt the user, possibly many times, if the
1177        certificate or private key is encrypted.  Can be overridden by the
1178        'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1179
1180http.sslCAInfo::
1181        File containing the certificates to verify the peer with when
1182        fetching or pushing over HTTPS. Can be overridden by the
1183        'GIT_SSL_CAINFO' environment variable.
1184
1185http.sslCAPath::
1186        Path containing files with the CA certificates to verify the peer
1187        with when fetching or pushing over HTTPS. Can be overridden
1188        by the 'GIT_SSL_CAPATH' environment variable.
1189
1190http.maxRequests::
1191        How many HTTP requests to launch in parallel. Can be overridden
1192        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1193
1194http.minSessions::
1195        The number of curl sessions (counted across slots) to be kept across
1196        requests. They will not be ended with curl_easy_cleanup() until
1197        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1198        value will be capped at 1. Defaults to 1.
1199
1200http.postBuffer::
1201        Maximum size in bytes of the buffer used by smart HTTP
1202        transports when POSTing data to the remote system.
1203        For requests larger than this buffer size, HTTP/1.1 and
1204        Transfer-Encoding: chunked is used to avoid creating a
1205        massive pack file locally.  Default is 1 MiB, which is
1206        sufficient for most requests.
1207
1208http.lowSpeedLimit, http.lowSpeedTime::
1209        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1210        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1211        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1212        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1213
1214http.noEPSV::
1215        A boolean which disables using of EPSV ftp command by curl.
1216        This can helpful with some "poor" ftp servers which don't
1217        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1218        environment variable. Default is false (curl will use EPSV).
1219
1220i18n.commitEncoding::
1221        Character encoding the commit messages are stored in; git itself
1222        does not care per se, but this information is necessary e.g. when
1223        importing commits from emails or in the gitk graphical history
1224        browser (and possibly at other places in the future or in other
1225        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1226
1227i18n.logOutputEncoding::
1228        Character encoding the commit messages are converted to when
1229        running 'git log' and friends.
1230
1231imap::
1232        The configuration variables in the 'imap' section are described
1233        in linkgit:git-imap-send[1].
1234
1235init.templatedir::
1236        Specify the directory from which templates will be copied.
1237        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1238
1239instaweb.browser::
1240        Specify the program that will be used to browse your working
1241        repository in gitweb. See linkgit:git-instaweb[1].
1242
1243instaweb.httpd::
1244        The HTTP daemon command-line to start gitweb on your working
1245        repository. See linkgit:git-instaweb[1].
1246
1247instaweb.local::
1248        If true the web server started by linkgit:git-instaweb[1] will
1249        be bound to the local IP (127.0.0.1).
1250
1251instaweb.modulepath::
1252        The module path for an apache httpd used by linkgit:git-instaweb[1].
1253
1254instaweb.port::
1255        The port number to bind the gitweb httpd to. See
1256        linkgit:git-instaweb[1].
1257
1258interactive.singlekey::
1259        In interactive commands, allow the user to provide one-letter
1260        input with a single key (i.e., without hitting enter).
1261        Currently this is used only by the `\--patch` mode of
1262        linkgit:git-add[1].  Note that this setting is silently
1263        ignored if portable keystroke input is not available.
1264
1265log.date::
1266        Set default date-time mode for the log command. Setting log.date
1267        value is similar to using 'git log'\'s --date option. The value is one of the
1268        following alternatives: {relative,local,default,iso,rfc,short}.
1269        See linkgit:git-log[1].
1270
1271log.showroot::
1272        If true, the initial commit will be shown as a big creation event.
1273        This is equivalent to a diff against an empty tree.
1274        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1275        normally hide the root commit will now show it. True by default.
1276
1277mailmap.file::
1278        The location of an augmenting mailmap file. The default
1279        mailmap, located in the root of the repository, is loaded
1280        first, then the mailmap file pointed to by this variable.
1281        The location of the mailmap file may be in a repository
1282        subdirectory, or somewhere outside of the repository itself.
1283        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1284
1285man.viewer::
1286        Specify the programs that may be used to display help in the
1287        'man' format. See linkgit:git-help[1].
1288
1289man.<tool>.cmd::
1290        Specify the command to invoke the specified man viewer. The
1291        specified command is evaluated in shell with the man page
1292        passed as argument. (See linkgit:git-help[1].)
1293
1294man.<tool>.path::
1295        Override the path for the given tool that may be used to
1296        display help in the 'man' format. See linkgit:git-help[1].
1297
1298include::merge-config.txt[]
1299
1300mergetool.<tool>.path::
1301        Override the path for the given tool.  This is useful in case
1302        your tool is not in the PATH.
1303
1304mergetool.<tool>.cmd::
1305        Specify the command to invoke the specified merge tool.  The
1306        specified command is evaluated in shell with the following
1307        variables available: 'BASE' is the name of a temporary file
1308        containing the common base of the files to be merged, if available;
1309        'LOCAL' is the name of a temporary file containing the contents of
1310        the file on the current branch; 'REMOTE' is the name of a temporary
1311        file containing the contents of the file from the branch being
1312        merged; 'MERGED' contains the name of the file to which the merge
1313        tool should write the results of a successful merge.
1314
1315mergetool.<tool>.trustExitCode::
1316        For a custom merge command, specify whether the exit code of
1317        the merge command can be used to determine whether the merge was
1318        successful.  If this is not set to true then the merge target file
1319        timestamp is checked and the merge assumed to have been successful
1320        if the file has been updated, otherwise the user is prompted to
1321        indicate the success of the merge.
1322
1323mergetool.keepBackup::
1324        After performing a merge, the original file with conflict markers
1325        can be saved as a file with a `.orig` extension.  If this variable
1326        is set to `false` then this file is not preserved.  Defaults to
1327        `true` (i.e. keep the backup files).
1328
1329mergetool.keepTemporaries::
1330        When invoking a custom merge tool, git uses a set of temporary
1331        files to pass to the tool. If the tool returns an error and this
1332        variable is set to `true`, then these temporary files will be
1333        preserved, otherwise they will be removed after the tool has
1334        exited. Defaults to `false`.
1335
1336mergetool.prompt::
1337        Prompt before each invocation of the merge resolution program.
1338
1339notes.displayRef::
1340        The (fully qualified) refname from which to show notes when
1341        showing commit messages.  The value of this variable can be set
1342        to a glob, in which case notes from all matching refs will be
1343        shown.  You may also specify this configuration variable
1344        several times.  A warning will be issued for refs that do not
1345        exist, but a glob that does not match any refs is silently
1346        ignored.
1347+
1348This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1349environment variable, which must be a colon separated list of refs or
1350globs.
1351+
1352The effective value of "core.notesRef" (possibly overridden by
1353GIT_NOTES_REF) is also implicitly added to the list of refs to be
1354displayed.
1355
1356notes.rewrite.<command>::
1357        When rewriting commits with <command> (currently `amend` or
1358        `rebase`) and this variable is set to `true`, git
1359        automatically copies your notes from the original to the
1360        rewritten commit.  Defaults to `true`, but see
1361        "notes.rewriteRef" below.
1362+
1363This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1364environment variable, which must be a colon separated list of refs or
1365globs.
1366
1367notes.rewriteMode::
1368        When copying notes during a rewrite (see the
1369        "notes.rewrite.<command>" option), determines what to do if
1370        the target commit already has a note.  Must be one of
1371        `overwrite`, `concatenate`, or `ignore`.  Defaults to
1372        `concatenate`.
1373+
1374This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1375environment variable.
1376
1377notes.rewriteRef::
1378        When copying notes during a rewrite, specifies the (fully
1379        qualified) ref whose notes should be copied.  The ref may be a
1380        glob, in which case notes in all matching refs will be copied.
1381        You may also specify this configuration several times.
1382+
1383Does not have a default value; you must configure this variable to
1384enable note rewriting.
1385
1386pack.window::
1387        The size of the window used by linkgit:git-pack-objects[1] when no
1388        window size is given on the command line. Defaults to 10.
1389
1390pack.depth::
1391        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1392        maximum depth is given on the command line. Defaults to 50.
1393
1394pack.windowMemory::
1395        The window memory size limit used by linkgit:git-pack-objects[1]
1396        when no limit is given on the command line.  The value can be
1397        suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1398        limit.
1399
1400pack.compression::
1401        An integer -1..9, indicating the compression level for objects
1402        in a pack file. -1 is the zlib default. 0 means no
1403        compression, and 1..9 are various speed/size tradeoffs, 9 being
1404        slowest.  If not set,  defaults to core.compression.  If that is
1405        not set,  defaults to -1, the zlib default, which is "a default
1406        compromise between speed and compression (currently equivalent
1407        to level 6)."
1408
1409pack.deltaCacheSize::
1410        The maximum memory in bytes used for caching deltas in
1411        linkgit:git-pack-objects[1] before writing them out to a pack.
1412        This cache is used to speed up the writing object phase by not
1413        having to recompute the final delta result once the best match
1414        for all objects is found.  Repacking large repositories on machines
1415        which are tight with memory might be badly impacted by this though,
1416        especially if this cache pushes the system into swapping.
1417        A value of 0 means no limit. The smallest size of 1 byte may be
1418        used to virtually disable this cache. Defaults to 256 MiB.
1419
1420pack.deltaCacheLimit::
1421        The maximum size of a delta, that is cached in
1422        linkgit:git-pack-objects[1]. This cache is used to speed up the
1423        writing object phase by not having to recompute the final delta
1424        result once the best match for all objects is found. Defaults to 1000.
1425
1426pack.threads::
1427        Specifies the number of threads to spawn when searching for best
1428        delta matches.  This requires that linkgit:git-pack-objects[1]
1429        be compiled with pthreads otherwise this option is ignored with a
1430        warning. This is meant to reduce packing time on multiprocessor
1431        machines. The required amount of memory for the delta search window
1432        is however multiplied by the number of threads.
1433        Specifying 0 will cause git to auto-detect the number of CPU's
1434        and set the number of threads accordingly.
1435
1436pack.indexVersion::
1437        Specify the default pack index version.  Valid values are 1 for
1438        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1439        the new pack index with capabilities for packs larger than 4 GB
1440        as well as proper protection against the repacking of corrupted
1441        packs.  Version 2 is the default.  Note that version 2 is enforced
1442        and this config option ignored whenever the corresponding pack is
1443        larger than 2 GB.
1444+
1445If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1446cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1447that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1448other side may give you a repository that cannot be accessed with your
1449older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1450you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1451the `{asterisk}.idx` file.
1452
1453pack.packSizeLimit::
1454        The maximum size of a pack.  This setting only affects
1455        packing to a file when repacking, i.e. the git:// protocol
1456        is unaffected.  It can be overridden by the `\--max-pack-size`
1457        option of linkgit:git-repack[1]. The minimum size allowed is
1458        limited to 1 MiB. The default is unlimited.
1459        Common unit suffixes of 'k', 'm', or 'g' are
1460        supported.
1461
1462pager.<cmd>::
1463        Allows turning on or off pagination of the output of a
1464        particular git subcommand when writing to a tty.  If
1465        `\--paginate` or `\--no-pager` is specified on the command line,
1466        it takes precedence over this option.  To disable pagination for
1467        all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1468
1469pull.octopus::
1470        The default merge strategy to use when pulling multiple branches
1471        at once.
1472
1473pull.twohead::
1474        The default merge strategy to use when pulling a single branch.
1475
1476push.default::
1477        Defines the action git push should take if no refspec is given
1478        on the command line, no refspec is configured in the remote, and
1479        no refspec is implied by any of the options given on the command
1480        line. Possible values are:
1481+
1482* `nothing` do not push anything.
1483* `matching` push all matching branches.
1484  All branches having the same name in both ends are considered to be
1485  matching. This is the default.
1486* `tracking` push the current branch to its upstream branch.
1487* `current` push the current branch to a branch of the same name.
1488
1489rebase.stat::
1490        Whether to show a diffstat of what changed upstream since the last
1491        rebase. False by default.
1492
1493receive.autogc::
1494        By default, git-receive-pack will run "git-gc --auto" after
1495        receiving data from git-push and updating refs.  You can stop
1496        it by setting this variable to false.
1497
1498receive.fsckObjects::
1499        If it is set to true, git-receive-pack will check all received
1500        objects. It will abort in the case of a malformed object or a
1501        broken link. The result of an abort are only dangling objects.
1502        Defaults to false.
1503
1504receive.unpackLimit::
1505        If the number of objects received in a push is below this
1506        limit then the objects will be unpacked into loose object
1507        files. However if the number of received objects equals or
1508        exceeds this limit then the received pack will be stored as
1509        a pack, after adding any missing delta bases.  Storing the
1510        pack from a push can make the push operation complete faster,
1511        especially on slow filesystems.  If not set, the value of
1512        `transfer.unpackLimit` is used instead.
1513
1514receive.denyDeletes::
1515        If set to true, git-receive-pack will deny a ref update that deletes
1516        the ref. Use this to prevent such a ref deletion via a push.
1517
1518receive.denyCurrentBranch::
1519        If set to true or "refuse", receive-pack will deny a ref update
1520        to the currently checked out branch of a non-bare repository.
1521        Such a push is potentially dangerous because it brings the HEAD
1522        out of sync with the index and working tree. If set to "warn",
1523        print a warning of such a push to stderr, but allow the push to
1524        proceed. If set to false or "ignore", allow such pushes with no
1525        message. Defaults to "refuse".
1526
1527receive.denyNonFastForwards::
1528        If set to true, git-receive-pack will deny a ref update which is
1529        not a fast-forward. Use this to prevent such an update via a push,
1530        even if that push is forced. This configuration variable is
1531        set when initializing a shared repository.
1532
1533receive.updateserverinfo::
1534        If set to true, git-receive-pack will run git-update-server-info
1535        after receiving data from git-push and updating refs.
1536
1537remote.<name>.url::
1538        The URL of a remote repository.  See linkgit:git-fetch[1] or
1539        linkgit:git-push[1].
1540
1541remote.<name>.pushurl::
1542        The push URL of a remote repository.  See linkgit:git-push[1].
1543
1544remote.<name>.proxy::
1545        For remotes that require curl (http, https and ftp), the URL to
1546        the proxy to use for that remote.  Set to the empty string to
1547        disable proxying for that remote.
1548
1549remote.<name>.fetch::
1550        The default set of "refspec" for linkgit:git-fetch[1]. See
1551        linkgit:git-fetch[1].
1552
1553remote.<name>.push::
1554        The default set of "refspec" for linkgit:git-push[1]. See
1555        linkgit:git-push[1].
1556
1557remote.<name>.mirror::
1558        If true, pushing to this remote will automatically behave
1559        as if the `\--mirror` option was given on the command line.
1560
1561remote.<name>.skipDefaultUpdate::
1562        If true, this remote will be skipped by default when updating
1563        using linkgit:git-fetch[1] or the `update` subcommand of
1564        linkgit:git-remote[1].
1565
1566remote.<name>.skipFetchAll::
1567        If true, this remote will be skipped by default when updating
1568        using linkgit:git-fetch[1] or the `update` subcommand of
1569        linkgit:git-remote[1].
1570
1571remote.<name>.receivepack::
1572        The default program to execute on the remote side when pushing.  See
1573        option \--receive-pack of linkgit:git-push[1].
1574
1575remote.<name>.uploadpack::
1576        The default program to execute on the remote side when fetching.  See
1577        option \--upload-pack of linkgit:git-fetch-pack[1].
1578
1579remote.<name>.tagopt::
1580        Setting this value to \--no-tags disables automatic tag following when
1581        fetching from remote <name>
1582
1583remote.<name>.vcs::
1584        Setting this to a value <vcs> will cause git to interact with
1585        the remote with the git-remote-<vcs> helper.
1586
1587remotes.<group>::
1588        The list of remotes which are fetched by "git remote update
1589        <group>".  See linkgit:git-remote[1].
1590
1591repack.usedeltabaseoffset::
1592        By default, linkgit:git-repack[1] creates packs that use
1593        delta-base offset. If you need to share your repository with
1594        git older than version 1.4.4, either directly or via a dumb
1595        protocol such as http, then you need to set this option to
1596        "false" and repack. Access from old git versions over the
1597        native protocol are unaffected by this option.
1598
1599rerere.autoupdate::
1600        When set to true, `git-rerere` updates the index with the
1601        resulting contents after it cleanly resolves conflicts using
1602        previously recorded resolution.  Defaults to false.
1603
1604rerere.enabled::
1605        Activate recording of resolved conflicts, so that identical
1606        conflict hunks can be resolved automatically, should they
1607        be encountered again.  linkgit:git-rerere[1] command is by
1608        default enabled if you create `rr-cache` directory under
1609        `$GIT_DIR`, but can be disabled by setting this option to false.
1610
1611sendemail.identity::
1612        A configuration identity. When given, causes values in the
1613        'sendemail.<identity>' subsection to take precedence over
1614        values in the 'sendemail' section. The default identity is
1615        the value of 'sendemail.identity'.
1616
1617sendemail.smtpencryption::
1618        See linkgit:git-send-email[1] for description.  Note that this
1619        setting is not subject to the 'identity' mechanism.
1620
1621sendemail.smtpssl::
1622        Deprecated alias for 'sendemail.smtpencryption = ssl'.
1623
1624sendemail.<identity>.*::
1625        Identity-specific versions of the 'sendemail.*' parameters
1626        found below, taking precedence over those when the this
1627        identity is selected, through command-line or
1628        'sendemail.identity'.
1629
1630sendemail.aliasesfile::
1631sendemail.aliasfiletype::
1632sendemail.bcc::
1633sendemail.cc::
1634sendemail.cccmd::
1635sendemail.chainreplyto::
1636sendemail.confirm::
1637sendemail.envelopesender::
1638sendemail.from::
1639sendemail.multiedit::
1640sendemail.signedoffbycc::
1641sendemail.smtppass::
1642sendemail.suppresscc::
1643sendemail.suppressfrom::
1644sendemail.to::
1645sendemail.smtpserver::
1646sendemail.smtpserverport::
1647sendemail.smtpuser::
1648sendemail.thread::
1649sendemail.validate::
1650        See linkgit:git-send-email[1] for description.
1651
1652sendemail.signedoffcc::
1653        Deprecated alias for 'sendemail.signedoffbycc'.
1654
1655showbranch.default::
1656        The default set of branches for linkgit:git-show-branch[1].
1657        See linkgit:git-show-branch[1].
1658
1659status.relativePaths::
1660        By default, linkgit:git-status[1] shows paths relative to the
1661        current directory. Setting this variable to `false` shows paths
1662        relative to the repository root (this was the default for git
1663        prior to v1.5.4).
1664
1665status.showUntrackedFiles::
1666        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1667        files which are not currently tracked by Git. Directories which
1668        contain only untracked files, are shown with the directory name
1669        only. Showing untracked files means that Git needs to lstat() all
1670        all the files in the whole repository, which might be slow on some
1671        systems. So, this variable controls how the commands displays
1672        the untracked files. Possible values are:
1673+
1674--
1675        - 'no'     - Show no untracked files
1676        - 'normal' - Shows untracked files and directories
1677        - 'all'    - Shows also individual files in untracked directories.
1678--
1679+
1680If this variable is not specified, it defaults to 'normal'.
1681This variable can be overridden with the -u|--untracked-files option
1682of linkgit:git-status[1] and linkgit:git-commit[1].
1683
1684tar.umask::
1685        This variable can be used to restrict the permission bits of
1686        tar archive entries.  The default is 0002, which turns off the
1687        world write bit.  The special value "user" indicates that the
1688        archiving user's umask will be used instead.  See umask(2) and
1689        linkgit:git-archive[1].
1690
1691transfer.unpackLimit::
1692        When `fetch.unpackLimit` or `receive.unpackLimit` are
1693        not set, the value of this variable is used instead.
1694        The default value is 100.
1695
1696url.<base>.insteadOf::
1697        Any URL that starts with this value will be rewritten to
1698        start, instead, with <base>. In cases where some site serves a
1699        large number of repositories, and serves them with multiple
1700        access methods, and some users need to use different access
1701        methods, this feature allows people to specify any of the
1702        equivalent URLs and have git automatically rewrite the URL to
1703        the best alternative for the particular user, even for a
1704        never-before-seen repository on the site.  When more than one
1705        insteadOf strings match a given URL, the longest match is used.
1706
1707url.<base>.pushInsteadOf::
1708        Any URL that starts with this value will not be pushed to;
1709        instead, it will be rewritten to start with <base>, and the
1710        resulting URL will be pushed to. In cases where some site serves
1711        a large number of repositories, and serves them with multiple
1712        access methods, some of which do not allow push, this feature
1713        allows people to specify a pull-only URL and have git
1714        automatically use an appropriate URL to push, even for a
1715        never-before-seen repository on the site.  When more than one
1716        pushInsteadOf strings match a given URL, the longest match is
1717        used.  If a remote has an explicit pushurl, git will ignore this
1718        setting for that remote.
1719
1720user.email::
1721        Your email address to be recorded in any newly created commits.
1722        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1723        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1724
1725user.name::
1726        Your full name to be recorded in any newly created commits.
1727        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1728        environment variables.  See linkgit:git-commit-tree[1].
1729
1730user.signingkey::
1731        If linkgit:git-tag[1] is not selecting the key you want it to
1732        automatically when creating a signed tag, you can override the
1733        default selection with this variable.  This option is passed
1734        unchanged to gpg's --local-user parameter, so you may specify a key
1735        using any method that gpg supports.
1736
1737web.browser::
1738        Specify a web browser that may be used by some commands.
1739        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1740        may use it.