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

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

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

18 19 20
Syntax
~~~~~~

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

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

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

--------

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

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

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

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

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

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

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
char sequences are valid.

Variable value ending in a '`\`' is continued on the next line in the
customary UNIX fashion.

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

Example
~~~~~~~

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

	# Our diff algorithm
	[diff]
		external = "/usr/local/bin/gnu-diff -u"
		renames = true

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

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

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

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

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

120 121 122 123 124 125 126 127 128 129 130 131
core.quotepath::
	The commands that output paths (e.g. `ls-files`,
	`diff`), when not given the `-z` option, will quote
	"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.

132 133 134 135 136 137 138 139 140 141
core.autocrlf::
	If true, makes git convert `CRLF` at the end of lines in text files to
	`LF` when reading from the filesystem, and convert in reverse when
	writing to the filesystem.  The variable can be set to
	'input', in which case the conversion happens only while
	reading from the filesystem but files are written out with
	`LF` at the end of lines.  Currently, which paths to consider
	"text" (i.e. be subjected to the autocrlf mechanism) is
	decided purely based on the contents.

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
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.

187 188
core.symlinks::
	If false, symbolic links are checked out as small plain files that
189 190
	contain the link text. linkgit:git-update-index[1] and
	linkgit:git-add[1] will not change the recorded type to regular
191 192 193
	file. Useful on filesystems like FAT that do not support
	symbolic links. True by default.

P
Petr Baudis 已提交
194 195 196 197 198 199 200 201
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.
202 203 204 205
+
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
(which always applies universally, without the special "for"
handling).
P
Petr Baudis 已提交
206 207

core.ignoreStat::
208 209 210 211 212 213 214
	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 已提交
215 216
	False by default.

217 218 219 220 221
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 已提交
222

223 224 225 226
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
227
	disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
228
+
229 230
This setting is automatically guessed by linkgit:git-clone[1] or
linkgit:git-init[1] when the repository was created.  By default a
231 232 233 234
repository that ends in "/.git" is assumed to be not bare (bare =
false), while all other repositories are assumed to be bare (bare
= true).

235 236 237 238
core.worktree::
	Set the path to the working tree.  The value will not be
	used in combination with repositories found automatically in
	a .git directory (i.e. $GIT_DIR is not set).
239
	This can be overridden by the GIT_WORK_TREE environment
240 241 242 243 244 245 246
	variable and the '--work-tree' command line option. It can be
	a absolute path or relative path to the directory specified by
	--git-dir or GIT_DIR.
	Note: If --git-dir or GIT_DIR are specified but none of
	--work-tree, GIT_WORK_TREE and core.worktree is specified,
	the current working directory is regarded as the top directory
	of your working tree.
247

248
core.logAllRefUpdates::
249
	Enable the reflog. Updates to a ref <ref> is logged to the file
250 251 252 253 254
	"$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.
255 256 257 258 259 260 261
+
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.
262

P
Petr Baudis 已提交
263 264 265 266 267
core.repositoryFormatVersion::
	Internal variable identifying the repository format and layout
	version.

core.sharedRepository::
268 269 270 271 272
	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
273 274 275 276 277 278
	reported by umask(2). When '0xxx', where '0xxx' is an octal number,
	files in the repository will have this mode value. '0xxx' will override
	user's umask value, and thus, users with a safe umask (0077) can use
	this option. Examples: '0660' is equivalent to 'group'. '0640' is a
	repository that is group-readable but not group-writable.
	See linkgit:git-init[1]. False by default.
P
Petr Baudis 已提交
279 280 281 282 283

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.

284
core.compression::
285 286 287
	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.
288 289
	If set, this provides a default to other compression variables,
	such as 'core.loosecompression' and 'pack.compression'.
290 291

core.loosecompression::
292
	An integer -1..9, indicating the compression level for objects that
293
	are not in a pack file. -1 is the zlib default. 0 means no
294
	compression, and 1..9 are various speed/size tradeoffs, 9 being
295
	slowest.  If not set,  defaults to core.compression.  If that is
296
	not set,  defaults to 1 (best speed).
297

298 299 300 301 302
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
303
	performance due to increased calls to the operating system's
304
	memory manager, but may improve performance when accessing
305 306 307 308 309 310
	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.
311 312
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
313

314 315 316 317 318
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.
319 320 321 322
+
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.
323 324
+
Common unit suffixes of 'k', 'm', or 'g' are supported.
325

326 327 328 329 330 331 332 333 334 335 336 337 338
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.

339
core.excludesfile::
340 341
	In addition to '.gitignore' (per-directory) and
	'.git/info/exclude', git looks into this file for patterns
