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

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 7
is used to store the configuration for that repository, and
`$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 12 13
The configuration variables are used by both the git plumbing
and the porcelains. The variables are divided into sections, wherein
the fully qualified variable name of the variable itself is the last
P
Petr Baudis 已提交
14
dot-separated segment and the section name is everything before the last
15 16 17
dot. The variable names are case-insensitive, allow only alphanumeric
characters and `-`, and must start with an alphabetic character.  Some
variables may appear multiple times.
P
Petr Baudis 已提交
18

19 20 21
Syntax
~~~~~~

P
Petr Baudis 已提交
22
The syntax is fairly flexible and permissive; whitespaces are mostly
23 24 25 26 27 28
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
29
characters, `-` and `.` are allowed in section names.  Each variable
30 31
must belong to some section, which means that there must be a section
header before the first setting of a variable.
32 33 34

Sections can be further divided into subsections.  To begin a subsection
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 39 40 41

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

--------

42 43 44
Subsection names are case sensitive and can contain any characters except
newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
respectively).  Section headers cannot span multiple
45 46 47 48
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.

49 50 51 52
There is also a deprecated `[section.subsection]` syntax. With this
syntax, the subsection name is converted to lower-case and is also
compared case sensitively. These subsection names follow the same
restrictions as section names.
53

54 55
All the other lines (and the remainder of the line after the section
header) are recognized as setting variables, in the form
56 57
'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".
58 59 60 61
The variable names are case-insensitive, allow only alphanumeric characters
and `-`, and must start with an alphabetic character.  There can be more
than one value for a given variable; we say then that the variable is
multivalued.
62 63 64 65 66 67

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,
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 74 75 76
You need to enclose variable values in double quotes if you want to
preserve leading or trailing whitespace, or if the variable value contains
comment characters (i.e. it contains '#' or ';').
Double quote `"` and backslash `\` characters in variable values must
77
be escaped: use `\"` for `"` and `\\` for `\`.
78

79 80 81
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
82 83
char sequences are valid.

84
Variable values ending in a `\` are continued on the next line in the
85 86
customary UNIX fashion.

87
Some variables may require a special value format.
P
Petr Baudis 已提交
88

J
Jeff King 已提交
89 90 91 92 93 94 95 96 97
Includes
~~~~~~~~

You can include one config file from another by setting the special
`include.path` variable to the name of the file to be included. The
included file is expanded immediately, as if its contents had been
found at the location of the include directive. If the value of the
`include.path` variable is a relative path, the path is considered to be
relative to the configuration file in which the include directive was
J
Jeff King 已提交
98 99
found. The value of `include.path` is subject to tilde expansion: `~/`
is expanded to the value of `$HOME`, and `~user/` to the specified
100
user's home directory. See below for examples.
J
Jeff King 已提交
101

P
Petr Baudis 已提交
102 103 104 105 106 107 108 109 110 111
Example
~~~~~~~

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

	# Our diff algorithm
	[diff]
112
		external = /usr/local/bin/diff-wrapper
P
Petr Baudis 已提交
113 114
		renames = true

115 116 117 118
	[branch "devel"]
		remote = origin
		merge = refs/heads/devel

119 120
	# Proxy settings
	[core]
121
		gitProxy="ssh" for "kernel.org"
122
		gitProxy=default-proxy ; for the rest
123

J
Jeff King 已提交
124 125 126
	[include]
		path = /path/to/foo.inc ; include by absolute path
		path = foo ; expand "foo" relative to the current file
127
		path = ~/foo ; expand "foo" in your $HOME directory
J
Jeff King 已提交
128

P
Petr Baudis 已提交
129 130 131 132
Variables
~~~~~~~~~

Note that this list is non-comprehensive and not necessarily complete.
133 134
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 已提交
135 136
porcelain configuration variables in the respective porcelain documentation.

137
advice.*::
138 139 140
	These variables control various optional help messages designed to
	aid new users. All 'advice.*' variables default to 'true', and you
	can tell Git that you do not need help by setting these to 'false':
141 142
+
--
143
	pushUpdateRejected::
144
		Set this variable to 'false' if you want to disable
145
		'pushNonFFCurrent', 'pushNonFFDefault',
146 147
		'pushNonFFMatching', 'pushAlreadyExists',
		'pushFetchFirst', and 'pushNeedsForce'
148
		simultaneously.
149 150 151 152 153 154 155 156 157 158 159 160 161 162
	pushNonFFCurrent::
		Advice shown when linkgit:git-push[1] fails due to a
		non-fast-forward update to the current branch.
	pushNonFFDefault::
		Advice to set 'push.default' to 'upstream' or 'current'
		when you ran linkgit:git-push[1] and pushed 'matching
		refs' by default (i.e. you did not provide an explicit
		refspec, and no 'push.default' configuration was set)
		and it resulted in a non-fast-forward error.
	pushNonFFMatching::
		Advice shown when you ran linkgit:git-push[1] and pushed
		'matching refs' explicitly (i.e. you used ':', or
		specified a refspec that isn't your current branch) and
		it resulted in a non-fast-forward error.
163 164 165
	pushAlreadyExists::
		Shown when linkgit:git-push[1] rejects an update that
		does not qualify for fast-forwarding (e.g., a tag.)
166 167 168 169 170 171 172 173 174
	pushFetchFirst::
		Shown when linkgit:git-push[1] rejects an update that
		tries to overwrite a remote ref that points at an
		object we do not have.
	pushNeedsForce::
		Shown when linkgit:git-push[1] rejects an update that
		tries to overwrite a remote ref that points at an
		object that is not a committish, or make the remote
		ref point at an object that is not a committish.
175
	statusHints::
176 177 178 179
		Show directions on how to proceed from the current
		state in the output of linkgit:git-status[1] and in
		the template shown when writing commit messages in
		linkgit:git-commit[1].
180 181
	commitBeforeMerge::
		Advice shown when linkgit:git-merge[1] refuses to
V
Ville Skyttä 已提交
182
		merge to avoid overwriting local changes.
183 184 185
	resolveConflict::
		Advices shown by various commands when conflicts
		prevent the operation from being performed.
186 187 188
	implicitIdentity::
		Advice on how to set your identity configuration when
		your information is guessed from the system username and
189
		domain name.
190
	detachedHead::
191
		Advice shown when you used linkgit:git-checkout[1] to
192
		move to the detach HEAD state, to instruct how to create
193
		a local branch after the fact.
194 195 196
	amWorkDir::
		Advice that shows the location of the patch file when
		linkgit:git-am[1] fails to apply it.
197 198
--

P
Petr Baudis 已提交
199 200
core.fileMode::
	If false, the executable bit differences between the index and
201
	the working tree are ignored; useful on broken filesystems like FAT.
202 203 204 205 206
	See linkgit:git-update-index[1].
+
The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.fileMode false if appropriate when the
repository is created.
P
Petr Baudis 已提交
207

208 209 210 211 212 213 214
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
215 216 217
	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.
218

219 220 221 222 223 224 225 226 227 228 229 230
core.ignorecase::
	If true, this option enables various workarounds to enable
	git to work better on filesystems that are not case sensitive,
	like FAT. For example, if a directory listing finds
	"makefile" when git expects "Makefile", git will assume
	it is really the same file, and continue to remember it as
	"Makefile".
+
The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.ignorecase true if appropriate when the repository
is created.

231 232 233 234 235 236 237 238 239
core.precomposeunicode::
	This option is only used by Mac OS implementation of git.
	When core.precomposeunicode=true, git reverts the unicode decomposition
	of filenames done by Mac OS. This is useful when sharing a repository
	between Mac OS and Linux or Windows.
	(Git for Windows 1.7.10 or higher is needed, or git under cygwin 1.7).
	When false, file names are handled fully transparent by git,
	which is backward compatible with older versions of git.

240 241
core.trustctime::
	If false, the ctime differences between the index and the
242
	working tree are ignored; useful when the inode change time
243 244 245 246
	is regularly modified by something outside Git (file system
	crawlers and some backup systems).
	See linkgit:git-update-index[1]. True by default.

247
core.quotepath::
248 249
	The commands that output paths (e.g. 'ls-files',
	'diff'), when not given the `-z` option, will quote
250 251 252 253 254 255 256 257 258
	"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.

259 260 261 262 263 264 265
core.eol::
	Sets the line ending type to use in the working directory for
	files that have the `text` property set.  Alternatives are
	'lf', 'crlf' and 'native', which uses the platform's native
	line ending.  The default value is `native`.  See
	linkgit:gitattributes[5] for more information on end-of-line
	conversion.
266

267
core.safecrlf::
268 269
	If true, makes git check if converting `CRLF` is reversible when
	end-of-line conversion is active.  Git will verify if a command
270 271 272 273 274 275 276 277 278
	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.
279
When it is enabled, git will convert CRLF to LF during commit and LF to
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
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
303 304 305
`core.eol` and `core.autocrlf`, but only for the current one.  For
example, a text file with `LF` would be accepted with `core.eol=lf`
and could later be checked out with `core.eol=crlf`, in which case the
306 307 308 309 310 311
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.

312 313 314 315 316 317 318 319 320 321
core.autocrlf::
	Setting this variable to "true" is almost the same as setting
	the `text` attribute to "auto" on all files except that text
	files are not guaranteed to be normalized: files that contain
	`CRLF` in the repository will not be touched.  Use this
	setting if you want to have `CRLF` line endings in your
	working directory even though the repository does not have
	normalized line endings.  This variable can be set to 'input',
	in which case no output conversion is performed.

322 323
core.symlinks::
	If false, symbolic links are checked out as small plain files that
324 325
	contain the link text. linkgit:git-update-index[1] and
	linkgit:git-add[1] will not change the recorded type to regular
326
	file. Useful on filesystems like FAT that do not support
327 328 329 330 331
	symbolic links.
+
The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.symlinks false if appropriate when the repository
is created.
332

P
Petr Baudis 已提交
333 334 335 336 337 338 339 340
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.
341 342 343 344
+
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
(which always applies universally, without the special "for"
handling).
345 346 347 348 349
+
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 已提交
350 351

core.ignoreStat::
352 353 354
	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
355
	working tree, until you mark them otherwise manually - Git will not
356 357 358
	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 已提交
359 360
	False by default.

361 362 363 364 365
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 已提交
366

367 368 369 370
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
371
	disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
372
+
373 374
This setting is automatically guessed by linkgit:git-clone[1] or
linkgit:git-init[1] when the repository was created.  By default a
375 376 377 378
repository that ends in "/.git" is assumed to be not bare (bare =
false), while all other repositories are assumed to be bare (bare
= true).

379
core.worktree::
380
	Set the path to the root of the working tree.
381
	This can be overridden by the GIT_WORK_TREE environment
382
	variable and the '--work-tree' command line option.
383
	The value can be an absolute path or relative to the path to
384 385 386
	the .git directory, which is either specified by --git-dir
	or GIT_DIR, or automatically discovered.
	If --git-dir or GIT_DIR is specified but none of
387
	--work-tree, GIT_WORK_TREE and core.worktree is specified,
388
	the current working directory is regarded as the top level
389
	of your working tree.
390 391 392 393 394 395 396 397 398 399
+
Note that this variable is honored even when set in a configuration
file in a ".git" subdirectory of a directory and its value differs
from the latter directory (e.g. "/path/to/.git/config" has
core.worktree set to "/different/path"), which is most likely a
misconfiguration.  Running git commands in the "/path/to" directory will
still use "/different/path" as the root of the work tree and can cause
confusion unless you know what you are doing (e.g. you are creating a
read-only snapshot of the same index to a location different from the
repository's usual working tree).
400

401
core.logAllRefUpdates::
402
	Enable the reflog. Updates to a ref <ref> is logged to the file
403 404 405 406
	"$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>"
407 408 409
	file is automatically created for branch heads (i.e. under
	refs/heads/), remote refs (i.e. under refs/remotes/),
	note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
410 411 412 413 414 415 416
+
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.
417

P
Petr Baudis 已提交
418 419 420 421 422
core.repositoryFormatVersion::
	Internal variable identifying the repository format and layout
	version.

core.sharedRepository::
423 424 425 426 427
	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
428 429
	reported by umask(2). When '0xxx', where '0xxx' is an octal number,
	files in the repository will have this mode value. '0xxx' will override
430 431 432 433
	user's umask value (whereas the other options will only override
	requested parts of the user's umask value). Examples: '0660' will make
	the repo read/write-able for the owner and group, but inaccessible to
	others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
434 435
	repository that is group-readable but not group-writable.
	See linkgit:git-init[1]. False by default.
P
Petr Baudis 已提交
436 437 438 439 440

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.

441
core.compression::
442 443 444
	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.
445 446
	If set, this provides a default to other compression variables,
	such as 'core.loosecompression' and 'pack.compression'.
447 448

core.loosecompression::
449
	An integer -1..9, indicating the compression level for objects that
450
	are not in a pack file. -1 is the zlib default. 0 means no
451
	compression, and 1..9 are various speed/size tradeoffs, 9 being
452
	slowest.  If not set,  defaults to core.compression.  If that is
453
	not set,  defaults to 1 (best speed).
454

455 456 457 458 459
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
460
	performance due to increased calls to the operating system's
461
	memory manager, but may improve performance when accessing
462 463 464 465 466 467
	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.
468 469
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
470

471 472 473 474 475
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.
476 477 478 479
+
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.
480 481
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
482

483 484
core.deltaBaseCacheLimit::
	Maximum number of bytes to reserve for caching base objects
V
Ville Skyttä 已提交
485
	that may be referenced by multiple deltified objects.  By storing the
486 487 488 489 490 491 492 493 494 495
	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.

496 497 498 499 500 501 502 503 504 505 506 507
core.bigFileThreshold::
	Files larger than this size are stored deflated, without
	attempting delta compression.  Storing large files without
	delta compression avoids excessive memory usage, at the
	slight expense of increased disk usage.
+
Default is 512 MiB on all platforms.  This should be reasonable
for most projects as source code and other text files can still
be delta compressed, but larger binary media files won't be.
+
Common unit suffixes of 'k', 'm', or 'g' are supported.

508
core.excludesfile::
509 510
	In addition to '.gitignore' (per-directory) and
	'.git/info/exclude', git looks into this file for patterns
511 512
	of files which are not meant to be tracked.  "`~/`" is expanded
	to the value of `$HOME` and "`~user/`" to the specified user's
513 514 515
	home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
	If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
	is used instead. See linkgit:gitignore[5].
516

A
Anselm Kruis 已提交
517 518 519
core.askpass::
	Some commands (e.g. svn and http interfaces) that interactively
	ask for a password can be told to use an external program given
520 521 522 523 524
	via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
	environment variable. If not set, fall back to the value of the
	'SSH_ASKPASS' environment variable or, failing that, a simple password
	prompt. The external program shall be given a suitable prompt as
	command line argument and write the password on its STDOUT.
A
Anselm Kruis 已提交
525

526 527 528 529
core.attributesfile::
	In addition to '.gitattributes' (per-directory) and
	'.git/info/attributes', git looks into this file for attributes
	(see linkgit:gitattributes[5]). Path expansions are made the same
530 531 532
	way as for `core.excludesfile`. Its default value is
	$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
	set or empty, $HOME/.config/git/attributes is used instead.
533

534 535
core.editor::
	Commands such as `commit` and `tag` that lets you edit
536
	messages by launching an editor uses the value of this
537
	variable when it is set, and the environment variable
538
	`GIT_EDITOR` is not set.  See linkgit:git-var[1].
539

540 541 542 543 544 545
sequence.editor::
	Text editor used by `git rebase -i` for editing the rebase insn file.
	The value is meant to be interpreted by the shell when it is used.
	It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
	When not configured the default commit message editor is used instead.

546
core.pager::
547 548 549 550 551
	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
552 553 554
	`LESS` variable to some other value.  Alternately,
	these settings can be overridden on a project or
	global basis by setting the `core.pager` option.
555
	Setting `core.pager` has no effect on the `LESS`
556 557 558 559
	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`
