config.txt 57.3 KB
Newer Older
P
Petr Baudis 已提交
1 2 3 4
CONFIGURATION FILE
------------------

The git configuration file contains a number of variables that affect
5 6 7
the git command's behavior. `.git/config` file for each repository
is used to store the information for that repository, and
`$HOME/.gitconfig` is used to store per user information to give
8 9
fallback values for `.git/config` file. The file `/etc/gitconfig`
can be used to store system-wide defaults.
10 11

They can be used by both the git plumbing
12
and the porcelains. The variables are divided into sections, where
P
Petr Baudis 已提交
13 14 15 16 17
in the fully qualified variable name the variable itself is the last
dot-separated segment and the section name is everything before the last
dot. The variable names are case-insensitive and only alphanumeric
characters are allowed. Some variables may appear multiple times.

18 19 20
Syntax
~~~~~~

P
Petr Baudis 已提交
21
The syntax is fairly flexible and permissive; whitespaces are mostly
22 23 24 25 26 27
ignored.  The '#' and ';' characters begin comments to the end of line,
blank lines are ignored.

The file consists of sections and variables.  A section begins with
the name of the section in square brackets and continues until the next
section begins.  Section names are not case sensitive.  Only alphanumeric
28
characters, `-` and `.` are allowed in section names.  Each variable
29 30 31 32 33 34 35 36 37 38 39 40
must belong to some section, which means that there must be section
header before first setting of a variable.

Sections can be further divided into subsections.  To begin a subsection
put its name in double quotes, separated by space from the section name,
in the section header, like in example below:

--------
	[section "subsection"]

--------

41
Subsection names can contain any characters except newline (doublequote
42
`"` and backslash have to be escaped as `\"` and `\\`,
P
Pavel Roskin 已提交
43
respectively) and are case sensitive.  Section header cannot span multiple
44 45 46 47 48 49 50 51 52 53 54 55
lines.  Variables may belong directly to a section or to a given subsection.
You can have `[section]` if you have `[section "subsection"]`, but you
don't need to.

There is also (case insensitive) alternative `[section.subsection]` syntax.
In this syntax subsection names follow the same restrictions as for section
name.

All the other lines are recognized as setting variables, in the form
'name = value'.  If there is no equal sign on the line, the entire line
is taken as 'name' and the variable is recognized as boolean "true".
The variable names are case-insensitive and only alphanumeric
56
characters and `-` are allowed.  There can be more than one value
57 58 59 60 61 62 63 64 65
for a given variable; we say then that variable is multivalued.

Leading and trailing whitespace in a variable value is discarded.
Internal whitespace within a variable value is retained verbatim.

The values following the equals sign in variable assign are all either
a string, an integer, or a boolean.  Boolean values may be given as yes/no,
0/1 or true/false.  Case is not significant in boolean values, when
converting value to the canonical form using '--bool' type specifier;
66
'git-config' will ensure that the output is "true" or "false".
67 68 69 70 71

