clean: require -f to do damage by default
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
5ea5621f
JH
5the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
32043c9f
JS
8fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
5ea5621f
JH
10
11They can be used by both the git plumbing
b8936cf0 12and the porcelains. The variables are divided into sections, where
1ab661dd
PB
13in the fully qualified variable name the variable itself is the last
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
e136f33b
JN
18Syntax
19~~~~~~
20
1ab661dd 21The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
22ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must belong to some section, which means that there must be section
30header before first setting of a variable.
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
34in the section header, like in example below:
35
36--------
37 [section "subsection"]
38
39--------
40
191453f6
JN
41Subsection names can contain any characters except newline (doublequote
42'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
3dff5379 43respectively) and are case sensitive. Section header cannot span multiple
e136f33b
JN
44lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
51
52All the other lines are recognized as setting variables, in the form
53'name = value'. If there is no equal sign on the line, the entire line
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
56characters and '`-`' are allowed. There can be more than one value
57for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
640/1 or true/false. Case is not significant in boolean values, when
65converting value to the canonical form using '--bool' type specifier;
e0d10e1c 66`git-config` will ensure that the output is "true" or "false".
e136f33b
JN
67
68String values may be entirely or partially enclosed in double quotes.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
75The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77and '`\b`' for backspace (BS). No other char escape sequence, nor octal
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary UNIX fashion.
82
83Some variables may require special value format.
1ab661dd
PB
84
85Example
86~~~~~~~
87
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
92
93 # Our diff algorithm
94 [diff]
95 external = "/usr/local/bin/gnu-diff -u"
96 renames = true
97
910c00c8
AK
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
101
e136f33b
JN
102 # Proxy settings
103 [core]
29093c28 104 gitProxy="ssh" for "kernel.org"
e136f33b 105 gitProxy=default-proxy ; for the rest
910c00c8 106
1ab661dd
PB
107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116 If false, the executable bit differences between the index and
117 the working copy are ignored; useful on broken filesystems like FAT.
118 See gitlink:git-update-index[1]. True by default.
119
9378c161
JH
120core.quotepath::
121 The commands that output paths (e.g. `ls-files`,
122 `diff`), when not given the `-z` option, will quote
123 "unusual" characters in the pathname by enclosing the
124 pathname in a double-quote pair and with backslashes the
125 same way strings in C source code are quoted. If this
126 variable is set to false, the bytes higher than 0x80 are
127 not quoted but output as verbatim. Note that double
128 quote, backslash and control characters are always
129 quoted without `-z` regardless of the setting of this
130 variable.
131
5cb71f82
FL
132core.autocrlf::
133 If true, makes git convert `CRLF` at the end of lines in text files to
134 `LF` when reading from the filesystem, and convert in reverse when
135 writing to the filesystem. The variable can be set to
136 'input', in which case the conversion happens only while
137 reading from the filesystem but files are written out with
138 `LF` at the end of lines. Currently, which paths to consider
139 "text" (i.e. be subjected to the autocrlf mechanism) is
140 decided purely based on the contents.
141
78a8d641
JS
142core.symlinks::
143 If false, symbolic links are checked out as small plain files that
144 contain the link text. gitlink:git-update-index[1] and
145 gitlink:git-add[1] will not change the recorded type to regular
146 file. Useful on filesystems like FAT that do not support
147 symbolic links. True by default.
148
1ab661dd
PB
149core.gitProxy::
150 A "proxy command" to execute (as 'command host port') instead
151 of establishing direct connection to the remote server when
152 using the git protocol for fetching. If the variable value is
153 in the "COMMAND for DOMAIN" format, the command is applied only
154 on hostnames ending with the specified domain string. This variable
155 may be set multiple times and is matched in the given order;
156 the first match wins.
b8936cf0
FD
157+
158Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
159(which always applies universally, without the special "for"
160handling).
1ab661dd
PB
161
162core.ignoreStat::
163 The working copy files are assumed to stay unchanged until you
164 mark them otherwise manually - Git will not detect the file changes
165 by lstat() calls. This is useful on systems where those are very
166 slow, such as Microsoft Windows. See gitlink:git-update-index[1].
167 False by default.
168
9f0bb90d
JH
169core.preferSymlinkRefs::
170 Instead of the default "symref" format for HEAD
171 and other symbolic reference files, use symbolic links.
172 This is sometimes needed to work with old scripts that
173 expect HEAD to be a symbolic link.
1ab661dd 174
e4a15f40
SP
175core.bare::
176 If true this repository is assumed to be 'bare' and has no
177 working directory associated with it. If this is the case a
178 number of commands that require a working directory will be
179 disabled, such as gitlink:git-add[1] or gitlink:git-merge[1].
180+
181This setting is automatically guessed by gitlink:git-clone[1] or
182gitlink:git-init[1] when the repository was created. By default a
183repository that ends in "/.git" is assumed to be not bare (bare =
184false), while all other repositories are assumed to be bare (bare
185= true).
186
892c41b9
ML
187core.worktree::
188 Set the path to the working tree. The value will not be
189 used in combination with repositories found automatically in
190 a .git directory (i.e. $GIT_DIR is not set).
191 This can be overriden by the GIT_WORK_TREE environment
192 variable and the '--work-tree' command line option.
193
6de08ae6 194core.logAllRefUpdates::
14cd5607 195 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
196 "$GIT_DIR/logs/<ref>", by appending the new and old
197 SHA1, the date/time and the reason of the update, but
198 only when the file exists. If this configuration
199 variable is set to true, missing "$GIT_DIR/logs/<ref>"
200 file is automatically created for branch heads.
a862f97e
JH
201+
202This information can be used to determine what commit
203was the tip of a branch "2 days ago".
204+
205This value is true by default in a repository that has
206a working directory associated with it, and false by
207default in a bare repository.
6de08ae6 208
1ab661dd
PB
209core.repositoryFormatVersion::
210 Internal variable identifying the repository format and layout
211 version.
212
213core.sharedRepository::
d5dc6a76
JF
214 When 'group' (or 'true'), the repository is made shareable between
215 several users in a group (making sure all the files and objects are
216 group-writable). When 'all' (or 'world' or 'everybody'), the
217 repository will be readable by all users, additionally to being
218 group-shareable. When 'umask' (or 'false'), git will use permissions
5c94f87e 219 reported by umask(2). See gitlink:git-init[1]. False by default.
1ab661dd
PB
220
221core.warnAmbiguousRefs::
222 If true, git will warn you if the ref name you passed it is ambiguous
223 and might match multiple refs in the .git/refs/ tree. True by default.
224
3d3e95af 225core.compression::
960ccca6
DH
226 An integer -1..9, indicating a default compression level.
227 -1 is the zlib default. 0 means no compression,
228 and 1..9 are various speed/size tradeoffs, 9 being slowest.
229
230core.loosecompression::
12f6c308 231 An integer -1..9, indicating the compression level for objects that
960ccca6 232 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 233 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6
DH
234 slowest. If not set, defaults to core.compression. If that is
235 not set, defaults to 0 (best speed).
12f6c308 236
60bb8b14
SP
237core.packedGitWindowSize::
238 Number of bytes of a pack file to map into memory in a
239 single mapping operation. Larger window sizes may allow
240 your system to process a smaller number of large pack files
241 more quickly. Smaller window sizes will negatively affect
eb92242f 242 performance due to increased calls to the operating system's
60bb8b14 243 memory manager, but may improve performance when accessing
22bac0ea
SP
244 a large number of large pack files.
245+
246Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
247MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
248be reasonable for all users/operating systems. You probably do
249not need to adjust this value.
eb92242f
SP
250+
251Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 252
77ccc5bb
SP
253core.packedGitLimit::
254 Maximum number of bytes to map simultaneously into memory
255 from pack files. If Git needs to access more than this many
256 bytes at once to complete an operation it will unmap existing
257 regions to reclaim virtual address space within the process.
22bac0ea
SP
258+
259Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
260This should be reasonable for all users/operating systems, except on
261the largest projects. You probably do not need to adjust this value.
eb92242f
SP
262+
263Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 264
18bdec11
SP
265core.deltaBaseCacheLimit::
266 Maximum number of bytes to reserve for caching base objects
267 that multiple deltafied objects reference. By storing the
268 entire decompressed base objects in a cache Git is able
269 to avoid unpacking and decompressing frequently used base
270 objects multiple times.
271+
272Default is 16 MiB on all platforms. This should be reasonable
273for all users/operating systems, except on the largest projects.
274You probably do not need to adjust this value.
275+
276Common unit suffixes of 'k', 'm', or 'g' are supported.
277
e8964a5b 278core.excludesfile::
0ba956d3
JS
279 In addition to '.gitignore' (per-directory) and
280 '.git/info/exclude', git looks into this file for patterns
cedb8d5d
JT
281 of files which are not meant to be tracked. See
282 gitlink:gitignore[5].
0ba956d3 283
ef0c2abf
AR
284core.editor::
285 Commands such as `commit` and `tag` that lets you edit
02783075 286 messages by launching an editor uses the value of this
ef0c2abf
AR
287 variable when it is set, and the environment variable
288 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
289 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
290 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 291
54adf370
BG
292core.pager::
293 The command that git will use to paginate output. Can be overridden
294 with the `GIT_PAGER` environment variable.
295
4514ad4f
PB
296alias.*::
297 Command aliases for the gitlink:git[1] command wrapper - e.g.
298 after defining "alias.last = cat-file commit HEAD", the invocation
299 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
300 confusion and troubles with script usage, aliases that
301 hide existing git commands are ignored. Arguments are split by
302 spaces, the usual shell quoting and escaping is supported.
303 quote pair and a backslash can be used to quote them.
f368f5a6
JH
304+
305If the alias expansion is prefixed with an exclamation point,
306it will be treated as a shell command. For example, defining
307"alias.new = !gitk --all --not ORIG_HEAD", the invocation
308"git new" is equivalent to running the shell command
309"gitk --all --not ORIG_HEAD".
dfd42a3c 310
1ab661dd
PB
311apply.whitespace::
312 Tells `git-apply` how to handle whitespaces, in the same way
313 as the '--whitespace' option. See gitlink:git-apply[1].
314
9902387d 315branch.autosetupmerge::
5fdcf75c 316 Tells `git-branch` and `git-checkout` to setup new branches
9902387d
PB
317 so that gitlink:git-pull[1] will appropriately merge from that
318 remote branch. Note that even if this option is not set,
319 this behavior can be chosen per-branch using the `--track`
6f084a56 320 and `--no-track` options. This option defaults to false.
9902387d 321
648ad18f
SB
322branch.<name>.remote::
323 When in branch <name>, it tells `git fetch` which remote to fetch.
62b339a5 324 If this option is not given, `git fetch` defaults to remote "origin".
648ad18f 325
5372806a 326branch.<name>.merge::
62b339a5
JW
327 When in branch <name>, it tells `git fetch` the default refspec to
328 be marked for merging in FETCH_HEAD. The value has exactly to match
329 a remote part of one of the refspecs which are fetched from the remote
330 given by "branch.<name>.remote".
331 The merge information is used by `git pull` (which at first calls
332 `git fetch`) to lookup the default branch for merging. Without
333 this option, `git pull` defaults to merge the first refspec fetched.
334 Specify multiple values to get an octopus merge.
9debc324
PB
335 If you wish to setup `git pull` so that it merges into <name> from
336 another branch in the local repository, you can point
337 branch.<name>.merge to the desired branch, and use the special setting
338 `.` (a period) for branch.<name>.remote.
5372806a 339
2122591b 340clean.requireForce::
562ca192
JH
341 A boolean to make git-clean do nothing unless given -f
342 or -n. Defaults to true.
2122591b 343
f3673988
BG
344color.branch::
345 A boolean to enable/disable color in the output of
346 gitlink:git-branch[1]. May be set to `true` (or `always`),
347 `false` (or `never`) or `auto`, in which case colors are used
348 only when the output is to a terminal. Defaults to false.
349
350color.branch.<slot>::
351 Use customized color for branch coloration. `<slot>` is one of
352 `current` (the current branch), `local` (a local branch),
353 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
354 refs).
355+
356The value for these configuration variables is a list of colors (at most
357two) and attributes (at most one), separated by spaces. The colors
358accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
359`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
360`blink` and `reverse`. The first color given is the foreground; the
361second is the background. The position of the attribute, if any,
362doesn't matter.
f3673988 363
a159ca0c 364color.diff::
b5376648
JH
365 When true (or `always`), always use colors in patch.
366 When false (or `never`), never. When set to `auto`, use
367 colors only when the output is to the terminal.
368
a159ca0c 369color.diff.<slot>::
4f193f20
MW
370 Use customized color for diff colorization. `<slot>` specifies
371 which part of the patch to use the specified color, and is one
372 of `plain` (context text), `meta` (metainformation), `frag`
373 (hunk header), `old` (removed lines), `new` (added lines),
374 `commit` (commit headers), or `whitespace` (highlighting dubious
375 whitespace). The values of these variables may be specified as
376 in color.branch.<slot>.
b5376648 377
1d77043b
JH
378color.pager::
379 A boolean to enable/disable colored output when the pager is in
380 use (default is true).
381
382color.status::
383 A boolean to enable/disable color in the output of
384 gitlink:git-status[1]. May be set to `true` (or `always`),
385 `false` (or `never`) or `auto`, in which case colors are used
386 only when the output is to a terminal. Defaults to false.
387
388color.status.<slot>::
389 Use customized color for status colorization. `<slot>` is
390 one of `header` (the header text of the status message),
82dca848
SP
391 `added` or `updated` (files which are added but not committed),
392 `changed` (files which are changed but not added in the index),
1d77043b 393 or `untracked` (files which are not tracked by git). The values of
f3673988 394 these variables may be specified as in color.branch.<slot>.
1d77043b 395
383e45ce
BG
396commit.template::
397 Specify a file to use as the template for new commit messages.
398
aecbf914
JH
399diff.autorefreshindex::
400 When using `git diff` to compare with work tree
401 files, do not consider stat-only change as changed.
402 Instead, silently run `git update-index --refresh` to
403 update the cached stat information for paths whose
404 contents in the work tree match the contents in the
405 index. This option defaults to true. Note that this
406 affects only `git diff` Porcelain, and not lower level
407 `diff` commands, such as `git diff-files`.
408
1ab661dd
PB
409diff.renameLimit::
410 The number of files to consider when performing the copy/rename
411 detection; equivalent to the git diff option '-l'.
412
b68ea12e
EW
413diff.renames::
414 Tells git to detect renames. If set to any boolean value, it
415 will enable basic rename detection. If set to "copies" or
416 "copy", it will detect copies, as well.
417
af7cf268
JH
418fetch.unpackLimit::
419 If the number of objects fetched over the git native
420 transfer is below this
421 limit, then the objects will be unpacked into loose object
422 files. However if the number of received objects equals or
423 exceeds this limit then the received pack will be stored as
424 a pack, after adding any missing delta bases. Storing the
425 pack from a push can make the push operation complete faster,
426 especially on slow filesystems.
427
1ab661dd
PB
428format.headers::
429 Additional email headers to include in a patch to be submitted
430 by mail. See gitlink:git-format-patch[1].
431
78cb59c8
JS
432format.suffix::
433 The default for format-patch is to output files with the suffix
434 `.patch`. Use this variable to change that suffix (make sure to
435 include the dot if you want it).
1ab661dd 436
0d7566a5
TT
437gc.aggressiveWindow::
438 The window size parameter used in the delta compression
439 algorithm used by 'git gc --aggressive'. This defaults
440 to 10.
441
c2120e5e
JS
442gc.packrefs::
443 `git gc` does not run `git pack-refs` in a bare repository by
444 default so that older dumb-transport clients can still fetch
445 from the repository. Setting this to `true` lets `git
446 gc` to run `git pack-refs`. Setting this to `false` tells
447 `git gc` never to run `git pack-refs`. The default setting is
448 `notbare`. Enable it only when you know you do not have to
449 support such clients. The default setting will change to `true`
450 at some stage, and setting this to `false` will continue to
451 prevent `git pack-refs` from being run from `git gc`.
452
4aec56d1
JH
453gc.reflogexpire::
454 `git reflog expire` removes reflog entries older than
455 this time; defaults to 90 days.
456
457gc.reflogexpireunreachable::
458 `git reflog expire` removes reflog entries older than
459 this time and are not reachable from the current tip;
460 defaults to 30 days.
461
48c32424
JH
462gc.rerereresolved::
463 Records of conflicted merge you resolved earlier are
464 kept for this many days when `git rerere gc` is run.
465 The default is 60 days. See gitlink:git-rerere[1].
466
467gc.rerereunresolved::
468 Records of conflicted merge you have not resolved are
469 kept for this many days when `git rerere gc` is run.
470 The default is 15 days. See gitlink:git-rerere[1].
471
b4372ef1
JS
472rerere.enabled::
473 Activate recording of resolved conflicts, so that identical
474 conflict hunks can be resolved automatically, should they
475 be encountered again. See gitlink:git-rerere[1].
476
1ab661dd 477gitcvs.enabled::
db218723 478 Whether the CVS server interface is enabled for this repository.
1ab661dd
PB
479 See gitlink:git-cvsserver[1].
480
481gitcvs.logfile::
db218723 482 Path to a log file where the CVS server interface well... logs
1ab661dd
PB
483 various stuff. See gitlink:git-cvsserver[1].
484
eabb0bfd
FL
485gitcvs.allbinary::
486 If true, all files are sent to the client in mode '-kb'. This
487 causes the client to treat all files as binary files which suppresses
488 any newline munging it otherwise might do. A work-around for the
489 fact that there is no way yet to set single files to mode '-kb'.
abbf5947 490
04752868
FL
491gitcvs.dbname::
492 Database used by git-cvsserver to cache revision information
493 derived from the git repository. The exact meaning depends on the
494 used database driver, for SQLite (which is the default driver) this
495 is a filename. Supports variable substitution (see
496 gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`).
497 Default: '%Ggitcvs.%m.sqlite'
498
499gitcvs.dbdriver::
500 Used Perl DBI driver. You can specify any available driver
501 for this here, but it might not work. git-cvsserver is tested
502 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
503 reported *not* to work with 'DBD::mysql'. Experimental feature.
504 May not contain double colons (`:`). Default: 'SQLite'.
eabb0bfd
FL
505 See gitlink:git-cvsserver[1].
506
04752868
FL
507gitcvs.dbuser, gitcvs.dbpass::
508 Database user and password. Only useful if setting 'gitcvs.dbdriver',
509 since SQLite has no concept of database users and/or passwords.
510 'gitcvs.dbuser' supports variable substitution (see
511 gitlink:git-cvsserver[1] for details).
512
02783075
BH
513All gitcvs variables except for 'gitcvs.allbinary' can also be
514specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
515is one of "ext" and "pserver") to make them apply only for the given
516access method.
04752868 517
1ab661dd
PB
518http.sslVerify::
519 Whether to verify the SSL certificate when fetching or pushing
37425065 520 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
521 variable.
522
523http.sslCert::
524 File containing the SSL certificate when fetching or pushing
37425065 525 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
526 variable.
527
528http.sslKey::
529 File containing the SSL private key when fetching or pushing
abda1ef5 530 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
531 variable.
532
533http.sslCAInfo::
534 File containing the certificates to verify the peer with when
abda1ef5 535 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
536 'GIT_SSL_CAINFO' environment variable.
537
538http.sslCAPath::
539 Path containing files with the CA certificates to verify the peer
37425065 540 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
541 by the 'GIT_SSL_CAPATH' environment variable.
542
543http.maxRequests::
abda1ef5 544 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
545 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
546
547http.lowSpeedLimit, http.lowSpeedTime::
548 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
549 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 550 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
551 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
552
3ea099d4
SK
553http.noEPSV::
554 A boolean which disables using of EPSV ftp command by curl.
befc9c42 555 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
556 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
557 environment variable. Default is false (curl will use EPSV).
558
1ab661dd
PB
559i18n.commitEncoding::
560 Character encoding the commit messages are stored in; git itself
561 does not care per se, but this information is necessary e.g. when
562 importing commits from emails or in the gitk graphical history
563 browser (and possibly at other places in the future or in other
564 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
565
d2c11a38
JH
566i18n.logOutputEncoding::
567 Character encoding the commit messages are converted to when
568 running `git-log` and friends.
569
0f03ca94
PB
570log.showroot::
571 If true, the initial commit will be shown as a big creation event.
572 This is equivalent to a diff against an empty tree.
573 Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
574 normally hide the root commit will now show it. True by default.
575
1ab661dd
PB
576merge.summary::
577 Whether to include summaries of merged commits in newly created
578 merge commit messages. False by default.
579
c4b4a5af
TT
580merge.tool::
581 Controls which merge resolution program is used by
6ea9c7eb 582 gitlink:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff",
730b5b45 583 "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
c4b4a5af 584
8c3275ab
SP
585merge.verbosity::
586 Controls the amount of output shown by the recursive merge
587 strategy. Level 0 outputs nothing except a final error
588 message if conflicts were detected. Level 1 outputs only
589 conflicts, 2 outputs conflicts and file changes. Level 5 and
590 above outputs debugging information. The default is level 2.
dbddb714 591 Can be overriden by 'GIT_MERGE_VERBOSITY' environment variable.
8c3275ab 592
88e7fdf2
JH
593merge.<driver>.name::
594 Defines a human readable name for a custom low-level
595 merge driver. See gitlink:gitattributes[5] for details.
596
597merge.<driver>.driver::
598 Defines the command that implements a custom low-level
599 merge driver. See gitlink:gitattributes[5] for details.
600
601merge.<driver>.recursive::
602 Names a low-level merge driver to be used when
603 performing an internal merge between common ancestors.
604 See gitlink:gitattributes[5] for details.
605
4812a93a
JK
606pack.window::
607 The size of the window used by gitlink:git-pack-objects[1] when no
608 window size is given on the command line. Defaults to 10.
609
842aaf93
TT
610pack.depth::
611 The maximum delta depth used by gitlink:git-pack-objects[1] when no
618e613a 612 maximum depth is given on the command line. Defaults to 50.
842aaf93 613
e93b15cd
BD
614pack.windowMemory::
615 The window memory size limit used by gitlink:git-pack-objects[1]
616 when no limit is given on the command line. The value can be
617 suffixed with "k", "m", or "g". Defaults to 0, meaning no
618 limit.
619
960ccca6
DH
620pack.compression::
621 An integer -1..9, indicating the compression level for objects
622 in a pack file. -1 is the zlib default. 0 means no
623 compression, and 1..9 are various speed/size tradeoffs, 9 being
624 slowest. If not set, defaults to core.compression. If that is
625 not set, defaults to -1.
626
074b2eea 627pack.deltaCacheSize::
02783075 628 The maximum memory in bytes used for caching deltas in
074b2eea
MK
629 gitlink:git-pack-objects[1].
630 A value of 0 means no limit. Defaults to 0.
631
e3dfddb3
MK
632pack.deltaCacheLimit::
633 The maxium size of a delta, that is cached in
634 gitlink:git-pack-objects[1]. Defaults to 1000.
635
1ab661dd
PB
636pull.octopus::
637 The default merge strategy to use when pulling multiple branches
638 at once.
639
640pull.twohead::
641 The default merge strategy to use when pulling a single branch.
642
0cc6d346
SB
643remote.<name>.url::
644 The URL of a remote repository. See gitlink:git-fetch[1] or
645 gitlink:git-push[1].
646
647remote.<name>.fetch::
648 The default set of "refspec" for gitlink:git-fetch[1]. See
649 gitlink:git-fetch[1].
650
651remote.<name>.push::
652 The default set of "refspec" for gitlink:git-push[1]. See
653 gitlink:git-push[1].
654
1918278e
TT
655remote.<name>.skipDefaultUpdate::
656 If true, this remote will be skipped by default when updating
657 using the remote subcommand of gitlink:git-remote[1].
658
060aafc1 659remote.<name>.receivepack::
5dee29ac 660 The default program to execute on the remote side when pushing. See
060aafc1
UKK
661 option \--exec of gitlink:git-push[1].
662
5dee29ac
UKK
663remote.<name>.uploadpack::
664 The default program to execute on the remote side when fetching. See
665 option \--exec of gitlink:git-fetch-pack[1].
666
047f636d
AK
667remote.<name>.tagopt::
668 Setting this value to --no-tags disables automatic tag following when fetching
669 from remote <name>
670
1918278e
TT
671remotes.<group>::
672 The list of remotes which are fetched by "git remote update
673 <group>". See gitlink:git-remote[1].
674
b6945f57
JH
675repack.usedeltabaseoffset::
676 Allow gitlink:git-repack[1] to create packs that uses
677 delta-base offset. Defaults to false.
678
1ab661dd
PB
679show.difftree::
680 The default gitlink:git-diff-tree[1] arguments to be used
681 for gitlink:git-show[1].
682
683showbranch.default::
684 The default set of branches for gitlink:git-show-branch[1].
685 See gitlink:git-show-branch[1].
686
ce1a79b6 687tar.umask::
687157c7
RS
688 This variable can be used to restrict the permission bits of
689 tar archive entries. The default is 0002, which turns off the
690 world write bit. The special value "user" indicates that the
691 archiving user's umask will be used instead. See umask(2) and
692 gitlink:git-archive[1].
ce1a79b6 693
1ab661dd
PB
694user.email::
695 Your email address to be recorded in any newly created commits.
28a94f88
JT
696 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
697 'EMAIL' environment variables. See gitlink:git-commit-tree[1].
1ab661dd
PB
698
699user.name::
700 Your full name to be recorded in any newly created commits.
abda1ef5 701 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1ab661dd
PB
702 environment variables. See gitlink:git-commit-tree[1].
703
d67778ec
AP
704user.signingkey::
705 If gitlink:git-tag[1] is not selecting the key you want it to
706 automatically when creating a signed tag, you can override the
707 default selection with this variable. This option is passed
708 unchanged to gpg's --local-user parameter, so you may specify a key
709 using any method that gpg supports.
710
1ab661dd
PB
711whatchanged.difftree::
712 The default gitlink:git-diff-tree[1] arguments to be used
713 for gitlink:git-whatchanged[1].
714
715imap::
716 The configuration variables in the 'imap' section are described
717 in gitlink:git-imap-send[1].
199a9218 718
fc04c412
SP
719receive.unpackLimit::
720 If the number of objects received in a push is below this
721 limit then the objects will be unpacked into loose object
722 files. However if the number of received objects equals or
723 exceeds this limit then the received pack will be stored as
724 a pack, after adding any missing delta bases. Storing the
725 pack from a push can make the push operation complete faster,
726 especially on slow filesystems.
727
728receive.denyNonFastForwards::
199a9218
JS
729 If set to true, git-receive-pack will deny a ref update which is
730 not a fast forward. Use this to prevent such an update via a push,
731 even if that push is forced. This configuration variable is
732 set when initializing a shared repository.
733
e28714c5
JH
734transfer.unpackLimit::
735 When `fetch.unpackLimit` or `receive.unpackLimit` are
736 not set, the value of this variable is used instead.