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

The git configuration file contains a number of variables that affect
5
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 15 16 17
dot-separated segment and the section name is everything before the last
dot. The variable names are case-insensitive and only alphanumeric
characters are allowed. Some variables may appear multiple times.

18 19 20
Syntax
~~~~~~

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

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

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

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

--------

41 42 43
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
44 45 46 47
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.

48 49 50
There is also a case insensitive alternative `[section.subsection]` syntax.
In this syntax, subsection names follow the same restrictions as for section
names.
51

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

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

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

String values may be entirely or partially enclosed in double quotes.
70 71 72 73
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
74
be escaped: use `\"` for `"` and `\\` for `\`.
75

76 77 78
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
79 80
char sequences are valid.

81
Variable values ending in a `\` are continued on the next line in the
82 83
customary UNIX fashion.

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

Example
~~~~~~~

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

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

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

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

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

Note that this list is non-comprehensive and not necessarily complete.
112 113
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 已提交
114 115
porcelain configuration variables in the respective porcelain documentation.

116 117 118 119 120 121 122 123 124
advice.*::
	When set to 'true', display the given optional help message.
	When set to 'false', do not display. The configuration variables
	are:
+
--
	pushNonFastForward::
		Advice shown when linkgit:git-push[1] refuses
		non-fast-forward refs. Default: true.
125 126 127 128
	statusHints::
		Directions on how to stage/unstage/add shown in the
		output of linkgit:git-status[1] and the template shown
		when writing commit messages. Default: true.
129 130 131 132
	commitBeforeMerge::
		Advice shown when linkgit:git-merge[1] refuses to
		merge to avoid overwritting local changes.
		Default: true.
133 134 135 136
	resolveConflict::
		Advices shown by various commands when conflicts
		prevent the operation from being performed.
		Default: true.
137 138 139 140
	implicitIdentity::
		Advice on how to set your identity configuration when
		your information is guessed from the system username and
		domain name. Default: true.
141 142
--

P
Petr Baudis 已提交
143 144 145
core.fileMode::
	If false, the executable bit differences between the index and
	the working copy are ignored; useful on broken filesystems like FAT.
146 147 148 149 150
	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 已提交
151

152 153 154 155 156 157 158
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
159 160 161
	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.
162

163 164 165 166 167 168 169 170 171 172 173 174
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.

175 176 177 178 179 180 181
core.trustctime::
	If false, the ctime differences between the index and the
	working copy are ignored; useful when the inode change time
	is regularly modified by something outside Git (file system
	crawlers and some backup systems).
	See linkgit:git-update-index[1]. True by default.

182
core.quotepath::
183 184
	The commands that output paths (e.g. 'ls-files',
	'diff'), when not given the `-z` option, will quote
185 186 187 188 189 190 191 192 193
	"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.

194 195 196 197 198 199
core.autocrlf::
	If true, makes git convert `CRLF` at the end of lines in text files to
	`LF` when reading from the filesystem, and convert in reverse when
	writing to the filesystem.  The variable can be set to
	'input', in which case the conversion happens only while
	reading from the filesystem but files are written out with
200 201 202 203
	`LF` at the end of lines.  A file is considered
	"text" (i.e. be subjected to the autocrlf mechanism) based on
	the file's `crlf` attribute, or if `crlf` is unspecified,
	based on the file's contents.  See linkgit:gitattributes[5].
204

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
core.safecrlf::
	If true, makes git check if converting `CRLF` as controlled by
	`core.autocrlf` is reversible.  Git will verify if a command
	modifies a file in the work tree either directly or indirectly.
	For example, committing a file followed by checking out the
	same file should yield the original file in the work tree.  If
	this is not the case for the current setting of
	`core.autocrlf`, git will reject the file.  The variable can
	be set to "warn", in which case git will only warn about an
	irreversible conversion but continue the operation.
+
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout.  A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git.  For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
+
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes.  Right
after committing you still have the original file in your work
tree and this file is not yet corrupted.  You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
+
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished.  In both cases CRLFs are removed
in an irreversible way.  For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
+
Note, this safety check does not mean that a checkout will generate a
file identical to the original file for a different setting of
`core.autocrlf`, but only for the current one.  For example, a text
file with `LF` would be accepted with `core.autocrlf=input` and could
later be checked out with `core.autocrlf=true`, in which case the
resulting file would contain `CRLF`, although the original file
contained `LF`.  However, in both work trees the line endings would be
consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
file with mixed line endings would be reported by the `core.safecrlf`
mechanism.

250 251
core.symlinks::
	If false, symbolic links are checked out as small plain files that
252 253
	contain the link text. linkgit:git-update-index[1] and
	linkgit:git-add[1] will not change the recorded type to regular
254
	file. Useful on filesystems like FAT that do not support
255 256 257 258 259
	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.
260

P
Petr Baudis 已提交
261 262 263 264 265 266 267 268
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.
269 270 271 272
+
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
(which always applies universally, without the special "for"
handling).
273 274 275 276 277
+
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 已提交
278 279

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

289 290 291 292 293
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 已提交
294

295 296 297 298
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
299
	disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
300
+
301 302
This setting is automatically guessed by linkgit:git-clone[1] or
linkgit:git-init[1] when the repository was created.  By default a
303 304 305 306
repository that ends in "/.git" is assumed to be not bare (bare =
false), while all other repositories are assumed to be bare (bare
= true).

307
core.worktree::
308
	Set the path to the root of the work tree.
309
	This can be overridden by the GIT_WORK_TREE environment
310
	variable and the '--work-tree' command line option. It can be
311 312 313 314
	an absolute path or a relative path to the .git directory,
	either specified by --git-dir or GIT_DIR, or automatically
	discovered.
	If --git-dir or GIT_DIR are specified but none of
315
	--work-tree, GIT_WORK_TREE and core.worktree is specified,
316 317 318 319 320 321 322 323 324 325
	the current working directory is regarded as the root of the
	work tree.
+
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 "/path/to" directory will
still use "/different/path" as the root of the work tree and can cause
great confusion to the users.
326

327
core.logAllRefUpdates::
328
	Enable the reflog. Updates to a ref <ref> is logged to the file
329 330 331 332 333
	"$GIT_DIR/logs/<ref>", by appending the new and old
	SHA1, the date/time and the reason of the update, but
	only when the file exists.  If this configuration
	variable is set to true, missing "$GIT_DIR/logs/<ref>"
	file is automatically created for branch heads.
334 335 336 337 338 339 340
+
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.
341

P
Petr Baudis 已提交
342 343 344 345 346
core.repositoryFormatVersion::
	Internal variable identifying the repository format and layout
	version.

core.sharedRepository::
347 348 349 350 351
	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
352 353
	reported by umask(2). When '0xxx', where '0xxx' is an octal number,
	files in the repository will have this mode value. '0xxx' will override
354 355 356 357
	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
358 359
	repository that is group-readable but not group-writable.
	See linkgit:git-init[1]. False by default.
P
Petr Baudis 已提交
360 361 362 363 364

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.

365
core.compression::
366 367 368
	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.
369 370
	If set, this provides a default to other compression variables,
	such as 'core.loosecompression' and 'pack.compression'.
371 372

core.loosecompression::
373
	An integer -1..9, indicating the compression level for objects that
374
	are not in a pack file. -1 is the zlib default. 0 means no
375
	compression, and 1..9 are various speed/size tradeoffs, 9 being
376
	slowest.  If not set,  defaults to core.compression.  If that is
377
	not set,  defaults to 1 (best speed).
378

379 380 381 382 383
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
384
	performance due to increased calls to the operating system's
385
	memory manager, but may improve performance when accessing
386 387 388 389 390 391
	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.
392 393
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
394

395 396 397 398 399
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.
400 401 402 403
+
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.
404 405
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
406

407 408 409 410 411 412 413 414 415 416 417 418 419
core.deltaBaseCacheLimit::
	Maximum number of bytes to reserve for caching base objects
	that multiple deltafied objects reference.  By storing the
	entire decompressed base objects in a cache Git is able
	to avoid unpacking and decompressing frequently used base
	objects multiple times.
+
Default is 16 MiB on all platforms.  This should be reasonable
for all users/operating systems, except on the largest projects.
You probably do not need to adjust this value.
+
Common unit suffixes of 'k', 'm', or 'g' are supported.

420 421 422 423 424 425 426 427 428 429 430 431 432 433
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.
+
Currently only linkgit:git-fast-import[1] honors this setting.

434
core.excludesfile::
435 436
	In addition to '.gitignore' (per-directory) and
	'.git/info/exclude', git looks into this file for patterns
437 438
	of files which are not meant to be tracked.  "{tilde}/" is expanded
	to the value of `$HOME` and "{tilde}user/" to the specified user's
439
	home directory.  See linkgit:gitignore[5].
440

441 442
core.editor::
	Commands such as `commit` and `tag` that lets you edit
443
	messages by launching an editor uses the value of this
444
	variable when it is set, and the environment variable
445
	`GIT_EDITOR` is not set.  See linkgit:git-var[1].
446

447
core.pager::
448 449 450 451 452
	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
453 454 455 456 457 458 459 460
	`LESS` variable to some other value.  Alternately,
	these settings can be overridden on a project or
	global basis by setting the `core.pager` option.
	Setting `core.pager` has no affect on the `LESS`
	environment variable behaviour above, so if you want
	to override git's default settings this way, you need
	to be explicit.  For example, to disable the S option
	in a backward compatible manner, set `core.pager`
461
	to `less -+$LESS -FRX`.  This will be passed to the
462
	shell by git, which will translate the final command to
463
	`LESS=FRSX less -+FRSX -FRX`.
464

465 466
core.whitespace::
	A comma separated list of common whitespace problems to
467 468
	notice.  'git diff' will use `color.diff.whitespace` to
	highlight them, and 'git apply --whitespace=error' will
469 470
	consider them as errors.  You can prefix `-` to disable
	any of them (e.g. `-trailing-space`):
471
+
472
* `blank-at-eol` treats trailing whitespaces at the end of the line
473 474 475 476 477
  as an error (enabled by default).
* `space-before-tab` treats a space character that appears immediately
  before a tab character in the initial indent part of the line as an
  error (enabled by default).
* `indent-with-non-tab` treats a line that is indented with 8 or more
478
  space characters as an error (not enabled by default).
479 480
* `blank-at-eof` treats blank lines added at the end of file as an error
  (enabled by default).
481 482
* `trailing-space` is a short-hand to cover both `blank-at-eol` and
  `blank-at-eof`.
J
Junio C Hamano 已提交
483 484 485 486
* `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).
487