String values may be entirely or partially enclosed in double quotes.
You need to enclose variable value in double quotes if you want to
preserve leading or trailing whitespace, or if variable value contains
beginning of comment characters (if it contains '#' or ';').
72 73
Double quote `"` and backslash `\` characters in variable value must
be escaped: use `\"` for `"` and `\\` for `\`.
74

75 76 77
The following escape sequences (beside `\"` and `\\`) are recognized:
`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
and `\b` for backspace (BS).  No other char escape sequence, nor octal
78 79
char sequences are valid.

80
Variable value ending in a `\` is continued on the next line in the
81 82 83
customary UNIX fashion.

Some variables may require special value format.
P
Petr Baudis 已提交
84 85 86 87 88 89 90 91 92 93 94

Example
~~~~~~~

	# Core variables
	[core]
		; Don't trust file modes
		filemode = false

	# Our diff algorithm
	[diff]
95
		external = /usr/local/bin/diff-wrapper
P
Petr Baudis 已提交
96 97
		renames = true

98 99 100 101
	[branch "devel"]
		remote = origin
		merge = refs/heads/devel

102 103
	# Proxy settings
	[core]
104
		gitProxy="ssh" for "kernel.org"
105
		gitProxy=default-proxy ; for the rest
106

P
Petr Baudis 已提交
107 108 109 110
Variables
~~~~~~~~~

Note that this list is non-comprehensive and not necessarily complete.
111 112
For command-specific variables, you will find a more detailed description
in the appropriate manual page. You will find a description of non-core
P
Petr Baudis 已提交
113 114 115 116 117
porcelain configuration variables in the respective porcelain documentation.

core.fileMode::
	If false, the executable bit differences between the index and
	the working copy are ignored; useful on broken filesystems like FAT.
118
	See linkgit:git-update-index[1]. True by default.
P
Petr Baudis 已提交
119

120 121 122 123 124 125 126
core.ignoreCygwinFSTricks::
	This option is only used by Cygwin implementation of Git. If false,
	the Cygwin stat() and lstat() functions are used. This may be useful
	if your repository consists of a few separate directories joined in
	one hierarchy using Cygwin mount. If true, Git uses native Win32 API
	whenever it is possible and falls back to Cygwin functions only to
	handle symbol links. The native mode is more than twice faster than
127 128 129
	normal Cygwin l/stat() functions. True by default, unless core.filemode
	is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
	POSIX emulation is required to support core.filemode.
130

131 132 133 134 135 136 137
core.trustctime::
	If false, the ctime differences between the index and the
	working copy are ignored; useful when the inode change time
	is regularly modified by something outside Git (file system
	crawlers and some backup systems).
	See linkgit:git-update-index[1]. True by default.

138
core.quotepath::
139 140
	The commands that output paths (e.g. 'ls-files',
	'diff'), when not given the `-z` option, will quote
141 142 143 144 145 146 147 148 149
	"unusual" characters in the pathname by enclosing the
	pathname in a double-quote pair and with backslashes the
	same way strings in C source code are quoted.  If this
	variable is set to false, the bytes higher than 0x80 are
	not quoted but output as verbatim.  Note that double
	quote, backslash and control characters are always
	quoted without `-z` regardless of the setting of this
	variable.

150 151 152 153 154 155 156 157 158 159
core.autocrlf::
	If true, makes git convert `CRLF` at the end of lines in text files to
	`LF` when reading from the filesystem, and convert in reverse when
	writing to the filesystem.  The variable can be set to
	'input', in which case the conversion happens only while
	reading from the filesystem but files are written out with
	`LF` at the end of lines.  Currently, which paths to consider
	"text" (i.e. be subjected to the autocrlf mechanism) is
	decided purely based on the contents.

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
core.safecrlf::
	If true, makes git check if converting `CRLF` as controlled by
	`core.autocrlf` is reversible.  Git will verify if a command
	modifies a file in the work tree either directly or indirectly.
	For example, committing a file followed by checking out the
	same file should yield the original file in the work tree.  If
	this is not the case for the current setting of
	`core.autocrlf`, git will reject the file.  The variable can
	be set to "warn", in which case git will only warn about an
	irreversible conversion but continue the operation.
+
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout.  A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git.  For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
+
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes.  Right
after committing you still have the original file in your work
tree and this file is not yet corrupted.  You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
+
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished.  In both cases CRLFs are removed
in an irreversible way.  For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
+
Note, this safety check does not mean that a checkout will generate a
file identical to the original file for a different setting of
`core.autocrlf`, but only for the current one.  For example, a text
file with `LF` would be accepted with `core.autocrlf=input` and could
later be checked out with `core.autocrlf=true`, in which case the
resulting file would contain `CRLF`, although the original file
contained `LF`.  However, in both work trees the line endings would be
consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
file with mixed line endings would be reported by the `core.safecrlf`
mechanism.

205 206
core.symlinks::
	If false, symbolic links are checked out as small plain files that
207 208
	contain the link text. linkgit:git-update-index[1] and
	linkgit:git-add[1] will not change the recorded type to regular
209 210 211
	file. Useful on filesystems like FAT that do not support
	symbolic links. True by default.

P
Petr Baudis 已提交
212 213 214 215 216 217 218 219
core.gitProxy::
	A "proxy command" to execute (as 'command host port') instead
	of establishing direct connection to the remote server when
	using the git protocol for fetching. If the variable value is
	in the "COMMAND for DOMAIN" format, the command is applied only
	on hostnames ending with the specified domain string. This variable
	may be set multiple times and is matched in the given order;
	the first match wins.
220 221 222 223
+
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
(which always applies universally, without the special "for"
handling).
224 225 226 227 228
+
The special string `none` can be used as the proxy command to
specify that no proxy be used for a given domain pattern.
This is useful for excluding servers inside a firewall from
proxy use, while defaulting to a common proxy for external domains.
P
Petr Baudis 已提交
229 230

core.ignoreStat::
231 232 233 234 235 236 237
	If true, commands which modify both the working tree and the index
	will mark the updated paths with the "assume unchanged" bit in the
	index. These marked files are then assumed to stay unchanged in the
	working copy, until you	mark them otherwise manually - Git will not
	detect the file changes	by lstat() calls. This is useful on systems
	where those are very slow, such as Microsoft Windows.
	See linkgit:git-update-index[1].
P
Petr Baudis 已提交
238 239
	False by default.

240 241 242 243 244
core.preferSymlinkRefs::
	Instead of the default "symref" format for HEAD
	and other symbolic reference files, use symbolic links.
	This is sometimes needed to work with old scripts that
	expect HEAD to be a symbolic link.
P
Petr Baudis 已提交
245

246 247 248 249
core.bare::
	If true this repository is assumed to be 'bare' and has no
	working directory associated with it.  If this is the case a
	number of commands that require a working directory will be
250
	disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
251
+
252 253
This setting is automatically guessed by linkgit:git-clone[1] or
linkgit:git-init[1] when the repository was created.  By default a
254 255 256 257
repository that ends in "/.git" is assumed to be not bare (bare =
false), while all other repositories are assumed to be bare (bare
= true).

258 259 260 261
core.worktree::
	Set the path to the working tree.  The value will not be
	used in combination with repositories found automatically in
	a .git directory (i.e. $GIT_DIR is not set).
262
	This can be overridden by the GIT_WORK_TREE environment
263 264 265 266 267 268 269
	variable and the '--work-tree' command line option. It can be
	a absolute path or relative path to the directory specified by
	--git-dir or GIT_DIR.
	Note: If --git-dir or GIT_DIR are specified but none of
	--work-tree, GIT_WORK_TREE and core.worktree is specified,
	the current working directory is regarded as the top directory
	of your working tree.
270

271
core.logAllRefUpdates::
272
	Enable the reflog. Updates to a ref <ref> is logged to the file
273 274 275 276 277
	"$GIT_DIR/logs/<ref>", by appending the new and old
	SHA1, the date/time and the reason of the update, but
	only when the file exists.  If this configuration
	variable is set to true, missing "$GIT_DIR/logs/<ref>"
	file is automatically created for branch heads.
278 279 280 281 282 283 284
+
This information can be used to determine what commit
was the tip of a branch "2 days ago".
+
This value is true by default in a repository that has
a working directory associated with it, and false by
default in a bare repository.
285

P
Petr Baudis 已提交
286 287 288 289 290
core.repositoryFormatVersion::
	Internal variable identifying the repository format and layout
	version.

core.sharedRepository::
291 292 293 294 295
	When 'group' (or 'true'), the repository is made shareable between
	several users in a group (making sure all the files and objects are
	group-writable). When 'all' (or 'world' or 'everybody'), the
	repository will be readable by all users, additionally to being
	group-shareable. When 'umask' (or 'false'), git will use permissions
296 297 298 299 300 301
	reported by umask(2). When '0xxx', where '0xxx' is an octal number,
	files in the repository will have this mode value. '0xxx' will override
	user's umask value, and thus, users with a safe umask (0077) can use
	this option. Examples: '0660' is equivalent to 'group'. '0640' is a
	repository that is group-readable but not group-writable.
	See linkgit:git-init[1]. False by default.
P
Petr Baudis 已提交
302 303 304 305 306

core.warnAmbiguousRefs::
	If true, git will warn you if the ref name you passed it is ambiguous
	and might match multiple refs in the .git/refs/ tree. True by default.

307
core.compression::
308 309 310
	An integer -1..9, indicating a default compression level.
	-1 is the zlib default. 0 means no compression,
	and 1..9 are various speed/size tradeoffs, 9 being slowest.
311 312
	If set, this provides a default to other compression variables,
	such as 'core.loosecompression' and 'pack.compression'.
313 314

core.loosecompression::
315
	An integer -1..9, indicating the compression level for objects that
316
	are not in a pack file. -1 is the zlib default. 0 means no
317
	compression, and 1..9 are various speed/size tradeoffs, 9 being
318
	slowest.  If not set,  defaults to core.compression.  If that is
319
	not set,  defaults to 1 (best speed).
320

321 322 323 324 325
core.packedGitWindowSize::
	Number of bytes of a pack file to map into memory in a
	single mapping operation.  Larger window sizes may allow
	your system to process a smaller number of large pack files
	more quickly.  Smaller window sizes will negatively affect
326
	performance due to increased calls to the operating system's
327
	memory manager, but may improve performance when accessing
328 329 330 331 332 333
	a large number of large pack files.
+
Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
be reasonable for all users/operating systems.  You probably do
not need to adjust this value.
334 335
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
336

337 338 339 340 341
core.packedGitLimit::
	Maximum number of bytes to map simultaneously into memory
	from pack files.  If Git needs to access more than this many
	bytes at once to complete an operation it will unmap existing
	regions to reclaim virtual address space within the process.
342 343 344 345
+
Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
This should be reasonable for all users/operating systems, except on
the largest projects.  You probably do not need to adjust this value.
346 347
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
348

349 350 351 352 353 354 355 356 357 358 359 360 361
core.deltaBaseCacheLimit::
	Maximum number of bytes to reserve for caching base objects
	that multiple deltafied objects reference.  By storing the
	entire decompressed base objects in a cache Git is able
	to avoid unpacking and decompressing frequently used base
	objects multiple times.
+
Default is 16 MiB on all platforms.  This should be reasonable
for all users/operating systems, except on the largest projects.
You probably do not need to adjust this value.
+
Common unit suffixes of 'k', 'm', or 'g' are supported.

362
core.excludesfile::
363 364
	In addition to '.gitignore' (per-directory) and
	'.git/info/exclude', git looks into this file for patterns
365
	of files which are not meant to be tracked.  See
366
	linkgit:gitignore[5].
367

368 369
core.editor::
	Commands such as `commit` and `tag` that lets you edit
370
	messages by launching an editor uses the value of this
371 372
	variable when it is set, and the environment variable
	`GIT_EDITOR` is not set.  The order of preference is
373 374
	`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
	`EDITOR` environment variables and then finally `vi`.