342
	of files which are not meant to be tracked.  See
343
	linkgit:gitignore[5].
344

345 346
core.editor::
	Commands such as `commit` and `tag` that lets you edit
347
	messages by launching an editor uses the value of this
348 349
	variable when it is set, and the environment variable
	`GIT_EDITOR` is not set.  The order of preference is
350 351
	`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
	`EDITOR` environment variables and then finally `vi`.
352

353 354 355 356
core.pager::
	The command that git will use to paginate output.  Can be overridden
	with the `GIT_PAGER` environment variable.

357 358 359 360 361 362 363 364 365 366 367 368
core.whitespace::
	A comma separated list of common whitespace problems to
	notice.  `git diff` will use `color.diff.whitespace` to
	highlight them, and `git apply --whitespace=error` will
	consider them as errors:
+
* `trailing-space` treats trailing whitespaces at the end of the line
  as an error (enabled by default).
* `space-before-tab` treats a space character that appears immediately
  before a tab character in the initial indent part of the line as an
  error (enabled by default).
* `indent-with-non-tab` treats a line that is indented with 8 or more
369
  space characters as an error (not enabled by default).
J
Junio C Hamano 已提交
370 371 372 373
* `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).
374

P
Petr Baudis 已提交
375
alias.*::
376
	Command aliases for the linkgit:git[1] command wrapper - e.g.
P
Petr Baudis 已提交
377 378
	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 已提交
379 380 381 382
	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.
383 384 385 386 387 388
+
If the alias expansion is prefixed with an exclamation point,
it will be treated as a shell command.  For example, defining
"alias.new = !gitk --all --not ORIG_HEAD", the invocation
"git new" is equivalent to running the shell command
"gitk --all --not ORIG_HEAD".
389

P
Petr Baudis 已提交
390 391
apply.whitespace::
	Tells `git-apply` how to handle whitespaces, in the same way
392
	as the '--whitespace' option. See linkgit:git-apply[1].
P
Petr Baudis 已提交
393

P
Paolo Bonzini 已提交
394
branch.autosetupmerge::
395
	Tells `git-branch` and `git-checkout` to setup new branches
396 397
	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 已提交
398
	this behavior can be chosen per-branch using the `--track`
399 400 401 402 403
	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 已提交
404

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
branch.autosetuprebase::
	When a new branch is created with `git-branch` or `git-checkout`
	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.

420 421
branch.<name>.remote::
	When in branch <name>, it tells `git fetch` which remote to fetch.
422
	If this option is not given, `git fetch` defaults to remote "origin".
423

424
branch.<name>.merge::
D
Daniel Barkalow 已提交
425 426 427 428 429
	When in branch <name>, it tells `git fetch` the default
	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".
430 431 432 433
	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.
	Specify multiple values to get an octopus merge.
434 435 436 437
	If you wish to setup `git pull` so that it merges into <name> from
	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.
438

439 440
branch.<name>.mergeoptions::
	Sets default options for merging into branch <name>. The syntax and
441
	supported options are equal to that of linkgit:git-merge[1], but
442 443 444
	option values containing whitespace characters are currently not
	supported.

445 446
branch.<name>.rebase::
	When true, rebase the branch <name> on top of the fetched branch,
447 448
	instead of merging the default branch from the default remote when
	"git pull" is run.
449
	*NOTE*: this is a possibly dangerous operation; do *not* use
450
	it unless you understand the implications (see linkgit:git-rebase[1]
451 452
	for details).

453 454 455 456 457
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].)

458 459
browser.<tool>.path::
	Override the path for the given tool that may be used to
460 461
	browse HTML help (see '-w' option in linkgit:git-help[1]) or a
	working repository in gitweb (see linkgit:git-instaweb[1]).
462

463
clean.requireForce::
464 465
	A boolean to make git-clean do nothing unless given -f
	or -n.   Defaults to true.
466

467 468
color.branch::
	A boolean to enable/disable color in the output of
469
	linkgit:git-branch[1]. May be set to `always`,
470
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
471 472 473 474 475 476
	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
477 478 479 480 481 482 483 484 485
	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.
486

487
color.diff::
488 489 490
	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.
491

492
color.diff.<slot>::
493 494 495 496
	Use customized color for diff colorization.  `<slot>` specifies
	which part of the patch to use the specified color, and is one
	of `plain` (context text), `meta` (metainformation), `frag`
	(hunk header), `old` (removed lines), `new` (added lines),
497 498
	`commit` (commit headers), or `whitespace` (highlighting
	whitespace errors). The values of these variables may be specified as