488 489 490 491 492 493 494 495
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 已提交
496 497 498 499 500 501 502 503 504
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.

505 506 507 508 509 510 511 512
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.
513

J
Johannes Schindelin 已提交
514 515 516 517 518 519 520 521 522 523 524 525 526
core.notesRef::
	When showing commit messages, also show notes which are stored in
	the given ref.  This ref is expected to contain files named
	after the full SHA-1 of the commit they annotate.
+
If such a file exists in the given ref, the referenced blob is read, and
appended to the commit message, separated by a "Notes:" line.  If the
given ref itself does not exist, it is not an error, but means that no
notes should be printed.
+
This setting defaults to "refs/notes/commits", and can be overridden by
the `GIT_NOTES_REF` environment variable.

527 528 529 530
core.sparseCheckout::
	Enable "sparse checkout" feature. See section "Sparse checkout" in
	linkgit:git-read-tree[1] for more information.

531
add.ignore-errors::
532
	Tells 'git add' to continue adding files when some files cannot be
533 534 535
	added due to indexing errors. Equivalent to the '--ignore-errors'
	option of linkgit:git-add[1].

P
Petr Baudis 已提交
536
alias.*::
537
	Command aliases for the linkgit:git[1] command wrapper - e.g.
P
Petr Baudis 已提交
538 539
	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 已提交