560 561 562
	to `less -+S`.  This will be passed to the shell by
	git, which will translate the final command to
	`LESS=FRSX less -+S`.
563

564 565
core.whitespace::
	A comma separated list of common whitespace problems to
566 567
	notice.  'git diff' will use `color.diff.whitespace` to
	highlight them, and 'git apply --whitespace=error' will
568 569
	consider them as errors.  You can prefix `-` to disable
	any of them (e.g. `-trailing-space`):
570
+
571
* `blank-at-eol` treats trailing whitespaces at the end of the line
572 573 574 575
  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).
576 577 578
* `indent-with-non-tab` treats a line that is indented with space
  characters instead of the equivalent tabs as an error (not enabled by
  default).
579 580
* `tab-in-indent` treats a tab character in the initial indent part of
  the line as an error (not enabled by default).
581 582
* `blank-at-eof` treats blank lines added at the end of file as an error
  (enabled by default).
583 584
* `trailing-space` is a short-hand to cover both `blank-at-eol` and
  `blank-at-eof`.
J
Junio C Hamano 已提交
585 586 587 588
* `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).
589 590 591
* `tabwidth=<n>` tells how many character positions a tab occupies; this
  is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
  errors. The default tab width is 8. Allowed values are 1 to 63.
592

593 594 595 596 597 598 599 600
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 已提交
601 602 603 604 605 606 607 608 609
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.

610 611 612 613 614 615 616 617
core.createObject::
	You can set this to 'link', in which case a hardlink followed by
	a delete of the source are used to make sure that object creation
	will not overwrite existing objects.
+
On some file system/operating system combinations, this is unreliable.
Set this config setting to 'rename' there; However, This will remove the
check that makes sure that existing object files will not get overwritten.
618

J
Johannes Schindelin 已提交
619 620
core.notesRef::
	When showing commit messages, also show notes which are stored in
621 622 623
	the given ref.  The ref must be fully qualified.  If the given
	ref does not exist, it is not an error but means that no
	notes should be printed.
J
Johannes Schindelin 已提交
624
+
625 626
This setting defaults to "refs/notes/commits", and it can be overridden by
the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
J
Johannes Schindelin 已提交
627

628 629 630 631
core.sparseCheckout::
	Enable "sparse checkout" feature. See section "Sparse checkout" in
	linkgit:git-read-tree[1] for more information.

632
core.abbrev::
633 634 635 636 637
	Set the length object names are abbreviated to.  If unspecified,
	many commands abbreviate to 7 hexdigits, which may not be enough
	for abbreviated object names to stay unique for sufficiently long
	time.

638
add.ignore-errors::
639
add.ignoreErrors::
640
	Tells 'git add' to continue adding files when some files cannot be
641
	added due to indexing errors. Equivalent to the '--ignore-errors'
642 643 644 645
	option of linkgit:git-add[1].  Older versions of git accept only
	`add.ignore-errors`, which does not follow the usual naming
	convention for configuration variables.  Newer versions of git
	honor `add.ignoreErrors` as well.
646

P
Petr Baudis 已提交
647
alias.*::
648
	Command aliases for the linkgit:git[1] command wrapper - e.g.
P
Petr Baudis 已提交
649 650
	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 已提交
651 652 653 654
	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.
655 656 657 658 659
+
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
660 661 662
"gitk --all --not ORIG_HEAD".  Note that shell commands will be
executed from the top-level directory of a repository, which may
not necessarily be the current directory.
663 664
'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
from the original current directory. See linkgit:git-rev-parse[1].
665

666 667 668
am.keepcr::
	If true, git-am will call git-mailsplit for patches in mbox format
	with parameter '--keep-cr'. In this case git-mailsplit will
V
Ville Skyttä 已提交
669
	not remove `\r` from lines ending with `\r\n`. Can be overridden
670 671 672
	by giving '--no-keep-cr' from the command line.
	See linkgit:git-am[1], linkgit:git-mailsplit[1].

673
apply.ignorewhitespace::
674
	When set to 'change', tells 'git apply' to ignore changes in
675 676
	whitespace, in the same way as the '--ignore-space-change'
	option.
677
	When set to one of: no, none, never, false tells 'git apply' to
678 679 680
	respect all whitespace differences.
	See linkgit:git-apply[1].

P
Petr Baudis 已提交
681
apply.whitespace::
682
	Tells 'git apply' how to handle whitespaces, in the same way
683
	as the '--whitespace' option. See linkgit:git-apply[1].
P
Petr Baudis 已提交
684

P
Paolo Bonzini 已提交
685
branch.autosetupmerge::
686
	Tells 'git branch' and 'git checkout' to set up new branches
687 688
	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 已提交
689
	this behavior can be chosen per-branch using the `--track`
690 691
	and `--no-track` options. The valid settings are: `false` -- no
	automatic setup is done; `true` -- automatic setup is done when the
692 693 694
	starting point is a remote-tracking branch; `always` --
	automatic setup is done when the starting point is either a
	local branch or remote-tracking
695
	branch. This option defaults to true.
P
Paolo Bonzini 已提交
696

697
branch.autosetuprebase::
698
	When a new branch is created with 'git branch' or 'git checkout'
699 700 701 702 703 704
	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
705
	remote-tracking branches.
706 707 708 709 710 711
	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.

712
branch.<name>.remote::
713
	When in branch <name>, it tells 'git fetch' and 'git push' which
714 715
	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.
716

717
branch.<name>.merge::
718
	Defines, together with branch.<name>.remote, the upstream branch
719
	for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
720 721
	branch to merge and can also affect 'git push' (see push.default).
	When in branch <name>, it tells 'git fetch' the default
D
Daniel Barkalow 已提交
722 723 724 725
	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".
726 727 728
	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.
729
	Specify multiple values to get an octopus merge.
730
	If you wish to setup 'git pull' so that it merges into <name> from
731 732 733
	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.
734

735 736
branch.<name>.mergeoptions::
	Sets default options for merging into branch <name>. The syntax and
737
	supported options are the same as those of linkgit:git-merge[1], but
738 739 740
	option values containing whitespace characters are currently not
	supported.

741 742
branch.<name>.rebase::
	When true, rebase the branch <name> on top of the fetched branch,
743
	instead of merging the default branch from the default remote when
744 745 746 747 748 749
	"git pull" is run. See "pull.rebase" for doing this in a non
	branch-specific manner.
+
*NOTE*: this is a possibly dangerous operation; do *not* use
it unless you understand the implications (see linkgit:git-rebase[1]
for details).
750

751 752 753
browser.<tool>.cmd::
	Specify the command to invoke the specified browser. The
	specified command is evaluated in shell with the URLs passed
754
	as arguments. (See linkgit:git-web{litdd}browse[1].)
755

756 757
browser.<tool>.path::
	Override the path for the given tool that may be used to
758 759
	browse HTML help (see '-w' option in linkgit:git-help[1]) or a
	working repository in gitweb (see linkgit:git-instaweb[1]).
760

761
clean.requireForce::
762 763
	A boolean to make git-clean do nothing unless given -f
	or -n.   Defaults to true.
764

765 766
color.branch::
	A boolean to enable/disable color in the output of
767
	linkgit:git-branch[1]. May be set to `always`,
768
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
769 770 771 772 773
	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),
774
	`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
