Add core.quotepath configuration variable.
[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]
104 gitProxy="ssh" for "ssh://kernel.org/"
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
6de08ae6 187core.logAllRefUpdates::
4057deb5
JH
188 Updates to a ref <ref> is logged to the file
189 "$GIT_DIR/logs/<ref>", by appending the new and old
190 SHA1, the date/time and the reason of the update, but
191 only when the file exists. If this configuration
192 variable is set to true, missing "$GIT_DIR/logs/<ref>"
193 file is automatically created for branch heads.
a862f97e
JH
194+
195This information can be used to determine what commit
196was the tip of a branch "2 days ago".
197+
198This value is true by default in a repository that has
199a working directory associated with it, and false by
200default in a bare repository.
6de08ae6 201
1ab661dd
PB
202core.repositoryFormatVersion::
203 Internal variable identifying the repository format and layout
204 version.
205
206core.sharedRepository::
d5dc6a76
JF
207 When 'group' (or 'true'), the repository is made shareable between
208 several users in a group (making sure all the files and objects are
209 group-writable). When 'all' (or 'world' or 'everybody'), the
210 repository will be readable by all users, additionally to being
211 group-shareable. When 'umask' (or 'false'), git will use permissions
5c94f87e 212 reported by umask(2). See gitlink:git-init[1]. False by default.
1ab661dd
PB
213
214core.warnAmbiguousRefs::
215 If true, git will warn you if the ref name you passed it is ambiguous
216 and might match multiple refs in the .git/refs/ tree. True by default.
217
3d3e95af 218core.compression::
960ccca6
DH
219 An integer -1..9, indicating a default compression level.
220 -1 is the zlib default. 0 means no compression,
221 and 1..9 are various speed/size tradeoffs, 9 being slowest.
222
223core.loosecompression::
12f6c308 224 An integer -1..9, indicating the compression level for objects that
960ccca6 225 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 226 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6
DH
227 slowest. If not set, defaults to core.compression. If that is
228 not set, defaults to 0 (best speed).
12f6c308 229
60bb8b14
SP
230core.packedGitWindowSize::
231 Number of bytes of a pack file to map into memory in a
232 single mapping operation. Larger window sizes may allow
233 your system to process a smaller number of large pack files
234 more quickly. Smaller window sizes will negatively affect
eb92242f 235 performance due to increased calls to the operating system's
60bb8b14 236 memory manager, but may improve performance when accessing
22bac0ea
SP
237 a large number of large pack files.
238+
239Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
240MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
241be reasonable for all users/operating systems. You probably do
242not need to adjust this value.
eb92242f
SP
243+
244Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 245
77ccc5bb
SP
246core.packedGitLimit::
247 Maximum number of bytes to map simultaneously into memory
248 from pack files. If Git needs to access more than this many
249 bytes at once to complete an operation it will unmap existing
250 regions to reclaim virtual address space within the process.
22bac0ea
SP
251+
252Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
253This should be reasonable for all users/operating systems, except on
254the largest projects. You probably do not need to adjust this value.
eb92242f
SP
255+
256Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 257
18bdec11
SP
258core.deltaBaseCacheLimit::
259 Maximum number of bytes to reserve for caching base objects
260 that multiple deltafied objects reference. By storing the
261 entire decompressed base objects in a cache Git is able
262 to avoid unpacking and decompressing frequently used base
263 objects multiple times.
264+
265Default is 16 MiB on all platforms. This should be reasonable
266for all users/operating systems, except on the largest projects.
267You probably do not need to adjust this value.
268+
269Common unit suffixes of 'k', 'm', or 'g' are supported.
270
0ba956d3
JS
271core.excludeFile::
272 In addition to '.gitignore' (per-directory) and
273 '.git/info/exclude', git looks into this file for patterns
cedb8d5d
JT
274 of files which are not meant to be tracked. See
275 gitlink:gitignore[5].
0ba956d3 276
4514ad4f
PB
277alias.*::
278 Command aliases for the gitlink:git[1] command wrapper - e.g.
279 after defining "alias.last = cat-file commit HEAD", the invocation
280 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
281 confusion and troubles with script usage, aliases that
282 hide existing git commands are ignored. Arguments are split by
283 spaces, the usual shell quoting and escaping is supported.
284 quote pair and a backslash can be used to quote them.
4514ad4f 285
dfd42a3c
TT
286 If the alias expansion is prefixed with an exclamation point,
287 it will be treated as a shell command. For example, defining
288 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
289 "git new" is equivalent to running the shell command
290 "gitk --all --not ORIG_HEAD".
291
1ab661dd
PB
292apply.whitespace::
293 Tells `git-apply` how to handle whitespaces, in the same way
294 as the '--whitespace' option. See gitlink:git-apply[1].
295
9902387d 296branch.autosetupmerge::
5fdcf75c 297 Tells `git-branch` and `git-checkout` to setup new branches
9902387d
PB
298 so that gitlink:git-pull[1] will appropriately merge from that
299 remote branch. Note that even if this option is not set,
300 this behavior can be chosen per-branch using the `--track`
301 and `--no-track` options. This option defaults to false.
302
648ad18f
SB
303branch.<name>.remote::
304 When in branch <name>, it tells `git fetch` which remote to fetch.
62b339a5 305 If this option is not given, `git fetch` defaults to remote "origin".
648ad18f 306
5372806a 307branch.<name>.merge::
62b339a5
JW
308 When in branch <name>, it tells `git fetch` the default refspec to
309 be marked for merging in FETCH_HEAD. The value has exactly to match
310 a remote part of one of the refspecs which are fetched from the remote
311 given by "branch.<name>.remote".
312 The merge information is used by `git pull` (which at first calls
313 `git fetch`) to lookup the default branch for merging. Without
314 this option, `git pull` defaults to merge the first refspec fetched.
315 Specify multiple values to get an octopus merge.
9debc324
PB
316 If you wish to setup `git pull` so that it merges into <name> from
317 another branch in the local repository, you can point
318 branch.<name>.merge to the desired branch, and use the special setting
319 `.` (a period) for branch.<name>.remote.
5372806a 320
2122591b
JT
321clean.requireForce::
322 A boolean to make git-clean do nothing unless given -f or -n. Defaults
323 to false.
324
f3673988
BG
325color.branch::
326 A boolean to enable/disable color in the output of
327 gitlink:git-branch[1]. May be set to `true` (or `always`),
328 `false` (or `never`) or `auto`, in which case colors are used
329 only when the output is to a terminal. Defaults to false.
330
331color.branch.<slot>::
332 Use customized color for branch coloration. `<slot>` is one of
333 `current` (the current branch), `local` (a local branch),
334 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
335 refs).
336+
337The value for these configuration variables is a list of colors (at most
338two) and attributes (at most one), separated by spaces. The colors
339accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
340`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
341`blink` and `reverse`. The first color given is the foreground; the
342second is the background. The position of the attribute, if any,
343doesn't matter.
f3673988 344
a159ca0c 345color.diff::
b5376648
JH
346 When true (or `always`), always use colors in patch.
347 When false (or `never`), never. When set to `auto`, use
348 colors only when the output is to the terminal.
349
a159ca0c 350color.diff.<slot>::
4f193f20
MW
351 Use customized color for diff colorization. `<slot>` specifies
352 which part of the patch to use the specified color, and is one
353 of `plain` (context text), `meta` (metainformation), `frag`
354 (hunk header), `old` (removed lines), `new` (added lines),
355 `commit` (commit headers), or `whitespace` (highlighting dubious
356 whitespace). The values of these variables may be specified as
357 in color.branch.<slot>.
b5376648 358
1d77043b
JH
359color.pager::
360 A boolean to enable/disable colored output when the pager is in
361 use (default is true).
362
363color.status::
364 A boolean to enable/disable color in the output of
365 gitlink:git-status[1]. May be set to `true` (or `always`),
366 `false` (or `never`) or `auto`, in which case colors are used
367 only when the output is to a terminal. Defaults to false.
368
369color.status.<slot>::
370 Use customized color for status colorization. `<slot>` is
371 one of `header` (the header text of the status message),
82dca848
SP
372 `added` or `updated` (files which are added but not committed),
373 `changed` (files which are changed but not added in the index),
1d77043b 374 or `untracked` (files which are not tracked by git). The values of
f3673988 375 these variables may be specified as in color.branch.<slot>.
1d77043b 376
1ab661dd
PB
377diff.renameLimit::
378 The number of files to consider when performing the copy/rename
379 detection; equivalent to the git diff option '-l'.
380
b68ea12e
EW
381diff.renames::
382 Tells git to detect renames. If set to any boolean value, it
383 will enable basic rename detection. If set to "copies" or
384 "copy", it will detect copies, as well.
385
af7cf268
JH
386fetch.unpackLimit::
387 If the number of objects fetched over the git native
388 transfer is below this
389 limit, then the objects will be unpacked into loose object
390 files. However if the number of received objects equals or
391 exceeds this limit then the received pack will be stored as
392 a pack, after adding any missing delta bases. Storing the
393 pack from a push can make the push operation complete faster,
394 especially on slow filesystems.
395
1ab661dd
PB
396format.headers::
397 Additional email headers to include in a patch to be submitted
398 by mail. See gitlink:git-format-patch[1].
399
78cb59c8
JS
400format.suffix::
401 The default for format-patch is to output files with the suffix
402 `.patch`. Use this variable to change that suffix (make sure to
403 include the dot if you want it).
1ab661dd 404
0d7566a5
TT
405gc.aggressiveWindow::
406 The window size parameter used in the delta compression
407 algorithm used by 'git gc --aggressive'. This defaults
408 to 10.
409
c2120e5e
JS
410gc.packrefs::
411 `git gc` does not run `git pack-refs` in a bare repository by
412 default so that older dumb-transport clients can still fetch
413 from the repository. Setting this to `true` lets `git
414 gc` to run `git pack-refs`. Setting this to `false` tells
415 `git gc` never to run `git pack-refs`. The default setting is
416 `notbare`. Enable it only when you know you do not have to
417 support such clients. The default setting will change to `true`
418 at some stage, and setting this to `false` will continue to
419 prevent `git pack-refs` from being run from `git gc`.
420
4aec56d1
JH
421gc.reflogexpire::
422 `git reflog expire` removes reflog entries older than
423 this time; defaults to 90 days.
424
425gc.reflogexpireunreachable::
426 `git reflog expire` removes reflog entries older than
427 this time and are not reachable from the current tip;
428 defaults to 30 days.
429
48c32424
JH
430gc.rerereresolved::
431 Records of conflicted merge you resolved earlier are
432 kept for this many days when `git rerere gc` is run.
433 The default is 60 days. See gitlink:git-rerere[1].
434
435gc.rerereunresolved::
436 Records of conflicted merge you have not resolved are
437 kept for this many days when `git rerere gc` is run.
438 The default is 15 days. See gitlink:git-rerere[1].
439
1ab661dd 440gitcvs.enabled::
5007af8c 441 Whether the cvs server interface is enabled for this repository.
1ab661dd
PB
442 See gitlink:git-cvsserver[1].
443
444gitcvs.logfile::
5007af8c 445 Path to a log file where the cvs server interface well... logs
1ab661dd
PB
446 various stuff. See gitlink:git-cvsserver[1].
447
eabb0bfd
FL
448gitcvs.allbinary::
449 If true, all files are sent to the client in mode '-kb'. This
450 causes the client to treat all files as binary files which suppresses
451 any newline munging it otherwise might do. A work-around for the
452 fact that there is no way yet to set single files to mode '-kb'.
abbf5947 453
04752868
FL
454gitcvs.dbname::
455 Database used by git-cvsserver to cache revision information
456 derived from the git repository. The exact meaning depends on the
457 used database driver, for SQLite (which is the default driver) this
458 is a filename. Supports variable substitution (see
459 gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`).
460 Default: '%Ggitcvs.%m.sqlite'
461
462gitcvs.dbdriver::
463 Used Perl DBI driver. You can specify any available driver
464 for this here, but it might not work. git-cvsserver is tested
465 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
466 reported *not* to work with 'DBD::mysql'. Experimental feature.
467 May not contain double colons (`:`). Default: 'SQLite'.
eabb0bfd
FL
468 See gitlink:git-cvsserver[1].
469
04752868
FL
470gitcvs.dbuser, gitcvs.dbpass::
471 Database user and password. Only useful if setting 'gitcvs.dbdriver',
472 since SQLite has no concept of database users and/or passwords.
473 'gitcvs.dbuser' supports variable substitution (see
474 gitlink:git-cvsserver[1] for details).
475
476All gitcvs variables except for 'gitcvs.allbinary' can also specifed
477as 'gitcvs.<access_method>.<varname>' (where 'access_method' is one
478of "ext" and "pserver") to make them apply only for the given access
479method.
480
1ab661dd
PB
481http.sslVerify::
482 Whether to verify the SSL certificate when fetching or pushing
37425065 483 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
484 variable.
485
486http.sslCert::
487 File containing the SSL certificate when fetching or pushing
37425065 488 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
489 variable.
490
491http.sslKey::
492 File containing the SSL private key when fetching or pushing
abda1ef5 493 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
494 variable.
495
496http.sslCAInfo::
497 File containing the certificates to verify the peer with when
abda1ef5 498 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
499 'GIT_SSL_CAINFO' environment variable.
500
501http.sslCAPath::
502 Path containing files with the CA certificates to verify the peer
37425065 503 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
504 by the 'GIT_SSL_CAPATH' environment variable.
505
506http.maxRequests::
abda1ef5 507 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
508 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
509
510http.lowSpeedLimit, http.lowSpeedTime::
511 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
512 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 513 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
514 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
515
3ea099d4
SK
516http.noEPSV::
517 A boolean which disables using of EPSV ftp command by curl.
befc9c42 518 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
519 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
520 environment variable. Default is false (curl will use EPSV).
521
1ab661dd
PB
522i18n.commitEncoding::
523 Character encoding the commit messages are stored in; git itself
524 does not care per se, but this information is necessary e.g. when
525 importing commits from emails or in the gitk graphical history
526 browser (and possibly at other places in the future or in other
527 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
528
d2c11a38
JH
529i18n.logOutputEncoding::
530 Character encoding the commit messages are converted to when
531 running `git-log` and friends.
532
0f03ca94
PB
533log.showroot::
534 If true, the initial commit will be shown as a big creation event.
535 This is equivalent to a diff against an empty tree.
536 Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
537 normally hide the root commit will now show it. True by default.
538
1ab661dd
PB
539merge.summary::
540 Whether to include summaries of merged commits in newly created
541 merge commit messages. False by default.
542
c4b4a5af
TT
543merge.tool::
544 Controls which merge resolution program is used by
545 gitlink:git-mergetool[l]. Valid values are: "kdiff3", "tkdiff",
730b5b45 546 "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
c4b4a5af 547
8c3275ab
SP
548merge.verbosity::
549 Controls the amount of output shown by the recursive merge
550 strategy. Level 0 outputs nothing except a final error
551 message if conflicts were detected. Level 1 outputs only
552 conflicts, 2 outputs conflicts and file changes. Level 5 and
553 above outputs debugging information. The default is level 2.
554
88e7fdf2
JH
555merge.<driver>.name::
556 Defines a human readable name for a custom low-level
557 merge driver. See gitlink:gitattributes[5] for details.
558
559merge.<driver>.driver::
560 Defines the command that implements a custom low-level
561 merge driver. See gitlink:gitattributes[5] for details.
562
563merge.<driver>.recursive::
564 Names a low-level merge driver to be used when
565 performing an internal merge between common ancestors.
566 See gitlink:gitattributes[5] for details.
567
4812a93a
JK
568pack.window::
569 The size of the window used by gitlink:git-pack-objects[1] when no
570 window size is given on the command line. Defaults to 10.
571
842aaf93
TT
572pack.depth::
573 The maximum delta depth used by gitlink:git-pack-objects[1] when no
618e613a 574 maximum depth is given on the command line. Defaults to 50.
842aaf93 575
960ccca6
DH
576pack.compression::
577 An integer -1..9, indicating the compression level for objects
578 in a pack file. -1 is the zlib default. 0 means no
579 compression, and 1..9 are various speed/size tradeoffs, 9 being
580 slowest. If not set, defaults to core.compression. If that is
581 not set, defaults to -1.
582
074b2eea
MK
583pack.deltaCacheSize::
584 The maxium memory in bytes used for caching deltas in
585 gitlink:git-pack-objects[1].
586 A value of 0 means no limit. Defaults to 0.
587
e3dfddb3
MK
588pack.deltaCacheLimit::
589 The maxium size of a delta, that is cached in
590 gitlink:git-pack-objects[1]. Defaults to 1000.
591
1ab661dd
PB
592pull.octopus::
593 The default merge strategy to use when pulling multiple branches
594 at once.
595
596pull.twohead::
597 The default merge strategy to use when pulling a single branch.
598
0cc6d346
SB
599remote.<name>.url::
600 The URL of a remote repository. See gitlink:git-fetch[1] or
601 gitlink:git-push[1].
602
603remote.<name>.fetch::
604 The default set of "refspec" for gitlink:git-fetch[1]. See
605 gitlink:git-fetch[1].
606
607remote.<name>.push::
608 The default set of "refspec" for gitlink:git-push[1]. See
609 gitlink:git-push[1].
610
1918278e
TT
611remote.<name>.skipDefaultUpdate::
612 If true, this remote will be skipped by default when updating
613 using the remote subcommand of gitlink:git-remote[1].
614
060aafc1 615remote.<name>.receivepack::
5dee29ac 616 The default program to execute on the remote side when pushing. See
060aafc1
UKK
617 option \--exec of gitlink:git-push[1].
618
5dee29ac
UKK
619remote.<name>.uploadpack::
620 The default program to execute on the remote side when fetching. See
621 option \--exec of gitlink:git-fetch-pack[1].
622
047f636d
AK
623remote.<name>.tagopt::
624 Setting this value to --no-tags disables automatic tag following when fetching
625 from remote <name>
626
1918278e
TT
627remotes.<group>::
628 The list of remotes which are fetched by "git remote update
629 <group>". See gitlink:git-remote[1].
630
b6945f57
JH
631repack.usedeltabaseoffset::
632 Allow gitlink:git-repack[1] to create packs that uses
633 delta-base offset. Defaults to false.
634
1ab661dd
PB
635show.difftree::
636 The default gitlink:git-diff-tree[1] arguments to be used
637 for gitlink:git-show[1].
638
639showbranch.default::
640 The default set of branches for gitlink:git-show-branch[1].
641 See gitlink:git-show-branch[1].
642
ce1a79b6 643tar.umask::
7fe08af4 644 By default, gitlink:git-tar-tree[1] sets file and directories modes
ce1a79b6
WT
645 to 0666 or 0777. While this is both useful and acceptable for projects
646 such as the Linux Kernel, it might be excessive for other projects.
647 With this variable, it becomes possible to tell
7fe08af4 648 gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
ce1a79b6
WT
649 The special value "user" indicates that the user's current umask will
650 be used. This should be enough for most projects, as it will lead to
7fe08af4 651 the same permissions as gitlink:git-checkout[1] would use. The default
ce1a79b6
WT
652 value remains 0, which means world read-write.
653
1ab661dd
PB
654user.email::
655 Your email address to be recorded in any newly created commits.
28a94f88
JT
656 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
657 'EMAIL' environment variables. See gitlink:git-commit-tree[1].
1ab661dd
PB
658
659user.name::
660 Your full name to be recorded in any newly created commits.
abda1ef5 661 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1ab661dd
PB
662 environment variables. See gitlink:git-commit-tree[1].
663
d67778ec
AP
664user.signingkey::
665 If gitlink:git-tag[1] is not selecting the key you want it to
666 automatically when creating a signed tag, you can override the
667 default selection with this variable. This option is passed
668 unchanged to gpg's --local-user parameter, so you may specify a key
669 using any method that gpg supports.
670
1ab661dd
PB
671whatchanged.difftree::
672 The default gitlink:git-diff-tree[1] arguments to be used
673 for gitlink:git-whatchanged[1].
674
675imap::
676 The configuration variables in the 'imap' section are described
677 in gitlink:git-imap-send[1].
199a9218 678
fc04c412
SP
679receive.unpackLimit::
680 If the number of objects received in a push is below this
681 limit then the objects will be unpacked into loose object
682 files. However if the number of received objects equals or
683 exceeds this limit then the received pack will be stored as
684 a pack, after adding any missing delta bases. Storing the
685 pack from a push can make the push operation complete faster,
686 especially on slow filesystems.
687
688receive.denyNonFastForwards::
199a9218
JS
689 If set to true, git-receive-pack will deny a ref update which is
690 not a fast forward. Use this to prevent such an update via a push,
691 even if that push is forced. This configuration variable is
692 set when initializing a shared repository.
693
e28714c5
JH
694transfer.unpackLimit::
695 When `fetch.unpackLimit` or `receive.unpackLimit` are
696 not set, the value of this variable is used instead.