540 541 542 543
	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.
544 545 546 547 548
+
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
549 550 551
"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.
552

553
apply.ignorewhitespace::
554
	When set to 'change', tells 'git apply' to ignore changes in
555 556
	whitespace, in the same way as the '--ignore-space-change'
	option.
557
	When set to one of: no, none, never, false tells 'git apply' to
558 559 560
	respect all whitespace differences.
	See linkgit:git-apply[1].

P
Petr Baudis 已提交
561
apply.whitespace::
562
	Tells 'git apply' how to handle whitespaces, in the same way
563
	as the '--whitespace' option. See linkgit:git-apply[1].
P
Petr Baudis 已提交
564

P
Paolo Bonzini 已提交
565
branch.autosetupmerge::
566
	Tells 'git branch' and 'git checkout' to set up new branches
567 568
	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 已提交
569
	this behavior can be chosen per-branch using the `--track`
570 571 572 573 574
	and `--no-track` options. The valid settings are: `false` -- no
	automatic setup is done; `true` -- automatic setup is done when the
	starting point is a remote branch; `always` -- automatic setup is
	done when the starting point is either a local branch or remote
	branch. This option defaults to true.
P
Paolo Bonzini 已提交
575

576
branch.autosetuprebase::
577
	When a new branch is created with 'git branch' or 'git checkout'
578 579 580 581 582 583 584 585 586 587 588 589 590
	that tracks another branch, this variable tells git to set
	up pull to rebase instead of merge (see "branch.<name>.rebase").
	When `never`, rebase is never automatically set to true.
	When `local`, rebase is set to true for tracked branches of
	other local branches.
	When `remote`, rebase is set to true for tracked branches of
	remote branches.
	When `always`, rebase will be set to true for all tracking
	branches.
	See "branch.autosetupmerge" for details on how to set up a
	branch to track another branch.
	This option defaults to never.

