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