375

376
core.pager::
377 378 379 380 381
	The command that git will use to paginate output.  Can
	be overridden with the `GIT_PAGER` environment
	variable.  Note that git sets the `LESS` environment
	variable to `FRSX` if it is unset when it runs the
	pager.  One can change these settings by setting the
382 383 384 385 386 387 388 389
	`LESS` variable to some other value.  Alternately,
	these settings can be overridden on a project or
	global basis by setting the `core.pager` option.
	Setting `core.pager` has no affect on the `LESS`
	environment variable behaviour above, so if you want
	to override git's default settings this way, you need
	to be explicit.  For example, to disable the S option
	in a backward compatible manner, set `core.pager`
390
	to `less -+$LESS -FRX`.  This will be passed to the
391
	shell by git, which will translate the final command to
392
	`LESS=FRSX less -+FRSX -FRX`.
393

394 395
core.whitespace::
	A comma separated list of common whitespace problems to
396 397
	notice.  'git-diff' will use `color.diff.whitespace` to
	highlight them, and 'git-apply --whitespace=error' will
398 399
	consider them as errors.  You can prefix `-` to disable
	any of them (e.g. `-trailing-space`):
400 401 402 403 404 405 406
+
* `trailing-space` treats trailing whitespaces at the end of the line
  as an error (enabled by default).
* `space-before-tab` treats a space character that appears immediately
  before a tab character in the initial indent part of the line as an
  error (enabled by default).
* `indent-with-non-tab` treats a line that is indented with 8 or more
407
  space characters as an error (not enabled by default).
J
Junio C Hamano 已提交
408 409 410 411
* `cr-at-eol` treats a carriage-return at the end of line as
  part of the line terminator, i.e. with it, `trailing-space`
  does not trigger if the character before such a carriage-return
  is not a whitespace (not enabled by default).
412

413 414 415 416 417 418 419 420
core.fsyncobjectfiles::
	This boolean will enable 'fsync()' when writing object files.
+
This is a total waste of time and effort on a filesystem that orders
data writes properly, but can be useful for filesystems that do not use
journalling (traditional UNIX filesystems) or that only journal metadata
and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").

L
Linus Torvalds 已提交
421 422 423 424 425 426 427 428 429
core.preloadindex::
	Enable parallel index preload for operations like 'git diff'
+
This can speed up operations like 'git diff' and 'git status' especially
on filesystems like NFS that have weak caching semantics and thus
relatively high IO latencies.  With this set to 'true', git will do the
index comparison to the filesystem data in parallel, allowing
overlapping IO's.

P
Petr Baudis 已提交
430
alias.*::
431
	Command aliases for the linkgit:git[1] command wrapper - e.g.
P
Petr Baudis 已提交
432 433
	after defining "alias.last = cat-file commit HEAD", the invocation
	"git last" is equivalent to "git cat-file commit HEAD". To avoid
P
Petr Baudis 已提交
434 435 436 437
	confusion and troubles with script usage, aliases that
	hide existing git commands are ignored. Arguments are split by
	spaces, the usual shell quoting and escaping is supported.
	quote pair and a backslash can be used to quote them.
438 439 440 441 442 443
+
If the alias expansion is prefixed with an exclamation point,
it will be treated as a shell command.  For example, defining
"alias.new = !gitk --all --not ORIG_HEAD", the invocation
"git new" is equivalent to running the shell command
"gitk --all --not ORIG_HEAD".
444

P
Petr Baudis 已提交
445
apply.whitespace::
446
	Tells 'git-apply' how to handle whitespaces, in the same way
447
	as the '--whitespace' option. See linkgit:git-apply[1].
P
Petr Baudis 已提交
448

P
Paolo Bonzini 已提交
449
branch.autosetupmerge::
450
	Tells 'git-branch' and 'git-checkout' to setup new branches
451 452
	so that linkgit:git-pull[1] will appropriately merge from the
	starting point branch. Note that even if this option is not set,
P
Paolo Bonzini 已提交
453
	this behavior can be chosen per-branch using the `--track`
454 455 456 457 458
	and `--no-track` options. The valid settings are: `false` -- no
	automatic setup is done; `true` -- automatic setup is done when the
	starting point is a remote branch; `always` -- automatic setup is
	done when the starting point is either a local branch or remote
	branch. This option defaults to true.
P
Paolo Bonzini 已提交
459

460
branch.autosetuprebase::
461
	When a new branch is created with 'git-branch' or 'git-checkout'
462 463 464 465 466 467 468 469 470 471 472 473 474
	that tracks another branch, this variable tells git to set
	up pull to rebase instead of merge (see "branch.<name>.rebase").
	When `never`, rebase is never automatically set to true.
	When `local`, rebase is set to true for tracked branches of
	other local branches.
	When `remote`, rebase is set to true for tracked branches of
	remote branches.
	When `always`, rebase will be set to true for all tracking
	branches.
	See "branch.autosetupmerge" for details on how to set up a
	branch to track another branch.
	This option defaults to never.

475
branch.<name>.remote::
476 477 478
	When in branch <name>, it tells 'git-fetch' and 'git-push' which
	remote to fetch from/push to.  It defaults to `origin` if no remote is
	configured. `origin` is also used if you are not on any branch.
479

480
branch.<name>.merge::
481 482 483
	Defines, together with branch.<name>.remote, the upstream branch
	for the given branch. It tells 'git-fetch'/'git-pull' which
	branch to merge from.
484
	When in branch <name>, it tells 'git-fetch' the default
D
Daniel Barkalow 已提交
485 486 487 488
	refspec to be marked for merging in FETCH_HEAD. The value is
	handled like the remote part of a refspec, and must match a
	ref which is fetched from the remote given by
	"branch.<name>.remote".
489 490 491
	The merge information is used by 'git-pull' (which at first calls
	'git-fetch') to lookup the default branch for merging. Without
	this option, 'git-pull' defaults to merge the first refspec fetched.
492
	Specify multiple values to get an octopus merge.
493
	If you wish to setup 'git-pull' so that it merges into <name> from
494 495 496
	another branch in the local repository, you can point
	branch.<name>.merge to the desired branch, and use the special setting
	`.` (a period) for branch.<name>.remote.
497

498 499
branch.<name>.mergeoptions::
	Sets default options for merging into branch <name>. The syntax and
500
	supported options are equal to that of linkgit:git-merge[1], but
501 502 503
	option values containing whitespace characters are currently not
	supported.

504 505
branch.<name>.rebase::
	When true, rebase the branch <name> on top of the fetched branch,
506 507
	instead of merging the default branch from the default remote when
	"git pull" is run.
508
	*NOTE*: this is a possibly dangerous operation; do *not* use
509
	it unless you understand the implications (see linkgit:git-rebase[1]
510 511
	for details).

512 513 514 515 516
browser.<tool>.cmd::
	Specify the command to invoke the specified browser. The
	specified command is evaluated in shell with the URLs passed
	as arguments. (See linkgit:git-web--browse[1].)

517 518
browser.<tool>.path::
	Override the path for the given tool that may be used to