775 776 777 778 779 780 781 782 783
	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.
784

785
color.diff::
786 787 788 789 790 791 792 793 794 795
	Whether to use ANSI escape sequences to add color to patches.
	If this is set to `always`, linkgit:git-diff[1],
	linkgit:git-log[1], and linkgit:git-show[1] will use color
	for all patches.  If it is set to `true` or `auto`, those
	commands will only use color when output is to the terminal.
	Defaults to false.
+
This does not affect linkgit:git-format-patch[1] nor the
'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
command line with the `--color[=<when>]` option.
796

797
color.diff.<slot>::
798 799 800
	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`
B
Bert Wesarg 已提交
801 802 803 804
	(hunk header), 'func' (function in hunk header), `old` (removed lines),
	`new` (added lines), `commit` (commit headers), or `whitespace`
	(highlighting whitespace errors). The values of these variables may be
	specified as in color.branch.<slot>.
805

806 807 808
color.decorate.<slot>::
	Use customized color for 'git log --decorate' output.  `<slot>` is one
	of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
809
	branches, remote-tracking branches, tags, stash and HEAD, respectively.
810

R
René Scharfe 已提交
811 812 813 814 815
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`.

816 817 818 819 820
color.grep.<slot>::
	Use customized color for grep colorization.  `<slot>` specifies which
	part of the line to use the specified color, and is one of
