Merge branch 'lt/case-insensitive'
[git/git.git] / Documentation / config.txt
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 ""
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 The working copy files are assumed to stay unchanged until you
209 mark them otherwise manually - Git will not detect the file changes
210 by lstat() calls. This is useful on systems where those are very
211 slow, such as Microsoft Windows. See linkgit:git-update-index[1].
212 False by default.
214 core.preferSymlinkRefs::
215 Instead of the default "symref" format for HEAD
216 and other symbolic reference files, use symbolic links.
217 This is sometimes needed to work with old scripts that
218 expect HEAD to be a symbolic link.
220 core.bare::
221 If true this repository is assumed to be 'bare' and has no
222 working directory associated with it. If this is the case a
223 number of commands that require a working directory will be
224 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
225 +
226 This setting is automatically guessed by linkgit:git-clone[1] or
227 linkgit:git-init[1] when the repository was created. By default a
228 repository that ends in "/.git" is assumed to be not bare (bare =
229 false), while all other repositories are assumed to be bare (bare
230 = true).
232 core.worktree::
233 Set the path to the working tree. The value will not be
234 used in combination with repositories found automatically in
235 a .git directory (i.e. $GIT_DIR is not set).
236 This can be overridden by the GIT_WORK_TREE environment
237 variable and the '--work-tree' command line option. It can be
238 a absolute path or relative path to the directory specified by
239 --git-dir or GIT_DIR.
240 Note: If --git-dir or GIT_DIR are specified but none of
241 --work-tree, GIT_WORK_TREE and core.worktree is specified,
242 the current working directory is regarded as the top directory
243 of your working tree.
245 core.logAllRefUpdates::
246 Enable the reflog. Updates to a ref <ref> is logged to the file
247 "$GIT_DIR/logs/<ref>", by appending the new and old
248 SHA1, the date/time and the reason of the update, but
249 only when the file exists. If this configuration
250 variable is set to true, missing "$GIT_DIR/logs/<ref>"
251 file is automatically created for branch heads.
252 +
253 This information can be used to determine what commit
254 was the tip of a branch "2 days ago".
255 +
256 This value is true by default in a repository that has
257 a working directory associated with it, and false by
258 default in a bare repository.
260 core.repositoryFormatVersion::
261 Internal variable identifying the repository format and layout
262 version.
264 core.sharedRepository::
265 When 'group' (or 'true'), the repository is made shareable between
266 several users in a group (making sure all the files and objects are
267 group-writable). When 'all' (or 'world' or 'everybody'), the
268 repository will be readable by all users, additionally to being
269 group-shareable. When 'umask' (or 'false'), git will use permissions
270 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
271 files in the repository will have this mode value. '0xxx' will override
272 user's umask value, and thus, users with a safe umask (0077) can use
273 this option. Examples: '0660' is equivalent to 'group'. '0640' is a
274 repository that is group-readable but not group-writable.
275 See linkgit:git-init[1]. False by default.
277 core.warnAmbiguousRefs::
278 If true, git will warn you if the ref name you passed it is ambiguous
279 and might match multiple refs in the .git/refs/ tree. True by default.
281 core.compression::
282 An integer -1..9, indicating a default compression level.
283 -1 is the zlib default. 0 means no compression,
284 and 1..9 are various speed/size tradeoffs, 9 being slowest.
285 If set, this provides a default to other compression variables,
286 such as 'core.loosecompression' and 'pack.compression'.
288 core.loosecompression::
289 An integer -1..9, indicating the compression level for objects that
290 are not in a pack file. -1 is the zlib default. 0 means no
291 compression, and 1..9 are various speed/size tradeoffs, 9 being
292 slowest. If not set, defaults to core.compression. If that is
293 not set, defaults to 1 (best speed).
295 core.packedGitWindowSize::
296 Number of bytes of a pack file to map into memory in a
297 single mapping operation. Larger window sizes may allow
298 your system to process a smaller number of large pack files
299 more quickly. Smaller window sizes will negatively affect
300 performance due to increased calls to the operating system's
301 memory manager, but may improve performance when accessing
302 a large number of large pack files.
303 +
304 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
305 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
306 be reasonable for all users/operating systems. You probably do
307 not need to adjust this value.
308 +
309 Common unit suffixes of 'k', 'm', or 'g' are supported.
311 core.packedGitLimit::
312 Maximum number of bytes to map simultaneously into memory
313 from pack files. If Git needs to access more than this many
314 bytes at once to complete an operation it will unmap existing
315 regions to reclaim virtual address space within the process.
316 +
317 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
318 This should be reasonable for all users/operating systems, except on
319 the largest projects. You probably do not need to adjust this value.
320 +
321 Common unit suffixes of 'k', 'm', or 'g' are supported.
323 core.deltaBaseCacheLimit::
324 Maximum number of bytes to reserve for caching base objects
325 that multiple deltafied objects reference. By storing the
326 entire decompressed base objects in a cache Git is able
327 to avoid unpacking and decompressing frequently used base
328 objects multiple times.
329 +
330 Default is 16 MiB on all platforms. This should be reasonable
331 for all users/operating systems, except on the largest projects.
332 You probably do not need to adjust this value.
333 +
334 Common unit suffixes of 'k', 'm', or 'g' are supported.
336 core.excludesfile::
337 In addition to '.gitignore' (per-directory) and
338 '.git/info/exclude', git looks into this file for patterns
339 of files which are not meant to be tracked. See
340 linkgit:gitignore[5].
342 core.editor::
343 Commands such as `commit` and `tag` that lets you edit
344 messages by launching an editor uses the value of this
345 variable when it is set, and the environment variable
346 `GIT_EDITOR` is not set. The order of preference is
347 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
348 `EDITOR` environment variables and then finally `vi`.
350 core.pager::
351 The command that git will use to paginate output. Can be overridden
352 with the `GIT_PAGER` environment variable.
354 core.whitespace::
355 A comma separated list of common whitespace problems to
356 notice. `git diff` will use `color.diff.whitespace` to
357 highlight them, and `git apply --whitespace=error` will
358 consider them as errors:
359 +
360 * `trailing-space` treats trailing whitespaces at the end of the line
361 as an error (enabled by default).
362 * `space-before-tab` treats a space character that appears immediately
363 before a tab character in the initial indent part of the line as an
364 error (enabled by default).
365 * `indent-with-non-tab` treats a line that is indented with 8 or more
366 space characters as an error (not enabled by default).
367 * `cr-at-eol` treats a carriage-return at the end of line as
368 part of the line terminator, i.e. with it, `trailing-space`
369 does not trigger if the character before such a carriage-return
370 is not a whitespace (not enabled by default).
372 alias.*::
373 Command aliases for the linkgit:git[1] command wrapper - e.g.
374 after defining "alias.last = cat-file commit HEAD", the invocation
375 "git last" is equivalent to "git cat-file commit HEAD". To avoid
376 confusion and troubles with script usage, aliases that
377 hide existing git commands are ignored. Arguments are split by
378 spaces, the usual shell quoting and escaping is supported.
379 quote pair and a backslash can be used to quote them.
380 +
381 If the alias expansion is prefixed with an exclamation point,
382 it will be treated as a shell command. For example, defining
383 " = !gitk --all --not ORIG_HEAD", the invocation
384 "git new" is equivalent to running the shell command
385 "gitk --all --not ORIG_HEAD".
387 apply.whitespace::
388 Tells `git-apply` how to handle whitespaces, in the same way
389 as the '--whitespace' option. See linkgit:git-apply[1].
391 branch.autosetupmerge::
392 Tells `git-branch` and `git-checkout` to setup new branches
393 so that linkgit:git-pull[1] will appropriately merge from the
394 starting point branch. Note that even if this option is not set,
395 this behavior can be chosen per-branch using the `--track`
396 and `--no-track` options. The valid settings are: `false` -- no
397 automatic setup is done; `true` -- automatic setup is done when the
398 starting point is a remote branch; `always` -- automatic setup is
399 done when the starting point is either a local branch or remote
400 branch. This option defaults to true.
402 branch.<name>.remote::
403 When in branch <name>, it tells `git fetch` which remote to fetch.
404 If this option is not given, `git fetch` defaults to remote "origin".
406 branch.<name>.merge::
407 When in branch <name>, it tells `git fetch` the default
408 refspec to be marked for merging in FETCH_HEAD. The value is
409 handled like the remote part of a refspec, and must match a
410 ref which is fetched from the remote given by
411 "branch.<name>.remote".
412 The merge information is used by `git pull` (which at first calls
413 `git fetch`) to lookup the default branch for merging. Without
414 this option, `git pull` defaults to merge the first refspec fetched.
415 Specify multiple values to get an octopus merge.
416 If you wish to setup `git pull` so that it merges into <name> from
417 another branch in the local repository, you can point
418 branch.<name>.merge to the desired branch, and use the special setting
419 `.` (a period) for branch.<name>.remote.
421 branch.<name>.mergeoptions::
422 Sets default options for merging into branch <name>. The syntax and
423 supported options are equal to that of linkgit:git-merge[1], but
424 option values containing whitespace characters are currently not
425 supported.
427 branch.<name>.rebase::
428 When true, rebase the branch <name> on top of the fetched branch,
429 instead of merging the default branch from the default remote when
430 "git pull" is run.
431 *NOTE*: this is a possibly dangerous operation; do *not* use
432 it unless you understand the implications (see linkgit:git-rebase[1]
433 for details).
435 browser.<tool>.cmd::
436 Specify the command to invoke the specified browser. The
437 specified command is evaluated in shell with the URLs passed
438 as arguments. (See linkgit:git-web--browse[1].)
440 browser.<tool>.path::
441 Override the path for the given tool that may be used to
442 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
443 working repository in gitweb (see linkgit:git-instaweb[1]).
445 clean.requireForce::
446 A boolean to make git-clean do nothing unless given -f
447 or -n. Defaults to true.
449 color.branch::
450 A boolean to enable/disable color in the output of
451 linkgit:git-branch[1]. May be set to `always`,
452 `false` (or `never`) or `auto` (or `true`), in which case colors are used
453 only when the output is to a terminal. Defaults to false.
455 color.branch.<slot>::
456 Use customized color for branch coloration. `<slot>` is one of
457 `current` (the current branch), `local` (a local branch),
458 `remote` (a tracking branch in refs/remotes/), `plain` (other
459 refs).
460 +
461 The value for these configuration variables is a list of colors (at most
462 two) and attributes (at most one), separated by spaces. The colors
463 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
464 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
465 `blink` and `reverse`. The first color given is the foreground; the
466 second is the background. The position of the attribute, if any,
467 doesn't matter.
469 color.diff::
470 When set to `always`, always use colors in patch.
471 When false (or `never`), never. When set to `true` or `auto`, use
472 colors only when the output is to the terminal. Defaults to false.
474 color.diff.<slot>::
475 Use customized color for diff colorization. `<slot>` specifies
476 which part of the patch to use the specified color, and is one
477 of `plain` (context text), `meta` (metainformation), `frag`
478 (hunk header), `old` (removed lines), `new` (added lines),
479 `commit` (commit headers), or `whitespace` (highlighting
480 whitespace errors). The values of these variables may be specified as
481 in color.branch.<slot>.
483 color.interactive::
484 When set to `always`, always use colors for interactive prompts
485 and displays (such as those used by "git add --interactive").
486 When false (or `never`), never. When set to `true` or `auto`, use
487 colors only when the output is to the terminal. Defaults to false.
489 color.interactive.<slot>::
490 Use customized color for `git add --interactive`
491 output. `<slot>` may be `prompt`, `header`, or `help`, for
492 three distinct types of normal output from interactive
493 programs. The values of these variables may be specified as
494 in color.branch.<slot>.
496 color.pager::
497 A boolean to enable/disable colored output when the pager is in
498 use (default is true).
500 color.status::
501 A boolean to enable/disable color in the output of
502 linkgit:git-status[1]. May be set to `always`,
503 `false` (or `never`) or `auto` (or `true`), in which case colors are used
504 only when the output is to a terminal. Defaults to false.
506 color.status.<slot>::
507 Use customized color for status colorization. `<slot>` is
508 one of `header` (the header text of the status message),
509 `added` or `updated` (files which are added but not committed),
510 `changed` (files which are changed but not added in the index),
511 or `untracked` (files which are not tracked by git). The values of
512 these variables may be specified as in color.branch.<slot>.
514 commit.template::
515 Specify a file to use as the template for new commit messages.
517 color.ui::
518 When set to `always`, always use colors in all git commands which
519 are capable of colored output. When false (or `never`), never. When
520 set to `true` or `auto`, use colors only when the output is to the
521 terminal. When more specific variables of color.* are set, they always
522 take precedence over this setting. Defaults to false.
524 diff.autorefreshindex::
525 When using `git diff` to compare with work tree
526 files, do not consider stat-only change as changed.
527 Instead, silently run `git update-index --refresh` to
528 update the cached stat information for paths whose
529 contents in the work tree match the contents in the
530 index. This option defaults to true. Note that this
531 affects only `git diff` Porcelain, and not lower level
532 `diff` commands, such as `git diff-files`.
534 diff.external::
535 If this config variable is set, diff generation is not
536 performed using the internal diff machinery, but using the
537 given command. Note: if you want to use an external diff
538 program only on a subset of your files, you might want to
539 use linkgit:gitattributes[5] instead.
541 diff.renameLimit::
542 The number of files to consider when performing the copy/rename
543 detection; equivalent to the git diff option '-l'.
545 diff.renames::
546 Tells git to detect renames. If set to any boolean value, it
547 will enable basic rename detection. If set to "copies" or
548 "copy", it will detect copies, as well.
550 fetch.unpackLimit::
551 If the number of objects fetched over the git native
552 transfer is below this
553 limit, then the objects will be unpacked into loose object
554 files. However if the number of received objects equals or
555 exceeds this limit then the received pack will be stored as
556 a pack, after adding any missing delta bases. Storing the
557 pack from a push can make the push operation complete faster,
558 especially on slow filesystems. If not set, the value of
559 `transfer.unpackLimit` is used instead.
561 format.numbered::
562 A boolean which can enable sequence numbers in patch subjects.
563 Setting this option to "auto" will enable it only if there is
564 more than one patch. See --numbered option in
565 linkgit:git-format-patch[1].
567 format.headers::
568 Additional email headers to include in a patch to be submitted
569 by mail. See linkgit:git-format-patch[1].
571 format.suffix::
572 The default for format-patch is to output files with the suffix
573 `.patch`. Use this variable to change that suffix (make sure to
574 include the dot if you want it).
576 format.pretty::
577 The default pretty format for log/show/whatchanged command,
578 See linkgit:git-log[1], linkgit:git-show[1],
579 linkgit:git-whatchanged[1].
581 gc.aggressiveWindow::
582 The window size parameter used in the delta compression
583 algorithm used by 'git gc --aggressive'. This defaults
584 to 10.
587 When there are approximately more than this many loose
588 objects in the repository, `git gc --auto` will pack them.
589 Some Porcelain commands use this command to perform a
590 light-weight garbage collection from time to time. The
591 default value is 6700. Setting this to 0 disables it.
593 gc.autopacklimit::
594 When there are more than this many packs that are not
595 marked with `*.keep` file in the repository, `git gc
596 --auto` consolidates them into one larger pack. The
597 default value is 50. Setting this to 0 disables it.
599 gc.packrefs::
600 `git gc` does not run `git pack-refs` in a bare repository by
601 default so that older dumb-transport clients can still fetch
602 from the repository. Setting this to `true` lets `git
603 gc` to run `git pack-refs`. Setting this to `false` tells
604 `git gc` never to run `git pack-refs`. The default setting is
605 `notbare`. Enable it only when you know you do not have to
606 support such clients. The default setting will change to `true`
607 at some stage, and setting this to `false` will continue to
608 prevent `git pack-refs` from being run from `git gc`.
610 gc.pruneexpire::
611 When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
612 Override the grace period with this config variable.
614 gc.reflogexpire::
615 `git reflog expire` removes reflog entries older than
616 this time; defaults to 90 days.
618 gc.reflogexpireunreachable::
619 `git reflog expire` removes reflog entries older than
620 this time and are not reachable from the current tip;
621 defaults to 30 days.
623 gc.rerereresolved::
624 Records of conflicted merge you resolved earlier are
625 kept for this many days when `git rerere gc` is run.
626 The default is 60 days. See linkgit:git-rerere[1].
628 gc.rerereunresolved::
629 Records of conflicted merge you have not resolved are
630 kept for this many days when `git rerere gc` is run.
631 The default is 15 days. See linkgit:git-rerere[1].
633 rerere.enabled::
634 Activate recording of resolved conflicts, so that identical
635 conflict hunks can be resolved automatically, should they
636 be encountered again. linkgit:git-rerere[1] command is by
637 default enabled if you create `rr-cache` directory under
638 `$GIT_DIR`, but can be disabled by setting this option to false.
640 gitcvs.enabled::
641 Whether the CVS server interface is enabled for this repository.
642 See linkgit:git-cvsserver[1].
644 gitcvs.logfile::
645 Path to a log file where the CVS server interface well... logs
646 various stuff. See linkgit:git-cvsserver[1].
648 gitcvs.allbinary::
649 If true, all files are sent to the client in mode '-kb'. This
650 causes the client to treat all files as binary files which suppresses
651 any newline munging it otherwise might do. A work-around for the
652 fact that there is no way yet to set single files to mode '-kb'.
654 gitcvs.dbname::
655 Database used by git-cvsserver to cache revision information
656 derived from the git repository. The exact meaning depends on the
657 used database driver, for SQLite (which is the default driver) this
658 is a filename. Supports variable substitution (see
659 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
660 Default: '%Ggitcvs.%m.sqlite'
662 gitcvs.dbdriver::
663 Used Perl DBI driver. You can specify any available driver
664 for this here, but it might not work. git-cvsserver is tested
665 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
666 reported *not* to work with 'DBD::mysql'. Experimental feature.
667 May not contain double colons (`:`). Default: 'SQLite'.
668 See linkgit:git-cvsserver[1].
670 gitcvs.dbuser, gitcvs.dbpass::
671 Database user and password. Only useful if setting 'gitcvs.dbdriver',
672 since SQLite has no concept of database users and/or passwords.
673 'gitcvs.dbuser' supports variable substitution (see
674 linkgit:git-cvsserver[1] for details).
676 gitcvs.dbTableNamePrefix::
677 Database table name prefix. Prepended to the names of any
678 database tables used, allowing a single database to be used
679 for several repositories. Supports variable substitution (see
680 linkgit:git-cvsserver[1] for details). Any non-alphabetic
681 characters will be replaced with underscores.
683 All gitcvs variables except for 'gitcvs.allbinary' can also be
684 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
685 is one of "ext" and "pserver") to make them apply only for the given
686 access method.
688 gui.commitmsgwidth::
689 Defines how wide the commit message window is in the
690 linkgit:git-gui[1]. "75" is the default.
692 gui.diffcontext::
693 Specifies how many context lines should be used in calls to diff
694 made by the linkgit:git-gui[1]. The default is "5".
696 gui.matchtrackingbranch::
697 Determines if new branches created with linkgit:git-gui[1] should
698 default to tracking remote branches with matching names or
699 not. Default: "false".
701 gui.newbranchtemplate::
702 Is used as suggested name when creating new branches using the
703 linkgit:git-gui[1].
705 gui.pruneduringfetch::
706 "true" if linkgit:git-gui[1] should prune tracking branches when
707 performing a fetch. The default value is "false".
709 gui.trustmtime::
710 Determines if linkgit:git-gui[1] should trust the file modification
711 timestamp or not. By default the timestamps are not trusted.
713 gui.spellingdictionary::
714 Specifies the dictionary used for spell checking commit messages in
715 the linkgit:git-gui[1]. When set to "none" spell checking is turned
716 off.
718 help.browser::
719 Specify the browser that will be used to display help in the
720 'web' format. See linkgit:git-help[1].
722 help.format::
723 Override the default help format used by linkgit:git-help[1].
724 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
725 the default. 'web' and 'html' are the same.
727 http.proxy::
728 Override the HTTP proxy, normally configured using the 'http_proxy'
729 environment variable (see linkgit:curl[1]). This can be overridden
730 on a per-remote basis; see remote.<name>.proxy
732 http.sslVerify::
733 Whether to verify the SSL certificate when fetching or pushing
734 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
735 variable.
737 http.sslCert::
738 File containing the SSL certificate when fetching or pushing
739 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
740 variable.
742 http.sslKey::
743 File containing the SSL private key when fetching or pushing
744 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
745 variable.
747 http.sslCAInfo::
748 File containing the certificates to verify the peer with when
749 fetching or pushing over HTTPS. Can be overridden by the
750 'GIT_SSL_CAINFO' environment variable.
752 http.sslCAPath::
753 Path containing files with the CA certificates to verify the peer
754 with when fetching or pushing over HTTPS. Can be overridden
755 by the 'GIT_SSL_CAPATH' environment variable.
757 http.maxRequests::
758 How many HTTP requests to launch in parallel. Can be overridden
759 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
761 http.lowSpeedLimit, http.lowSpeedTime::
762 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
763 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
764 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
765 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
767 http.noEPSV::
768 A boolean which disables using of EPSV ftp command by curl.
769 This can helpful with some "poor" ftp servers which don't
770 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
771 environment variable. Default is false (curl will use EPSV).
773 i18n.commitEncoding::
774 Character encoding the commit messages are stored in; git itself
775 does not care per se, but this information is necessary e.g. when
776 importing commits from emails or in the gitk graphical history
777 browser (and possibly at other places in the future or in other
778 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
780 i18n.logOutputEncoding::
781 Character encoding the commit messages are converted to when
782 running `git-log` and friends.
784 instaweb.browser::
785 Specify the program that will be used to browse your working
786 repository in gitweb. See linkgit:git-instaweb[1].
788 instaweb.httpd::
789 The HTTP daemon command-line to start gitweb on your working
790 repository. See linkgit:git-instaweb[1].
792 instaweb.local::
793 If true the web server started by linkgit:git-instaweb[1] will
794 be bound to the local IP (
796 instaweb.modulepath::
797 The module path for an apache httpd used by linkgit:git-instaweb[1].
799 instaweb.port::
800 The port number to bind the gitweb httpd to. See
801 linkgit:git-instaweb[1].
803 log.showroot::
804 If true, the initial commit will be shown as a big creation event.
805 This is equivalent to a diff against an empty tree.
806 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
807 normally hide the root commit will now show it. True by default.
809 man.viewer::
810 Specify the programs that may be used to display help in the
811 'man' format. See linkgit:git-help[1].
813 include::merge-config.txt[]
815 man.<tool>.cmd::
816 Specify the command to invoke the specified man viewer. The
817 specified command is evaluated in shell with the man page
818 passed as argument. (See linkgit:git-help[1].)
820 man.<tool>.path::
821 Override the path for the given tool that may be used to
822 display help in the 'man' format. See linkgit:git-help[1].
824 mergetool.<tool>.path::
825 Override the path for the given tool. This is useful in case
826 your tool is not in the PATH.
828 mergetool.<tool>.cmd::
829 Specify the command to invoke the specified merge tool. The
830 specified command is evaluated in shell with the following
831 variables available: 'BASE' is the name of a temporary file
832 containing the common base of the files to be merged, if available;
833 'LOCAL' is the name of a temporary file containing the contents of
834 the file on the current branch; 'REMOTE' is the name of a temporary
835 file containing the contents of the file from the branch being
836 merged; 'MERGED' contains the name of the file to which the merge
837 tool should write the results of a successful merge.
839 mergetool.<tool>.trustExitCode::
840 For a custom merge command, specify whether the exit code of
841 the merge command can be used to determine whether the merge was
842 successful. If this is not set to true then the merge target file
843 timestamp is checked and the merge assumed to have been successful
844 if the file has been updated, otherwise the user is prompted to
845 indicate the success of the merge.
847 mergetool.keepBackup::
848 After performing a merge, the original file with conflict markers
849 can be saved as a file with a `.orig` extension. If this variable
850 is set to `false` then this file is not preserved. Defaults to
851 `true` (i.e. keep the backup files).
853 pack.window::
854 The size of the window used by linkgit:git-pack-objects[1] when no
855 window size is given on the command line. Defaults to 10.
857 pack.depth::
858 The maximum delta depth used by linkgit:git-pack-objects[1] when no
859 maximum depth is given on the command line. Defaults to 50.
861 pack.windowMemory::
862 The window memory size limit used by linkgit:git-pack-objects[1]
863 when no limit is given on the command line. The value can be
864 suffixed with "k", "m", or "g". Defaults to 0, meaning no
865 limit.
867 pack.compression::
868 An integer -1..9, indicating the compression level for objects
869 in a pack file. -1 is the zlib default. 0 means no
870 compression, and 1..9 are various speed/size tradeoffs, 9 being
871 slowest. If not set, defaults to core.compression. If that is
872 not set, defaults to -1, the zlib default, which is "a default
873 compromise between speed and compression (currently equivalent
874 to level 6)."
876 pack.deltaCacheSize::
877 The maximum memory in bytes used for caching deltas in
878 linkgit:git-pack-objects[1].
879 A value of 0 means no limit. Defaults to 0.
881 pack.deltaCacheLimit::
882 The maximum size of a delta, that is cached in
883 linkgit:git-pack-objects[1]. Defaults to 1000.
885 pack.threads::
886 Specifies the number of threads to spawn when searching for best
887 delta matches. This requires that linkgit:git-pack-objects[1]
888 be compiled with pthreads otherwise this option is ignored with a
889 warning. This is meant to reduce packing time on multiprocessor
890 machines. The required amount of memory for the delta search window
891 is however multiplied by the number of threads.
892 Specifying 0 will cause git to auto-detect the number of CPU's
893 and set the number of threads accordingly.
895 pack.indexVersion::
896 Specify the default pack index version. Valid values are 1 for
897 legacy pack index used by Git versions prior to 1.5.2, and 2 for
898 the new pack index with capabilities for packs larger than 4 GB
899 as well as proper protection against the repacking of corrupted
900 packs. Version 2 is selected and this config option ignored
901 whenever the corresponding pack is larger than 2 GB. Otherwise
902 the default is 1.
904 pack.packSizeLimit::
905 The default maximum size of a pack. This setting only affects
906 packing to a file, i.e. the git:// protocol is unaffected. It
907 can be overridden by the `\--max-pack-size` option of
908 linkgit:git-repack[1].
910 pull.octopus::
911 The default merge strategy to use when pulling multiple branches
912 at once.
914 pull.twohead::
915 The default merge strategy to use when pulling a single branch.
917 remote.<name>.url::
918 The URL of a remote repository. See linkgit:git-fetch[1] or
919 linkgit:git-push[1].
921 remote.<name>.proxy::
922 For remotes that require curl (http, https and ftp), the URL to
923 the proxy to use for that remote. Set to the empty string to
924 disable proxying for that remote.
926 remote.<name>.fetch::
927 The default set of "refspec" for linkgit:git-fetch[1]. See
928 linkgit:git-fetch[1].
930 remote.<name>.push::
931 The default set of "refspec" for linkgit:git-push[1]. See
932 linkgit:git-push[1].
934 remote.<name>.mirror::
935 If true, pushing to this remote will automatically behave
936 as if the `\--mirror` option was given on the command line.
938 remote.<name>.skipDefaultUpdate::
939 If true, this remote will be skipped by default when updating
940 using the update subcommand of linkgit:git-remote[1].
942 remote.<name>.receivepack::
943 The default program to execute on the remote side when pushing. See
944 option \--receive-pack of linkgit:git-push[1].
946 remote.<name>.uploadpack::
947 The default program to execute on the remote side when fetching. See
948 option \--upload-pack of linkgit:git-fetch-pack[1].
950 remote.<name>.tagopt::
951 Setting this value to \--no-tags disables automatic tag following when
952 fetching from remote <name>
954 remotes.<group>::
955 The list of remotes which are fetched by "git remote update
956 <group>". See linkgit:git-remote[1].
958 repack.usedeltabaseoffset::
959 Allow linkgit:git-repack[1] to create packs that uses
960 delta-base offset. Defaults to false.
962 show.difftree::
963 The default linkgit:git-diff-tree[1] arguments to be used
964 for linkgit:git-show[1].
966 showbranch.default::
967 The default set of branches for linkgit:git-show-branch[1].
968 See linkgit:git-show-branch[1].
970 status.relativePaths::
971 By default, linkgit:git-status[1] shows paths relative to the
972 current directory. Setting this variable to `false` shows paths
973 relative to the repository root (this was the default for git
974 prior to v1.5.4).
976 tar.umask::
977 This variable can be used to restrict the permission bits of
978 tar archive entries. The default is 0002, which turns off the
979 world write bit. The special value "user" indicates that the
980 archiving user's umask will be used instead. See umask(2) and
981 linkgit:git-archive[1].
983 url.<base>.insteadOf::
984 Any URL that starts with this value will be rewritten to
985 start, instead, with <base>. In cases where some site serves a
986 large number of repositories, and serves them with multiple
987 access methods, and some users need to use different access
988 methods, this feature allows people to specify any of the
989 equivalent URLs and have git automatically rewrite the URL to
990 the best alternative for the particular user, even for a
991 never-before-seen repository on the site. When more than one
992 insteadOf strings match a given URL, the longest match is used.
995 Your email address to be recorded in any newly created commits.
996 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
997 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1000 Your full name to be recorded in any newly created commits.
1001 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1002 environment variables. See linkgit:git-commit-tree[1].
1004 user.signingkey::
1005 If linkgit:git-tag[1] is not selecting the key you want it to
1006 automatically when creating a signed tag, you can override the
1007 default selection with this variable. This option is passed
1008 unchanged to gpg's --local-user parameter, so you may specify a key
1009 using any method that gpg supports.
1011 whatchanged.difftree::
1012 The default linkgit:git-diff-tree[1] arguments to be used
1013 for linkgit:git-whatchanged[1].
1015 imap::
1016 The configuration variables in the 'imap' section are described
1017 in linkgit:git-imap-send[1].
1019 receive.fsckObjects::
1020 If it is set to true, git-receive-pack will check all received
1021 objects. It will abort in the case of a malformed object or a
1022 broken link. The result of an abort are only dangling objects.
1023 Defaults to false.
1025 receive.unpackLimit::
1026 If the number of objects received in a push is below this
1027 limit then the objects will be unpacked into loose object
1028 files. However if the number of received objects equals or
1029 exceeds this limit then the received pack will be stored as
1030 a pack, after adding any missing delta bases. Storing the
1031 pack from a push can make the push operation complete faster,
1032 especially on slow filesystems. If not set, the value of
1033 `transfer.unpackLimit` is used instead.
1035 receive.denyNonFastForwards::
1036 If set to true, git-receive-pack will deny a ref update which is
1037 not a fast forward. Use this to prevent such an update via a push,
1038 even if that push is forced. This configuration variable is
1039 set when initializing a shared repository.
1041 transfer.unpackLimit::
1042 When `fetch.unpackLimit` or `receive.unpackLimit` are
1043 not set, the value of this variable is used instead.
1044 The default value is 100.
1046 web.browser::
1047 Specify a web browser that may be used by some commands.
1048 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1049 may use it.