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