519 520
	browse HTML help (see '-w' option in linkgit:git-help[1]) or a
	working repository in gitweb (see linkgit:git-instaweb[1]).
521

522
clean.requireForce::
523 524
	A boolean to make git-clean do nothing unless given -f
	or -n.   Defaults to true.
525

526 527
color.branch::
	A boolean to enable/disable color in the output of
528
	linkgit:git-branch[1]. May be set to `always`,
529
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
530 531 532 533 534 535
	only when the output is to a terminal. Defaults to false.

color.branch.<slot>::
	Use customized color for branch coloration. `<slot>` is one of
	`current` (the current branch), `local` (a local branch),
	`remote` (a tracking branch in refs/remotes/), `plain` (other
536 537 538 539 540 541 542 543 544
	refs).
+
The value for these configuration variables is a list of colors (at most
two) and attributes (at most one), separated by spaces.  The colors
accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
`blink` and `reverse`.  The first color given is the foreground; the
second is the background.  The position of the attribute, if any,
doesn't matter.
545

546
color.diff::
547 548 549
	When set to `always`, always use colors in patch.
	When false (or `never`), never.  When set to `true` or `auto`, use
	colors only when the output is to the terminal. Defaults to false.
550

551
color.diff.<slot>::
552 553 554 555
	Use customized color for diff colorization.  `<slot>` specifies
	which part of the patch to use the specified color, and is one
	of `plain` (context text), `meta` (metainformation), `frag`
	(hunk header), `old` (removed lines), `new` (added lines),
556 557
	`commit` (commit headers), or `whitespace` (highlighting
	whitespace errors). The values of these variables may be specified as
558
	in color.branch.<slot>.
559

R
René Scharfe 已提交
560 561 562 563 564
color.grep::
	When set to `always`, always highlight matches.  When `false` (or
	`never`), never.  When set to `true` or `auto`, use color only
	when the output is written to the terminal.  Defaults to `false`.

565 566 567 568 569 570 571 572
color.grep.external::
	The string value of this variable is passed to an external 'grep'
	command as a command line option if match highlighting is turned
	on.  If set to an empty string, no option is passed at all,
	turning off coloring for external 'grep' calls; this is the default.
	For GNU grep, set it to `--color=always` to highlight matches even
	when a pager is used.

R
René Scharfe 已提交
573 574
color.grep.match::
	Use customized color for matches.  The value of this variable
575 576 577
	may be specified as in color.branch.<slot>.  It is passed using
	the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
	calling an external 'grep'.
R
René Scharfe 已提交
578

J
Junio C Hamano 已提交
579
color.interactive::
580
	When set to `always`, always use colors for interactive prompts
581
	and displays (such as those used by "git-add --interactive").
J
Junio C Hamano 已提交
582 583 584 585
	When false (or `never`), never.  When set to `true` or `auto`, use
	colors only when the output is to the terminal. Defaults to false.

color.interactive.<slot>::
586
	Use customized color for 'git-add --interactive'
587 588
	output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
	four distinct types of normal output from interactive
J
Junio C Hamano 已提交
589 590 591
	programs.  The values of these variables may be specified as
	in color.branch.<slot>.

592 593 594 595 596 597
color.pager::
	A boolean to enable/disable colored output when the pager is in
	use (default is true).

color.status::
	A boolean to enable/disable color in the output of
598
	linkgit:git-status[1]. May be set to `always`,
599
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
600 601 602 603 604
	only when the output is to a terminal. Defaults to false.

color.status.<slot>::
	Use customized color for status colorization. `<slot>` is
	one of `header` (the header text of the status message),
605 606
	`added` or `updated` (files which are added but not committed),
	`changed` (files which are changed but not added in the index),
607 608 609 610
	`untracked` (files which are not tracked by git), or
	`nobranch` (the color the 'no branch' warning is shown in, defaulting
	to red). The values of these variables may be specified as in
	color.branch.<slot>.
611

612 613 614 615 616 617 618
color.ui::
	When set to `always`, always use colors in all git commands which
	are capable of colored output. When false (or `never`), never. When
	set to `true` or `auto`, use colors only when the output is to the
	terminal. When more specific variables of color.* are set, they always
	take precedence over this setting. Defaults to false.

619 620 621
commit.template::
	Specify a file to use as the template for new commit messages.

622
diff.autorefreshindex::
623
	When using 'git-diff' to compare with work tree
624 625 626 627 628
	files, do not consider stat-only change as changed.
	Instead, silently run `git update-index --refresh` to
	update the cached stat information for paths whose
	contents in the work tree match the contents in the
	index.  This option defaults to true.  Note that this
629
	affects only 'git-diff' Porcelain, and not lower level
630
	'diff' commands, such as 'git-diff-files'.
631

632 633 634
diff.external::
	If this config variable is set, diff generation is not
	performed using the internal diff machinery, but using the
635 636 637 638 639
	given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
	environment variable.  The command is called with parameters
	as described under "git Diffs" in linkgit:git[1].  Note: if
	you want to use an external diff program only on a subset of
	your files, you	might want to use linkgit:gitattributes[5] instead.
640

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
diff.mnemonicprefix::
	If set, 'git-diff' uses a prefix pair that is different from the
	standard "a/" and "b/" depending on what is being compared.  When
	this configuration is in effect, reverse diff output also swaps
	the order of the prefixes:
'git-diff';;
	compares the (i)ndex and the (w)ork tree;
'git-diff HEAD';;
	 compares a (c)ommit and the (w)ork tree;
'git diff --cached';;
	compares a (c)ommit and the (i)ndex;
'git-diff HEAD:file1 file2';;
	compares an (o)bject and a (w)ork tree entity;
'git diff --no-index a b';;
	compares two non-git things (1) and (2).

P
Petr Baudis 已提交
657 658
diff.renameLimit::
	The number of files to consider when performing the copy/rename
659
	detection; equivalent to the 'git-diff' option '-l'.
P
Petr Baudis 已提交
660

661 662 663 664 665
diff.renames::
	Tells git to detect renames.  If set to any boolean value, it
	will enable basic rename detection.  If set to "copies" or
	"copy", it will detect copies, as well.

666
diff.suppressBlankEmpty::
R
Richard Hartmann 已提交
667 668 669
	A boolean to inhibit the standard behavior of printing a space
	before each empty output line. Defaults to false.

670
diff.wordRegex::
671 672 673 674 675
	A POSIX Extended Regular Expression used to determine what is a "word"
	when performing word-by-word difference calculations.  Character
	sequences that match the regular expression are "words", all other
	characters are *ignorable* whitespace.

676 677 678 679 680 681 682 683
fetch.unpackLimit::
	If the number of objects fetched over the git native
	transfer is below this
	limit, then the objects will be unpacked into loose object
	files. However if the number of received objects equals or
	exceeds this limit then the received pack will be stored as
	a pack, after adding any missing delta bases.  Storing the
	pack from a push can make the push operation complete faster,
684 685
	especially on slow filesystems.  If not set, the value of
	`transfer.unpackLimit` is used instead.
686

687
format.numbered::
688 689 690 691 692
	A boolean which can enable or disable sequence numbers in patch
	subjects.  It defaults to "auto" which enables it only if there
	is more than one patch.  It can be enabled or disabled for all
	messages by setting it to "true" or "false".  See --numbered
	option in linkgit:git-format-patch[1].