591
branch.<name>.remote::
592
	When in branch <name>, it tells 'git fetch' and 'git push' which
593 594
	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.
595

596
branch.<name>.merge::
597
	Defines, together with branch.<name>.remote, the upstream branch
598 599 600
	for the given branch. It tells 'git fetch'/'git pull' which
	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 已提交
601 602 603 604
	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".
605 606 607
	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.
608
	Specify multiple values to get an octopus merge.
609
	If you wish to setup 'git pull' so that it merges into <name> from
610 611 612
	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.
613

614 615
branch.<name>.mergeoptions::
	Sets default options for merging into branch <name>. The syntax and
616
	supported options are the same as those of linkgit:git-merge[1], but
617 618 619
	option values containing whitespace characters are currently not
	supported.

620 621
branch.<name>.rebase::
	When true, rebase the branch <name> on top of the fetched branch,
622 623
	instead of merging the default branch from the default remote when
	"git pull" is run.
624
	*NOTE*: this is a possibly dangerous operation; do *not* use
625
	it unless you understand the implications (see linkgit:git-rebase[1]
626 627
	for details).

628 629 630 631 632
browser.<tool>.cmd::
	Specify the command to invoke the specified browser. The
	specified command is evaluated in shell with the URLs passed
	as arguments. (See linkgit:git-web--browse[1].)

633 634
browser.<tool>.path::
	Override the path for the given tool that may be used to
635 636
	browse HTML help (see '-w' option in linkgit:git-help[1]) or a
	working repository in gitweb (see linkgit:git-instaweb[1]).
637

638
clean.requireForce::
639 640
	A boolean to make git-clean do nothing unless given -f
	or -n.   Defaults to true.
641

642 643
color.branch::
	A boolean to enable/disable color in the output of
644
	linkgit:git-branch[1]. May be set to `always`,
645
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
646 647 648 649 650 651
	only when the output is to a terminal. Defaults to false.

