Documentation / config.txton commit Merge branch 'maint' (b281eea)
   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 or true/false.  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.trustctime::
 121        If false, the ctime differences between the index and the
 122        working copy are ignored; useful when the inode change time
 123        is regularly modified by something outside Git (file system
 124        crawlers and some backup systems).
 125        See linkgit:git-update-index[1]. True by default.
 126
 127core.quotepath::
 128        The commands that output paths (e.g. 'ls-files',
 129        'diff'), when not given the `-z` option, will quote
 130        "unusual" characters in the pathname by enclosing the
 131        pathname in a double-quote pair and with backslashes the
 132        same way strings in C source code are quoted.  If this
 133        variable is set to false, the bytes higher than 0x80 are
 134        not quoted but output as verbatim.  Note that double
 135        quote, backslash and control characters are always
 136        quoted without `-z` regardless of the setting of this
 137        variable.
 138
 139core.autocrlf::
 140        If true, makes git convert `CRLF` at the end of lines in text files to
 141        `LF` when reading from the filesystem, and convert in reverse when
 142        writing to the filesystem.  The variable can be set to
 143        'input', in which case the conversion happens only while
 144        reading from the filesystem but files are written out with
 145        `LF` at the end of lines.  Currently, which paths to consider
 146        "text" (i.e. be subjected to the autocrlf mechanism) is
 147        decided purely based on the contents.
 148
 149core.safecrlf::
 150        If true, makes git check if converting `CRLF` as controlled by
 151        `core.autocrlf` is reversible.  Git will verify if a command
 152        modifies a file in the work tree either directly or indirectly.
 153        For example, committing a file followed by checking out the
 154        same file should yield the original file in the work tree.  If
 155        this is not the case for the current setting of
 156        `core.autocrlf`, git will reject the file.  The variable can
 157        be set to "warn", in which case git will only warn about an
 158        irreversible conversion but continue the operation.
 159+
 160CRLF conversion bears a slight chance of corrupting data.
 161autocrlf=true will convert CRLF to LF during commit and LF to
 162CRLF during checkout.  A file that contains a mixture of LF and
 163CRLF before the commit cannot be recreated by git.  For text
 164files this is the right thing to do: it corrects line endings
 165such that we have only LF line endings in the repository.
 166But for binary files that are accidentally classified as text the
 167conversion can corrupt data.
 168+
 169If you recognize such corruption early you can easily fix it by
 170setting the conversion type explicitly in .gitattributes.  Right
 171after committing you still have the original file in your work
 172tree and this file is not yet corrupted.  You can explicitly tell
 173git that this file is binary and git will handle the file
 174appropriately.
 175+
 176Unfortunately, the desired effect of cleaning up text files with
 177mixed line endings and the undesired effect of corrupting binary
 178files cannot be distinguished.  In both cases CRLFs are removed
 179in an irreversible way.  For text files this is the right thing
 180to do because CRLFs are line endings, while for binary files
 181converting CRLFs corrupts data.
 182+
 183Note, this safety check does not mean that a checkout will generate a
 184file identical to the original file for a different setting of
 185`core.autocrlf`, but only for the current one.  For example, a text
 186file with `LF` would be accepted with `core.autocrlf=input` and could
 187later be checked out with `core.autocrlf=true`, in which case the
 188resulting file would contain `CRLF`, although the original file
 189contained `LF`.  However, in both work trees the line endings would be
 190consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 191file with mixed line endings would be reported by the `core.safecrlf`
 192mechanism.
 193
 194core.symlinks::
 195        If false, symbolic links are checked out as small plain files that
 196        contain the link text. linkgit:git-update-index[1] and
 197        linkgit:git-add[1] will not change the recorded type to regular
 198        file. Useful on filesystems like FAT that do not support
 199        symbolic links. True by default.
 200
 201core.gitProxy::
 202        A "proxy command" to execute (as 'command host port') instead
 203        of establishing direct connection to the remote server when
 204        using the git protocol for fetching. If the variable value is
 205        in the "COMMAND for DOMAIN" format, the command is applied only
 206        on hostnames ending with the specified domain string. This variable
 207        may be set multiple times and is matched in the given order;
 208        the first match wins.
 209+
 210Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
 211(which always applies universally, without the special "for"
 212handling).
 213
 214core.ignoreStat::
 215        If true, commands which modify both the working tree and the index
 216        will mark the updated paths with the "assume unchanged" bit in the
 217        index. These marked files are then assumed to stay unchanged in the
 218        working copy, until you mark them otherwise manually - Git will not
 219        detect the file changes by lstat() calls. This is useful on systems
 220        where those are very slow, such as Microsoft Windows.
 221        See linkgit:git-update-index[1].
 222        False by default.
 223
 224core.preferSymlinkRefs::
 225        Instead of the default "symref" format for HEAD
 226        and other symbolic reference files, use symbolic links.
 227        This is sometimes needed to work with old scripts that
 228        expect HEAD to be a symbolic link.
 229
 230core.bare::
 231        If true this repository is assumed to be 'bare' and has no
 232        working directory associated with it.  If this is the case a
 233        number of commands that require a working directory will be
 234        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 235+
 236This setting is automatically guessed by linkgit:git-clone[1] or
 237linkgit:git-init[1] when the repository was created.  By default a
 238repository that ends in "/.git" is assumed to be not bare (bare =
 239false), while all other repositories are assumed to be bare (bare
 240= true).
 241
 242core.worktree::
 243        Set the path to the working tree.  The value will not be
 244        used in combination with repositories found automatically in
 245        a .git directory (i.e. $GIT_DIR is not set).
 246        This can be overridden by the GIT_WORK_TREE environment
 247        variable and the '--work-tree' command line option. It can be
 248        a absolute path or relative path to the directory specified by
 249        --git-dir or GIT_DIR.
 250        Note: If --git-dir or GIT_DIR are specified but none of
 251        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 252        the current working directory is regarded as the top directory
 253        of your working tree.
 254
 255core.logAllRefUpdates::
 256        Enable the reflog. Updates to a ref <ref> is logged to the file
 257        "$GIT_DIR/logs/<ref>", by appending the new and old
 258        SHA1, the date/time and the reason of the update, but
 259        only when the file exists.  If this configuration
 260        variable is set to true, missing "$GIT_DIR/logs/<ref>"
 261        file is automatically created for branch heads.
 262+
 263This information can be used to determine what commit
 264was the tip of a branch "2 days ago".
 265+
 266This value is true by default in a repository that has
 267a working directory associated with it, and false by
 268default in a bare repository.
 269
 270core.repositoryFormatVersion::
 271        Internal variable identifying the repository format and layout
 272        version.
 273
 274core.sharedRepository::
 275        When 'group' (or 'true'), the repository is made shareable between
 276        several users in a group (making sure all the files and objects are
 277        group-writable). When 'all' (or 'world' or 'everybody'), the
 278        repository will be readable by all users, additionally to being
 279        group-shareable. When 'umask' (or 'false'), git will use permissions
 280        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 281        files in the repository will have this mode value. '0xxx' will override
 282        user's umask value, and thus, users with a safe umask (0077) can use
 283        this option. Examples: '0660' is equivalent to 'group'. '0640' is a
 284        repository that is group-readable but not group-writable.
 285        See linkgit:git-init[1]. False by default.
 286
 287core.warnAmbiguousRefs::
 288        If true, git will warn you if the ref name you passed it is ambiguous
 289        and might match multiple refs in the .git/refs/ tree. True by default.
 290
 291core.compression::
 292        An integer -1..9, indicating a default compression level.
 293        -1 is the zlib default. 0 means no compression,
 294        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 295        If set, this provides a default to other compression variables,
 296        such as 'core.loosecompression' and 'pack.compression'.
 297
 298core.loosecompression::
 299        An integer -1..9, indicating the compression level for objects that
 300        are not in a pack file. -1 is the zlib default. 0 means no
 301        compression, and 1..9 are various speed/size tradeoffs, 9 being
 302        slowest.  If not set,  defaults to core.compression.  If that is
 303        not set,  defaults to 1 (best speed).
 304
 305core.packedGitWindowSize::
 306        Number of bytes of a pack file to map into memory in a
 307        single mapping operation.  Larger window sizes may allow
 308        your system to process a smaller number of large pack files
 309        more quickly.  Smaller window sizes will negatively affect
 310        performance due to increased calls to the operating system's
 311        memory manager, but may improve performance when accessing
 312        a large number of large pack files.
 313+
 314Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 315MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 316be reasonable for all users/operating systems.  You probably do
 317not need to adjust this value.
 318+
 319Common unit suffixes of 'k', 'm', or 'g' are supported.
 320
 321core.packedGitLimit::
 322        Maximum number of bytes to map simultaneously into memory
 323        from pack files.  If Git needs to access more than this many
 324        bytes at once to complete an operation it will unmap existing
 325        regions to reclaim virtual address space within the process.
 326+
 327Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 328This should be reasonable for all users/operating systems, except on
 329the largest projects.  You probably do not need to adjust this value.
 330+
 331Common unit suffixes of 'k', 'm', or 'g' are supported.
 332
 333core.deltaBaseCacheLimit::
 334        Maximum number of bytes to reserve for caching base objects
 335        that multiple deltafied objects reference.  By storing the
 336        entire decompressed base objects in a cache Git is able
 337        to avoid unpacking and decompressing frequently used base
 338        objects multiple times.
 339+
 340Default is 16 MiB on all platforms.  This should be reasonable
 341for all users/operating systems, except on the largest projects.
 342You probably do not need to adjust this value.
 343+
 344Common unit suffixes of 'k', 'm', or 'g' are supported.
 345
 346core.excludesfile::
 347        In addition to '.gitignore' (per-directory) and
 348        '.git/info/exclude', git looks into this file for patterns
 349        of files which are not meant to be tracked.  See
 350        linkgit:gitignore[5].
 351
 352core.editor::
 353        Commands such as `commit` and `tag` that lets you edit
 354        messages by launching an editor uses the value of this
 355        variable when it is set, and the environment variable
 356        `GIT_EDITOR` is not set.  The order of preference is
 357        `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
 358        `EDITOR` environment variables and then finally `vi`.
 359
 360core.pager::
 361        The command that git will use to paginate output.  Can
 362        be overridden with the `GIT_PAGER` environment
 363        variable.  Note that git sets the `LESS` environment
 364        variable to `FRSX` if it is unset when it runs the
 365        pager.  One can change these settings by setting the
 366        `LESS` variable to some other value or by giving the
 367        `core.pager` option a value such as "`less -+FRSX`".
 368
 369core.whitespace::
 370        A comma separated list of common whitespace problems to
 371        notice.  'git-diff' will use `color.diff.whitespace` to
 372        highlight them, and 'git-apply --whitespace=error' will
 373        consider them as errors.  You can prefix `-` to disable
 374        any of them (e.g. `-trailing-space`):
 375+
 376* `trailing-space` treats trailing whitespaces at the end of the line
 377  as an error (enabled by default).
 378* `space-before-tab` treats a space character that appears immediately
 379  before a tab character in the initial indent part of the line as an
 380  error (enabled by default).
 381* `indent-with-non-tab` treats a line that is indented with 8 or more
 382  space characters as an error (not enabled by default).
 383* `cr-at-eol` treats a carriage-return at the end of line as
 384  part of the line terminator, i.e. with it, `trailing-space`
 385  does not trigger if the character before such a carriage-return
 386  is not a whitespace (not enabled by default).
 387
 388core.fsyncobjectfiles::
 389        This boolean will enable 'fsync()' when writing object files.
 390+
 391This is a total waste of time and effort on a filesystem that orders
 392data writes properly, but can be useful for filesystems that do not use
 393journalling (traditional UNIX filesystems) or that only journal metadata
 394and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 395
 396alias.*::
 397        Command aliases for the linkgit:git[1] command wrapper - e.g.
 398        after defining "alias.last = cat-file commit HEAD", the invocation
 399        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 400        confusion and troubles with script usage, aliases that
 401        hide existing git commands are ignored. Arguments are split by
 402        spaces, the usual shell quoting and escaping is supported.
 403        quote pair and a backslash can be used to quote them.
 404+
 405If the alias expansion is prefixed with an exclamation point,
 406it will be treated as a shell command.  For example, defining
 407"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 408"git new" is equivalent to running the shell command
 409"gitk --all --not ORIG_HEAD".
 410
 411apply.whitespace::
 412        Tells 'git-apply' how to handle whitespaces, in the same way
 413        as the '--whitespace' option. See linkgit:git-apply[1].
 414
 415branch.autosetupmerge::
 416        Tells 'git-branch' and 'git-checkout' to setup new branches
 417        so that linkgit:git-pull[1] will appropriately merge from the
 418        starting point branch. Note that even if this option is not set,
 419        this behavior can be chosen per-branch using the `--track`
 420        and `--no-track` options. The valid settings are: `false` -- no
 421        automatic setup is done; `true` -- automatic setup is done when the
 422        starting point is a remote branch; `always` -- automatic setup is
 423        done when the starting point is either a local branch or remote
 424        branch. This option defaults to true.
 425
 426branch.autosetuprebase::
 427        When a new branch is created with 'git-branch' or 'git-checkout'
 428        that tracks another branch, this variable tells git to set
 429        up pull to rebase instead of merge (see "branch.<name>.rebase").
 430        When `never`, rebase is never automatically set to true.
 431        When `local`, rebase is set to true for tracked branches of
 432        other local branches.
 433        When `remote`, rebase is set to true for tracked branches of
 434        remote branches.
 435        When `always`, rebase will be set to true for all tracking
 436        branches.
 437        See "branch.autosetupmerge" for details on how to set up a
 438        branch to track another branch.
 439        This option defaults to never.
 440
 441branch.<name>.remote::
 442        When in branch <name>, it tells 'git-fetch' which remote to fetch.
 443        If this option is not given, 'git-fetch' defaults to remote "origin".
 444
 445branch.<name>.merge::
 446        When in branch <name>, it tells 'git-fetch' the default
 447        refspec to be marked for merging in FETCH_HEAD. The value is
 448        handled like the remote part of a refspec, and must match a
 449        ref which is fetched from the remote given by
 450        "branch.<name>.remote".
 451        The merge information is used by 'git-pull' (which at first calls
 452        'git-fetch') to lookup the default branch for merging. Without
 453        this option, 'git-pull' defaults to merge the first refspec fetched.
 454        Specify multiple values to get an octopus merge.
 455        If you wish to setup 'git-pull' so that it merges into <name> from
 456        another branch in the local repository, you can point
 457        branch.<name>.merge to the desired branch, and use the special setting
 458        `.` (a period) for branch.<name>.remote.
 459
 460branch.<name>.mergeoptions::
 461        Sets default options for merging into branch <name>. The syntax and
 462        supported options are equal to that of linkgit:git-merge[1], but
 463        option values containing whitespace characters are currently not
 464        supported.
 465
 466branch.<name>.rebase::
 467        When true, rebase the branch <name> on top of the fetched branch,
 468        instead of merging the default branch from the default remote when
 469        "git pull" is run.
 470        *NOTE*: this is a possibly dangerous operation; do *not* use
 471        it unless you understand the implications (see linkgit:git-rebase[1]
 472        for details).
 473
 474browser.<tool>.cmd::
 475        Specify the command to invoke the specified browser. The
 476        specified command is evaluated in shell with the URLs passed
 477        as arguments. (See linkgit:git-web--browse[1].)
 478
 479browser.<tool>.path::
 480        Override the path for the given tool that may be used to
 481        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 482        working repository in gitweb (see linkgit:git-instaweb[1]).
 483
 484clean.requireForce::
 485        A boolean to make git-clean do nothing unless given -f
 486        or -n.   Defaults to true.
 487
 488color.branch::
 489        A boolean to enable/disable color in the output of
 490        linkgit:git-branch[1]. May be set to `always`,
 491        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 492        only when the output is to a terminal. Defaults to false.
 493
 494color.branch.<slot>::
 495        Use customized color for branch coloration. `<slot>` is one of
 496        `current` (the current branch), `local` (a local branch),
 497        `remote` (a tracking branch in refs/remotes/), `plain` (other
 498        refs).
 499+
 500The value for these configuration variables is a list of colors (at most
 501two) and attributes (at most one), separated by spaces.  The colors
 502accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 503`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 504`blink` and `reverse`.  The first color given is the foreground; the
 505second is the background.  The position of the attribute, if any,
 506doesn't matter.
 507
 508color.diff::
 509        When set to `always`, always use colors in patch.
 510        When false (or `never`), never.  When set to `true` or `auto`, use
 511        colors only when the output is to the terminal. Defaults to false.
 512
 513color.diff.<slot>::
 514        Use customized color for diff colorization.  `<slot>` specifies
 515        which part of the patch to use the specified color, and is one
 516        of `plain` (context text), `meta` (metainformation), `frag`
 517        (hunk header), `old` (removed lines), `new` (added lines),
 518        `commit` (commit headers), or `whitespace` (highlighting
 519        whitespace errors). The values of these variables may be specified as
 520        in color.branch.<slot>.
 521
 522color.interactive::
 523        When set to `always`, always use colors for interactive prompts
 524        and displays (such as those used by "git-add --interactive").
 525        When false (or `never`), never.  When set to `true` or `auto`, use
 526        colors only when the output is to the terminal. Defaults to false.
 527
 528color.interactive.<slot>::
 529        Use customized color for 'git-add --interactive'
 530        output. `<slot>` may be `prompt`, `header`, or `help`, for
 531        three distinct types of normal output from interactive
 532        programs.  The values of these variables may be specified as
 533        in color.branch.<slot>.
 534
 535color.pager::
 536        A boolean to enable/disable colored output when the pager is in
 537        use (default is true).
 538
 539color.status::
 540        A boolean to enable/disable color in the output of
 541        linkgit:git-status[1]. May be set to `always`,
 542        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 543        only when the output is to a terminal. Defaults to false.
 544
 545color.status.<slot>::
 546        Use customized color for status colorization. `<slot>` is
 547        one of `header` (the header text of the status message),
 548        `added` or `updated` (files which are added but not committed),
 549        `changed` (files which are changed but not added in the index),
 550        `untracked` (files which are not tracked by git), or
 551        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 552        to red). The values of these variables may be specified as in
 553        color.branch.<slot>.
 554
 555commit.template::
 556        Specify a file to use as the template for new commit messages.
 557
 558color.ui::
 559        When set to `always`, always use colors in all git commands which
 560        are capable of colored output. When false (or `never`), never. When
 561        set to `true` or `auto`, use colors only when the output is to the
 562        terminal. When more specific variables of color.* are set, they always
 563        take precedence over this setting. Defaults to false.
 564
 565diff.autorefreshindex::
 566        When using 'git-diff' to compare with work tree
 567        files, do not consider stat-only change as changed.
 568        Instead, silently run `git update-index --refresh` to
 569        update the cached stat information for paths whose
 570        contents in the work tree match the contents in the
 571        index.  This option defaults to true.  Note that this
 572        affects only 'git-diff' Porcelain, and not lower level
 573        'diff' commands, such as 'git-diff-files'.
 574
 575diff.suppress-blank-empty::
 576        A boolean to inhibit the standard behavior of printing a space
 577        before each empty output line. Defaults to false.
 578
 579diff.external::
 580        If this config variable is set, diff generation is not
 581        performed using the internal diff machinery, but using the
 582        given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
 583        environment variable.  The command is called with parameters
 584        as described under "git Diffs" in linkgit:git[1].  Note: if
 585        you want to use an external diff program only on a subset of
 586        your files, you might want to use linkgit:gitattributes[5] instead.
 587
 588diff.renameLimit::
 589        The number of files to consider when performing the copy/rename
 590        detection; equivalent to the 'git-diff' option '-l'.
 591
 592diff.renames::
 593        Tells git to detect renames.  If set to any boolean value, it
 594        will enable basic rename detection.  If set to "copies" or
 595        "copy", it will detect copies, as well.
 596
 597fetch.unpackLimit::
 598        If the number of objects fetched over the git native
 599        transfer is below this
 600        limit, then the objects will be unpacked into loose object
 601        files. However if the number of received objects equals or
 602        exceeds this limit then the received pack will be stored as
 603        a pack, after adding any missing delta bases.  Storing the
 604        pack from a push can make the push operation complete faster,
 605        especially on slow filesystems.  If not set, the value of
 606        `transfer.unpackLimit` is used instead.
 607
 608format.numbered::
 609        A boolean which can enable sequence numbers in patch subjects.
 610        Setting this option to "auto" will enable it only if there is
 611        more than one patch.  See --numbered option in
 612        linkgit:git-format-patch[1].
 613
 614format.headers::
 615        Additional email headers to include in a patch to be submitted
 616        by mail.  See linkgit:git-format-patch[1].
 617
 618format.suffix::
 619        The default for format-patch is to output files with the suffix
 620        `.patch`. Use this variable to change that suffix (make sure to
 621        include the dot if you want it).
 622
 623format.pretty::
 624        The default pretty format for log/show/whatchanged command,
 625        See linkgit:git-log[1], linkgit:git-show[1],
 626        linkgit:git-whatchanged[1].
 627
 628gc.aggressiveWindow::
 629        The window size parameter used in the delta compression
 630        algorithm used by 'git-gc --aggressive'.  This defaults
 631        to 10.
 632
 633gc.auto::
 634        When there are approximately more than this many loose
 635        objects in the repository, `git gc --auto` will pack them.
 636        Some Porcelain commands use this command to perform a
 637        light-weight garbage collection from time to time.  The
 638        default value is 6700.  Setting this to 0 disables it.
 639
 640gc.autopacklimit::
 641        When there are more than this many packs that are not
 642        marked with `*.keep` file in the repository, `git gc
 643        --auto` consolidates them into one larger pack.  The
 644        default value is 50.  Setting this to 0 disables it.
 645
 646gc.packrefs::
 647        'git-gc' does not run `git pack-refs` in a bare repository by
 648        default so that older dumb-transport clients can still fetch
 649        from the repository.  Setting this to `true` lets 'git-gc'
 650        to run `git pack-refs`.  Setting this to `false` tells
 651        'git-gc' never to run `git pack-refs`. The default setting is
 652        `notbare`. Enable it only when you know you do not have to
 653        support such clients.  The default setting will change to `true`
 654        at some stage, and setting this to `false` will continue to
 655        prevent `git pack-refs` from being run from 'git-gc'.
 656
 657gc.pruneexpire::
 658        When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
 659        Override the grace period with this config variable.
 660
 661gc.reflogexpire::
 662        'git-reflog expire' removes reflog entries older than
 663        this time; defaults to 90 days.
 664
 665gc.reflogexpireunreachable::
 666        'git-reflog expire' removes reflog entries older than
 667        this time and are not reachable from the current tip;
 668        defaults to 30 days.
 669
 670gc.rerereresolved::
 671        Records of conflicted merge you resolved earlier are
 672        kept for this many days when 'git-rerere gc' is run.
 673        The default is 60 days.  See linkgit:git-rerere[1].
 674
 675gc.rerereunresolved::
 676        Records of conflicted merge you have not resolved are
 677        kept for this many days when 'git-rerere gc' is run.
 678        The default is 15 days.  See linkgit:git-rerere[1].
 679
 680rerere.autoupdate::
 681        When set to true, `git-rerere` updates the index with the
 682        resulting contents after it cleanly resolves conflicts using
 683        previously recorded resolution.  Defaults to false.
 684
 685rerere.enabled::
 686        Activate recording of resolved conflicts, so that identical
 687        conflict hunks can be resolved automatically, should they
 688        be encountered again.  linkgit:git-rerere[1] command is by
 689        default enabled if you create `rr-cache` directory under
 690        `$GIT_DIR`, but can be disabled by setting this option to false.
 691
 692gitcvs.enabled::
 693        Whether the CVS server interface is enabled for this repository.
 694        See linkgit:git-cvsserver[1].
 695
 696gitcvs.logfile::
 697        Path to a log file where the CVS server interface well... logs
 698        various stuff. See linkgit:git-cvsserver[1].
 699
 700gitcvs.usecrlfattr::
 701        If true, the server will look up the `crlf` attribute for
 702        files to determine the '-k' modes to use. If `crlf` is set,
 703        the '-k' mode will be left blank, so cvs clients will
 704        treat it as text. If `crlf` is explicitly unset, the file
 705        will be set with '-kb' mode, which suppresses any newline munging
 706        the client might otherwise do. If `crlf` is not specified,
 707        then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
 708
 709gitcvs.allbinary::
 710        This is used if 'gitcvs.usecrlfattr' does not resolve
 711        the correct '-kb' mode to use. If true, all
 712        unresolved files are sent to the client in
 713        mode '-kb'. This causes the client to treat them
 714        as binary files, which suppresses any newline munging it
 715        otherwise might do. Alternatively, if it is set to "guess",
 716        then the contents of the file are examined to decide if
 717        it is binary, similar to 'core.autocrlf'.
 718
 719gitcvs.dbname::
 720        Database used by git-cvsserver to cache revision information
 721        derived from the git repository. The exact meaning depends on the
 722        used database driver, for SQLite (which is the default driver) this
 723        is a filename. Supports variable substitution (see
 724        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
 725        Default: '%Ggitcvs.%m.sqlite'
 726
 727gitcvs.dbdriver::
 728        Used Perl DBI driver. You can specify any available driver
 729        for this here, but it might not work. git-cvsserver is tested
 730        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
 731        reported *not* to work with 'DBD::mysql'. Experimental feature.
 732        May not contain double colons (`:`). Default: 'SQLite'.
 733        See linkgit:git-cvsserver[1].
 734
 735gitcvs.dbuser, gitcvs.dbpass::
 736        Database user and password. Only useful if setting 'gitcvs.dbdriver',
 737        since SQLite has no concept of database users and/or passwords.
 738        'gitcvs.dbuser' supports variable substitution (see
 739        linkgit:git-cvsserver[1] for details).
 740
 741gitcvs.dbTableNamePrefix::
 742        Database table name prefix.  Prepended to the names of any
 743        database tables used, allowing a single database to be used
 744        for several repositories.  Supports variable substitution (see
 745        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
 746        characters will be replaced with underscores.
 747
 748All gitcvs variables except for 'gitcvs.usecrlfattr' and
 749'gitcvs.allbinary' can also be specified as
 750'gitcvs.<access_method>.<varname>' (where 'access_method'
 751is one of "ext" and "pserver") to make them apply only for the given
 752access method.
 753
 754gui.commitmsgwidth::
 755        Defines how wide the commit message window is in the
 756        linkgit:git-gui[1]. "75" is the default.
 757
 758gui.diffcontext::
 759        Specifies how many context lines should be used in calls to diff
 760        made by the linkgit:git-gui[1]. The default is "5".
 761
 762gui.matchtrackingbranch::
 763        Determines if new branches created with linkgit:git-gui[1] should
 764        default to tracking remote branches with matching names or
 765        not. Default: "false".
 766
 767gui.newbranchtemplate::
 768        Is used as suggested name when creating new branches using the
 769        linkgit:git-gui[1].
 770
 771gui.pruneduringfetch::
 772        "true" if linkgit:git-gui[1] should prune tracking branches when
 773        performing a fetch. The default value is "false".
 774
 775gui.trustmtime::
 776        Determines if linkgit:git-gui[1] should trust the file modification
 777        timestamp or not. By default the timestamps are not trusted.
 778
 779gui.spellingdictionary::
 780        Specifies the dictionary used for spell checking commit messages in
 781        the linkgit:git-gui[1]. When set to "none" spell checking is turned
 782        off.
 783
 784help.browser::
 785        Specify the browser that will be used to display help in the
 786        'web' format. See linkgit:git-help[1].
 787
 788help.format::
 789        Override the default help format used by linkgit:git-help[1].
 790        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
 791        the default. 'web' and 'html' are the same.
 792
 793help.autocorrect::
 794        Automatically correct and execute mistyped commands after
 795        waiting for the given number of deciseconds (0.1 sec). If more
 796        than one command can be deduced from the entered text, nothing
 797        will be executed.  If the value of this option is negative,
 798        the corrected command will be executed immediately. If the
 799        value is 0 - the command will be just shown but not executed.
 800        This is the default.
 801
 802http.proxy::
 803        Override the HTTP proxy, normally configured using the 'http_proxy'
 804        environment variable (see linkgit:curl[1]).  This can be overridden
 805        on a per-remote basis; see remote.<name>.proxy
 806
 807http.sslVerify::
 808        Whether to verify the SSL certificate when fetching or pushing
 809        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
 810        variable.
 811
 812http.sslCert::
 813        File containing the SSL certificate when fetching or pushing
 814        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
 815        variable.
 816
 817http.sslKey::
 818        File containing the SSL private key when fetching or pushing
 819        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
 820        variable.
 821
 822http.sslCAInfo::
 823        File containing the certificates to verify the peer with when
 824        fetching or pushing over HTTPS. Can be overridden by the
 825        'GIT_SSL_CAINFO' environment variable.
 826
 827http.sslCAPath::
 828        Path containing files with the CA certificates to verify the peer
 829        with when fetching or pushing over HTTPS. Can be overridden
 830        by the 'GIT_SSL_CAPATH' environment variable.
 831
 832http.maxRequests::
 833        How many HTTP requests to launch in parallel. Can be overridden
 834        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
 835
 836http.lowSpeedLimit, http.lowSpeedTime::
 837        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 838        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 839        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
 840        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
 841
 842http.noEPSV::
 843        A boolean which disables using of EPSV ftp command by curl.
 844        This can helpful with some "poor" ftp servers which don't
 845        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
 846        environment variable. Default is false (curl will use EPSV).
 847
 848i18n.commitEncoding::
 849        Character encoding the commit messages are stored in; git itself
 850        does not care per se, but this information is necessary e.g. when
 851        importing commits from emails or in the gitk graphical history
 852        browser (and possibly at other places in the future or in other
 853        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
 854
 855i18n.logOutputEncoding::
 856        Character encoding the commit messages are converted to when
 857        running 'git-log' and friends.
 858
 859instaweb.browser::
 860        Specify the program that will be used to browse your working
 861        repository in gitweb. See linkgit:git-instaweb[1].
 862
 863instaweb.httpd::
 864        The HTTP daemon command-line to start gitweb on your working
 865        repository. See linkgit:git-instaweb[1].
 866
 867instaweb.local::
 868        If true the web server started by linkgit:git-instaweb[1] will
 869        be bound to the local IP (127.0.0.1).
 870
 871instaweb.modulepath::
 872        The module path for an apache httpd used by linkgit:git-instaweb[1].
 873
 874instaweb.port::
 875        The port number to bind the gitweb httpd to. See
 876        linkgit:git-instaweb[1].
 877
 878log.date::
 879        Set default date-time mode for the log command. Setting log.date
 880        value is similar to using 'git-log'\'s --date option. The value is one of the
 881        following alternatives: {relative,local,default,iso,rfc,short}.
 882        See linkgit:git-log[1].
 883
 884log.showroot::
 885        If true, the initial commit will be shown as a big creation event.
 886        This is equivalent to a diff against an empty tree.
 887        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
 888        normally hide the root commit will now show it. True by default.
 889
 890man.viewer::
 891        Specify the programs that may be used to display help in the
 892        'man' format. See linkgit:git-help[1].
 893
 894include::merge-config.txt[]
 895
 896man.<tool>.cmd::
 897        Specify the command to invoke the specified man viewer. The
 898        specified command is evaluated in shell with the man page
 899        passed as argument. (See linkgit:git-help[1].)
 900
 901man.<tool>.path::
 902        Override the path for the given tool that may be used to
 903        display help in the 'man' format. See linkgit:git-help[1].
 904
 905mergetool.<tool>.path::
 906        Override the path for the given tool.  This is useful in case
 907        your tool is not in the PATH.
 908
 909mergetool.<tool>.cmd::
 910        Specify the command to invoke the specified merge tool.  The
 911        specified command is evaluated in shell with the following
 912        variables available: 'BASE' is the name of a temporary file
 913        containing the common base of the files to be merged, if available;
 914        'LOCAL' is the name of a temporary file containing the contents of
 915        the file on the current branch; 'REMOTE' is the name of a temporary
 916        file containing the contents of the file from the branch being
 917        merged; 'MERGED' contains the name of the file to which the merge
 918        tool should write the results of a successful merge.
 919
 920mergetool.<tool>.trustExitCode::
 921        For a custom merge command, specify whether the exit code of
 922        the merge command can be used to determine whether the merge was
 923        successful.  If this is not set to true then the merge target file
 924        timestamp is checked and the merge assumed to have been successful
 925        if the file has been updated, otherwise the user is prompted to
 926        indicate the success of the merge.
 927
 928mergetool.keepBackup::
 929        After performing a merge, the original file with conflict markers
 930        can be saved as a file with a `.orig` extension.  If this variable
 931        is set to `false` then this file is not preserved.  Defaults to
 932        `true` (i.e. keep the backup files).
 933
 934pack.window::
 935        The size of the window used by linkgit:git-pack-objects[1] when no
 936        window size is given on the command line. Defaults to 10.
 937
 938pack.depth::
 939        The maximum delta depth used by linkgit:git-pack-objects[1] when no
 940        maximum depth is given on the command line. Defaults to 50.
 941
 942pack.windowMemory::
 943        The window memory size limit used by linkgit:git-pack-objects[1]
 944        when no limit is given on the command line.  The value can be
 945        suffixed with "k", "m", or "g".  Defaults to 0, meaning no
 946        limit.
 947
 948pack.compression::
 949        An integer -1..9, indicating the compression level for objects
 950        in a pack file. -1 is the zlib default. 0 means no
 951        compression, and 1..9 are various speed/size tradeoffs, 9 being
 952        slowest.  If not set,  defaults to core.compression.  If that is
 953        not set,  defaults to -1, the zlib default, which is "a default
 954        compromise between speed and compression (currently equivalent
 955        to level 6)."
 956
 957pack.deltaCacheSize::
 958        The maximum memory in bytes used for caching deltas in
 959        linkgit:git-pack-objects[1].
 960        A value of 0 means no limit. Defaults to 0.
 961
 962pack.deltaCacheLimit::
 963        The maximum size of a delta, that is cached in
 964        linkgit:git-pack-objects[1]. Defaults to 1000.
 965
 966pack.threads::
 967        Specifies the number of threads to spawn when searching for best
 968        delta matches.  This requires that linkgit:git-pack-objects[1]
 969        be compiled with pthreads otherwise this option is ignored with a
 970        warning. This is meant to reduce packing time on multiprocessor
 971        machines. The required amount of memory for the delta search window
 972        is however multiplied by the number of threads.
 973        Specifying 0 will cause git to auto-detect the number of CPU's
 974        and set the number of threads accordingly.
 975
 976pack.indexVersion::
 977        Specify the default pack index version.  Valid values are 1 for
 978        legacy pack index used by Git versions prior to 1.5.2, and 2 for
 979        the new pack index with capabilities for packs larger than 4 GB
 980        as well as proper protection against the repacking of corrupted
 981        packs.  Version 2 is the default.  Note that version 2 is enforced
 982        and this config option ignored whenever the corresponding pack is
 983        larger than 2 GB.
 984+
 985If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
 986cloning or fetching over a non native protocol (e.g. "http" and "rsync")
 987that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
 988other side may give you a repository that cannot be accessed with your
 989older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
 990you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
 991the `{asterisk}.idx` file.
 992
 993pack.packSizeLimit::
 994        The default maximum size of a pack.  This setting only affects
 995        packing to a file, i.e. the git:// protocol is unaffected.  It
 996        can be overridden by the `\--max-pack-size` option of
 997        linkgit:git-repack[1].
 998
 999pager.<cmd>::
1000        Allows turning on or off pagination of the output of a
1001        particular git subcommand when writing to a tty.  If
1002        `\--paginate` or `\--no-pager` is specified on the command line,
1003        it takes precedence over this option.  To disable pagination for
1004        all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".
1005
1006pull.octopus::
1007        The default merge strategy to use when pulling multiple branches
1008        at once.
1009
1010pull.twohead::
1011        The default merge strategy to use when pulling a single branch.
1012
1013remote.<name>.url::
1014        The URL of a remote repository.  See linkgit:git-fetch[1] or
1015        linkgit:git-push[1].
1016
1017remote.<name>.proxy::
1018        For remotes that require curl (http, https and ftp), the URL to
1019        the proxy to use for that remote.  Set to the empty string to
1020        disable proxying for that remote.
1021
1022remote.<name>.fetch::
1023        The default set of "refspec" for linkgit:git-fetch[1]. See
1024        linkgit:git-fetch[1].
1025
1026remote.<name>.push::
1027        The default set of "refspec" for linkgit:git-push[1]. See
1028        linkgit:git-push[1].
1029
1030remote.<name>.mirror::
1031        If true, pushing to this remote will automatically behave
1032        as if the `\--mirror` option was given on the command line.
1033
1034remote.<name>.skipDefaultUpdate::
1035        If true, this remote will be skipped by default when updating
1036        using the update subcommand of linkgit:git-remote[1].
1037
1038remote.<name>.receivepack::
1039        The default program to execute on the remote side when pushing.  See
1040        option \--receive-pack of linkgit:git-push[1].
1041
1042remote.<name>.uploadpack::
1043        The default program to execute on the remote side when fetching.  See
1044        option \--upload-pack of linkgit:git-fetch-pack[1].
1045
1046remote.<name>.tagopt::
1047        Setting this value to \--no-tags disables automatic tag following when
1048        fetching from remote <name>
1049
1050remotes.<group>::
1051        The list of remotes which are fetched by "git remote update
1052        <group>".  See linkgit:git-remote[1].
1053
1054repack.usedeltabaseoffset::
1055        By default, linkgit:git-repack[1] creates packs that use
1056        delta-base offset. If you need to share your repository with
1057        git older than version 1.4.4, either directly or via a dumb
1058        protocol such as http, then you need to set this option to
1059        "false" and repack. Access from old git versions over the
1060        native protocol are unaffected by this option.
1061
1062showbranch.default::
1063        The default set of branches for linkgit:git-show-branch[1].
1064        See linkgit:git-show-branch[1].
1065
1066status.relativePaths::
1067        By default, linkgit:git-status[1] shows paths relative to the
1068        current directory. Setting this variable to `false` shows paths
1069        relative to the repository root (this was the default for git
1070        prior to v1.5.4).
1071
1072status.showUntrackedFiles::
1073        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1074        files which are not currently tracked by Git. Directories which
1075        contain only untracked files, are shown with the directory name
1076        only. Showing untracked files means that Git needs to lstat() all
1077        all the files in the whole repository, which might be slow on some
1078        systems. So, this variable controls how the commands displays
1079        the untracked files. Possible values are:
1080+
1081--
1082        - 'no'     - Show no untracked files
1083        - 'normal' - Shows untracked files and directories
1084        - 'all'    - Shows also individual files in untracked directories.
1085--
1086+
1087If this variable is not specified, it defaults to 'normal'.
1088This variable can be overridden with the -u|--untracked-files option
1089of linkgit:git-status[1] and linkgit:git-commit[1].
1090
1091tar.umask::
1092        This variable can be used to restrict the permission bits of
1093        tar archive entries.  The default is 0002, which turns off the
1094        world write bit.  The special value "user" indicates that the
1095        archiving user's umask will be used instead.  See umask(2) and
1096        linkgit:git-archive[1].
1097
1098url.<base>.insteadOf::
1099        Any URL that starts with this value will be rewritten to
1100        start, instead, with <base>. In cases where some site serves a
1101        large number of repositories, and serves them with multiple
1102        access methods, and some users need to use different access
1103        methods, this feature allows people to specify any of the
1104        equivalent URLs and have git automatically rewrite the URL to
1105        the best alternative for the particular user, even for a
1106        never-before-seen repository on the site.  When more than one
1107        insteadOf strings match a given URL, the longest match is used.
1108
1109user.email::
1110        Your email address to be recorded in any newly created commits.
1111        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1112        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1113
1114user.name::
1115        Your full name to be recorded in any newly created commits.
1116        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1117        environment variables.  See linkgit:git-commit-tree[1].
1118
1119user.signingkey::
1120        If linkgit:git-tag[1] is not selecting the key you want it to
1121        automatically when creating a signed tag, you can override the
1122        default selection with this variable.  This option is passed
1123        unchanged to gpg's --local-user parameter, so you may specify a key
1124        using any method that gpg supports.
1125
1126imap::
1127        The configuration variables in the 'imap' section are described
1128        in linkgit:git-imap-send[1].
1129
1130receive.fsckObjects::
1131        If it is set to true, git-receive-pack will check all received
1132        objects. It will abort in the case of a malformed object or a
1133        broken link. The result of an abort are only dangling objects.
1134        Defaults to false.
1135
1136receive.unpackLimit::
1137        If the number of objects received in a push is below this
1138        limit then the objects will be unpacked into loose object
1139        files. However if the number of received objects equals or
1140        exceeds this limit then the received pack will be stored as
1141        a pack, after adding any missing delta bases.  Storing the
1142        pack from a push can make the push operation complete faster,
1143        especially on slow filesystems.  If not set, the value of
1144        `transfer.unpackLimit` is used instead.
1145
1146receive.denyNonFastForwards::
1147        If set to true, git-receive-pack will deny a ref update which is
1148        not a fast forward. Use this to prevent such an update via a push,
1149        even if that push is forced. This configuration variable is
1150        set when initializing a shared repository.
1151
1152transfer.unpackLimit::
1153        When `fetch.unpackLimit` or `receive.unpackLimit` are
1154        not set, the value of this variable is used instead.
1155        The default value is 100.
1156
1157web.browser::
1158        Specify a web browser that may be used by some commands.
1159        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1160        may use it.