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