da2cb3f9f45899b780785b18512a5af4c3fbf263
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/diff-wrapper
96 renames = true
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
102 # Proxy settings
103 [core]
104 gitProxy="ssh" for "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 linkgit:git-update-index[1]. True by default.
120 core.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.
132 core.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.
142 core.safecrlf::
143 If true, makes git check if converting `CRLF` as controlled by
144 `core.autocrlf` is reversible. Git will verify if a command
145 modifies a file in the work tree either directly or indirectly.
146 For example, committing a file followed by checking out the
147 same file should yield the original file in the work tree. If
148 this is not the case for the current setting of
149 `core.autocrlf`, git will reject the file. The variable can
150 be set to "warn", in which case git will only warn about an
151 irreversible conversion but continue the operation.
152 +
153 CRLF conversion bears a slight chance of corrupting data.
154 autocrlf=true will convert CRLF to LF during commit and LF to
155 CRLF during checkout. A file that contains a mixture of LF and
156 CRLF before the commit cannot be recreated by git. For text
157 files this is the right thing to do: it corrects line endings
158 such that we have only LF line endings in the repository.
159 But for binary files that are accidentally classified as text the
160 conversion can corrupt data.
161 +
162 If you recognize such corruption early you can easily fix it by
163 setting the conversion type explicitly in .gitattributes. Right
164 after committing you still have the original file in your work
165 tree and this file is not yet corrupted. You can explicitly tell
166 git that this file is binary and git will handle the file
167 appropriately.
168 +
169 Unfortunately, the desired effect of cleaning up text files with
170 mixed line endings and the undesired effect of corrupting binary
171 files cannot be distinguished. In both cases CRLFs are removed
172 in an irreversible way. For text files this is the right thing
173 to do because CRLFs are line endings, while for binary files
174 converting CRLFs corrupts data.
175 +
176 Note, this safety check does not mean that a checkout will generate a
177 file identical to the original file for a different setting of
178 `core.autocrlf`, but only for the current one. For example, a text
179 file with `LF` would be accepted with `core.autocrlf=input` and could
180 later be checked out with `core.autocrlf=true`, in which case the
181 resulting file would contain `CRLF`, although the original file
182 contained `LF`. However, in both work trees the line endings would be
183 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
184 file with mixed line endings would be reported by the `core.safecrlf`
185 mechanism.
187 core.symlinks::
188 If false, symbolic links are checked out as small plain files that
189 contain the link text. linkgit:git-update-index[1] and
190 linkgit:git-add[1] will not change the recorded type to regular
191 file. Useful on filesystems like FAT that do not support
192 symbolic links. True by default.
194 core.gitProxy::
195 A "proxy command" to execute (as 'command host port') instead
196 of establishing direct connection to the remote server when
197 using the git protocol for fetching. If the variable value is
198 in the "COMMAND for DOMAIN" format, the command is applied only
199 on hostnames ending with the specified domain string. This variable
200 may be set multiple times and is matched in the given order;
201 the first match wins.
202 +
203 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
204 (which always applies universally, without the special "for"
205 handling).
207 core.ignoreStat::
208 If true, commands which modify both the working tree and the index
209 will mark the updated paths with the "assume unchanged" bit in the
210 index. These marked files are then assumed to stay unchanged in the
211 working copy, until you mark them otherwise manually - Git will not
212 detect the file changes by lstat() calls. This is useful on systems
213 where those are very slow, such as Microsoft Windows.
214 See linkgit:git-update-index[1].
215 False by default.
217 core.preferSymlinkRefs::
218 Instead of the default "symref" format for HEAD
219 and other symbolic reference files, use symbolic links.
220 This is sometimes needed to work with old scripts that
221 expect HEAD to be a symbolic link.
223 core.bare::
224 If true this repository is assumed to be 'bare' and has no
225 working directory associated with it. If this is the case a
226 number of commands that require a working directory will be
227 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
228 +
229 This setting is automatically guessed by linkgit:git-clone[1] or
230 linkgit:git-init[1] when the repository was created. By default a
231 repository that ends in "/.git" is assumed to be not bare (bare =
232 false), while all other repositories are assumed to be bare (bare
233 = true).
235 core.worktree::
236 Set the path to the working tree. The value will not be
237 used in combination with repositories found automatically in
238 a .git directory (i.e. $GIT_DIR is not set).
239 This can be overridden by the GIT_WORK_TREE environment
240 variable and the '--work-tree' command line option. It can be
241 a absolute path or relative path to the directory specified by
242 --git-dir or GIT_DIR.
243 Note: If --git-dir or GIT_DIR are specified but none of
244 --work-tree, GIT_WORK_TREE and core.worktree is specified,
245 the current working directory is regarded as the top directory
246 of your working tree.
248 core.logAllRefUpdates::
249 Enable the reflog. Updates to a ref <ref> is logged to the file
250 "$GIT_DIR/logs/<ref>", by appending the new and old
251 SHA1, the date/time and the reason of the update, but
252 only when the file exists. If this configuration
253 variable is set to true, missing "$GIT_DIR/logs/<ref>"
254 file is automatically created for branch heads.
255 +
256 This information can be used to determine what commit
257 was the tip of a branch "2 days ago".
258 +
259 This value is true by default in a repository that has
260 a working directory associated with it, and false by
261 default in a bare repository.
263 core.repositoryFormatVersion::
264 Internal variable identifying the repository format and layout
265 version.
267 core.sharedRepository::
268 When 'group' (or 'true'), the repository is made shareable between
269 several users in a group (making sure all the files and objects are
270 group-writable). When 'all' (or 'world' or 'everybody'), the
271 repository will be readable by all users, additionally to being
272 group-shareable. When 'umask' (or 'false'), git will use permissions
273 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
274 files in the repository will have this mode value. '0xxx' will override
275 user's umask value, and thus, users with a safe umask (0077) can use
276 this option. Examples: '0660' is equivalent to 'group'. '0640' is a
277 repository that is group-readable but not group-writable.
278 See linkgit:git-init[1]. False by default.
280 core.warnAmbiguousRefs::
281 If true, git will warn you if the ref name you passed it is ambiguous
282 and might match multiple refs in the .git/refs/ tree. True by default.
284 core.compression::
285 An integer -1..9, indicating a default compression level.
286 -1 is the zlib default. 0 means no compression,
287 and 1..9 are various speed/size tradeoffs, 9 being slowest.
288 If set, this provides a default to other compression variables,
289 such as 'core.loosecompression' and 'pack.compression'.
291 core.loosecompression::
292 An integer -1..9, indicating the compression level for objects that
293 are not in a pack file. -1 is the zlib default. 0 means no
294 compression, and 1..9 are various speed/size tradeoffs, 9 being
295 slowest. If not set, defaults to core.compression. If that is
296 not set, defaults to 1 (best speed).
298 core.packedGitWindowSize::
299 Number of bytes of a pack file to map into memory in a
300 single mapping operation. Larger window sizes may allow
301 your system to process a smaller number of large pack files
302 more quickly. Smaller window sizes will negatively affect
303 performance due to increased calls to the operating system's
304 memory manager, but may improve performance when accessing
305 a large number of large pack files.
306 +
307 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
308 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
309 be reasonable for all users/operating systems. You probably do
310 not need to adjust this value.
311 +
312 Common unit suffixes of 'k', 'm', or 'g' are supported.
314 core.packedGitLimit::
315 Maximum number of bytes to map simultaneously into memory
316 from pack files. If Git needs to access more than this many
317 bytes at once to complete an operation it will unmap existing
318 regions to reclaim virtual address space within the process.
319 +
320 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
321 This should be reasonable for all users/operating systems, except on
322 the largest projects. You probably do not need to adjust this value.
323 +
324 Common unit suffixes of 'k', 'm', or 'g' are supported.
326 core.deltaBaseCacheLimit::
327 Maximum number of bytes to reserve for caching base objects
328 that multiple deltafied objects reference. By storing the
329 entire decompressed base objects in a cache Git is able
330 to avoid unpacking and decompressing frequently used base
331 objects multiple times.
332 +
333 Default is 16 MiB on all platforms. This should be reasonable
334 for all users/operating systems, except on the largest projects.
335 You probably do not need to adjust this value.
336 +
337 Common unit suffixes of 'k', 'm', or 'g' are supported.
339 core.excludesfile::
340 In addition to '.gitignore' (per-directory) and
341 '.git/info/exclude', git looks into this file for patterns
342 of files which are not meant to be tracked. See
343 linkgit:gitignore[5].
345 core.editor::
346 Commands such as `commit` and `tag` that lets you edit
347 messages by launching an editor uses the value of this
348 variable when it is set, and the environment variable
349 `GIT_EDITOR` is not set. The order of preference is
350 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
351 `EDITOR` environment variables and then finally `vi`.
353 core.pager::
354 The command that git will use to paginate output. Can be overridden
355 with the `GIT_PAGER` environment variable.
357 core.whitespace::
358 A comma separated list of common whitespace problems to
359 notice. `git diff` will use `color.diff.whitespace` to
360 highlight them, and `git apply --whitespace=error` will
361 consider them as errors:
362 +
363 * `trailing-space` treats trailing whitespaces at the end of the line
364 as an error (enabled by default).
365 * `space-before-tab` treats a space character that appears immediately
366 before a tab character in the initial indent part of the line as an
367 error (enabled by default).
368 * `indent-with-non-tab` treats a line that is indented with 8 or more
369 space characters as an error (not enabled by default).
370 * `cr-at-eol` treats a carriage-return at the end of line as
371 part of the line terminator, i.e. with it, `trailing-space`
372 does not trigger if the character before such a carriage-return
373 is not a whitespace (not enabled by default).
375 core.fsyncobjectfiles::
376 This boolean will enable 'fsync()' when writing object files.
377 +
378 This is a total waste of time and effort on a filesystem that orders
379 data writes properly, but can be useful for filesystems that do not use
380 journalling (traditional UNIX filesystems) or that only journal metadata
381 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
383 alias.*::
384 Command aliases for the linkgit:git[1] command wrapper - e.g.
385 after defining "alias.last = cat-file commit HEAD", the invocation
386 "git last" is equivalent to "git cat-file commit HEAD". To avoid
387 confusion and troubles with script usage, aliases that
388 hide existing git commands are ignored. Arguments are split by
389 spaces, the usual shell quoting and escaping is supported.
390 quote pair and a backslash can be used to quote them.
391 +
392 If the alias expansion is prefixed with an exclamation point,
393 it will be treated as a shell command. For example, defining
394 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
395 "git new" is equivalent to running the shell command
396 "gitk --all --not ORIG_HEAD".
398 apply.whitespace::
399 Tells `git-apply` how to handle whitespaces, in the same way
400 as the '--whitespace' option. See linkgit:git-apply[1].
402 branch.autosetupmerge::
403 Tells `git-branch` and `git-checkout` to setup new branches
404 so that linkgit:git-pull[1] will appropriately merge from the
405 starting point branch. Note that even if this option is not set,
406 this behavior can be chosen per-branch using the `--track`
407 and `--no-track` options. The valid settings are: `false` -- no
408 automatic setup is done; `true` -- automatic setup is done when the
409 starting point is a remote branch; `always` -- automatic setup is
410 done when the starting point is either a local branch or remote
411 branch. This option defaults to true.
413 branch.autosetuprebase::
414 When a new branch is created with `git-branch` or `git-checkout`
415 that tracks another branch, this variable tells git to set
416 up pull to rebase instead of merge (see "branch.<name>.rebase").
417 When `never`, rebase is never automatically set to true.
418 When `local`, rebase is set to true for tracked branches of
419 other local branches.
420 When `remote`, rebase is set to true for tracked branches of
421 remote branches.
422 When `always`, rebase will be set to true for all tracking
423 branches.
424 See "branch.autosetupmerge" for details on how to set up a
425 branch to track another branch.
426 This option defaults to never.
428 branch.<name>.remote::
429 When in branch <name>, it tells `git fetch` which remote to fetch.
430 If this option is not given, `git fetch` defaults to remote "origin".
432 branch.<name>.merge::
433 When in branch <name>, it tells `git fetch` the default
434 refspec to be marked for merging in FETCH_HEAD. The value is
435 handled like the remote part of a refspec, and must match a
436 ref which is fetched from the remote given by
437 "branch.<name>.remote".
438 The merge information is used by `git pull` (which at first calls
439 `git fetch`) to lookup the default branch for merging. Without
440 this option, `git pull` defaults to merge the first refspec fetched.
441 Specify multiple values to get an octopus merge.
442 If you wish to setup `git pull` so that it merges into <name> from
443 another branch in the local repository, you can point
444 branch.<name>.merge to the desired branch, and use the special setting
445 `.` (a period) for branch.<name>.remote.
447 branch.<name>.mergeoptions::
448 Sets default options for merging into branch <name>. The syntax and
449 supported options are equal to that of linkgit:git-merge[1], but
450 option values containing whitespace characters are currently not
451 supported.
453 branch.<name>.rebase::
454 When true, rebase the branch <name> on top of the fetched branch,
455 instead of merging the default branch from the default remote when
456 "git pull" is run.
457 *NOTE*: this is a possibly dangerous operation; do *not* use
458 it unless you understand the implications (see linkgit:git-rebase[1]
459 for details).
461 browser.<tool>.cmd::
462 Specify the command to invoke the specified browser. The
463 specified command is evaluated in shell with the URLs passed
464 as arguments. (See linkgit:git-web--browse[1].)
466 browser.<tool>.path::
467 Override the path for the given tool that may be used to
468 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
469 working repository in gitweb (see linkgit:git-instaweb[1]).
471 clean.requireForce::
472 A boolean to make git-clean do nothing unless given -f
473 or -n. Defaults to true.
475 color.branch::
476 A boolean to enable/disable color in the output of
477 linkgit:git-branch[1]. May be set to `always`,
478 `false` (or `never`) or `auto` (or `true`), in which case colors are used
479 only when the output is to a terminal. Defaults to false.
481 color.branch.<slot>::
482 Use customized color for branch coloration. `<slot>` is one of
483 `current` (the current branch), `local` (a local branch),
484 `remote` (a tracking branch in refs/remotes/), `plain` (other
485 refs).
486 +
487 The value for these configuration variables is a list of colors (at most
488 two) and attributes (at most one), separated by spaces. The colors
489 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
490 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
491 `blink` and `reverse`. The first color given is the foreground; the
492 second is the background. The position of the attribute, if any,
493 doesn't matter.
495 color.diff::
496 When set to `always`, always use colors in patch.
497 When false (or `never`), never. When set to `true` or `auto`, use
498 colors only when the output is to the terminal. Defaults to false.
500 color.diff.<slot>::
501 Use customized color for diff colorization. `<slot>` specifies
502 which part of the patch to use the specified color, and is one
503 of `plain` (context text), `meta` (metainformation), `frag`
504 (hunk header), `old` (removed lines), `new` (added lines),
505 `commit` (commit headers), or `whitespace` (highlighting
506 whitespace errors). The values of these variables may be specified as
507 in color.branch.<slot>.
509 color.interactive::
510 When set to `always`, always use colors for interactive prompts
511 and displays (such as those used by "git add --interactive").
512 When false (or `never`), never. When set to `true` or `auto`, use
513 colors only when the output is to the terminal. Defaults to false.
515 color.interactive.<slot>::
516 Use customized color for `git add --interactive`
517 output. `<slot>` may be `prompt`, `header`, or `help`, for
518 three distinct types of normal output from interactive
519 programs. The values of these variables may be specified as
520 in color.branch.<slot>.
522 color.pager::
523 A boolean to enable/disable colored output when the pager is in
524 use (default is true).
526 color.status::
527 A boolean to enable/disable color in the output of
528 linkgit:git-status[1]. May be set to `always`,
529 `false` (or `never`) or `auto` (or `true`), in which case colors are used
530 only when the output is to a terminal. Defaults to false.
532 color.status.<slot>::
533 Use customized color for status colorization. `<slot>` is
534 one of `header` (the header text of the status message),
535 `added` or `updated` (files which are added but not committed),
536 `changed` (files which are changed but not added in the index),
537 `untracked` (files which are not tracked by git), or
538 `nobranch` (the color the 'no branch' warning is shown in, defaulting
539 to red). The values of these variables may be specified as in
540 color.branch.<slot>.
542 commit.template::
543 Specify a file to use as the template for new commit messages.
545 color.ui::
546 When set to `always`, always use colors in all git commands which
547 are capable of colored output. When false (or `never`), never. When
548 set to `true` or `auto`, use colors only when the output is to the
549 terminal. When more specific variables of color.* are set, they always
550 take precedence over this setting. Defaults to false.
552 diff.autorefreshindex::
553 When using `git diff` to compare with work tree
554 files, do not consider stat-only change as changed.
555 Instead, silently run `git update-index --refresh` to
556 update the cached stat information for paths whose
557 contents in the work tree match the contents in the
558 index. This option defaults to true. Note that this
559 affects only `git diff` Porcelain, and not lower level
560 `diff` commands, such as `git diff-files`.
562 diff.external::
563 If this config variable is set, diff generation is not
564 performed using the internal diff machinery, but using the
565 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
566 environment variable. The command is called with parameters
567 as described under "git Diffs" in linkgit:git[1]. Note: if
568 you want to use an external diff program only on a subset of
569 your files, you might want to use linkgit:gitattributes[5] instead.
571 diff.renameLimit::
572 The number of files to consider when performing the copy/rename
573 detection; equivalent to the git diff option '-l'.
575 diff.renames::
576 Tells git to detect renames. If set to any boolean value, it
577 will enable basic rename detection. If set to "copies" or
578 "copy", it will detect copies, as well.
580 fetch.unpackLimit::
581 If the number of objects fetched over the git native
582 transfer is below this
583 limit, then the objects will be unpacked into loose object
584 files. However if the number of received objects equals or
585 exceeds this limit then the received pack will be stored as
586 a pack, after adding any missing delta bases. Storing the
587 pack from a push can make the push operation complete faster,
588 especially on slow filesystems. If not set, the value of
589 `transfer.unpackLimit` is used instead.
591 format.numbered::
592 A boolean which can enable sequence numbers in patch subjects.
593 Setting this option to "auto" will enable it only if there is
594 more than one patch. See --numbered option in
595 linkgit:git-format-patch[1].
597 format.headers::
598 Additional email headers to include in a patch to be submitted
599 by mail. See linkgit:git-format-patch[1].
601 format.suffix::
602 The default for format-patch is to output files with the suffix
603 `.patch`. Use this variable to change that suffix (make sure to
604 include the dot if you want it).
606 format.pretty::
607 The default pretty format for log/show/whatchanged command,
608 See linkgit:git-log[1], linkgit:git-show[1],
609 linkgit:git-whatchanged[1].
611 gc.aggressiveWindow::
612 The window size parameter used in the delta compression
613 algorithm used by 'git gc --aggressive'. This defaults
614 to 10.
616 gc.auto::
617 When there are approximately more than this many loose
618 objects in the repository, `git gc --auto` will pack them.
619 Some Porcelain commands use this command to perform a
620 light-weight garbage collection from time to time. The
621 default value is 6700. Setting this to 0 disables it.
623 gc.autopacklimit::
624 When there are more than this many packs that are not
625 marked with `*.keep` file in the repository, `git gc
626 --auto` consolidates them into one larger pack. The
627 default value is 50. Setting this to 0 disables it.
629 gc.packrefs::
630 `git gc` does not run `git pack-refs` in a bare repository by
631 default so that older dumb-transport clients can still fetch
632 from the repository. Setting this to `true` lets `git
633 gc` to run `git pack-refs`. Setting this to `false` tells
634 `git gc` never to run `git pack-refs`. The default setting is
635 `notbare`. Enable it only when you know you do not have to
636 support such clients. The default setting will change to `true`
637 at some stage, and setting this to `false` will continue to
638 prevent `git pack-refs` from being run from `git gc`.
640 gc.pruneexpire::
641 When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
642 Override the grace period with this config variable.
644 gc.reflogexpire::
645 `git reflog expire` removes reflog entries older than
646 this time; defaults to 90 days.
648 gc.reflogexpireunreachable::
649 `git reflog expire` removes reflog entries older than
650 this time and are not reachable from the current tip;
651 defaults to 30 days.
653 gc.rerereresolved::
654 Records of conflicted merge you resolved earlier are
655 kept for this many days when `git rerere gc` is run.
656 The default is 60 days. See linkgit:git-rerere[1].
658 gc.rerereunresolved::
659 Records of conflicted merge you have not resolved are
660 kept for this many days when `git rerere gc` is run.
661 The default is 15 days. See linkgit:git-rerere[1].
663 rerere.enabled::
664 Activate recording of resolved conflicts, so that identical
665 conflict hunks can be resolved automatically, should they
666 be encountered again. linkgit:git-rerere[1] command is by
667 default enabled if you create `rr-cache` directory under
668 `$GIT_DIR`, but can be disabled by setting this option to false.
670 gitcvs.enabled::
671 Whether the CVS server interface is enabled for this repository.
672 See linkgit:git-cvsserver[1].
674 gitcvs.logfile::
675 Path to a log file where the CVS server interface well... logs
676 various stuff. See linkgit:git-cvsserver[1].
678 gitcvs.usecrlfattr
679 If true, the server will look up the `crlf` attribute for
680 files to determine the '-k' modes to use. If `crlf` is set,
681 the '-k' mode will be left blank, so cvs clients will
682 treat it as text. If `crlf` is explicitly unset, the file
683 will be set with '-kb' mode, which supresses any newline munging
684 the client might otherwise do. If `crlf` is not specified,
685 then 'gitcvs.allbinary' is used. See linkgit:gitattribute[5].
687 gitcvs.allbinary::
688 This is used if 'gitcvs.usecrlfattr' does not resolve
689 the correct '-kb' mode to use. If true, all
690 unresolved files are sent to the client in
691 mode '-kb'. This causes the client to treat them
692 as binary files, which suppresses any newline munging it
693 otherwise might do. Alternatively, if it is set to "guess",
694 then the contents of the file are examined to decide if
695 it is binary, similar to 'core.autocrlf'.
697 gitcvs.dbname::
698 Database used by git-cvsserver to cache revision information
699 derived from the git repository. The exact meaning depends on the
700 used database driver, for SQLite (which is the default driver) this
701 is a filename. Supports variable substitution (see
702 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
703 Default: '%Ggitcvs.%m.sqlite'
705 gitcvs.dbdriver::
706 Used Perl DBI driver. You can specify any available driver
707 for this here, but it might not work. git-cvsserver is tested
708 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
709 reported *not* to work with 'DBD::mysql'. Experimental feature.
710 May not contain double colons (`:`). Default: 'SQLite'.
711 See linkgit:git-cvsserver[1].
713 gitcvs.dbuser, gitcvs.dbpass::
714 Database user and password. Only useful if setting 'gitcvs.dbdriver',
715 since SQLite has no concept of database users and/or passwords.
716 'gitcvs.dbuser' supports variable substitution (see
717 linkgit:git-cvsserver[1] for details).
719 gitcvs.dbTableNamePrefix::
720 Database table name prefix. Prepended to the names of any
721 database tables used, allowing a single database to be used
722 for several repositories. Supports variable substitution (see
723 linkgit:git-cvsserver[1] for details). Any non-alphabetic
724 characters will be replaced with underscores.
726 All gitcvs variables except for 'gitcvs.usecrlfattr' and
727 'gitcvs.allbinary' can also be specified as
728 'gitcvs.<access_method>.<varname>' (where 'access_method'
729 is one of "ext" and "pserver") to make them apply only for the given
730 access method.
732 gui.commitmsgwidth::
733 Defines how wide the commit message window is in the
734 linkgit:git-gui[1]. "75" is the default.
736 gui.diffcontext::
737 Specifies how many context lines should be used in calls to diff
738 made by the linkgit:git-gui[1]. The default is "5".
740 gui.matchtrackingbranch::
741 Determines if new branches created with linkgit:git-gui[1] should
742 default to tracking remote branches with matching names or
743 not. Default: "false".
745 gui.newbranchtemplate::
746 Is used as suggested name when creating new branches using the
747 linkgit:git-gui[1].
749 gui.pruneduringfetch::
750 "true" if linkgit:git-gui[1] should prune tracking branches when
751 performing a fetch. The default value is "false".
753 gui.trustmtime::
754 Determines if linkgit:git-gui[1] should trust the file modification
755 timestamp or not. By default the timestamps are not trusted.
757 gui.spellingdictionary::
758 Specifies the dictionary used for spell checking commit messages in
759 the linkgit:git-gui[1]. When set to "none" spell checking is turned
760 off.
762 help.browser::
763 Specify the browser that will be used to display help in the
764 'web' format. See linkgit:git-help[1].
766 help.format::
767 Override the default help format used by linkgit:git-help[1].
768 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
769 the default. 'web' and 'html' are the same.
771 http.proxy::
772 Override the HTTP proxy, normally configured using the 'http_proxy'
773 environment variable (see linkgit:curl[1]). This can be overridden
774 on a per-remote basis; see remote.<name>.proxy
776 http.sslVerify::
777 Whether to verify the SSL certificate when fetching or pushing
778 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
779 variable.
781 http.sslCert::
782 File containing the SSL certificate when fetching or pushing
783 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
784 variable.
786 http.sslKey::
787 File containing the SSL private key when fetching or pushing
788 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
789 variable.
791 http.sslCAInfo::
792 File containing the certificates to verify the peer with when
793 fetching or pushing over HTTPS. Can be overridden by the
794 'GIT_SSL_CAINFO' environment variable.
796 http.sslCAPath::
797 Path containing files with the CA certificates to verify the peer
798 with when fetching or pushing over HTTPS. Can be overridden
799 by the 'GIT_SSL_CAPATH' environment variable.
801 http.maxRequests::
802 How many HTTP requests to launch in parallel. Can be overridden
803 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
805 http.lowSpeedLimit, http.lowSpeedTime::
806 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
807 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
808 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
809 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
811 http.noEPSV::
812 A boolean which disables using of EPSV ftp command by curl.
813 This can helpful with some "poor" ftp servers which don't
814 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
815 environment variable. Default is false (curl will use EPSV).
817 i18n.commitEncoding::
818 Character encoding the commit messages are stored in; git itself
819 does not care per se, but this information is necessary e.g. when
820 importing commits from emails or in the gitk graphical history
821 browser (and possibly at other places in the future or in other
822 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
824 i18n.logOutputEncoding::
825 Character encoding the commit messages are converted to when
826 running `git-log` and friends.
828 instaweb.browser::
829 Specify the program that will be used to browse your working
830 repository in gitweb. See linkgit:git-instaweb[1].
832 instaweb.httpd::
833 The HTTP daemon command-line to start gitweb on your working
834 repository. See linkgit:git-instaweb[1].
836 instaweb.local::
837 If true the web server started by linkgit:git-instaweb[1] will
838 be bound to the local IP (127.0.0.1).
840 instaweb.modulepath::
841 The module path for an apache httpd used by linkgit:git-instaweb[1].
843 instaweb.port::
844 The port number to bind the gitweb httpd to. See
845 linkgit:git-instaweb[1].
847 log.date::
848 Set default date-time mode for the log command. Setting log.date
849 value is similar to using git log's --date option. The value is one of
850 following alternatives: {relative,local,default,iso,rfc,short}.
851 See linkgit:git-log[1].
853 log.showroot::
854 If true, the initial commit will be shown as a big creation event.
855 This is equivalent to a diff against an empty tree.
856 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
857 normally hide the root commit will now show it. True by default.
859 man.viewer::
860 Specify the programs that may be used to display help in the
861 'man' format. See linkgit:git-help[1].
863 include::merge-config.txt[]
865 man.<tool>.cmd::
866 Specify the command to invoke the specified man viewer. The
867 specified command is evaluated in shell with the man page
868 passed as argument. (See linkgit:git-help[1].)
870 man.<tool>.path::
871 Override the path for the given tool that may be used to
872 display help in the 'man' format. See linkgit:git-help[1].
874 mergetool.<tool>.path::
875 Override the path for the given tool. This is useful in case
876 your tool is not in the PATH.
878 mergetool.<tool>.cmd::
879 Specify the command to invoke the specified merge tool. The
880 specified command is evaluated in shell with the following
881 variables available: 'BASE' is the name of a temporary file
882 containing the common base of the files to be merged, if available;
883 'LOCAL' is the name of a temporary file containing the contents of
884 the file on the current branch; 'REMOTE' is the name of a temporary
885 file containing the contents of the file from the branch being
886 merged; 'MERGED' contains the name of the file to which the merge
887 tool should write the results of a successful merge.
889 mergetool.<tool>.trustExitCode::
890 For a custom merge command, specify whether the exit code of
891 the merge command can be used to determine whether the merge was
892 successful. If this is not set to true then the merge target file
893 timestamp is checked and the merge assumed to have been successful
894 if the file has been updated, otherwise the user is prompted to
895 indicate the success of the merge.
897 mergetool.keepBackup::
898 After performing a merge, the original file with conflict markers
899 can be saved as a file with a `.orig` extension. If this variable
900 is set to `false` then this file is not preserved. Defaults to
901 `true` (i.e. keep the backup files).
903 pack.window::
904 The size of the window used by linkgit:git-pack-objects[1] when no
905 window size is given on the command line. Defaults to 10.
907 pack.depth::
908 The maximum delta depth used by linkgit:git-pack-objects[1] when no
909 maximum depth is given on the command line. Defaults to 50.
911 pack.windowMemory::
912 The window memory size limit used by linkgit:git-pack-objects[1]
913 when no limit is given on the command line. The value can be
914 suffixed with "k", "m", or "g". Defaults to 0, meaning no
915 limit.
917 pack.compression::
918 An integer -1..9, indicating the compression level for objects
919 in a pack file. -1 is the zlib default. 0 means no
920 compression, and 1..9 are various speed/size tradeoffs, 9 being
921 slowest. If not set, defaults to core.compression. If that is
922 not set, defaults to -1, the zlib default, which is "a default
923 compromise between speed and compression (currently equivalent
924 to level 6)."
926 pack.deltaCacheSize::
927 The maximum memory in bytes used for caching deltas in
928 linkgit:git-pack-objects[1].
929 A value of 0 means no limit. Defaults to 0.
931 pack.deltaCacheLimit::
932 The maximum size of a delta, that is cached in
933 linkgit:git-pack-objects[1]. Defaults to 1000.
935 pack.threads::
936 Specifies the number of threads to spawn when searching for best
937 delta matches. This requires that linkgit:git-pack-objects[1]
938 be compiled with pthreads otherwise this option is ignored with a
939 warning. This is meant to reduce packing time on multiprocessor
940 machines. The required amount of memory for the delta search window
941 is however multiplied by the number of threads.
942 Specifying 0 will cause git to auto-detect the number of CPU's
943 and set the number of threads accordingly.
945 pack.indexVersion::
946 Specify the default pack index version. Valid values are 1 for
947 legacy pack index used by Git versions prior to 1.5.2, and 2 for
948 the new pack index with capabilities for packs larger than 4 GB
949 as well as proper protection against the repacking of corrupted
950 packs. Version 2 is selected and this config option ignored
951 whenever the corresponding pack is larger than 2 GB. Otherwise
952 the default is 1.
954 pack.packSizeLimit::
955 The default maximum size of a pack. This setting only affects
956 packing to a file, i.e. the git:// protocol is unaffected. It
957 can be overridden by the `\--max-pack-size` option of
958 linkgit:git-repack[1].
960 pull.octopus::
961 The default merge strategy to use when pulling multiple branches
962 at once.
964 pull.twohead::
965 The default merge strategy to use when pulling a single branch.
967 remote.<name>.url::
968 The URL of a remote repository. See linkgit:git-fetch[1] or
969 linkgit:git-push[1].
971 remote.<name>.proxy::
972 For remotes that require curl (http, https and ftp), the URL to
973 the proxy to use for that remote. Set to the empty string to
974 disable proxying for that remote.
976 remote.<name>.fetch::
977 The default set of "refspec" for linkgit:git-fetch[1]. See
978 linkgit:git-fetch[1].
980 remote.<name>.push::
981 The default set of "refspec" for linkgit:git-push[1]. See
982 linkgit:git-push[1].
984 remote.<name>.mirror::
985 If true, pushing to this remote will automatically behave
986 as if the `\--mirror` option was given on the command line.
988 remote.<name>.skipDefaultUpdate::
989 If true, this remote will be skipped by default when updating
990 using the update subcommand of linkgit:git-remote[1].
992 remote.<name>.receivepack::
993 The default program to execute on the remote side when pushing. See
994 option \--receive-pack of linkgit:git-push[1].
996 remote.<name>.uploadpack::
997 The default program to execute on the remote side when fetching. See
998 option \--upload-pack of linkgit:git-fetch-pack[1].
1000 remote.<name>.tagopt::
1001 Setting this value to \--no-tags disables automatic tag following when
1002 fetching from remote <name>
1004 remotes.<group>::
1005 The list of remotes which are fetched by "git remote update
1006 <group>". See linkgit:git-remote[1].
1008 repack.usedeltabaseoffset::
1009 Allow linkgit:git-repack[1] to create packs that uses
1010 delta-base offset. Defaults to false.
1012 show.difftree::
1013 The default linkgit:git-diff-tree[1] arguments to be used
1014 for linkgit:git-show[1].
1016 showbranch.default::
1017 The default set of branches for linkgit:git-show-branch[1].
1018 See linkgit:git-show-branch[1].
1020 status.relativePaths::
1021 By default, linkgit:git-status[1] shows paths relative to the
1022 current directory. Setting this variable to `false` shows paths
1023 relative to the repository root (this was the default for git
1024 prior to v1.5.4).
1026 tar.umask::
1027 This variable can be used to restrict the permission bits of
1028 tar archive entries. The default is 0002, which turns off the
1029 world write bit. The special value "user" indicates that the
1030 archiving user's umask will be used instead. See umask(2) and
1031 linkgit:git-archive[1].
1033 url.<base>.insteadOf::
1034 Any URL that starts with this value will be rewritten to
1035 start, instead, with <base>. In cases where some site serves a
1036 large number of repositories, and serves them with multiple
1037 access methods, and some users need to use different access
1038 methods, this feature allows people to specify any of the
1039 equivalent URLs and have git automatically rewrite the URL to
1040 the best alternative for the particular user, even for a
1041 never-before-seen repository on the site. When more than one
1042 insteadOf strings match a given URL, the longest match is used.
1044 user.email::
1045 Your email address to be recorded in any newly created commits.
1046 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1047 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1049 user.name::
1050 Your full name to be recorded in any newly created commits.
1051 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1052 environment variables. See linkgit:git-commit-tree[1].
1054 user.signingkey::
1055 If linkgit:git-tag[1] is not selecting the key you want it to
1056 automatically when creating a signed tag, you can override the
1057 default selection with this variable. This option is passed
1058 unchanged to gpg's --local-user parameter, so you may specify a key
1059 using any method that gpg supports.
1061 whatchanged.difftree::
1062 The default linkgit:git-diff-tree[1] arguments to be used
1063 for linkgit:git-whatchanged[1].
1065 imap::
1066 The configuration variables in the 'imap' section are described
1067 in linkgit:git-imap-send[1].
1069 receive.fsckObjects::
1070 If it is set to true, git-receive-pack will check all received
1071 objects. It will abort in the case of a malformed object or a
1072 broken link. The result of an abort are only dangling objects.
1073 Defaults to false.
1075 receive.unpackLimit::
1076 If the number of objects received in a push is below this
1077 limit then the objects will be unpacked into loose object
1078 files. However if the number of received objects equals or
1079 exceeds this limit then the received pack will be stored as
1080 a pack, after adding any missing delta bases. Storing the
1081 pack from a push can make the push operation complete faster,
1082 especially on slow filesystems. If not set, the value of
1083 `transfer.unpackLimit` is used instead.
1085 receive.denyNonFastForwards::
1086 If set to true, git-receive-pack will deny a ref update which is
1087 not a fast forward. Use this to prevent such an update via a push,
1088 even if that push is forced. This configuration variable is
1089 set when initializing a shared repository.
1091 transfer.unpackLimit::
1092 When `fetch.unpackLimit` or `receive.unpackLimit` are
1093 not set, the value of this variable is used instead.
1094 The default value is 100.
1096 web.browser::
1097 Specify a web browser that may be used by some commands.
1098 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1099 may use it.