Documentation/config.txt

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