+
--
821 822
`context`;;
	non-matching text in context lines (when using `-A`, `-B`, or `-C`)
823 824
`filename`;;
	filename prefix (when not using `-h`)
825 826
`function`;;
	function name lines (when using `-p`)
827 828 829 830
`linenumber`;;
	line number prefix (when using `-n`)
`match`;;
	matching text
831 832
`selected`;;
	non-matching text in selected lines
833 834 835 836 837 838
`separator`;;
	separators between fields on a line (`:`, `-`, and `=`)
	and between hunks (`--`)
--
+
The values of these variables may be specified as in color.branch.<slot>.
R
René Scharfe 已提交
839

J
Junio C Hamano 已提交
840
color.interactive::
841
	When set to `always`, always use colors for interactive prompts
842
	and displays (such as those used by "git-add --interactive").
J
Junio C Hamano 已提交
843 844 845 846
	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>::
847
	Use customized color for 'git add --interactive'
848 849
	output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
	four distinct types of normal output from interactive
850
	commands.  The values of these variables may be specified as
J
Junio C Hamano 已提交
851 852
	in color.branch.<slot>.

853 854 855 856
color.pager::
	A boolean to enable/disable colored output when the pager is in
	use (default is true).

857 858 859 860 861 862
color.showbranch::
	A boolean to enable/disable color in the output of
	linkgit:git-show-branch[1]. May be set to `always`,
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
	only when the output is to a terminal. Defaults to false.

863 864
color.status::
	A boolean to enable/disable color in the output of
865
	linkgit:git-status[1]. May be set to `always`,
866
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
867 868 869 870 871
	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),
872 873
	`added` or `updated` (files which are added but not committed),
	`changed` (files which are changed but not added in the index),
874 875
	`untracked` (files which are not tracked by git),
	`branch` (the current branch), or
876 877 878
	`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>.
879

880
color.ui::
881 882 883 884 885 886 887 888 889
	This variable determines the default value for variables such
	as `color.diff` and `color.grep` that control the use of color
	per command family. Its scope will expand as more commands learn
	configuration to set a default for the `--color` option.  Set it
	to `always` if you want all output not intended for machine
	consumption to use color, to `true` or `auto` if you want such
	output to use color when written to the terminal, or to `false` or
	`never` if you prefer git commands not to use color unless enabled
	explicitly with some other configuration or the `--color` option.
890

891 892 893 894 895 896 897 898 899 900 901 902
column.ui::
	Specify whether supported commands should output in columns.
	This variable consists of a list of tokens separated by spaces
	or commas:
+
--
`always`;;
	always show in columns
`never`;;
	never show in columns
`auto`;;
	show in columns if the output is to the terminal
903 904 905 906
`column`;;
	fill columns before rows (default)
`row`;;
	fill rows before columns
907 908
`plain`;;
	show in one column
909 910 911 912
`dense`;;
	make unequal size columns to utilize more space
`nodense`;;
	make equal size columns
913 914
--
+
A
Andreas Schwab 已提交
915
This option defaults to 'never'.
916

N
Nguyễn Thái Ngọc Duy 已提交
917 918 919 920
column.branch::
	Specify whether to output branch listing in `git branch` in columns.
	See `column.ui` for details.

N
Nguyễn Thái Ngọc Duy 已提交
921 922 923 924
column.status::
	Specify whether to output untracked files in `git status` in columns.
	See `column.ui` for details.

N
Nguyễn Thái Ngọc Duy 已提交
925 926 927 928
column.tag::
	Specify whether to output tag listing in `git tag` in columns.
	See `column.ui` for details.

929
commit.status::
930 931 932 933
	A boolean to enable/disable inclusion of status information in the
	commit message template when using an editor to prepare the commit
	message.  Defaults to true.

934 935
commit.template::
	Specify a file to use as the template for new commit messages.
936
	"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
937
	specified user's home directory.
938

939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
credential.helper::
	Specify an external helper to be called when a username or
	password credential is needed; the helper may consult external
	storage to avoid prompting the user for the credentials. See
	linkgit:gitcredentials[7] for details.

credential.useHttpPath::
	When acquiring credentials, consider the "path" component of an http
	or https URL to be important. Defaults to false. See
	linkgit:gitcredentials[7] for more information.

credential.username::
	If no username is set for a network authentication, use this username
	by default. See credential.<context>.* below, and
	linkgit:gitcredentials[7].

credential.<url>.*::
	Any of the credential.* options above can be applied selectively to
	some credentials. For example "credential.https://example.com.username"
	would set the default username only for https connections to
	example.com. See linkgit:gitcredentials[7] for details on how URLs are
	matched.

962
include::diff-config.txt[]
963 964 965 966 967 968 969 970 971 972 973 974 975

difftool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.

difftool.<tool>.cmd::
	Specify the command to invoke the specified diff tool.
	The specified command is evaluated in shell with the following
	variables available:  'LOCAL' is set to the name of the temporary
	file containing the contents of the diff pre-image and 'REMOTE'
	is set to the name of the temporary file containing the contents
	of the diff post-image.

976 977 978
difftool.prompt::
	Prompt before each invocation of the diff tool.

979
diff.wordRegex::
980 981 982 983 984
	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.

985
fetch.recurseSubmodules::
986 987 988 989 990 991 992
	This option can be either set to a boolean value or to 'on-demand'.
	Setting it to a boolean changes the behavior of fetch and pull to
	unconditionally recurse into submodules when set to true or to not
	recurse at all when set to false. When set to 'on-demand' (the default
	value), fetch and pull will only recurse into a populated submodule
	when its superproject retrieves a commit that updates the submodule's
	reference.
993

994 995 996 997
fetch.fsckObjects::
	If it is set to true, git-fetch-pack will check all fetched
	objects. It will abort in the case of a malformed object or a
	broken link. The result of an abort are only dangling objects.
998 999
	Defaults to false. If not set, the value of `transfer.fsckObjects`
	is used instead.
1000

1001 1002 1003 1004 1005 1006 1007 1008
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,
1009 1010
	especially on slow filesystems.  If not set, the value of
	`transfer.unpackLimit` is used instead.
1011

1012 1013 1014 1015 1016 1017 1018
format.attach::
	Enable multipart/mixed attachments as the default for
	'format-patch'.  The value can also be a double quoted string
	which will enable attachments as the default and set the
	value as the boundary.  See the --attach option in
	linkgit:git-format-patch[1].

1019
format.numbered::
1020 1021 1022 1023 1024
	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].
1025

P
Petr Baudis 已提交
1026 1027
format.headers::
	Additional email headers to include in a patch to be submitted
1028
	by mail.  See linkgit:git-format-patch[1].
P
Petr Baudis 已提交
1029

1030
format.to::
1031
format.cc::
1032 1033 1034
	Additional recipients to include in a patch to be submitted
	by mail.  See the --to and --cc options in
	linkgit:git-format-patch[1].
1035 1036 1037 1038 1039

format.subjectprefix::
	The default for format-patch is to output files with the '[PATCH]'
	subject prefix. Use this variable to change that prefix.

1040 1041 1042 1043 1044 1045
format.signature::
	The default for format-patch is to output a signature containing
	the git version number. Use this variable to change that default.
	Set this variable to the empty string ("") to suppress
	signature generation.

1046 1047 1048 1049
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 已提交
1050

1051 1052 1053 1054 1055
format.pretty::
	The default pretty format for log/show/whatchanged command,
	See linkgit:git-log[1], linkgit:git-show[1],
	linkgit:git-whatchanged[1].

1056
format.thread::
1057
	The default threading style for 'git format-patch'.  Can be
1058 1059
	a boolean value, or `shallow` or `deep`.  `shallow` threading
	makes every mail a reply to the head of the series,
1060
	where the head is chosen from the cover letter, the
1061
	`--in-reply-to`, and the first patch mail, in this order.
1062
	`deep` threading makes every mail a reply to the previous one.
1063 1064 1065
	A true boolean value is the same as `shallow`, and a false
	value disables threading.

1066 1067 1068 1069 1070 1071 1072
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.

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
filter.<driver>.clean::
	The command which is used to convert the content of a worktree
	file to a blob upon checkin.  See linkgit:gitattributes[5] for
	details.

filter.<driver>.smudge::
	The command which is used to convert the content of a blob
	object to a worktree file upon checkout.  See
	linkgit:gitattributes[5] for details.

1083 1084
gc.aggressiveWindow::
	The window size parameter used in the delta compression
1085
	algorithm used by 'git gc --aggressive'.  This defaults
1086
	to 250.
1087

1088 1089 1090 1091
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
1092 1093
	light-weight garbage collection from time to time.  The
	default value is 6700.  Setting this to 0 disables it.
1094

1095 1096 1097
gc.autopacklimit::
	When there are more than this many packs that are not
	marked with `*.keep` file in the repository, `git gc
