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