499
	in color.branch.<slot>.
500

J
Junio C Hamano 已提交
501
color.interactive::
502 503
	When set to `always`, always use colors for interactive prompts
	and displays (such as those used by "git add --interactive").
J
Junio C Hamano 已提交
504 505 506 507 508 509 510 511 512 513
	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>::
	Use customized color for `git add --interactive`
	output. `<slot>` may be `prompt`, `header`, or `help`, for
	three distinct types of normal output from interactive
	programs.  The values of these variables may be specified as
	in color.branch.<slot>.

514 515 516 517 518 519
color.pager::
	A boolean to enable/disable colored output when the pager is in
	use (default is true).

color.status::
	A boolean to enable/disable color in the output of
520
	linkgit:git-status[1]. May be set to `always`,
521
	`false` (or `never`) or `auto` (or `true`), in which case colors are used
522 523 524 525 526
	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),
527 528
	`added` or `updated` (files which are added but not committed),
	`changed` (files which are changed but not added in the index),
529 530 531 532
	`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>.
533

534 535 536
commit.template::
	Specify a file to use as the template for new commit messages.

537 538 539 540 541 542 543
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.

544 545 546 547 548 549 550 551 552 553
diff.autorefreshindex::
	When using `git diff` to compare with work tree
	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
	affects only `git diff` Porcelain, and not lower level
	`diff` commands, such as `git diff-files`.

554 555 556 557 558
diff.external::
	If this config variable is set, diff generation is not
	performed using the internal diff machinery, but using the
	given command.  Note: if you want to use an external diff
	program only on a subset of your files, you might want to
559
	use linkgit:gitattributes[5] instead.
560

P
Petr Baudis 已提交
561 562 563 564
diff.renameLimit::
	The number of files to consider when performing the copy/rename
	detection; equivalent to the git diff option '-l'.

565 566 567 568 569
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.

570 571 572 573 574 575 576 577
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,
578 579
	especially on slow filesystems.  If not set, the value of
	`transfer.unpackLimit` is used instead.
580

581 582
format.numbered::
	A boolean which can enable sequence numbers in patch subjects.
R
Ralf Wildenhues 已提交
583
	Setting this option to "auto" will enable it only if there is
584
	more than one patch.  See --numbered option in
585
	linkgit:git-format-patch[1].
586

P
Petr Baudis 已提交
587 588
format.headers::
	Additional email headers to include in a patch to be submitted
589
	by mail.  See linkgit:git-format-patch[1].
P
Petr Baudis 已提交
590

591 592 593 594
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 已提交
595

596 597 598 599 600
format.pretty::
	The default pretty format for log/show/whatchanged command,
	See linkgit:git-log[1], linkgit:git-show[1],
	linkgit:git-whatchanged[1].

601 602 603 604 605
gc.aggressiveWindow::
	The window size parameter used in the delta compression
	algorithm used by 'git gc --aggressive'.  This defaults
	to 10.

606 607 608 609
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
610 611
	light-weight garbage collection from time to time.  The
	default value is 6700.  Setting this to 0 disables it.
612

613 614 615
gc.autopacklimit::
	When there are more than this many packs that are not
	marked with `*.keep` file in the repository, `git gc
