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