693

P
Petr Baudis 已提交
694 695
format.headers::
	Additional email headers to include in a patch to be submitted
696
	by mail.  See linkgit:git-format-patch[1].
P
Petr Baudis 已提交
697

698 699 700 701
format.suffix::
	The default for format-patch is to output files with the suffix
	`.patch`. Use this variable to change that suffix (make sure to
	include the dot if you want it).
P
Petr Baudis 已提交
702

703 704 705 706 707
format.pretty::
	The default pretty format for log/show/whatchanged command,
	See linkgit:git-log[1], linkgit:git-show[1],
	linkgit:git-whatchanged[1].

708 709 710 711 712 713 714 715 716 717
format.thread::
	The default threading style for 'git-format-patch'.  Can be
	either a boolean value, `shallow` or `deep`.  'Shallow'
	threading makes every mail a reply to the head of the series,
	where the head is chosen from the cover letter, the
	`\--in-reply-to`, and the first patch mail, in this order.
	'Deep' threading makes every mail a reply to the previous one.
	A true boolean value is the same as `shallow`, and a false
	value disables threading.

718 719 720 721 722 723 724
format.signoff::
    A boolean value which lets you enable the `-s/--signoff` option of
    format-patch by default. *Note:* Adding the Signed-off-by: line to a
    patch should be a conscious act and means that you certify you have
    the rights to submit this work under the same open source license.
    Please see the 'SubmittingPatches' document for further discussion.

725 726
gc.aggressiveWindow::
	The window size parameter used in the delta compression
727
	algorithm used by 'git-gc --aggressive'.  This defaults
728 729
	to 10.

730 731 732 733
gc.auto::
	When there are approximately more than this many loose
	objects in the repository, `git gc --auto` will pack them.
	Some Porcelain commands use this command to perform a
734 735
	light-weight garbage collection from time to time.  The
	default value is 6700.  Setting this to 0 disables it.
736

737 738 739
gc.autopacklimit::
	When there are more than this many packs that are not
	marked with `*.keep` file in the repository, `git gc
740
	--auto` consolidates them into one larger pack.  The
741
	default	value is 50.  Setting this to 0 disables it.
742

743
gc.packrefs::
744
	'git-gc' does not run `git pack-refs` in a bare repository by
745
	default so that older dumb-transport clients can still fetch
746
	from the repository.  Setting this to `true` lets 'git-gc'
747
	to run `git pack-refs`.  Setting this to `false` tells
748
	'git-gc' never to run `git pack-refs`. The default setting is
749 750 751
	`notbare`. Enable it only when you know you do not have to
	support such clients.  The default setting will change to `true`
	at some stage, and setting this to `false` will continue to
752
	prevent `git pack-refs` from being run from 'git-gc'.
753

754
gc.pruneexpire::
755
	When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
756 757 758
	Override the grace period with this config variable.  The value
	"now" may be used to disable this  grace period and always prune
	unreachable objects immediately.
759

760
gc.reflogexpire::
761
	'git-reflog expire' removes reflog entries older than
762 763 764
	this time; defaults to 90 days.

gc.reflogexpireunreachable::
765
	'git-reflog expire' removes reflog entries older than
766 767 768
	this time and are not reachable from the current tip;
	defaults to 30 days.

769 770
gc.rerereresolved::
	Records of conflicted merge you resolved earlier are
771
	kept for this many days when 'git-rerere gc' is run.
772
	The default is 60 days.  See linkgit:git-rerere[1].
773 774 775

gc.rerereunresolved::
	Records of conflicted merge you have not resolved are
776
	kept for this many days when 'git-rerere gc' is run.
777
	The default is 15 days.  See linkgit:git-rerere[1].
778

779 780 781 782
gitcvs.commitmsgannotation::
	Append this string to each commit message. Set to empty string
	to disable this feature. Defaults to "via git-CVS emulator".

P
Petr Baudis 已提交
783
gitcvs.enabled::
784
	Whether the CVS server interface is enabled for this repository.
785
	See linkgit:git-cvsserver[1].
P
Petr Baudis 已提交
786 787

gitcvs.logfile::
788
	Path to a log file where the CVS server interface well... logs
789
	various stuff. See linkgit:git-cvsserver[1].
P
Petr Baudis 已提交
790

791
gitcvs.usecrlfattr::
M
Matthew Ogilvie 已提交
792 793 794 795
	If true, the server will look up the `crlf` attribute for
	files to determine the '-k' modes to use. If `crlf` is set,
	the '-k' mode will be left blank, so cvs clients will
	treat it as text. If `crlf` is explicitly unset, the file
796
	will be set with '-kb' mode, which suppresses any newline munging
M
Matthew Ogilvie 已提交
797
	the client might otherwise do. If `crlf` is not specified,
798
	then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
M
Matthew Ogilvie 已提交
799

800
gitcvs.allbinary::
801 802 803 804 805 806 807 808
	This is used if 'gitcvs.usecrlfattr' does not resolve
	the correct '-kb' mode to use. If true, all
	unresolved files are sent to the client in
	mode '-kb'. This causes the client to treat them
	as binary files, which suppresses any newline munging it
	otherwise might do. Alternatively, if it is set to "guess",
	then the contents of the file are examined to decide if
	it is binary, similar to 'core.autocrlf'.
J
Junio C Hamano 已提交
809