color.branch.<slot>::
	Use customized color for branch coloration. `<slot>` is one of
	`current` (the current branch), `local` (a local branch),
	`remote` (a tracking branch in refs/remotes/), `plain` (other
652 653 654 655 656 657 658 659 660
	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.
661

662
color.diff::
663 664 665
	When set to `always`, always use colors in patch.
	When false (or `never`), never.  When set to `true` or `auto`, use
	colors only when the output is to the terminal. Defaults to false.
666

667
color.diff.<slot>::
668 669 670
	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 已提交
671 672 673 674
	(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>.
675

R
René Scharfe 已提交
676 677 678 679 680 681 682
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`.

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

J
Junio C Hamano 已提交
687
color.interactive::
688
	When set to `always`, always use colors for interactive prompts
689
	and displays (such as those used by "git-add --interactive").
J
Junio C Hamano 已提交
690 691 692 693
	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>::
694
	Use customized color for 'git add --interactive'
695 696
	output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
	four distinct types of normal output from interactive
697
	commands.  The values of these variables may be specified as
J
Junio C Hamano 已提交
698 699
	in color.branch.<slot>.

700 701 702 703
color.pager::
	A boolean to enable/disable colored output when the pager is in
	use (default is true).

704 705 706 707 708 709
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.

710 711
color.status::
	A boolean to enable/disable color in the output of
712
	linkgit:git-status[1]. May be set to `always`,
713
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
714 715 716 717 718
	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),
719 720
	`added` or `updated` (files which are added but not committed),
	`changed` (files which are changed but not added in the index),
721 722 723 724
	`untracked` (files which are not tracked by git), or
	`nobranch` (the color the 'no branch' warning is shown in, defaulting
	to red). The values of these variables may be specified as in
	color.branch.<slot>.
725

726 727 728 729 730 731 732
color.ui::
	When set to `always`, always use colors in all git commands which
	are capable of colored output. When false (or `never`), never. When
	set to `true` or `auto`, use colors only when the output is to the
	terminal. When more specific variables of color.* are set, they always
	take precedence over this setting. Defaults to false.

733
commit.status::
734 735 736 737
	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.

738 739
commit.template::
	Specify a file to use as the template for new commit messages.
740
	"{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
741
	specified user's home directory.
742

743
diff.autorefreshindex::
744
	When using 'git diff' to compare with work tree
745 746 747 748 749
	files, do not consider stat-only change as changed.
	Instead, silently run `git update-index --refresh` to
	update the cached stat information for paths whose
	contents in the work tree match the contents in the
	index.  This option defaults to true.  Note that this
750
	affects only 'git diff' Porcelain, and not lower level
751
	'diff' commands such as 'git diff-files'.
752

753 754 755
diff.external::
	If this config variable is set, diff generation is not
	performed using the internal diff machinery, but using the
756 757 758 759 760
	given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
	environment variable.  The command is called with parameters
	as described under "git Diffs" in linkgit:git[1].  Note: if
	you want to use an external diff program only on a subset of
	your files, you	might want to use linkgit:gitattributes[5] instead.
761

762
diff.mnemonicprefix::
763
	If set, 'git diff' uses a prefix pair that is different from the
764 765 766
	standard "a/" and "b/" depending on what is being compared.  When
	this configuration is in effect, reverse diff output also swaps
	the order of the prefixes:
767
`git diff`;;
768
	compares the (i)ndex and the (w)ork tree;
769
`git diff HEAD`;;
770
	 compares a (c)ommit and the (w)ork tree;
771
`git diff --cached`;;
772
	compares a (c)ommit and the (i)ndex;
773
`git diff HEAD:file1 file2`;;
774
	compares an (o)bject and a (w)ork tree entity;
775
`git diff --no-index a b`;;
776 777
	compares two non-git things (1) and (2).

P
Petr Baudis 已提交
778 779
diff.renameLimit::
	The number of files to consider when performing the copy/rename
780
	detection; equivalent to the 'git diff' option '-l'.
P
Petr Baudis 已提交
781

782 783 784 785 786
diff.renames::
	Tells git to detect renames.  If set to any boolean value, it
	will enable basic rename detection.  If set to "copies" or
	"copy", it will detect copies, as well.

787
diff.suppressBlankEmpty::
R
Richard Hartmann 已提交
788 789 790
	A boolean to inhibit the standard behavior of printing a space
	before each empty output line. Defaults to false.

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
diff.tool::
	Controls which diff tool is used.  `diff.tool` overrides
	`merge.tool` when used by linkgit:git-difftool[1] and has
	the same valid values as `merge.tool` minus "tortoisemerge"
	and plus "kompare".

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.

809 810 811
difftool.prompt::
	Prompt before each invocation of the diff tool.

812
diff.wordRegex::
813 814 815 816 817
	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.

818 819 820 821 822 823 824 825
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,
826 827
	especially on slow filesystems.  If not set, the value of
	`transfer.unpackLimit` is used instead.
828

829 830 831 832 833 834 835
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].

836
format.numbered::
837 838 839 840 841
	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].
842

P
Petr Baudis 已提交
843 844
format.headers::
	Additional email headers to include in a patch to be submitted
845
	by mail.  See linkgit:git-format-patch[1].
P
Petr Baudis 已提交
846

847 848 849 850 851 852 853 854
format.cc::
	Additional "Cc:" headers to include in a patch to be submitted
	by mail.  See the --cc option in linkgit:git-format-patch[1].

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

855 856 857 858
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 已提交
859

860 861 862 863 864
format.pretty::
	The default pretty format for log/show/whatchanged command,
	See linkgit:git-log[1], linkgit:git-show[1],
	linkgit:git-whatchanged[1].

865
format.thread::
866
	The default threading style for 'git format-patch'.  Can be
867 868
	a boolean value, or `shallow` or `deep`.  `shallow` threading
	makes every mail a reply to the head of the series,
869 870
	where the head is chosen from the cover letter, the
	`\--in-reply-to`, and the first patch mail, in this order.
871
	`deep` threading makes every mail a reply to the previous one.
872 873 874
	A true boolean value is the same as `shallow`, and a false
	value disables threading.

875 876 877 878 879 880 881
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.

882 883
gc.aggressiveWindow::
	The window size parameter used in the delta compression
884
	algorithm used by 'git gc --aggressive'.  This defaults
885 886
	to 10.

887 888 889 890
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
891 892
	light-weight garbage collection from time to time.  The
	default value is 6700.  Setting this to 0 disables it.
893

894 895 896
gc.autopacklimit::
	When there are more than this many packs that are not
	marked with `*.keep` file in the repository, `git gc
897
	--auto` consolidates them into one larger pack.  The
898
	default	value is 50.  Setting this to 0 disables it.
899

900
gc.packrefs::
901 902 903
	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
904
	'git gc' runs `git pack-refs`. This can be set to `nobare`
905 906
	to enable it within all non-bare repos or it can be set to a
	boolean value.  The default is `true`.
907

908
gc.pruneexpire::
909
	When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
910 911 912
	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.
913

914
gc.reflogexpire::
915
	'git reflog expire' removes reflog entries older than
916 917 918
	this time; defaults to 90 days.

gc.reflogexpireunreachable::
919
	'git reflog expire' removes reflog entries older than
920 921 922
	this time and are not reachable from the current tip;
	defaults to 30 days.

923 924
gc.rerereresolved::
	Records of conflicted merge you resolved earlier are
925
	kept for this many days when 'git rerere gc' is run.
926
	The default is 60 days.  See linkgit:git-rerere[1].
927 928 929

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

933 934 935 936
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 已提交
937
gitcvs.enabled::
938
	Whether the CVS server interface is enabled for this repository.
939
	See linkgit:git-cvsserver[1].
P
Petr Baudis 已提交
940 941

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

945
gitcvs.usecrlfattr::
M
Matthew Ogilvie 已提交
946 947 948 949
	If true, the server will look up the `crlf` attribute for
	files to determine the '-k' modes to use. If `crlf` is set,
	the '-k' mode will be left blank, so cvs clients will
	treat it as text. If `crlf` is explicitly unset, the file
950
	will be set with '-kb' mode, which suppresses any newline munging
M
Matthew Ogilvie 已提交
951
	the client might otherwise do. If `crlf` is not specified,
952
	then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
M
Matthew Ogilvie 已提交
953

954
gitcvs.allbinary::
955 956 957 958 959 960 961 962
	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 已提交
963

964 965 966 967 968
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
969
	linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
970 971 972 973 974 975 976 977
	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'.
978
	See linkgit:git-cvsserver[1].
979

980 981 982 983
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
984
	linkgit:git-cvsserver[1] for details).
985

986 987 988 989 990 991 992
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 已提交
993 994 995
All gitcvs variables except for 'gitcvs.usecrlfattr' and
'gitcvs.allbinary' can also be specified as
'gitcvs.<access_method>.<varname>' (where 'access_method'
996 997
is one of "ext" and "pserver") to make them apply only for the given
access method.
998

999 1000 1001 1002 1003 1004 1005 1006
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".

1007 1008 1009 1010 1011 1012 1013 1014
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.

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
gui.matchtrackingbranch::
	Determines if new branches created with linkgit:git-gui[1] should
	default to tracking remote branches with matching names or
	not. Default: "false".

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

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

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

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

1037
gui.fastcopyblame::
1038
	If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1039 1040 1041 1042
	location detection. It makes blame significantly faster on huge
	repositories at the expense of less thorough copy detection.

gui.copyblamethreshold::
R
Ralf Wildenhues 已提交
1043
	Specifies the threshold to use in 'git gui blame' original location
1044 1045 1046 1047 1048 1049 1050 1051 1052
	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.

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
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.

1104 1105 1106 1107 1108 1109 1110 1111 1112
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.

1113 1114 1115 1116 1117 1118 1119 1120 1121
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.

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

P
Petr Baudis 已提交
1127 1128
http.sslVerify::
	Whether to verify the SSL certificate when fetching or pushing
F
Francis Daly 已提交
1129
	over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
P
Petr Baudis 已提交
1130 1131 1132 1133
	variable.

http.sslCert::
	File containing the SSL certificate when fetching or pushing
F
Francis Daly 已提交
1134
	over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
P
Petr Baudis 已提交
1135 1136 1137 1138
	variable.

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

1142 1143 1144 1145 1146 1147
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 已提交
1148 1149
http.sslCAInfo::
	File containing the certificates to verify the peer with when
1150
	fetching or pushing over HTTPS. Can be overridden by the
P
Petr Baudis 已提交
1151 1152 1153 1154
	'GIT_SSL_CAINFO' environment variable.

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

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

T
Tay Ray Chuan 已提交
1162 1163 1164 1165 1166 1167
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.

1168 1169 1170 1171 1172 1173 1174 1175
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 已提交
1176 1177 1178
http.lowSpeedLimit, http.lowSpeedTime::
	If the HTTP transfer speed is less than 'http.lowSpeedLimit'
	for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1179
	Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
P
Petr Baudis 已提交
1180 1181
	'GIT_HTTP_LOW_SPEED_TIME' environment variables.

1182 1183
http.noEPSV::
	A boolean which disables using of EPSV ftp command by curl.
1184
	This can helpful with some "poor" ftp servers which don't
1185 1186 1187
	support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
	environment variable. Default is false (curl will use EPSV).

P
Petr Baudis 已提交
1188 1189 1190 1191 1192
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
1193
	porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
P
Petr Baudis 已提交
1194

1195 1196
i18n.logOutputEncoding::
	Character encoding the commit messages are converted to when
1197
	running 'git log' and friends.
1198

1199 1200 1201 1202
imap::
	The configuration variables in the 'imap' section are described
	in linkgit:git-imap-send[1].

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
instaweb.browser::
	Specify the program that will be used to browse your working
	repository in gitweb. See linkgit:git-instaweb[1].

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

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

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

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

1222
interactive.singlekey::
1223
	In interactive commands, allow the user to provide one-letter
1224 1225 1226 1227 1228
	input with a single key (i.e., without hitting enter).
	Currently this is used only by the `\--patch` mode of
	linkgit:git-add[1].  Note that this setting is silently
	ignored if portable keystroke input is not available.

H
Heikki Orsila 已提交
1229 1230
log.date::
	Set default date-time mode for the log command. Setting log.date
1231
	value is similar to using 'git log'\'s --date option. The value is one of the
H
Heikki Orsila 已提交
1232 1233 1234
	following alternatives: {relative,local,default,iso,rfc,short}.
	See linkgit:git-log[1].

1235 1236 1237
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.
1238
	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1239 1240
	normally hide the root commit will now show it. True by default.

1241 1242 1243 1244 1245 1246 1247 1248
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].

1249
man.viewer::
1250
	Specify the programs that may be used to display help in the
1251 1252
	'man' format. See linkgit:git-help[1].

1253 1254 1255 1256 1257
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].)

1258 1259 1260 1261
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].

1262
include::merge-config.txt[]
1263

1264 1265 1266 1267
mergetool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.

1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
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.

1287 1288 1289 1290 1291 1292
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).

1293 1294 1295 1296 1297 1298 1299
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`.

1300 1301 1302
mergetool.prompt::
	Prompt before each invocation of the merge resolution program.

1303
pack.window::
1304
	The size of the window used by linkgit:git-pack-objects[1] when no
1305 1306
	window size is given on the command line. Defaults to 10.

1307
pack.depth::
1308
	The maximum delta depth used by linkgit:git-pack-objects[1] when no
1309
	maximum depth is given on the command line. Defaults to 50.
1310

1311
pack.windowMemory::
1312
	The window memory size limit used by linkgit:git-pack-objects[1]
1313 1314 1315 1316
	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.

1317 1318 1319 1320 1321
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
1322 1323 1324
	not set,  defaults to -1, the zlib default, which is "a default
	compromise between speed and compression (currently equivalent
	to level 6)."
1325

1326
pack.deltaCacheSize::
1327
	The maximum memory in bytes used for caching deltas in
1328 1329 1330 1331 1332 1333 1334 1335
	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.
1336

1337
pack.deltaCacheLimit::
1338
	The maximum size of a delta, that is cached in
1339 1340 1341
	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.
1342

1343 1344
pack.threads::
	Specifies the number of threads to spawn when searching for best
1345
	delta matches.  This requires that linkgit:git-pack-objects[1]
1346 1347 1348 1349
	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.
1350 1351
	Specifying 0 will cause git to auto-detect the number of CPU's
	and set the number of threads accordingly.
1352

1353 1354 1355 1356 1357
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
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
	packs.  Version 2 is the default.  Note that version 2 is enforced
	and this config option ignored whenever the corresponding pack is
	larger than 2 GB.
+
If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
cloning or fetching over a non native protocol (e.g. "http" and "rsync")
that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
other side may give you a repository that cannot be accessed with your
older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
the `{asterisk}.idx` file.
1369

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

1376
pager.<cmd>::
1377 1378 1379 1380
	Allows turning on or off pagination of the output of a
	particular git subcommand when writing to a tty.  If
	`\--paginate` or `\--no-pager` is specified on the command line,
	it takes precedence over this option.  To disable pagination for
1381
	all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1382

P
Petr Baudis 已提交
1383 1384 1385 1386 1387 1388 1389
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.

1390 1391 1392 1393
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
1394
	line. Possible values are:
1395 1396
+
* `nothing` do not push anything.
1397
* `matching` push all matching branches.
1398
  All branches having the same name in both ends are considered to be
1399
  matching. This is the default.
1400
* `tracking` push the current branch to its upstream branch.
1401
* `current` push the current branch to a branch of the same name.
1402

1403 1404 1405 1406
rebase.stat::
	Whether to show a diffstat of what changed upstream since the last
	rebase. False by default.

1407 1408 1409 1410 1411
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.

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
receive.fsckObjects::
	If it is set to true, git-receive-pack will check all received
	objects. It will abort in the case of a malformed object or a
	broken link. The result of an abort are only dangling objects.
	Defaults to false.

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

1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
receive.denyDeletes::
	If set to true, git-receive-pack will deny a ref update that deletes
	the ref. Use this to prevent such a ref deletion via a push.

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

1441 1442
receive.denyNonFastForwards::
	If set to true, git-receive-pack will deny a ref update which is
1443
	not a fast-forward. Use this to prevent such an update via a push,
1444 1445 1446
	even if that push is forced. This configuration variable is
	set when initializing a shared repository.

1447 1448 1449 1450
receive.updateserverinfo::
	If set to true, git-receive-pack will run git-update-server-info
	after receiving data from git-push and updating refs.

1451
remote.<name>.url::
1452 1453
	The URL of a remote repository.  See linkgit:git-fetch[1] or
	linkgit:git-push[1].
1454

1455 1456 1457
remote.<name>.pushurl::
	The push URL of a remote repository.  See linkgit:git-push[1].

S
Sam Vilain 已提交
1458 1459 1460 1461 1462
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.

1463
remote.<name>.fetch::
1464 1465
	The default set of "refspec" for linkgit:git-fetch[1]. See
	linkgit:git-fetch[1].
1466 1467

remote.<name>.push::
1468 1469
	The default set of "refspec" for linkgit:git-push[1]. See
	linkgit:git-push[1].
1470

1471 1472 1473 1474
remote.<name>.mirror::
	If true, pushing to this remote will automatically behave
	as if the `\--mirror` option was given on the command line.

1475 1476
remote.<name>.skipDefaultUpdate::
	If true, this remote will be skipped by default when updating
1477 1478 1479 1480 1481 1482 1483
	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].
1484

1485
remote.<name>.receivepack::
1486
	The default program to execute on the remote side when pushing.  See
1487
	option \--receive-pack of linkgit:git-push[1].
1488

1489 1490
remote.<name>.uploadpack::
	The default program to execute on the remote side when fetching.  See
1491
	option \--upload-pack of linkgit:git-fetch-pack[1].
1492

1493
remote.<name>.tagopt::
1494 1495
	Setting this value to \--no-tags disables automatic tag following when
	fetching from remote <name>
1496

1497 1498 1499 1500
remote.<name>.vcs::
	Setting this to a value <vcs> will cause git to interact with
	the remote with the git-remote-<vcs> helper.

1501 1502
remotes.<group>::
	The list of remotes which are fetched by "git remote update
1503
	<group>".  See linkgit:git-remote[1].
1504

1505
repack.usedeltabaseoffset::
1506 1507 1508 1509 1510 1511
	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.
1512

1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
rerere.autoupdate::
	When set to true, `git-rerere` updates the index with the
	resulting contents after it cleanly resolves conflicts using
	previously recorded resolution.  Defaults to false.

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

1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
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::
sendemail.smtpserver::
sendemail.smtpserverport::
sendemail.smtpuser::
sendemail.thread::
sendemail.validate::
	See linkgit:git-send-email[1] for description.

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

P
Petr Baudis 已提交
1569
showbranch.default::
1570 1571
	The default set of branches for linkgit:git-show-branch[1].
	See linkgit:git-show-branch[1].
P
Petr Baudis 已提交
1572

1573
status.relativePaths::
1574
	By default, linkgit:git-status[1] shows paths relative to the
1575 1576 1577 1578
	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).