616
	--auto` consolidates them into one larger pack.  The
617
	default	value is 50.  Setting this to 0 disables it.
618

619 620 621 622 623 624 625 626 627 628 629
gc.packrefs::
	`git gc` does not run `git pack-refs` in a bare repository by
	default so that older dumb-transport clients can still fetch
	from the repository.  Setting this to `true` lets `git
	gc` to run `git pack-refs`.  Setting this to `false` tells
	`git gc` never to run `git pack-refs`. The default setting is
	`notbare`. Enable it only when you know you do not have to
	support such clients.  The default setting will change to `true`
	at some stage, and setting this to `false` will continue to
	prevent `git pack-refs` from being run from `git gc`.

630 631 632 633
gc.pruneexpire::
	When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
	Override the grace period with this config variable.

634 635 636 637 638 639 640 641 642
gc.reflogexpire::
	`git reflog expire` removes reflog entries older than
	this time; defaults to 90 days.

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

643 644 645
gc.rerereresolved::
	Records of conflicted merge you resolved earlier are
	kept for this many days when `git rerere gc` is run.
646
	The default is 60 days.  See linkgit:git-rerere[1].
647 648 649 650

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

653 654 655
rerere.enabled::
	Activate recording of resolved conflicts, so that identical
	conflict hunks can be resolved automatically, should they
656
	be encountered again.  linkgit:git-rerere[1] command is by
J
Junio C Hamano 已提交
657 658
	default enabled if you create `rr-cache` directory under
	`$GIT_DIR`, but can be disabled by setting this option to false.
659

P
Petr Baudis 已提交
660
gitcvs.enabled::
661
	Whether the CVS server interface is enabled for this repository.
662
	See linkgit:git-cvsserver[1].
P
Petr Baudis 已提交
663 664

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

M
Matthew Ogilvie 已提交
668 669 670 671 672 673 674 675 676
gitcvs.usecrlfattr
	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
	will be set with '-kb' mode, which supresses any newline munging
	the client might otherwise do. If `crlf` is not specified,
	then 'gitcvs.allbinary' is used. See linkgit:gitattribute[5].

677
gitcvs.allbinary::
678 679 680 681 682 683 684 685
	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 已提交
686

687 688 689 690 691
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
692
	linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
693 694 695 696 697 698 699 700
	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'.
701
	See linkgit:git-cvsserver[1].
702

703 704 705 706
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
707
	linkgit:git-cvsserver[1] for details).
708

709 710 711 712 713 714 715
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 已提交
716 717 718
All gitcvs variables except for 'gitcvs.usecrlfattr' and
'gitcvs.allbinary' can also be specified as
'gitcvs.<access_method>.<varname>' (where 'access_method'
719 720
is one of "ext" and "pserver") to make them apply only for the given
access method.
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
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".

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.

752 753 754 755 756 757 758 759 760
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.

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

P
Petr Baudis 已提交
766 767
http.sslVerify::
	Whether to verify the SSL certificate when fetching or pushing
F
Francis Daly 已提交
768
	over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
P
Petr Baudis 已提交
769 770 771 772
	variable.

http.sslCert::
	File containing the SSL certificate when fetching or pushing
F
Francis Daly 已提交
773
	over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
P
Petr Baudis 已提交
774 775 776 777
	variable.

http.sslKey::
	File containing the SSL private key when fetching or pushing
778
	over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
P
Petr Baudis 已提交
779 780 781 782
	variable.

http.sslCAInfo::
	File containing the certificates to verify the peer with when
783
	fetching or pushing over HTTPS. Can be overridden by the
P
Petr Baudis 已提交
784 785 786 787
	'GIT_SSL_CAINFO' environment variable.

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

http.maxRequests::
792
	How many HTTP requests to launch in parallel. Can be overridden
P
Petr Baudis 已提交
793 794 795 796 797
	by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.

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

801 802
http.noEPSV::
	A boolean which disables using of EPSV ftp command by curl.
803
	This can helpful with some "poor" ftp servers which don't
804 805 806
	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 已提交
807 808 809 810 811
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
812
	porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
P
Petr Baudis 已提交
813

814 815 816 817
i18n.logOutputEncoding::
	Character encoding the commit messages are converted to when
	running `git-log` and friends.

818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
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].

H
Heikki Orsila 已提交
837 838 839 840 841 842
log.date::
	Set default date-time mode for the log command. Setting log.date
	value is similar to using git log's --date option. The value is one of
	following alternatives: {relative,local,default,iso,rfc,short}.
	See linkgit:git-log[1].

843 844 845
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.
846
	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
847 848
	normally hide the root commit will now show it. True by default.

849
man.viewer::
850
	Specify the programs that may be used to display help in the
851 852
	'man' format. See linkgit:git-help[1].

853
include::merge-config.txt[]
J
Junio C Hamano 已提交
854

855 856 857 858 859
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].)

860 861 862 863
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].

864 865 866 867
mergetool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.

868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
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.

887 888 889 890 891 892
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).

893
pack.window::
894
	The size of the window used by linkgit:git-pack-objects[1] when no
895 896
	window size is given on the command line. Defaults to 10.

897
pack.depth::
898
	The maximum delta depth used by linkgit:git-pack-objects[1] when no
899
	maximum depth is given on the command line. Defaults to 50.
900

901
pack.windowMemory::
902
	The window memory size limit used by linkgit:git-pack-objects[1]
903 904 905 906
	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.

907 908 909 910 911
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
912 913 914
	not set,  defaults to -1, the zlib default, which is "a default
	compromise between speed and compression (currently equivalent
	to level 6)."
915

916
pack.deltaCacheSize::
917
	The maximum memory in bytes used for caching deltas in
918
	linkgit:git-pack-objects[1].
919 920
	A value of 0 means no limit. Defaults to 0.

921
pack.deltaCacheLimit::
922
	The maximum size of a delta, that is cached in
923
	linkgit:git-pack-objects[1]. Defaults to 1000.
924

925 926
pack.threads::
	Specifies the number of threads to spawn when searching for best
927
	delta matches.  This requires that linkgit:git-pack-objects[1]
928 929 930 931
	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.
932 933
	Specifying 0 will cause git to auto-detect the number of CPU's
	and set the number of threads accordingly.
934

935 936 937 938 939 940 941 942 943
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
	packs.  Version 2 is selected and this config option ignored
	whenever the corresponding pack is larger than 2 GB.  Otherwise
	the default is 1.

J
Junio C Hamano 已提交
944
pack.packSizeLimit::
945 946 947 948 949
	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].

P
Petr Baudis 已提交
950 951 952 953 954 955 956
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.

957
remote.<name>.url::
958 959
	The URL of a remote repository.  See linkgit:git-fetch[1] or
	linkgit:git-push[1].
960

S
Sam Vilain 已提交
961 962 963 964 965
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.

966
remote.<name>.fetch::
967 968
	The default set of "refspec" for linkgit:git-fetch[1]. See
	linkgit:git-fetch[1].
969 970

remote.<name>.push::
971 972
	The default set of "refspec" for linkgit:git-push[1]. See
	linkgit:git-push[1].
973

974 975 976 977
remote.<name>.mirror::
	If true, pushing to this remote will automatically behave
	as if the `\--mirror` option was given on the command line.

978 979
remote.<name>.skipDefaultUpdate::
	If true, this remote will be skipped by default when updating
980
	using the update subcommand of linkgit:git-remote[1].
981

982
remote.<name>.receivepack::
983
	The default program to execute on the remote side when pushing.  See
984
	option \--receive-pack of linkgit:git-push[1].
985

986 987
remote.<name>.uploadpack::
	The default program to execute on the remote side when fetching.  See
988
	option \--upload-pack of linkgit:git-fetch-pack[1].
989

990
remote.<name>.tagopt::
991 992
	Setting this value to \--no-tags disables automatic tag following when
	fetching from remote <name>
993

994 995
remotes.<group>::
	The list of remotes which are fetched by "git remote update
996
	<group>".  See linkgit:git-remote[1].
997

998
repack.usedeltabaseoffset::
999
	Allow linkgit:git-repack[1] to create packs that uses
1000 1001
	delta-base offset.  Defaults to false.

P
Petr Baudis 已提交
1002
show.difftree::
1003 1004
	The default linkgit:git-diff-tree[1] arguments to be used
	for linkgit:git-show[1].
P
Petr Baudis 已提交
1005 1006

showbranch.default::
1007 1008
	The default set of branches for linkgit:git-show-branch[1].
	See linkgit:git-show-branch[1].
P
Petr Baudis 已提交
1009

1010
status.relativePaths::
1011
	By default, linkgit:git-status[1] shows paths relative to the
1012 1013 1014 1015
	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).

1016
tar.umask::
1017 1018 1019 1020
	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
1021
	linkgit:git-archive[1].
1022

1023 1024 1025 1026 1027 1028 1029 1030
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
1031 1032
	never-before-seen repository on the site.  When more than one
	insteadOf strings match a given URL, the longest match is used.
1033

P
Petr Baudis 已提交
1034 1035
user.email::
	Your email address to be recorded in any newly created commits.
1036
	Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1037
	'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
P
Petr Baudis 已提交
1038 1039 1040

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

1044
user.signingkey::
1045
	If linkgit:git-tag[1] is not selecting the key you want it to
1046 1047 1048 1049 1050
	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.

P
Petr Baudis 已提交
1051
whatchanged.difftree::
1052 1053
	The default linkgit:git-diff-tree[1] arguments to be used
	for linkgit:git-whatchanged[1].
P
Petr Baudis 已提交
1054 1055 1056

imap::
	The configuration variables in the 'imap' section are described
1057
	in linkgit:git-imap-send[1].
1058

1059 1060 1061 1062 1063 1064
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.

1065 1066 1067 1068 1069 1070 1071
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,
1072 1073
	especially on slow filesystems.  If not set, the value of
	`transfer.unpackLimit` is used instead.
1074 1075

receive.denyNonFastForwards::
1076 1077 1078 1079 1080
	If set to true, git-receive-pack will deny a ref update which is
	not a fast forward. Use this to prevent such an update via a push,
	even if that push is forced. This configuration variable is
	set when initializing a shared repository.

1081 1082 1083
transfer.unpackLimit::
	When `fetch.unpackLimit` or `receive.unpackLimit` are
	not set, the value of this variable is used instead.
1084
	The default value is 100.
1085 1086 1087 1088 1089

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.