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