1098
	--auto` consolidates them into one larger pack.  The
1099
	default	value is 50.  Setting this to 0 disables it.
1100

1101
gc.packrefs::
1102 1103 1104
	Running `git pack-refs` in a repository renders it
	unclonable by Git versions prior to 1.5.1.2 over dumb
	transports such as HTTP.  This variable determines whether
J
Jiang Xin 已提交
1105
	'git gc' runs `git pack-refs`. This can be set to `notbare`
1106 1107
	to enable it within all non-bare repos or it can be set to a
	boolean value.  The default is `true`.
1108

1109
gc.pruneexpire::
1110
	When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1111 1112 1113
	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.
1114

1115
gc.reflogexpire::
1116
gc.<pattern>.reflogexpire::
1117
	'git reflog expire' removes reflog entries older than
1118 1119 1120
	this time; defaults to 90 days.  With "<pattern>" (e.g.
	"refs/stash") in the middle the setting applies only to
	the refs that match the <pattern>.
1121 1122

gc.reflogexpireunreachable::
1123
gc.<ref>.reflogexpireunreachable::
1124
	'git reflog expire' removes reflog entries older than
1125
	this time and are not reachable from the current tip;
1126 1127 1128
	defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
	in the middle, the setting applies only to the refs that
	match the <pattern>.
1129

1130 1131
gc.rerereresolved::
	Records of conflicted merge you resolved earlier are
1132
	kept for this many days when 'git rerere gc' is run.
1133
	The default is 60 days.  See linkgit:git-rerere[1].
1134 1135 1136

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

1140 1141 1142 1143
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 已提交
1144
gitcvs.enabled::
1145
	Whether the CVS server interface is enabled for this repository.
1146
	See linkgit:git-cvsserver[1].
P
Petr Baudis 已提交
1147 1148

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

1152
gitcvs.usecrlfattr::
1153 1154 1155
	If true, the server will look up the end-of-line conversion
	attributes for files to determine the '-k' modes to use. If
	the attributes force git to treat a file as text,
V
Ville Skyttä 已提交
1156
	the '-k' mode will be left blank so CVS clients will
1157
	treat it as text. If they suppress text conversion, the file
1158
	will be set with '-kb' mode, which suppresses any newline munging
1159 1160 1161
	the client might otherwise do. If the attributes do not allow
	the file type to be determined, then 'gitcvs.allbinary' is
	used. See linkgit:gitattributes[5].
M
Matthew Ogilvie 已提交
1162

1163
gitcvs.allbinary::
1164 1165 1166 1167 1168 1169 1170 1171
	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 已提交
1172

1173 1174 1175 1176 1177
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
1178
	linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1179 1180 1181 1182 1183 1184 1185 1186
	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'.
1187
	See linkgit:git-cvsserver[1].
1188

1189 1190 1191 1192
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
1193
	linkgit:git-cvsserver[1] for details).
1194

1195 1196 1197 1198 1199 1200 1201
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 已提交
1202 1203 1204
All gitcvs variables except for 'gitcvs.usecrlfattr' and
'gitcvs.allbinary' can also be specified as
'gitcvs.<access_method>.<varname>' (where 'access_method'
1205 1206
is one of "ext" and "pserver") to make them apply only for the given
access method.
1207

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
gitweb.category::
gitweb.description::
gitweb.owner::
gitweb.url::
	See linkgit:gitweb[1] for description.

gitweb.avatar::
gitweb.blame::
gitweb.grep::
gitweb.highlight::
gitweb.patches::
gitweb.pickaxe::
gitweb.remote_heads::
gitweb.showsizes::
gitweb.snapshot::
	See linkgit:gitweb.conf[5] for description.

1225 1226 1227
grep.lineNumber::
	If set to true, enable '-n' option by default.

1228 1229 1230 1231 1232 1233
grep.patternType::
	Set the default matching behavior. Using a value of 'basic', 'extended',
	'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
	'--fixed-strings', or '--perl-regexp' option accordingly, while the
	value 'default' will return to the default matching behavior.

1234
grep.extendedRegexp::
1235 1236 1237
	If set to true, enable '--extended-regexp' option by default. This
	option is ignored when the 'grep.patternType' option is set to a value
	other than 'default'.
1238

1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
gpg.program::
	Use this custom program instead of "gpg" found on $PATH when
	making or verifying a PGP signature. The program must support the
	same command line interface as GPG, namely, to verify a detached
	signature, "gpg --verify $file - <$signature" is run, and the
	program is expected to signal a good signature by exiting with
	code 0, and to generate an ascii-armored detached signature, the
	standard input of "gpg -bsau $key" is fed with the contents to be
	signed, and the program is expected to send the result to its
	standard output.

1250 1251 1252 1253 1254 1255 1256 1257
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".

1258 1259 1260 1261 1262 1263 1264 1265
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.

1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
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::
1276
	"true" if linkgit:git-gui[1] should prune remote-tracking branches when
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
	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.

1288
gui.fastcopyblame::
1289
	If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1290 1291 1292 1293
	location detection. It makes blame significantly faster on huge
	repositories at the expense of less thorough copy detection.

gui.copyblamethreshold::
R
Ralf Wildenhues 已提交
1294
	Specifies the threshold to use in 'git gui blame' original location
1295 1296 1297 1298 1299 1300 1301 1302 1303
	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.

1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
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.

1355 1356 1357 1358 1359 1360 1361 1362 1363
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.

1364 1365 1366 1367 1368 1369 1370 1371 1372
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.

1373
http.proxy::
1374 1375 1376 1377
	Override the HTTP proxy, normally configured using the 'http_proxy',
	'https_proxy', and 'all_proxy' environment variables (see
	`curl(1)`).  This can be overridden on a per-remote basis; see
	remote.<name>.proxy
1378

1379 1380 1381 1382 1383 1384 1385 1386
http.cookiefile::
	File containing previously stored cookie lines which should be used
	in the git http session, if they match the server. The file format
	of the file to read cookies from should be plain HTTP headers or
	the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
	NOTE that the file specified with http.cookiefile is only used as
	input. No cookies will be stored in the file.

P
Petr Baudis 已提交
1387 1388
http.sslVerify::
	Whether to verify the SSL certificate when fetching or pushing
F
Francis Daly 已提交
1389
	over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
P
Petr Baudis 已提交
1390 1391 1392 1393
	variable.

http.sslCert::
	File containing the SSL certificate when fetching or pushing
F
Francis Daly 已提交
1394
	over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
P
Petr Baudis 已提交
1395 1396 1397 1398
	variable.

http.sslKey::
	File containing the SSL private key when fetching or pushing
1399
	over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
P
Petr Baudis 已提交
1400 1401
	variable.

1402 1403 1404 1405 1406 1407
http.sslCertPasswordProtected::
	Enable git's password prompt for the SSL certificate.  Otherwise
	OpenSSL will prompt the user, possibly many times, if the
	certificate or private key is encrypted.  Can be overridden by the
	'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.

P
Petr Baudis 已提交
1408 1409
http.sslCAInfo::
	File containing the certificates to verify the peer with when
1410
	fetching or pushing over HTTPS. Can be overridden by the
P
Petr Baudis 已提交
1411 1412 1413 1414
	'GIT_SSL_CAINFO' environment variable.

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

http.maxRequests::
1419
	How many HTTP requests to launch in parallel. Can be overridden
P
Petr Baudis 已提交
1420 1421
	by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.

T
Tay Ray Chuan 已提交
1422 1423 1424 1425 1426 1427
http.minSessions::
	The number of curl sessions (counted across slots) to be kept across
	requests. They will not be ended with curl_easy_cleanup() until
	http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
	value will be capped at 1. Defaults to 1.

1428 1429 1430 1431 1432 1433 1434 1435
http.postBuffer::
	Maximum size in bytes of the buffer used by smart HTTP
	transports when POSTing data to the remote system.
	For requests larger than this buffer size, HTTP/1.1 and
	Transfer-Encoding: chunked is used to avoid creating a
	massive pack file locally.  Default is 1 MiB, which is
	sufficient for most requests.

P
Petr Baudis 已提交
1436 1437 1438
http.lowSpeedLimit, http.lowSpeedTime::
	If the HTTP transfer speed is less than 'http.lowSpeedLimit'
	for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1439
	Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
P
Petr Baudis 已提交
1440 1441
	'GIT_HTTP_LOW_SPEED_TIME' environment variables.

1442 1443
http.noEPSV::
	A boolean which disables using of EPSV ftp command by curl.
1444
	This can helpful with some "poor" ftp servers which don't
1445 1446 1447
	support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
	environment variable. Default is false (curl will use EPSV).

1448 1449 1450 1451 1452 1453 1454 1455 1456
http.useragent::
	The HTTP USER_AGENT string presented to an HTTP server.  The default
	value represents the version of the client git such as git/1.7.1.
	This option allows you to override this value to a more common value
	such as Mozilla/4.0.  This may be necessary, for instance, if
	connecting through a firewall that restricts HTTP connections to a set
	of common USER_AGENT strings (but not including those like git/1.7.1).
	Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.

P
Petr Baudis 已提交
1457 1458 1459 1460 1461
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
1462
	porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
P
Petr Baudis 已提交
1463

1464 1465
i18n.logOutputEncoding::
	Character encoding the commit messages are converted to when
1466
	running 'git log' and friends.
1467

1468 1469 1470 1471
imap::
	The configuration variables in the 'imap' section are described
	in linkgit:git-imap-send[1].

1472 1473 1474 1475
init.templatedir::
	Specify the directory from which templates will be copied.
	(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
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::
V
Ville Skyttä 已提交
1489 1490 1491
	The default module path for linkgit:git-instaweb[1] to use
	instead of /usr/lib/apache2/modules.  Only used if httpd
	is Apache.
1492 1493 1494 1495 1496

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

1497
interactive.singlekey::
1498
	In interactive commands, allow the user to provide one-letter
1499
	input with a single key (i.e., without hitting enter).
1500
	Currently this is used by the `--patch` mode of
1501 1502 1503 1504
	linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
	linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
	setting is silently ignored if portable keystroke input
	is not available.
1505

1506 1507
log.abbrevCommit::
	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1508 1509
	linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
	override this option with `--no-abbrev-commit`.
1510

H
Heikki Orsila 已提交
1511
log.date::
1512 1513
	Set the default date-time mode for the 'log' command.
	Setting a value for log.date is similar to using 'git log''s
1514
	`--date` option.  Possible values are `relative`, `local`,
1515 1516
	`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
	for details.