810 811 812 813 814
gitcvs.dbname::
	Database used by git-cvsserver to cache revision information
	derived from the git repository. The exact meaning depends on the
	used database driver, for SQLite (which is the default driver) this
	is a filename. Supports variable substitution (see
815
	linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
816 817 818 819 820 821 822 823
	Default: '%Ggitcvs.%m.sqlite'

gitcvs.dbdriver::
	Used Perl DBI driver. You can specify any available driver
        for this here, but it might not work. git-cvsserver is tested
	with 'DBD::SQLite', reported to work with 'DBD::Pg', and
	reported *not* to work with 'DBD::mysql'. Experimental feature.
	May not contain double colons (`:`). Default: 'SQLite'.
824
	See linkgit:git-cvsserver[1].
825

826 827 828 829
gitcvs.dbuser, gitcvs.dbpass::
	Database user and password. Only useful if setting 'gitcvs.dbdriver',
	since SQLite has no concept of database users and/or passwords.
	'gitcvs.dbuser' supports variable substitution (see
830
	linkgit:git-cvsserver[1] for details).
831

832 833 834 835 836 837 838
gitcvs.dbTableNamePrefix::
	Database table name prefix.  Prepended to the names of any
	database tables used, allowing a single database to be used
	for several repositories.  Supports variable substitution (see
	linkgit:git-cvsserver[1] for details).  Any non-alphabetic
	characters will be replaced with underscores.

M
Matthew Ogilvie 已提交
839 840 841
All gitcvs variables except for 'gitcvs.usecrlfattr' and
'gitcvs.allbinary' can also be specified as
'gitcvs.<access_method>.<varname>' (where 'access_method'
842 843
is one of "ext" and "pserver") to make them apply only for the given
access method.
844

845 846 847 848 849 850 851 852
gui.commitmsgwidth::
	Defines how wide the commit message window is in the
	linkgit:git-gui[1]. "75" is the default.

gui.diffcontext::
	Specifies how many context lines should be used in calls to diff
	made by the linkgit:git-gui[1]. The default is "5".

853 854 855 856 857 858 859 860
gui.encoding::
	Specifies the default encoding to use for displaying of
	file contents in linkgit:git-gui[1] and linkgit:gitk[1].
	It can be overridden by setting the 'encoding' attribute
	for relevant files (see linkgit:gitattributes[5]).
	If this option is not set, the tools default to the
	locale encoding.

861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
gui.matchtrackingbranch::
	Determines if new branches created with linkgit:git-gui[1] should
	default to tracking remote branches with matching names or
	not. Default: "false".

gui.newbranchtemplate::
	Is used as suggested name when creating new branches using the
	linkgit:git-gui[1].

gui.pruneduringfetch::
	"true" if linkgit:git-gui[1] should prune tracking branches when
	performing a fetch. The default value is "false".

gui.trustmtime::
	Determines if linkgit:git-gui[1] should trust the file modification
	timestamp or not. By default the timestamps are not trusted.

gui.spellingdictionary::
	Specifies the dictionary used for spell checking commit messages in
	the linkgit:git-gui[1]. When set to "none" spell checking is turned
	off.

883 884 885 886 887 888
gui.fastcopyblame::
	If true, 'git gui blame' uses '-C' instead of '-C -C' for original
	location detection. It makes blame significantly faster on huge
	repositories at the expense of less thorough copy detection.

gui.copyblamethreshold::
R
Ralf Wildenhues 已提交
889
	Specifies the threshold to use in 'git gui blame' original location
890 891 892 893 894 895 896 897 898
	detection, measured in alphanumeric characters. See the
	linkgit:git-blame[1] manual for more information on copy detection.

gui.blamehistoryctx::
	Specifies the radius of history context in days to show in
	linkgit:gitk[1] for the selected commit, when the `Show History
	Context` menu item is invoked from 'git gui blame'. If this
	variable is set to zero, the whole history is shown.

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
guitool.<name>.cmd::
	Specifies the shell command line to execute when the corresponding item
	of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
	mandatory for every tool. The command is executed from the root of
	the working directory, and in the environment it receives the name of
	the tool as 'GIT_GUITOOL', the name of the currently selected file as
	'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
	the head is detached, 'CUR_BRANCH' is empty).

guitool.<name>.needsfile::
	Run the tool only if a diff is selected in the GUI. It guarantees
	that 'FILENAME' is not empty.

guitool.<name>.noconsole::
	Run the command silently, without creating a window to display its
	output.

guitool.<name>.norescan::
	Don't rescan the working directory for changes after the tool
	finishes execution.

guitool.<name>.confirm::
	Show a confirmation dialog before actually running the tool.

guitool.<name>.argprompt::
	Request a string argument from the user, and pass it to the tool
	through the 'ARGS' environment variable. Since requesting an
	argument implies confirmation, the 'confirm' option has no effect
	if this is enabled. If the option is set to 'true', 'yes', or '1',
	the dialog uses a built-in generic prompt; otherwise the exact
	value of the variable is used.

guitool.<name>.revprompt::
	Request a single valid revision from the user, and set the
	'REVISION' environment variable. In other aspects this option
	is similar to 'argprompt', and can be used together with it.

guitool.<name>.revunmerged::
	Show only unmerged branches in the 'revprompt' subdialog.
	This is useful for tools similar to merge or rebase, but not
	for things like checkout or reset.

guitool.<name>.title::
	Specifies the title to use for the prompt dialog. The default
	is the tool name.

guitool.<name>.prompt::
	Specifies the general prompt string to display at the top of
	the dialog, before subsections for 'argprompt' and 'revprompt'.
	The default value includes the actual command.

950 951 952 953 954 955 956 957 958
help.browser::
	Specify the browser that will be used to display help in the
	'web' format. See linkgit:git-help[1].

help.format::
	Override the default help format used by linkgit:git-help[1].
	Values 'man', 'info', 'web' and 'html' are supported. 'man' is
	the default. 'web' and 'html' are the same.

959 960 961 962 963 964 965 966 967
help.autocorrect::
	Automatically correct and execute mistyped commands after
	waiting for the given number of deciseconds (0.1 sec). If more
	than one command can be deduced from the entered text, nothing
	will be executed.  If the value of this option is negative,
	the corrected command will be executed immediately. If the
	value is 0 - the command will be just shown but not executed.
	This is the default.

968 969
http.proxy::
	Override the HTTP proxy, normally configured using the 'http_proxy'
970
	environment variable (see linkgit:curl[1]).  This can be overridden
S
Sam Vilain 已提交
971
	on a per-remote basis; see remote.<name>.proxy
972

P
Petr Baudis 已提交
973 974
http.sslVerify::
	Whether to verify the SSL certificate when fetching or pushing
F
Francis Daly 已提交
975
	over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
P
Petr Baudis 已提交
976 977 978 979
	variable.

http.sslCert::
	File containing the SSL certificate when fetching or pushing
F
Francis Daly 已提交
980
	over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
P
Petr Baudis 已提交
981 982 983 984
	variable.

http.sslKey::
	File containing the SSL private key when fetching or pushing
985
	over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
P
Petr Baudis 已提交
986 987 988 989
	variable.

http.sslCAInfo::
	File containing the certificates to verify the peer with when
990
	fetching or pushing over HTTPS. Can be overridden by the
P
Petr Baudis 已提交
991 992 993 994
	'GIT_SSL_CAINFO' environment variable.

http.sslCAPath::
	Path containing files with the CA certificates to verify the peer
F
Francis Daly 已提交
995
	with when fetching or pushing over HTTPS. Can be overridden
P
Petr Baudis 已提交
996 997 998
	by the 'GIT_SSL_CAPATH' environment variable.

http.maxRequests::
999
	How many HTTP requests to launch in parallel. Can be overridden
P
Petr Baudis 已提交
1000 1001 1002 1003 1004
	by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.

http.lowSpeedLimit, http.lowSpeedTime::
	If the HTTP transfer speed is less than 'http.lowSpeedLimit'
	for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1005
	Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
P
Petr Baudis 已提交
1006 1007
	'GIT_HTTP_LOW_SPEED_TIME' environment variables.

1008 1009
http.noEPSV::
	A boolean which disables using of EPSV ftp command by curl.
1010
	This can helpful with some "poor" ftp servers which don't
1011 1012 1013
	support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
	environment variable. Default is false (curl will use EPSV).

