wt-status: Actually accept `color.status.BLAH' configuration variables.
[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
8fallback values for `.git/config` file.
9
10They can be used by both the git plumbing
b8936cf0 11and the porcelains. The variables are divided into sections, where
1ab661dd
PB
12in the fully qualified variable name the variable itself is the last
13dot-separated segment and the section name is everything before the last
14dot. The variable names are case-insensitive and only alphanumeric
15characters are allowed. Some variables may appear multiple times.
16
e136f33b
JN
17Syntax
18~~~~~~
19
1ab661dd 20The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
21ignored. The '#' and ';' characters begin comments to the end of line,
22blank lines are ignored.
23
24The file consists of sections and variables. A section begins with
25the name of the section in square brackets and continues until the next
26section begins. Section names are not case sensitive. Only alphanumeric
27characters, '`-`' and '`.`' are allowed in section names. Each variable
28must belong to some section, which means that there must be section
29header before first setting of a variable.
30
31Sections can be further divided into subsections. To begin a subsection
32put its name in double quotes, separated by space from the section name,
33in the section header, like in example below:
34
35--------
36 [section "subsection"]
37
38--------
39
191453f6
JN
40Subsection names can contain any characters except newline (doublequote
41'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
e136f33b
JN
42respecitvely) and are case sensitive. Section header cannot span multiple
43lines. Variables may belong directly to a section or to a given subsection.
44You can have `[section]` if you have `[section "subsection"]`, but you
45don't need to.
46
47There is also (case insensitive) alternative `[section.subsection]` syntax.
48In this syntax subsection names follow the same restrictions as for section
49name.
50
51All the other lines are recognized as setting variables, in the form
52'name = value'. If there is no equal sign on the line, the entire line
53is taken as 'name' and the variable is recognized as boolean "true".
54The variable names are case-insensitive and only alphanumeric
55characters and '`-`' are allowed. There can be more than one value
56for a given variable; we say then that variable is multivalued.
57
58Leading and trailing whitespace in a variable value is discarded.
59Internal whitespace within a variable value is retained verbatim.
60
61The values following the equals sign in variable assign are all either
62a string, an integer, or a boolean. Boolean values may be given as yes/no,
630/1 or true/false. Case is not significant in boolean values, when
64converting value to the canonical form using '--bool' type specifier;
65`git-repo-config` will ensure that the output is "true" or "false".
66
67String values may be entirely or partially enclosed in double quotes.
68You need to enclose variable value in double quotes if you want to
69preserve leading or trailing whitespace, or if variable value contains
70beginning of comment characters (if it contains '#' or ';').
71Double quote '`"`' and backslash '`\`' characters in variable value must
72be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
73
74The following escape sequences (beside '`\"`' and '`\\`') are recognized:
75'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
76and '`\b`' for backspace (BS). No other char escape sequence, nor octal
77char sequences are valid.
78
79Variable value ending in a '`\`' is continued on the next line in the
80customary UNIX fashion.
81
82Some variables may require special value format.
1ab661dd
PB
83
84Example
85~~~~~~~
86
87 # Core variables
88 [core]
89 ; Don't trust file modes
90 filemode = false
91
92 # Our diff algorithm
93 [diff]
94 external = "/usr/local/bin/gnu-diff -u"
95 renames = true
96
910c00c8
AK
97 [branch "devel"]
98 remote = origin
99 merge = refs/heads/devel
100
e136f33b
JN
101 # Proxy settings
102 [core]
103 gitProxy="ssh" for "ssh://kernel.org/"
104 gitProxy=default-proxy ; for the rest
910c00c8 105
1ab661dd
PB
106Variables
107~~~~~~~~~
108
109Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
110For command-specific variables, you will find a more detailed description
111in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
112porcelain configuration variables in the respective porcelain documentation.
113
114core.fileMode::
115 If false, the executable bit differences between the index and
116 the working copy are ignored; useful on broken filesystems like FAT.
117 See gitlink:git-update-index[1]. True by default.
118
119core.gitProxy::
120 A "proxy command" to execute (as 'command host port') instead
121 of establishing direct connection to the remote server when
122 using the git protocol for fetching. If the variable value is
123 in the "COMMAND for DOMAIN" format, the command is applied only
124 on hostnames ending with the specified domain string. This variable
125 may be set multiple times and is matched in the given order;
126 the first match wins.
b8936cf0
FD
127+
128Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
129(which always applies universally, without the special "for"
130handling).
1ab661dd
PB
131
132core.ignoreStat::
133 The working copy files are assumed to stay unchanged until you
134 mark them otherwise manually - Git will not detect the file changes
135 by lstat() calls. This is useful on systems where those are very
136 slow, such as Microsoft Windows. See gitlink:git-update-index[1].
137 False by default.
138
9f0bb90d
JH
139core.preferSymlinkRefs::
140 Instead of the default "symref" format for HEAD
141 and other symbolic reference files, use symbolic links.
142 This is sometimes needed to work with old scripts that
143 expect HEAD to be a symbolic link.
1ab661dd 144
6de08ae6 145core.logAllRefUpdates::
4057deb5
JH
146 Updates to a ref <ref> is logged to the file
147 "$GIT_DIR/logs/<ref>", by appending the new and old
148 SHA1, the date/time and the reason of the update, but
149 only when the file exists. If this configuration
150 variable is set to true, missing "$GIT_DIR/logs/<ref>"
151 file is automatically created for branch heads.
a862f97e
JH
152+
153This information can be used to determine what commit
154was the tip of a branch "2 days ago".
155+
156This value is true by default in a repository that has
157a working directory associated with it, and false by
158default in a bare repository.
6de08ae6 159
1ab661dd
PB
160core.repositoryFormatVersion::
161 Internal variable identifying the repository format and layout
162 version.
163
164core.sharedRepository::
d5dc6a76
JF
165 When 'group' (or 'true'), the repository is made shareable between
166 several users in a group (making sure all the files and objects are
167 group-writable). When 'all' (or 'world' or 'everybody'), the
168 repository will be readable by all users, additionally to being
169 group-shareable. When 'umask' (or 'false'), git will use permissions
5c94f87e 170 reported by umask(2). See gitlink:git-init[1]. False by default.
1ab661dd
PB
171
172core.warnAmbiguousRefs::
173 If true, git will warn you if the ref name you passed it is ambiguous
174 and might match multiple refs in the .git/refs/ tree. True by default.
175
3d3e95af 176core.compression::
12f6c308
JBH
177 An integer -1..9, indicating the compression level for objects that
178 are not in a pack file. -1 is the zlib and git default. 0 means no
179 compression, and 1..9 are various speed/size tradeoffs, 9 being
180 slowest.
181
93821bd9
LT
182core.legacyheaders::
183 A boolean which enables the legacy object header format in case
184 you want to interoperate with old clients accessing the object
185 database directly (where the "http://" and "rsync://" protocols
186 count as direct access).
187
60bb8b14
SP
188core.packedGitWindowSize::
189 Number of bytes of a pack file to map into memory in a
190 single mapping operation. Larger window sizes may allow
191 your system to process a smaller number of large pack files
192 more quickly. Smaller window sizes will negatively affect
eb92242f 193 performance due to increased calls to the operating system's
60bb8b14 194 memory manager, but may improve performance when accessing
22bac0ea
SP
195 a large number of large pack files.
196+
197Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
198MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
199be reasonable for all users/operating systems. You probably do
200not need to adjust this value.
eb92242f
SP
201+
202Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 203
77ccc5bb
SP
204core.packedGitLimit::
205 Maximum number of bytes to map simultaneously into memory
206 from pack files. If Git needs to access more than this many
207 bytes at once to complete an operation it will unmap existing
208 regions to reclaim virtual address space within the process.
22bac0ea
SP
209+
210Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
211This should be reasonable for all users/operating systems, except on
212the largest projects. You probably do not need to adjust this value.
eb92242f
SP
213+
214Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 215
4514ad4f
PB
216alias.*::
217 Command aliases for the gitlink:git[1] command wrapper - e.g.
218 after defining "alias.last = cat-file commit HEAD", the invocation
219 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
220 confusion and troubles with script usage, aliases that
221 hide existing git commands are ignored. Arguments are split by
222 spaces, the usual shell quoting and escaping is supported.
223 quote pair and a backslash can be used to quote them.
4514ad4f 224
1ab661dd
PB
225apply.whitespace::
226 Tells `git-apply` how to handle whitespaces, in the same way
227 as the '--whitespace' option. See gitlink:git-apply[1].
228
648ad18f
SB
229branch.<name>.remote::
230 When in branch <name>, it tells `git fetch` which remote to fetch.
62b339a5 231 If this option is not given, `git fetch` defaults to remote "origin".
648ad18f 232
5372806a 233branch.<name>.merge::
62b339a5
JW
234 When in branch <name>, it tells `git fetch` the default refspec to
235 be marked for merging in FETCH_HEAD. The value has exactly to match
236 a remote part of one of the refspecs which are fetched from the remote
237 given by "branch.<name>.remote".
238 The merge information is used by `git pull` (which at first calls
239 `git fetch`) to lookup the default branch for merging. Without
240 this option, `git pull` defaults to merge the first refspec fetched.
241 Specify multiple values to get an octopus merge.
5372806a 242
f3673988
BG
243color.branch::
244 A boolean to enable/disable color in the output of
245 gitlink:git-branch[1]. May be set to `true` (or `always`),
246 `false` (or `never`) or `auto`, in which case colors are used
247 only when the output is to a terminal. Defaults to false.
248
249color.branch.<slot>::
250 Use customized color for branch coloration. `<slot>` is one of
251 `current` (the current branch), `local` (a local branch),
252 `remote` (a tracking branch in refs/remotes/), `plain` (other
253 refs), or `reset` (the normal terminal color). The value for
254 these configuration variables can be one of: `normal`, `bold`,
255 `dim`, `ul`, `blink`, `reverse`, `reset`, `black`, `red`,
256 `green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`.
257
a159ca0c 258color.diff::
b5376648
JH
259 When true (or `always`), always use colors in patch.
260 When false (or `never`), never. When set to `auto`, use
261 colors only when the output is to the terminal.
262
a159ca0c 263color.diff.<slot>::
b5376648
JH
264 Use customized color for diff colorization. `<slot>`
265 specifies which part of the patch to use the specified
266 color, and is one of `plain` (context text), `meta`
267 (metainformation), `frag` (hunk header), `old` (removed
f3673988
BG
268 lines), or `new` (added lines). The values of these
269 variables may be specified as in color.branch.<slot>.
b5376648 270
1d77043b
JH
271color.pager::
272 A boolean to enable/disable colored output when the pager is in
273 use (default is true).
274
275color.status::
276 A boolean to enable/disable color in the output of
277 gitlink:git-status[1]. May be set to `true` (or `always`),
278 `false` (or `never`) or `auto`, in which case colors are used
279 only when the output is to a terminal. Defaults to false.
280
281color.status.<slot>::
282 Use customized color for status colorization. `<slot>` is
283 one of `header` (the header text of the status message),
82dca848
SP
284 `added` or `updated` (files which are added but not committed),
285 `changed` (files which are changed but not added in the index),
1d77043b 286 or `untracked` (files which are not tracked by git). The values of
f3673988 287 these variables may be specified as in color.branch.<slot>.
1d77043b 288
1ab661dd
PB
289diff.renameLimit::
290 The number of files to consider when performing the copy/rename
291 detection; equivalent to the git diff option '-l'.
292
b68ea12e
EW
293diff.renames::
294 Tells git to detect renames. If set to any boolean value, it
295 will enable basic rename detection. If set to "copies" or
296 "copy", it will detect copies, as well.
297
af7cf268
JH
298fetch.unpackLimit::
299 If the number of objects fetched over the git native
300 transfer is below this
301 limit, then the objects will be unpacked into loose object
302 files. However if the number of received objects equals or
303 exceeds this limit then the received pack will be stored as
304 a pack, after adding any missing delta bases. Storing the
305 pack from a push can make the push operation complete faster,
306 especially on slow filesystems.
307
1ab661dd
PB
308format.headers::
309 Additional email headers to include in a patch to be submitted
310 by mail. See gitlink:git-format-patch[1].
311
4aec56d1
JH
312gc.reflogexpire::
313 `git reflog expire` removes reflog entries older than
314 this time; defaults to 90 days.
315
316gc.reflogexpireunreachable::
317 `git reflog expire` removes reflog entries older than
318 this time and are not reachable from the current tip;
319 defaults to 30 days.
320
48c32424
JH
321gc.rerereresolved::
322 Records of conflicted merge you resolved earlier are
323 kept for this many days when `git rerere gc` is run.
324 The default is 60 days. See gitlink:git-rerere[1].
325
326gc.rerereunresolved::
327 Records of conflicted merge you have not resolved are
328 kept for this many days when `git rerere gc` is run.
329 The default is 15 days. See gitlink:git-rerere[1].
330
1ab661dd
PB
331gitcvs.enabled::
332 Whether the cvs pserver interface is enabled for this repository.
333 See gitlink:git-cvsserver[1].
334
335gitcvs.logfile::
336 Path to a log file where the cvs pserver interface well... logs
337 various stuff. See gitlink:git-cvsserver[1].
338
339http.sslVerify::
340 Whether to verify the SSL certificate when fetching or pushing
37425065 341 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
342 variable.
343
344http.sslCert::
345 File containing the SSL certificate when fetching or pushing
37425065 346 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
347 variable.
348
349http.sslKey::
350 File containing the SSL private key when fetching or pushing
abda1ef5 351 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
352 variable.
353
354http.sslCAInfo::
355 File containing the certificates to verify the peer with when
abda1ef5 356 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
357 'GIT_SSL_CAINFO' environment variable.
358
359http.sslCAPath::
360 Path containing files with the CA certificates to verify the peer
37425065 361 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
362 by the 'GIT_SSL_CAPATH' environment variable.
363
364http.maxRequests::
abda1ef5 365 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
366 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
367
368http.lowSpeedLimit, http.lowSpeedTime::
369 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
370 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 371 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
372 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
373
3ea099d4
SK
374http.noEPSV::
375 A boolean which disables using of EPSV ftp command by curl.
376 This can helpful with some "poor" ftp servers which doesn't
377 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
378 environment variable. Default is false (curl will use EPSV).
379
1ab661dd
PB
380i18n.commitEncoding::
381 Character encoding the commit messages are stored in; git itself
382 does not care per se, but this information is necessary e.g. when
383 importing commits from emails or in the gitk graphical history
384 browser (and possibly at other places in the future or in other
385 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
386
d2c11a38
JH
387i18n.logOutputEncoding::
388 Character encoding the commit messages are converted to when
389 running `git-log` and friends.
390
0f03ca94
PB
391log.showroot::
392 If true, the initial commit will be shown as a big creation event.
393 This is equivalent to a diff against an empty tree.
394 Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
395 normally hide the root commit will now show it. True by default.
396
1ab661dd
PB
397merge.summary::
398 Whether to include summaries of merged commits in newly created
399 merge commit messages. False by default.
400
8c3275ab
SP
401merge.verbosity::
402 Controls the amount of output shown by the recursive merge
403 strategy. Level 0 outputs nothing except a final error
404 message if conflicts were detected. Level 1 outputs only
405 conflicts, 2 outputs conflicts and file changes. Level 5 and
406 above outputs debugging information. The default is level 2.
407
4812a93a
JK
408pack.window::
409 The size of the window used by gitlink:git-pack-objects[1] when no
410 window size is given on the command line. Defaults to 10.
411
1ab661dd
PB
412pull.octopus::
413 The default merge strategy to use when pulling multiple branches
414 at once.
415
416pull.twohead::
417 The default merge strategy to use when pulling a single branch.
418
0cc6d346
SB
419remote.<name>.url::
420 The URL of a remote repository. See gitlink:git-fetch[1] or
421 gitlink:git-push[1].
422
423remote.<name>.fetch::
424 The default set of "refspec" for gitlink:git-fetch[1]. See
425 gitlink:git-fetch[1].
426
427remote.<name>.push::
428 The default set of "refspec" for gitlink:git-push[1]. See
429 gitlink:git-push[1].
430
060aafc1 431remote.<name>.receivepack::
5dee29ac 432 The default program to execute on the remote side when pushing. See
060aafc1
UKK
433 option \--exec of gitlink:git-push[1].
434
5dee29ac
UKK
435remote.<name>.uploadpack::
436 The default program to execute on the remote side when fetching. See
437 option \--exec of gitlink:git-fetch-pack[1].
438
b6945f57
JH
439repack.usedeltabaseoffset::
440 Allow gitlink:git-repack[1] to create packs that uses
441 delta-base offset. Defaults to false.
442
1ab661dd
PB
443show.difftree::
444 The default gitlink:git-diff-tree[1] arguments to be used
445 for gitlink:git-show[1].
446
447showbranch.default::
448 The default set of branches for gitlink:git-show-branch[1].
449 See gitlink:git-show-branch[1].
450
ce1a79b6 451tar.umask::
7fe08af4 452 By default, gitlink:git-tar-tree[1] sets file and directories modes
ce1a79b6
WT
453 to 0666 or 0777. While this is both useful and acceptable for projects
454 such as the Linux Kernel, it might be excessive for other projects.
455 With this variable, it becomes possible to tell
7fe08af4 456 gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
ce1a79b6
WT
457 The special value "user" indicates that the user's current umask will
458 be used. This should be enough for most projects, as it will lead to
7fe08af4 459 the same permissions as gitlink:git-checkout[1] would use. The default
ce1a79b6
WT
460 value remains 0, which means world read-write.
461
1ab661dd
PB
462user.email::
463 Your email address to be recorded in any newly created commits.
abda1ef5 464 Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
1ab661dd
PB
465 environment variables. See gitlink:git-commit-tree[1].
466
467user.name::
468 Your full name to be recorded in any newly created commits.
abda1ef5 469 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1ab661dd
PB
470 environment variables. See gitlink:git-commit-tree[1].
471
d67778ec
AP
472user.signingkey::
473 If gitlink:git-tag[1] is not selecting the key you want it to
474 automatically when creating a signed tag, you can override the
475 default selection with this variable. This option is passed
476 unchanged to gpg's --local-user parameter, so you may specify a key
477 using any method that gpg supports.
478
1ab661dd
PB
479whatchanged.difftree::
480 The default gitlink:git-diff-tree[1] arguments to be used
481 for gitlink:git-whatchanged[1].
482
483imap::
484 The configuration variables in the 'imap' section are described
485 in gitlink:git-imap-send[1].
199a9218 486
fc04c412
SP
487receive.unpackLimit::
488 If the number of objects received in a push is below this
489 limit then the objects will be unpacked into loose object
490 files. However if the number of received objects equals or
491 exceeds this limit then the received pack will be stored as
492 a pack, after adding any missing delta bases. Storing the
493 pack from a push can make the push operation complete faster,
494 especially on slow filesystems.
495
496receive.denyNonFastForwards::
199a9218
JS
497 If set to true, git-receive-pack will deny a ref update which is
498 not a fast forward. Use this to prevent such an update via a push,
499 even if that push is forced. This configuration variable is
500 set when initializing a shared repository.
501
e28714c5
JH
502transfer.unpackLimit::
503 When `fetch.unpackLimit` or `receive.unpackLimit` are
504 not set, the value of this variable is used instead.
505
506