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