P
Petr Baudis 已提交
1014 1015 1016 1017 1018
i18n.commitEncoding::
	Character encoding the commit messages are stored in; git itself
	does not care per se, but this information is necessary e.g. when
	importing commits from emails or in the gitk graphical history
	browser (and possibly at other places in the future or in other
1019
	porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
P
Petr Baudis 已提交
1020

1021 1022
i18n.logOutputEncoding::
	Character encoding the commit messages are converted to when
1023
	running 'git-log' and friends.
1024

1025 1026 1027 1028
imap::
	The configuration variables in the 'imap' section are described
	in linkgit:git-imap-send[1].

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
instaweb.browser::
	Specify the program that will be used to browse your working
	repository in gitweb. See linkgit:git-instaweb[1].

instaweb.httpd::
	The HTTP daemon command-line to start gitweb on your working
	repository. See linkgit:git-instaweb[1].

instaweb.local::
	If true the web server started by linkgit:git-instaweb[1] will
	be bound to the local IP (127.0.0.1).

instaweb.modulepath::
	The module path for an apache httpd used by linkgit:git-instaweb[1].

instaweb.port::
	The port number to bind the gitweb httpd to. See
	linkgit:git-instaweb[1].

1048 1049 1050 1051 1052 1053 1054
interactive.singlekey::
	In interactive programs, allow the user to provide one-letter
	input with a single key (i.e., without hitting enter).
	Currently this is used only by the `\--patch` mode of
	linkgit:git-add[1].  Note that this setting is silently
	ignored if portable keystroke input is not available.

H
Heikki Orsila 已提交
1055 1056
log.date::
	Set default date-time mode for the log command. Setting log.date
1057
	value is similar to using 'git-log'\'s --date option. The value is one of the
H
Heikki Orsila 已提交
1058 1059 1060
	following alternatives: {relative,local,default,iso,rfc,short}.
	See linkgit:git-log[1].

1061 1062 1063
log.showroot::
	If true, the initial commit will be shown as a big creation event.
	This is equivalent to a diff against an empty tree.
1064
	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1065 1066
	normally hide the root commit will now show it. True by default.

1067 1068 1069 1070 1071 1072 1073 1074
mailmap.file::
	The location of an augmenting mailmap file. The default
	mailmap, located in the root of the repository, is loaded
	first, then the mailmap file pointed to by this variable.
	The location of the mailmap file may be in a repository
	subdirectory, or somewhere outside of the repository itself.
	See linkgit:git-shortlog[1] and linkgit:git-blame[1].

1075
man.viewer::
1076
	Specify the programs that may be used to display help in the
1077 1078
	'man' format. See linkgit:git-help[1].

1079 1080 1081 1082 1083
man.<tool>.cmd::
	Specify the command to invoke the specified man viewer. The
	specified command is evaluated in shell with the man page
	passed as argument. (See linkgit:git-help[1].)

1084 1085 1086 1087
man.<tool>.path::
	Override the path for the given tool that may be used to
	display help in the 'man' format. See linkgit:git-help[1].

1088
include::merge-config.txt[]
1089

1090 1091 1092 1093
mergetool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
mergetool.<tool>.cmd::
	Specify the command to invoke the specified merge tool.  The
	specified command is evaluated in shell with the following
	variables available: 'BASE' is the name of a temporary file
	containing the common base of the files to be merged, if available;
	'LOCAL' is the name of a temporary file containing the contents of
	the file on the current branch; 'REMOTE' is the name of a temporary
	file containing the contents of the file from the branch being
	merged; 'MERGED' contains the name of the file to which the merge
	tool should write the results of a successful merge.

mergetool.<tool>.trustExitCode::
	For a custom merge command, specify whether the exit code of
	the merge command can be used to determine whether the merge was
	successful.  If this is not set to true then the merge target file
	timestamp is checked and the merge assumed to have been successful
	if the file has been updated, otherwise the user is prompted to
	indicate the success of the merge.

1113 1114 1115 1116 1117 1118
mergetool.keepBackup::
	After performing a merge, the original file with conflict markers
	can be saved as a file with a `.orig` extension.  If this variable
	is set to `false` then this file is not preserved.  Defaults to
	`true` (i.e. keep the backup files).

1119 1120 1121 1122 1123 1124 1125
mergetool.keepTemporaries::
	When invoking a custom merge tool, git uses a set of temporary
	files to pass to the tool. If the tool returns an error and this
	variable is set to `true`, then these temporary files will be
	preserved, otherwise they will be removed after the tool has
	exited. Defaults to `false`.

1126 1127 1128
mergetool.prompt::
	Prompt before each invocation of the merge resolution program.

1129
pack.window::
1130
	The size of the window used by linkgit:git-pack-objects[1] when no
1131 1132
	window size is given on the command line. Defaults to 10.

1133
pack.depth::
1134
	The maximum delta depth used by linkgit:git-pack-objects[1] when no
1135
	maximum depth is given on the command line. Defaults to 50.
1136

1137
pack.windowMemory::
1138
	The window memory size limit used by linkgit:git-pack-objects[1]
1139 1140 1141 1142
	when no limit is given on the command line.  The value can be
	suffixed with "k", "m", or "g".  Defaults to 0, meaning no
	limit.

1143 1144 1145 1146 1147
pack.compression::
	An integer -1..9, indicating the compression level for objects
	in a pack file. -1 is the zlib default. 0 means no
	compression, and 1..9 are various speed/size tradeoffs, 9 being
	slowest.  If not set,  defaults to core.compression.  If that is
1148 1149 1150
	not set,  defaults to -1, the zlib default, which is "a default
	compromise between speed and compression (currently equivalent
	to level 6)."
1151

1152
pack.deltaCacheSize::
1153
	The maximum memory in bytes used for caching deltas in
1154
	linkgit:git-pack-objects[1].
1155 1156
	A value of 0 means no limit. Defaults to 0.

1157
pack.deltaCacheLimit::
1158
	The maximum size of a delta, that is cached in
1159
	linkgit:git-pack-objects[1]. Defaults to 1000.
1160

1161 1162
pack.threads::
	Specifies the number of threads to spawn when searching for best
1163
	delta matches.  This requires that linkgit:git-pack-objects[1]
1164 1165 1166 1167
	be compiled with pthreads otherwise this option is ignored with a
	warning. This is meant to reduce packing time on multiprocessor
	machines. The required amount of memory for the delta search window
	is however multiplied by the number of threads.
1168 1169
	Specifying 0 will cause git to auto-detect the number of CPU's
	and set the number of threads accordingly.
1170

1171 1172 1173 1174 1175
pack.indexVersion::
	Specify the default pack index version.  Valid values are 1 for
	legacy pack index used by Git versions prior to 1.5.2, and 2 for
	the new pack index with capabilities for packs larger than 4 GB
	as well as proper protection against the repacking of corrupted
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
	packs.  Version 2 is the default.  Note that version 2 is enforced
	and this config option ignored whenever the corresponding pack is
	larger than 2 GB.
+
If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
cloning or fetching over a non native protocol (e.g. "http" and "rsync")
that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
other side may give you a repository that cannot be accessed with your
older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
the `{asterisk}.idx` file.
1187

J
Junio C Hamano 已提交
1188
pack.packSizeLimit::
1189 1190 1191 1192 1193
	The default maximum size of a pack.  This setting only affects
	packing to a file, i.e. the git:// protocol is unaffected.  It
	can be overridden by the `\--max-pack-size` option of
	linkgit:git-repack[1].

1194
pager.<cmd>::
1195 1196 1197 1198
	Allows turning on or off pagination of the output of a
	particular git subcommand when writing to a tty.  If
	`\--paginate` or `\--no-pager` is specified on the command line,
	it takes precedence over this option.  To disable pagination for
1199
	all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1200

P
Petr Baudis 已提交
1201 1202 1203 1204 1205 1206 1207
pull.octopus::
	The default merge strategy to use when pulling multiple branches
	at once.

pull.twohead::
	The default merge strategy to use when pulling a single branch.

1208 1209 1210 1211
push.default::
	Defines the action git push should take if no refspec is given
	on the command line, no refspec is configured in the remote, and
	no refspec is implied by any of the options given on the command
1212
	line. Possible values are:
1213 1214
+
* `nothing` do not push anything.
1215
* `matching` push all matching branches.
1216
  All branches having the same name in both ends are considered to be
1217
  matching. This is the default.
1218
* `tracking` push the current branch to the branch it is tracking.
1219
* `current` push the current branch to a branch of the same name.
1220

1221 1222 1223 1224
rebase.stat::
	Whether to show a diffstat of what changed upstream since the last
	rebase. False by default.

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
receive.fsckObjects::
	If it is set to true, git-receive-pack will check all received
	objects. It will abort in the case of a malformed object or a
	broken link. The result of an abort are only dangling objects.
	Defaults to false.

receive.unpackLimit::
	If the number of objects received in a push is below this
	limit then the objects will be unpacked into loose object
	files. However if the number of received objects equals or
	exceeds this limit then the received pack will be stored as
	a pack, after adding any missing delta bases.  Storing the
	pack from a push can make the push operation complete faster,
	especially on slow filesystems.  If not set, the value of
	`transfer.unpackLimit` is used instead.

1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
receive.denyDeletes::
	If set to true, git-receive-pack will deny a ref update that deletes
	the ref. Use this to prevent such a ref deletion via a push.

receive.denyCurrentBranch::
	If set to true or "refuse", receive-pack will deny a ref update
	to the currently checked out branch of a non-bare repository.
	Such a push is potentially dangerous because it brings the HEAD
	out of sync with the index and working tree. If set to "warn",
	print a warning of such a push to stderr, but allow the push to
	proceed. If set to false or "ignore", allow such pushes with no
	message. Defaults to "warn".

1254 1255 1256 1257 1258 1259
receive.denyNonFastForwards::
	If set to true, git-receive-pack will deny a ref update which is
	not a fast forward. Use this to prevent such an update via a push,
	even if that push is forced. This configuration variable is
	set when initializing a shared repository.

1260
remote.<name>.url::
1261 1262
	The URL of a remote repository.  See linkgit:git-fetch[1] or
	linkgit:git-push[1].
1263

S
Sam Vilain 已提交
1264 1265 1266 1267 1268
remote.<name>.proxy::
	For remotes that require curl (http, https and ftp), the URL to
	the proxy to use for that remote.  Set to the empty string to
	disable proxying for that remote.

1269
remote.<name>.fetch::
1270 1271
	The default set of "refspec" for linkgit:git-fetch[1]. See
	linkgit:git-fetch[1].
1272 1273

remote.<name>.push::
1274 1275
	The default set of "refspec" for linkgit:git-push[1]. See
	linkgit:git-push[1].
1276

1277 1278 1279 1280
remote.<name>.mirror::
	If true, pushing to this remote will automatically behave
	as if the `\--mirror` option was given on the command line.

1281 1282
remote.<name>.skipDefaultUpdate::
	If true, this remote will be skipped by default when updating
1283
	using the update subcommand of linkgit:git-remote[1].
1284

1285
remote.<name>.receivepack::
1286
	The default program to execute on the remote side when pushing.  See
1287
	option \--receive-pack of linkgit:git-push[1].
1288

1289 1290
remote.<name>.uploadpack::
	The default program to execute on the remote side when fetching.  See
1291
	option \--upload-pack of linkgit:git-fetch-pack[1].
1292

1293
remote.<name>.tagopt::
1294 1295
	Setting this value to \--no-tags disables automatic tag following when
	fetching from remote <name>
1296

1297 1298
remotes.<group>::
	The list of remotes which are fetched by "git remote update
1299
	<group>".  See linkgit:git-remote[1].
1300

1301
repack.usedeltabaseoffset::
1302 1303 1304 1305 1306 1307
	By default, linkgit:git-repack[1] creates packs that use
	delta-base offset. If you need to share your repository with
	git older than version 1.4.4, either directly or via a dumb
	protocol such as http, then you need to set this option to
	"false" and repack. Access from old git versions over the
	native protocol are unaffected by this option.
1308

1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
rerere.autoupdate::
	When set to true, `git-rerere` updates the index with the
	resulting contents after it cleanly resolves conflicts using
	previously recorded resolution.  Defaults to false.

rerere.enabled::
	Activate recording of resolved conflicts, so that identical
	conflict hunks can be resolved automatically, should they
	be encountered again.  linkgit:git-rerere[1] command is by
	default enabled if you create `rr-cache` directory under
	`$GIT_DIR`, but can be disabled by setting this option to false.

P
Petr Baudis 已提交
1321
showbranch.default::
1322 1323
	The default set of branches for linkgit:git-show-branch[1].
	See linkgit:git-show-branch[1].
P
Petr Baudis 已提交
1324

1325
status.relativePaths::
1326
	By default, linkgit:git-status[1] shows paths relative to the
1327 1328 1329 1330
	current directory. Setting this variable to `false` shows paths
	relative to the repository root (this was the default for git
	prior to v1.5.4).

1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
status.showUntrackedFiles::
	By default, linkgit:git-status[1] and linkgit:git-commit[1] show
	files which are not currently tracked by Git. Directories which
	contain only untracked files, are shown with the directory name
	only. Showing untracked files means that Git needs to lstat() all
	all the files in the whole repository, which might be slow on some
	systems. So, this variable controls how the commands displays
	the untracked files. Possible values are:
+
--
	- 'no'     - Show no untracked files
	- 'normal' - Shows untracked files and directories
	- 'all'    - Shows also individual files in untracked directories.
--
+
If this variable is not specified, it defaults to 'normal'.
This variable can be overridden with the -u|--untracked-files option
of linkgit:git-status[1] and linkgit:git-commit[1].

1350
tar.umask::
1351 1352 1353 1354
	This variable can be used to restrict the permission bits of
	tar archive entries.  The default is 0002, which turns off the
	world write bit.  The special value "user" indicates that the
	archiving user's umask will be used instead.  See umask(2) and
1355
	linkgit:git-archive[1].
1356

1357 1358 1359 1360 1361
transfer.unpackLimit::
	When `fetch.unpackLimit` or `receive.unpackLimit` are
	not set, the value of this variable is used instead.
	The default value is 100.

1362 1363 1364 1365 1366 1367 1368 1369
url.<base>.insteadOf::
	Any URL that starts with this value will be rewritten to
	start, instead, with <base>. In cases where some site serves a
	large number of repositories, and serves them with multiple
	access methods, and some users need to use different access
	methods, this feature allows people to specify any of the
	equivalent URLs and have git automatically rewrite the URL to
	the best alternative for the particular user, even for a
1370 1371
	never-before-seen repository on the site.  When more than one
	insteadOf strings match a given URL, the longest match is used.
1372

P
Petr Baudis 已提交
1373 1374
user.email::
	Your email address to be recorded in any newly created commits.
1375
	Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1376
	'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
P
Petr Baudis 已提交
1377 1378 1379

user.name::
	Your full name to be recorded in any newly created commits.
1380
	Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1381
	environment variables.  See linkgit:git-commit-tree[1].
P
Petr Baudis 已提交
1382

1383
user.signingkey::
1384
	If linkgit:git-tag[1] is not selecting the key you want it to
1385 1386 1387 1388 1389
	automatically when creating a signed tag, you can override the
	default selection with this variable.  This option is passed
	unchanged to gpg's --local-user parameter, so you may specify a key
	using any method that gpg supports.

1390 1391 1392 1393
web.browser::
	Specify a web browser that may be used by some commands.
	Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
	may use it.