1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
status.showUntrackedFiles::
	By default, linkgit:git-status[1] and linkgit:git-commit[1] show
	files which are not currently tracked by Git. Directories which
	contain only untracked files, are shown with the directory name
	only. Showing untracked files means that Git needs to lstat() all
	all the files in the whole repository, which might be slow on some
	systems. So, this variable controls how the commands displays
	the untracked files. Possible values are:
+
--
	- 'no'     - Show no untracked files
	- 'normal' - Shows untracked files and directories
	- 'all'    - Shows also individual files in untracked directories.
--
+
If this variable is not specified, it defaults to 'normal'.
This variable can be overridden with the -u|--untracked-files option
of linkgit:git-status[1] and linkgit:git-commit[1].

1598
tar.umask::
1599 1600 1601 1602
	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
1603
	linkgit:git-archive[1].
1604

1605 1606 1607 1608 1609
transfer.unpackLimit::
	When `fetch.unpackLimit` or `receive.unpackLimit` are
	not set, the value of this variable is used instead.
	The default value is 100.

1610 1611 1612 1613 1614 1615 1616 1617
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
1618 1619
	never-before-seen repository on the site.  When more than one
	insteadOf strings match a given URL, the longest match is used.
1620

1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
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 已提交
1634 1635
user.email::
	Your email address to be recorded in any newly created commits.
1636
	Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1637
	'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
P
Petr Baudis 已提交
1638 1639 1640

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

1644
user.signingkey::
1645
	If linkgit:git-tag[1] is not selecting the key you want it to
1646 1647 1648 1649 1650
	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.

1651 1652 1653 1654
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.