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