H
Heikki Orsila 已提交
1517

1518 1519 1520 1521 1522 1523 1524
log.decorate::
	Print out the ref names of any commits that are shown by the log
	command. If 'short' is specified, the ref name prefixes 'refs/heads/',
	'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
	specified, the full ref name (including prefix) will be printed.
	This is the same as the log commands '--decorate' option.

1525 1526 1527
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.
1528
	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1529 1530
	normally hide the root commit will now show it. True by default.

1531 1532 1533 1534 1535 1536 1537 1538
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].

1539
man.viewer::
1540
	Specify the programs that may be used to display help in the
1541 1542
	'man' format. See linkgit:git-help[1].

1543 1544 1545 1546 1547
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].)

1548 1549 1550 1551
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].

1552
include::merge-config.txt[]
1553

1554 1555 1556 1557
mergetool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
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.

1577 1578 1579 1580 1581 1582
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).

1583 1584 1585 1586 1587 1588 1589
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`.

1590 1591 1592
mergetool.prompt::
	Prompt before each invocation of the merge resolution program.

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
notes.displayRef::
	The (fully qualified) refname from which to show notes when
	showing commit messages.  The value of this variable can be set
	to a glob, in which case notes from all matching refs will be
	shown.  You may also specify this configuration variable
	several times.  A warning will be issued for refs that do not
	exist, but a glob that does not match any refs is silently
	ignored.
+
This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
environment variable, which must be a colon separated list of refs or
globs.
+
The effective value of "core.notesRef" (possibly overridden by
GIT_NOTES_REF) is also implicitly added to the list of refs to be
displayed.

1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
notes.rewrite.<command>::
	When rewriting commits with <command> (currently `amend` or
	`rebase`) and this variable is set to `true`, git
	automatically copies your notes from the original to the
	rewritten commit.  Defaults to `true`, but see
	"notes.rewriteRef" below.

notes.rewriteMode::
	When copying notes during a rewrite (see the
	"notes.rewrite.<command>" option), determines what to do if
	the target commit already has a note.  Must be one of
	`overwrite`, `concatenate`, or `ignore`.  Defaults to
	`concatenate`.
+
This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
environment variable.

notes.rewriteRef::
	When copying notes during a rewrite, specifies the (fully
	qualified) ref whose notes should be copied.  The ref may be a
	glob, in which case notes in all matching refs will be copied.
	You may also specify this configuration several times.
+
Does not have a default value; you must configure this variable to
1634 1635
enable note rewriting.  Set it to `refs/notes/commits` to enable
rewriting for the default commit notes.
1636 1637 1638 1639
+
This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
environment variable, which must be a colon separated list of refs or
globs.
1640

1641
pack.window::
1642
	The size of the window used by linkgit:git-pack-objects[1] when no
1643 1644
	window size is given on the command line. Defaults to 10.

1645
pack.depth::
1646
	The maximum delta depth used by linkgit:git-pack-objects[1] when no
1647
	maximum depth is given on the command line. Defaults to 50.
1648

1649
pack.windowMemory::
1650
	The window memory size limit used by linkgit:git-pack-objects[1]
1651 1652 1653 1654
	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.

1655 1656 1657 1658 1659
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
1660 1661 1662
	not set,  defaults to -1, the zlib default, which is "a default
	compromise between speed and compression (currently equivalent
	to level 6)."
1663 1664 1665 1666
+
Note that changing the compression level will not automatically recompress
all existing objects. You can force recompression by passing the -F option
to linkgit:git-repack[1].
1667

1668
pack.deltaCacheSize::
1669
	The maximum memory in bytes used for caching deltas in
1670 1671 1672 1673 1674 1675 1676 1677
	linkgit:git-pack-objects[1] before writing them out to a pack.
	This cache is used to speed up the writing object phase by not
	having to recompute the final delta result once the best match
	for all objects is found.  Repacking large repositories on machines
	which are tight with memory might be badly impacted by this though,
	especially if this cache pushes the system into swapping.
	A value of 0 means no limit. The smallest size of 1 byte may be
	used to virtually disable this cache. Defaults to 256 MiB.
1678

1679
pack.deltaCacheLimit::
1680
	The maximum size of a delta, that is cached in
1681 1682 1683
	linkgit:git-pack-objects[1]. This cache is used to speed up the
	writing object phase by not having to recompute the final delta
	result once the best match for all objects is found. Defaults to 1000.
1684

1685 1686
pack.threads::
	Specifies the number of threads to spawn when searching for best
1687
	delta matches.  This requires that linkgit:git-pack-objects[1]
1688 1689 1690 1691
	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.
1692 1693
	Specifying 0 will cause git to auto-detect the number of CPU's
	and set the number of threads accordingly.
1694

1695 1696 1697 1698 1699
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
1700 1701 1702 1703
	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.
+
1704
If you have an old git that does not understand the version 2 `*.idx` file,
1705
cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1706
that will copy both `*.pack` file and corresponding `*.idx` file from the
1707
other side may give you a repository that cannot be accessed with your
1708
older version of git. If the `*.pack` file is smaller than 2 GB, however,
1709
you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1710
the `*.idx` file.
1711

J
Junio C Hamano 已提交
1712
pack.packSizeLimit::
1713 1714
	The maximum size of a pack.  This setting only affects
	packing to a file when repacking, i.e. the git:// protocol
1715
	is unaffected.  It can be overridden by the `--max-pack-size`
1716 1717 1718 1719
	option of linkgit:git-repack[1]. The minimum size allowed is
	limited to 1 MiB. The default is unlimited.
	Common unit suffixes of 'k', 'm', or 'g' are
	supported.
1720

1721
pager.<cmd>::
1722 1723 1724
	If the value is boolean, turns on or off pagination of the
	output of a particular git subcommand when writing to a tty.
	Otherwise, turns on pagination for the subcommand using the
1725 1726
	pager specified by the value of `pager.<cmd>`.  If `--paginate`
	or `--no-pager` is specified on the command line, it takes
1727 1728
	precedence over this option.  To disable pagination for all
	commands, set `core.pager` or `GIT_PAGER` to `cat`.
1729

1730 1731 1732 1733
pretty.<name>::
	Alias for a --pretty= format string, as specified in
	linkgit:git-log[1]. Any aliases defined here can be used just
	as the built-in pretty formats could. For example,
1734
	running `git config pretty.changelog "format:* %H %s"`
1735
	would cause the invocation `git log --pretty=changelog`
1736
	to be equivalent to running `git log "--pretty=format:* %H %s"`.
1737 1738 1739
	Note that an alias with the same name as a built-in format
	will be silently ignored.

1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
pull.rebase::
	When true, rebase branches on top of the fetched branch, instead
	of merging the default branch from the default remote when "git
	pull" is run. See "branch.<name>.rebase" for setting this on a
	per-branch basis.
+
*NOTE*: this is a possibly dangerous operation; do *not* use
it unless you understand the implications (see linkgit:git-rebase[1]
for details).

P
Petr Baudis 已提交
1750 1751 1752 1753 1754 1755 1756
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.

1757 1758 1759 1760
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
1761
	line. Possible values are:
1762
+
A
Andreas Schwab 已提交
1763
--
1764
* `nothing` - do not push anything.
1765 1766 1767 1768 1769
* `matching` - push all branches having the same name in both ends.
  This is for those who prepare all the branches into a publishable
  shape and then push them out with a single command.  It is not
  appropriate for pushing into a repository shared by multiple users,
  since locally stalled branches will attempt a non-fast forward push
1770 1771 1772 1773
  if other users updated the branch.
  +
  This is currently the default, but Git 2.0 will change the default
  to `simple`.
1774
* `upstream` - push the current branch to its upstream branch.
1775 1776 1777
  With this, `git push` will update the same remote ref as the one which
  is merged by `git pull`, making `push` and `pull` symmetrical.
  See "branch.<name>.merge" for how to configure the upstream branch.
1778 1779 1780 1781
* `simple` - like `upstream`, but refuses to push if the upstream
  branch's name is different from the local one. This is the safest
  option and is well-suited for beginners. It will become the default
  in Git 2.0.
1782
* `current` - push the current branch to a branch of the same name.
A
Andreas Schwab 已提交
1783 1784 1785 1786 1787 1788 1789
--
+
The `simple`, `current` and `upstream` modes are for those who want to
push out a single branch after finishing work, even when the other
branches are not yet ready to be pushed out. If you are working with
other people to push into the same shared repository, you would want
to use one of these.
1790

1791 1792 1793 1794
rebase.stat::
	Whether to show a diffstat of what changed upstream since the last
	rebase. False by default.

1795 1796 1797
rebase.autosquash::
	If set to true enable '--autosquash' option by default.

1798 1799 1800 1801 1802
receive.autogc::
	By default, git-receive-pack will run "git-gc --auto" after
	receiving data from git-push and updating refs.  You can stop
	it by setting this variable to false.

1803 1804 1805 1806
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.
1807 1808
	Defaults to false. If not set, the value of `transfer.fsckObjects`
	is used instead.
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819

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.

1820 1821 1822 1823
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.

T
Thomas Rast 已提交
1824 1825 1826 1827
receive.denyDeleteCurrent::
	If set to true, git-receive-pack will deny a ref update that
	deletes the currently checked out branch of a non-bare repository.

1828
receive.denyCurrentBranch::
1829
	If set to true or "refuse", git-receive-pack will deny a ref update
1830 1831 1832 1833 1834
	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
1835
	message. Defaults to "refuse".
1836

1837 1838
receive.denyNonFastForwards::
	If set to true, git-receive-pack will deny a ref update which is
1839
	not a fast-forward. Use this to prevent such an update via a push,
1840 1841 1842
	even if that push is forced. This configuration variable is
	set when initializing a shared repository.

1843 1844 1845 1846
receive.updateserverinfo::
	If set to true, git-receive-pack will run git-update-server-info
	after receiving data from git-push and updating refs.

1847
remote.<name>.url::
1848 1849
	The URL of a remote repository.  See linkgit:git-fetch[1] or
	linkgit:git-push[1].
1850

1851 1852 1853
remote.<name>.pushurl::
	The push URL of a remote repository.  See linkgit:git-push[1].

S
Sam Vilain 已提交
1854 1855 1856 1857 1858
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.

1859
remote.<name>.fetch::
1860 1861
	The default set of "refspec" for linkgit:git-fetch[1]. See
	linkgit:git-fetch[1].
1862 1863

remote.<name>.push::
1864 1865
	The default set of "refspec" for linkgit:git-push[1]. See
	linkgit:git-push[1].
1866

1867 1868
remote.<name>.mirror::
	If true, pushing to this remote will automatically behave
1869
	as if the `--mirror` option was given on the command line.
1870

1871 1872
remote.<name>.skipDefaultUpdate::
	If true, this remote will be skipped by default when updating
1873 1874 1875 1876 1877 1878 1879
	using linkgit:git-fetch[1] or the `update` subcommand of
	linkgit:git-remote[1].

remote.<name>.skipFetchAll::
	If true, this remote will be skipped by default when updating
	using linkgit:git-fetch[1] or the `update` subcommand of
	linkgit:git-remote[1].
1880

1881
remote.<name>.receivepack::
1882
	The default program to execute on the remote side when pushing.  See
1883
	option \--receive-pack of linkgit:git-push[1].
1884

1885 1886
remote.<name>.uploadpack::
	The default program to execute on the remote side when fetching.  See
1887
	option \--upload-pack of linkgit:git-fetch-pack[1].
1888

1889
remote.<name>.tagopt::
1890
	Setting this value to \--no-tags disables automatic tag following when
1891 1892
	fetching from remote <name>. Setting it to \--tags will fetch every
	tag from remote <name>, even if they are not reachable from remote
1893 1894 1895
	branch heads. Passing these flags directly to linkgit:git-fetch[1] can
	override this setting. See options \--tags and \--no-tags of
	linkgit:git-fetch[1].
1896

1897 1898 1899 1900
remote.<name>.vcs::
	Setting this to a value <vcs> will cause git to interact with
	the remote with the git-remote-<vcs> helper.

1901 1902
remotes.<group>::
	The list of remotes which are fetched by "git remote update
1903
	<group>".  See linkgit:git-remote[1].
1904

1905
repack.usedeltabaseoffset::
1906 1907 1908 1909 1910 1911
	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.
1912

1913 1914 1915 1916 1917 1918 1919
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
1920 1921 1922
	conflict hunks can be resolved automatically, should they be
	encountered again.  By default, linkgit:git-rerere[1] is
	enabled if there is an `rr-cache` directory under the
1923 1924
	`$GIT_DIR`, e.g. if "rerere" was previously used in the
	repository.
1925

1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959
sendemail.identity::
	A configuration identity. When given, causes values in the
	'sendemail.<identity>' subsection to take precedence over
	values in the 'sendemail' section. The default identity is
	the value of 'sendemail.identity'.

sendemail.smtpencryption::
	See linkgit:git-send-email[1] for description.  Note that this
	setting is not subject to the 'identity' mechanism.

sendemail.smtpssl::
	Deprecated alias for 'sendemail.smtpencryption = ssl'.

sendemail.<identity>.*::
	Identity-specific versions of the 'sendemail.*' parameters
	found below, taking precedence over those when the this
	identity is selected, through command-line or
	'sendemail.identity'.

sendemail.aliasesfile::
sendemail.aliasfiletype::
sendemail.bcc::
sendemail.cc::
sendemail.cccmd::
sendemail.chainreplyto::
sendemail.confirm::
sendemail.envelopesender::
sendemail.from::
sendemail.multiedit::
sendemail.signedoffbycc::
sendemail.smtppass::
sendemail.suppresscc::
sendemail.suppressfrom::
sendemail.to::
1960
sendemail.smtpdomain::
1961 1962
sendemail.smtpserver::
sendemail.smtpserverport::
1963
sendemail.smtpserveroption::
1964 1965 1966 1967 1968 1969 1970 1971
sendemail.smtpuser::
sendemail.thread::
sendemail.validate::
	See linkgit:git-send-email[1] for description.

sendemail.signedoffcc::
	Deprecated alias for 'sendemail.signedoffbycc'.

P
Petr Baudis 已提交
1972
showbranch.default::
1973 1974
	The default set of branches for linkgit:git-show-branch[1].
	See linkgit:git-show-branch[1].
P
Petr Baudis 已提交
1975

1976
status.relativePaths::
1977
	By default, linkgit:git-status[1] shows paths relative to the
1978 1979 1980 1981
	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).

1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
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:
+
--
1992 1993 1994
* `no` - Show no untracked files.
* `normal` - Show untracked files and directories.
* `all` - Show also individual files in untracked directories.
1995 1996 1997 1998 1999 2000
--
+
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].

2001 2002 2003 2004 2005 2006 2007
status.submodulesummary::
	Defaults to false.
	If this is set to a non zero number or true (identical to -1 or an
	unlimited number), the submodule summary will be enabled and a
	summary of commits for modified submodules will be shown (see
	--summary-limit option of linkgit:git-submodule[1]).

2008 2009 2010 2011 2012 2013 2014 2015 2016
submodule.<name>.path::
submodule.<name>.url::
submodule.<name>.update::
	The path within this project, URL, and the updating strategy
	for a submodule.  These variables are initially populated
	by 'git submodule init'; edit them to override the
	URL and other values found in the `.gitmodules` file.  See
	linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.

2017
submodule.<name>.fetchRecurseSubmodules::
2018
	This option can be used to control recursive fetching of this
R
Ralf Wildenhues 已提交
2019
	submodule. It can be overridden by using the --[no-]recurse-submodules
2020 2021 2022 2023
	command line option to "git fetch" and "git pull".
	This setting will override that from in the linkgit:gitmodules[5]
	file.

2024 2025 2026 2027 2028 2029 2030 2031 2032
submodule.<name>.ignore::
	Defines under what circumstances "git status" and the diff family show
	a submodule as modified. When set to "all", it will never be considered
	modified, "dirty" will ignore all changes to the submodules work tree and
	takes only differences between the HEAD of the submodule and the commit
	recorded in the superproject into account. "untracked" will additionally
	let submodules with modified tracked files in their work tree show up.
	Using "none" (the default when this option is not set) also shows
	submodules that have untracked files in their work tree as changed.
2033
	This setting overrides any setting made in .gitmodules for this submodule,
2034
	both settings can be overridden on the command line by using the
2035
	"--ignore-submodules" option.
2036

2037
tar.umask::
2038 2039 2040 2041
	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
2042
	linkgit:git-archive[1].
2043

2044 2045 2046 2047 2048
transfer.fsckObjects::
	When `fetch.fsckObjects` or `receive.fsckObjects` are
	not set, the value of this variable is used instead.
	Defaults to false.

2049 2050 2051 2052 2053
transfer.unpackLimit::
	When `fetch.unpackLimit` or `receive.unpackLimit` are
	not set, the value of this variable is used instead.
	The default value is 100.

2054 2055 2056 2057 2058 2059 2060 2061
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
2062 2063
	never-before-seen repository on the site.  When more than one
	insteadOf strings match a given URL, the longest match is used.
2064

2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
url.<base>.pushInsteadOf::
	Any URL that starts with this value will not be pushed to;
	instead, it will be rewritten to start with <base>, and the
	resulting URL will be pushed to. In cases where some site serves
	a large number of repositories, and serves them with multiple
	access methods, some of which do not allow push, this feature
	allows people to specify a pull-only URL and have git
	automatically use an appropriate URL to push, even for a
	never-before-seen repository on the site.  When more than one
	pushInsteadOf strings match a given URL, the longest match is
	used.  If a remote has an explicit pushurl, git will ignore this
	setting for that remote.

P
Petr Baudis 已提交
2078 2079
user.email::
	Your email address to be recorded in any newly created commits.
2080
	Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2081
	'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
P
Petr Baudis 已提交
2082 2083 2084

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

2088
user.signingkey::
2089
	If linkgit:git-tag[1] is not selecting the key you want it to
2090 2091 2092 2093 2094
	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.

2095 2096 2097 2098
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.