gitweb: Clearly distinguish regexp / exact match searches
[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.
239 core.logAllRefUpdates::
240 Enable the reflog. Updates to a ref <ref> is logged to the file
241 "$GIT_DIR/logs/<ref>", by appending the new and old
242 SHA1, the date/time and the reason of the update, but
243 only when the file exists. If this configuration
244 variable is set to true, missing "$GIT_DIR/logs/<ref>"
245 file is automatically created for branch heads.
246 +
247 This information can be used to determine what commit
248 was the tip of a branch "2 days ago".
249 +
250 This value is true by default in a repository that has
251 a working directory associated with it, and false by
252 default in a bare repository.
254 core.repositoryFormatVersion::
255 Internal variable identifying the repository format and layout
256 version.
258 core.sharedRepository::
259 When 'group' (or 'true'), the repository is made shareable between
260 several users in a group (making sure all the files and objects are
261 group-writable). When 'all' (or 'world' or 'everybody'), the
262 repository will be readable by all users, additionally to being
263 group-shareable. When 'umask' (or 'false'), git will use permissions
264 reported by umask(2). See linkgit:git-init[1]. False by default.
266 core.warnAmbiguousRefs::
267 If true, git will warn you if the ref name you passed it is ambiguous
268 and might match multiple refs in the .git/refs/ tree. True by default.
270 core.compression::
271 An integer -1..9, indicating a default compression level.
272 -1 is the zlib default. 0 means no compression,
273 and 1..9 are various speed/size tradeoffs, 9 being slowest.
274 If set, this provides a default to other compression variables,
275 such as 'core.loosecompression' and 'pack.compression'.
277 core.loosecompression::
278 An integer -1..9, indicating the compression level for objects that
279 are not in a pack file. -1 is the zlib default. 0 means no
280 compression, and 1..9 are various speed/size tradeoffs, 9 being
281 slowest. If not set, defaults to core.compression. If that is
282 not set, defaults to 1 (best speed).
284 core.packedGitWindowSize::
285 Number of bytes of a pack file to map into memory in a
286 single mapping operation. Larger window sizes may allow
287 your system to process a smaller number of large pack files
288 more quickly. Smaller window sizes will negatively affect
289 performance due to increased calls to the operating system's
290 memory manager, but may improve performance when accessing
291 a large number of large pack files.
292 +
293 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
294 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
295 be reasonable for all users/operating systems. You probably do
296 not need to adjust this value.
297 +
298 Common unit suffixes of 'k', 'm', or 'g' are supported.
300 core.packedGitLimit::
301 Maximum number of bytes to map simultaneously into memory
302 from pack files. If Git needs to access more than this many
303 bytes at once to complete an operation it will unmap existing
304 regions to reclaim virtual address space within the process.
305 +
306 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
307 This should be reasonable for all users/operating systems, except on
308 the largest projects. You probably do not need to adjust this value.
309 +
310 Common unit suffixes of 'k', 'm', or 'g' are supported.
312 core.deltaBaseCacheLimit::
313 Maximum number of bytes to reserve for caching base objects
314 that multiple deltafied objects reference. By storing the
315 entire decompressed base objects in a cache Git is able
316 to avoid unpacking and decompressing frequently used base
317 objects multiple times.
318 +
319 Default is 16 MiB on all platforms. This should be reasonable
320 for all users/operating systems, except on the largest projects.
321 You probably do not need to adjust this value.
322 +
323 Common unit suffixes of 'k', 'm', or 'g' are supported.
325 core.excludesfile::
326 In addition to '.gitignore' (per-directory) and
327 '.git/info/exclude', git looks into this file for patterns
328 of files which are not meant to be tracked. See
329 linkgit:gitignore[5].
331 core.editor::
332 Commands such as `commit` and `tag` that lets you edit
333 messages by launching an editor uses the value of this
334 variable when it is set, and the environment variable
335 `GIT_EDITOR` is not set. The order of preference is
336 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
337 `EDITOR` environment variables and then finally `vi`.
339 core.pager::
340 The command that git will use to paginate output. Can be overridden
341 with the `GIT_PAGER` environment variable.
343 core.whitespace::
344 A comma separated list of common whitespace problems to
345 notice. `git diff` will use `color.diff.whitespace` to
346 highlight them, and `git apply --whitespace=error` will
347 consider them as errors:
348 +
349 * `trailing-space` treats trailing whitespaces at the end of the line
350 as an error (enabled by default).
351 * `space-before-tab` treats a space character that appears immediately
352 before a tab character in the initial indent part of the line as an
353 error (enabled by default).
354 * `indent-with-non-tab` treats a line that is indented with 8 or more
355 space characters as an error (not enabled by default).
356 * `cr-at-eol` treats a carriage-return at the end of line as
357 part of the line terminator, i.e. with it, `trailing-space`
358 does not trigger if the character before such a carriage-return
359 is not a whitespace (not enabled by default).
361 alias.*::
362 Command aliases for the linkgit:git[1] command wrapper - e.g.
363 after defining "alias.last = cat-file commit HEAD", the invocation
364 "git last" is equivalent to "git cat-file commit HEAD". To avoid
365 confusion and troubles with script usage, aliases that
366 hide existing git commands are ignored. Arguments are split by
367 spaces, the usual shell quoting and escaping is supported.
368 quote pair and a backslash can be used to quote them.
369 +
370 If the alias expansion is prefixed with an exclamation point,
371 it will be treated as a shell command. For example, defining
372 " = !gitk --all --not ORIG_HEAD", the invocation
373 "git new" is equivalent to running the shell command
374 "gitk --all --not ORIG_HEAD".
376 apply.whitespace::
377 Tells `git-apply` how to handle whitespaces, in the same way
378 as the '--whitespace' option. See linkgit:git-apply[1].
380 branch.autosetupmerge::
381 Tells `git-branch` and `git-checkout` to setup new branches
382 so that linkgit:git-pull[1] will appropriately merge from that
383 remote branch. Note that even if this option is not set,
384 this behavior can be chosen per-branch using the `--track`
385 and `--no-track` options. This option defaults to true.
387 branch.<name>.remote::
388 When in branch <name>, it tells `git fetch` which remote to fetch.
389 If this option is not given, `git fetch` defaults to remote "origin".
391 branch.<name>.merge::
392 When in branch <name>, it tells `git fetch` the default
393 refspec to be marked for merging in FETCH_HEAD. The value is
394 handled like the remote part of a refspec, and must match a
395 ref which is fetched from the remote given by
396 "branch.<name>.remote".
397 The merge information is used by `git pull` (which at first calls
398 `git fetch`) to lookup the default branch for merging. Without
399 this option, `git pull` defaults to merge the first refspec fetched.
400 Specify multiple values to get an octopus merge.
401 If you wish to setup `git pull` so that it merges into <name> from
402 another branch in the local repository, you can point
403 branch.<name>.merge to the desired branch, and use the special setting
404 `.` (a period) for branch.<name>.remote.
406 branch.<name>.mergeoptions::
407 Sets default options for merging into branch <name>. The syntax and
408 supported options are equal to that of linkgit:git-merge[1], but
409 option values containing whitespace characters are currently not
410 supported.
412 branch.<name>.rebase::
413 When true, rebase the branch <name> on top of the fetched branch,
414 instead of merging the default branch from the default remote.
415 *NOTE*: this is a possibly dangerous operation; do *not* use
416 it unless you understand the implications (see linkgit:git-rebase[1]
417 for details).
419 browser.<tool>.path::
420 Override the path for the given tool that may be used to
421 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
422 working repository in gitweb (see linkgit:git-instaweb[1]).
424 clean.requireForce::
425 A boolean to make git-clean do nothing unless given -f
426 or -n. Defaults to true.
428 color.branch::
429 A boolean to enable/disable color in the output of
430 linkgit:git-branch[1]. May be set to `always`,
431 `false` (or `never`) or `auto` (or `true`), in which case colors are used
432 only when the output is to a terminal. Defaults to false.
434 color.branch.<slot>::
435 Use customized color for branch coloration. `<slot>` is one of
436 `current` (the current branch), `local` (a local branch),
437 `remote` (a tracking branch in refs/remotes/), `plain` (other
438 refs).
439 +
440 The value for these configuration variables is a list of colors (at most
441 two) and attributes (at most one), separated by spaces. The colors
442 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
443 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
444 `blink` and `reverse`. The first color given is the foreground; the
445 second is the background. The position of the attribute, if any,
446 doesn't matter.
448 color.diff::
449 When set to `always`, always use colors in patch.
450 When false (or `never`), never. When set to `true` or `auto`, use
451 colors only when the output is to the terminal. Defaults to false.
453 color.diff.<slot>::
454 Use customized color for diff colorization. `<slot>` specifies
455 which part of the patch to use the specified color, and is one
456 of `plain` (context text), `meta` (metainformation), `frag`
457 (hunk header), `old` (removed lines), `new` (added lines),
458 `commit` (commit headers), or `whitespace` (highlighting
459 whitespace errors). The values of these variables may be specified as
460 in color.branch.<slot>.
462 color.interactive::
463 When set to `always`, always use colors for interactive prompts
464 and displays (such as those used by "git add --interactive").
465 When false (or `never`), never. When set to `true` or `auto`, use
466 colors only when the output is to the terminal. Defaults to false.
468 color.interactive.<slot>::
469 Use customized color for `git add --interactive`
470 output. `<slot>` may be `prompt`, `header`, or `help`, for
471 three distinct types of normal output from interactive
472 programs. The values of these variables may be specified as
473 in color.branch.<slot>.
475 color.pager::
476 A boolean to enable/disable colored output when the pager is in
477 use (default is true).
479 color.status::
480 A boolean to enable/disable color in the output of
481 linkgit:git-status[1]. May be set to `always`,
482 `false` (or `never`) or `auto` (or `true`), in which case colors are used
483 only when the output is to a terminal. Defaults to false.
485 color.status.<slot>::
486 Use customized color for status colorization. `<slot>` is
487 one of `header` (the header text of the status message),
488 `added` or `updated` (files which are added but not committed),
489 `changed` (files which are changed but not added in the index),
490 or `untracked` (files which are not tracked by git). The values of
491 these variables may be specified as in color.branch.<slot>.
493 commit.template::
494 Specify a file to use as the template for new commit messages.
496 color.ui::
497 When set to `always`, always use colors in all git commands which
498 are capable of colored output. When false (or `never`), never. When
499 set to `true` or `auto`, use colors only when the output is to the
500 terminal. When more specific variables of color.* are set, they always
501 take precedence over this setting. Defaults to false.
503 diff.autorefreshindex::
504 When using `git diff` to compare with work tree
505 files, do not consider stat-only change as changed.
506 Instead, silently run `git update-index --refresh` to
507 update the cached stat information for paths whose
508 contents in the work tree match the contents in the
509 index. This option defaults to true. Note that this
510 affects only `git diff` Porcelain, and not lower level
511 `diff` commands, such as `git diff-files`.
513 diff.external::
514 If this config variable is set, diff generation is not
515 performed using the internal diff machinery, but using the
516 given command. Note: if you want to use an external diff
517 program only on a subset of your files, you might want to
518 use linkgit:gitattributes[5] instead.
520 diff.renameLimit::
521 The number of files to consider when performing the copy/rename
522 detection; equivalent to the git diff option '-l'.
524 diff.renames::
525 Tells git to detect renames. If set to any boolean value, it
526 will enable basic rename detection. If set to "copies" or
527 "copy", it will detect copies, as well.
529 fetch.unpackLimit::
530 If the number of objects fetched over the git native
531 transfer is below this
532 limit, then the objects will be unpacked into loose object
533 files. However if the number of received objects equals or
534 exceeds this limit then the received pack will be stored as
535 a pack, after adding any missing delta bases. Storing the
536 pack from a push can make the push operation complete faster,
537 especially on slow filesystems. If not set, the value of
538 `transfer.unpackLimit` is used instead.
540 format.numbered::
541 A boolean which can enable sequence numbers in patch subjects.
542 Setting this option to "auto" will enable it only if there is
543 more than one patch. See --numbered option in
544 linkgit:git-format-patch[1].
546 format.headers::
547 Additional email headers to include in a patch to be submitted
548 by mail. See linkgit:git-format-patch[1].
550 format.suffix::
551 The default for format-patch is to output files with the suffix
552 `.patch`. Use this variable to change that suffix (make sure to
553 include the dot if you want it).
555 gc.aggressiveWindow::
556 The window size parameter used in the delta compression
557 algorithm used by 'git gc --aggressive'. This defaults
558 to 10.
561 When there are approximately more than this many loose
562 objects in the repository, `git gc --auto` will pack them.
563 Some Porcelain commands use this command to perform a
564 light-weight garbage collection from time to time. The
565 default value is 6700. Setting this to 0 disables it.
567 gc.autopacklimit::
568 When there are more than this many packs that are not
569 marked with `*.keep` file in the repository, `git gc
570 --auto` consolidates them into one larger pack. The
571 default value is 20. Setting this to 0 disables it.
573 gc.packrefs::
574 `git gc` does not run `git pack-refs` in a bare repository by
575 default so that older dumb-transport clients can still fetch
576 from the repository. Setting this to `true` lets `git
577 gc` to run `git pack-refs`. Setting this to `false` tells
578 `git gc` never to run `git pack-refs`. The default setting is
579 `notbare`. Enable it only when you know you do not have to
580 support such clients. The default setting will change to `true`
581 at some stage, and setting this to `false` will continue to
582 prevent `git pack-refs` from being run from `git gc`.
584 gc.reflogexpire::
585 `git reflog expire` removes reflog entries older than
586 this time; defaults to 90 days.
588 gc.reflogexpireunreachable::
589 `git reflog expire` removes reflog entries older than
590 this time and are not reachable from the current tip;
591 defaults to 30 days.
593 gc.rerereresolved::
594 Records of conflicted merge you resolved earlier are
595 kept for this many days when `git rerere gc` is run.
596 The default is 60 days. See linkgit:git-rerere[1].
598 gc.rerereunresolved::
599 Records of conflicted merge you have not resolved are
600 kept for this many days when `git rerere gc` is run.
601 The default is 15 days. See linkgit:git-rerere[1].
603 rerere.enabled::
604 Activate recording of resolved conflicts, so that identical
605 conflict hunks can be resolved automatically, should they
606 be encountered again. linkgit:git-rerere[1] command is by
607 default enabled if you create `rr-cache` directory under
608 `$GIT_DIR`, but can be disabled by setting this option to false.
610 gitcvs.enabled::
611 Whether the CVS server interface is enabled for this repository.
612 See linkgit:git-cvsserver[1].
614 gitcvs.logfile::
615 Path to a log file where the CVS server interface well... logs
616 various stuff. See linkgit:git-cvsserver[1].
618 gitcvs.allbinary::
619 If true, all files are sent to the client in mode '-kb'. This
620 causes the client to treat all files as binary files which suppresses
621 any newline munging it otherwise might do. A work-around for the
622 fact that there is no way yet to set single files to mode '-kb'.
624 gitcvs.dbname::
625 Database used by git-cvsserver to cache revision information
626 derived from the git repository. The exact meaning depends on the
627 used database driver, for SQLite (which is the default driver) this
628 is a filename. Supports variable substitution (see
629 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
630 Default: '%Ggitcvs.%m.sqlite'
632 gitcvs.dbdriver::
633 Used Perl DBI driver. You can specify any available driver
634 for this here, but it might not work. git-cvsserver is tested
635 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
636 reported *not* to work with 'DBD::mysql'. Experimental feature.
637 May not contain double colons (`:`). Default: 'SQLite'.
638 See linkgit:git-cvsserver[1].
640 gitcvs.dbuser, gitcvs.dbpass::
641 Database user and password. Only useful if setting 'gitcvs.dbdriver',
642 since SQLite has no concept of database users and/or passwords.
643 'gitcvs.dbuser' supports variable substitution (see
644 linkgit:git-cvsserver[1] for details).
646 All gitcvs variables except for 'gitcvs.allbinary' can also be
647 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
648 is one of "ext" and "pserver") to make them apply only for the given
649 access method.
651 help.browser::
652 Specify the browser that will be used to display help in the
653 'web' format. See linkgit:git-help[1].
655 help.format::
656 Override the default help format used by linkgit:git-help[1].
657 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
658 the default. 'web' and 'html' are the same.
660 http.proxy::
661 Override the HTTP proxy, normally configured using the 'http_proxy'
662 environment variable (see linkgit:curl[1]). This can be overridden
663 on a per-remote basis; see remote.<name>.proxy
665 http.sslVerify::
666 Whether to verify the SSL certificate when fetching or pushing
667 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
668 variable.
670 http.sslCert::
671 File containing the SSL certificate when fetching or pushing
672 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
673 variable.
675 http.sslKey::
676 File containing the SSL private key when fetching or pushing
677 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
678 variable.
680 http.sslCAInfo::
681 File containing the certificates to verify the peer with when
682 fetching or pushing over HTTPS. Can be overridden by the
683 'GIT_SSL_CAINFO' environment variable.
685 http.sslCAPath::
686 Path containing files with the CA certificates to verify the peer
687 with when fetching or pushing over HTTPS. Can be overridden
688 by the 'GIT_SSL_CAPATH' environment variable.
690 http.maxRequests::
691 How many HTTP requests to launch in parallel. Can be overridden
692 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
694 http.lowSpeedLimit, http.lowSpeedTime::
695 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
696 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
697 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
698 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
700 http.noEPSV::
701 A boolean which disables using of EPSV ftp command by curl.
702 This can helpful with some "poor" ftp servers which don't
703 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
704 environment variable. Default is false (curl will use EPSV).
706 i18n.commitEncoding::
707 Character encoding the commit messages are stored in; git itself
708 does not care per se, but this information is necessary e.g. when
709 importing commits from emails or in the gitk graphical history
710 browser (and possibly at other places in the future or in other
711 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
713 i18n.logOutputEncoding::
714 Character encoding the commit messages are converted to when
715 running `git-log` and friends.
717 instaweb.browser::
718 Specify the program that will be used to browse your working
719 repository in gitweb. See linkgit:git-instaweb[1].
721 instaweb.httpd::
722 The HTTP daemon command-line to start gitweb on your working
723 repository. See linkgit:git-instaweb[1].
725 instaweb.local::
726 If true the web server started by linkgit:git-instaweb[1] will
727 be bound to the local IP (
729 instaweb.modulepath::
730 The module path for an apache httpd used by linkgit:git-instaweb[1].
732 instaweb.port::
733 The port number to bind the gitweb httpd to. See
734 linkgit:git-instaweb[1].
736 log.showroot::
737 If true, the initial commit will be shown as a big creation event.
738 This is equivalent to a diff against an empty tree.
739 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
740 normally hide the root commit will now show it. True by default.
742 merge.summary::
743 Whether to include summaries of merged commits in newly created
744 merge commit messages. False by default.
746 merge.tool::
747 Controls which merge resolution program is used by
748 linkgit:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff",
749 "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
751 merge.verbosity::
752 Controls the amount of output shown by the recursive merge
753 strategy. Level 0 outputs nothing except a final error
754 message if conflicts were detected. Level 1 outputs only
755 conflicts, 2 outputs conflicts and file changes. Level 5 and
756 above outputs debugging information. The default is level 2.
757 Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
759 merge.<driver>.name::
760 Defines a human readable name for a custom low-level
761 merge driver. See linkgit:gitattributes[5] for details.
763 merge.<driver>.driver::
764 Defines the command that implements a custom low-level
765 merge driver. See linkgit:gitattributes[5] for details.
767 merge.<driver>.recursive::
768 Names a low-level merge driver to be used when
769 performing an internal merge between common ancestors.
770 See linkgit:gitattributes[5] for details.
772 mergetool.<tool>.path::
773 Override the path for the given tool. This is useful in case
774 your tool is not in the PATH.
776 pack.window::
777 The size of the window used by linkgit:git-pack-objects[1] when no
778 window size is given on the command line. Defaults to 10.
780 pack.depth::
781 The maximum delta depth used by linkgit:git-pack-objects[1] when no
782 maximum depth is given on the command line. Defaults to 50.
784 pack.windowMemory::
785 The window memory size limit used by linkgit:git-pack-objects[1]
786 when no limit is given on the command line. The value can be
787 suffixed with "k", "m", or "g". Defaults to 0, meaning no
788 limit.
790 pack.compression::
791 An integer -1..9, indicating the compression level for objects
792 in a pack file. -1 is the zlib default. 0 means no
793 compression, and 1..9 are various speed/size tradeoffs, 9 being
794 slowest. If not set, defaults to core.compression. If that is
795 not set, defaults to -1, the zlib default, which is "a default
796 compromise between speed and compression (currently equivalent
797 to level 6)."
799 pack.deltaCacheSize::
800 The maximum memory in bytes used for caching deltas in
801 linkgit:git-pack-objects[1].
802 A value of 0 means no limit. Defaults to 0.
804 pack.deltaCacheLimit::
805 The maximum size of a delta, that is cached in
806 linkgit:git-pack-objects[1]. Defaults to 1000.
808 pack.threads::
809 Specifies the number of threads to spawn when searching for best
810 delta matches. This requires that linkgit:git-pack-objects[1]
811 be compiled with pthreads otherwise this option is ignored with a
812 warning. This is meant to reduce packing time on multiprocessor
813 machines. The required amount of memory for the delta search window
814 is however multiplied by the number of threads.
816 pack.indexVersion::
817 Specify the default pack index version. Valid values are 1 for
818 legacy pack index used by Git versions prior to 1.5.2, and 2 for
819 the new pack index with capabilities for packs larger than 4 GB
820 as well as proper protection against the repacking of corrupted
821 packs. Version 2 is selected and this config option ignored
822 whenever the corresponding pack is larger than 2 GB. Otherwise
823 the default is 1.
825 pack.packSizeLimit:
826 The default maximum size of a pack. This setting only affects
827 packing to a file, i.e. the git:// protocol is unaffected. It
828 can be overridden by the `\--max-pack-size` option of
829 linkgit:git-repack[1].
831 pull.octopus::
832 The default merge strategy to use when pulling multiple branches
833 at once.
835 pull.twohead::
836 The default merge strategy to use when pulling a single branch.
838 remote.<name>.url::
839 The URL of a remote repository. See linkgit:git-fetch[1] or
840 linkgit:git-push[1].
842 remote.<name>.proxy::
843 For remotes that require curl (http, https and ftp), the URL to
844 the proxy to use for that remote. Set to the empty string to
845 disable proxying for that remote.
847 remote.<name>.fetch::
848 The default set of "refspec" for linkgit:git-fetch[1]. See
849 linkgit:git-fetch[1].
851 remote.<name>.push::
852 The default set of "refspec" for linkgit:git-push[1]. See
853 linkgit:git-push[1].
855 remote.<name>.skipDefaultUpdate::
856 If true, this remote will be skipped by default when updating
857 using the update subcommand of linkgit:git-remote[1].
859 remote.<name>.receivepack::
860 The default program to execute on the remote side when pushing. See
861 option \--exec of linkgit:git-push[1].
863 remote.<name>.uploadpack::
864 The default program to execute on the remote side when fetching. See
865 option \--exec of linkgit:git-fetch-pack[1].
867 remote.<name>.tagopt::
868 Setting this value to --no-tags disables automatic tag following when fetching
869 from remote <name>
871 remotes.<group>::
872 The list of remotes which are fetched by "git remote update
873 <group>". See linkgit:git-remote[1].
875 repack.usedeltabaseoffset::
876 Allow linkgit:git-repack[1] to create packs that uses
877 delta-base offset. Defaults to false.
879 show.difftree::
880 The default linkgit:git-diff-tree[1] arguments to be used
881 for linkgit:git-show[1].
883 showbranch.default::
884 The default set of branches for linkgit:git-show-branch[1].
885 See linkgit:git-show-branch[1].
887 status.relativePaths::
888 By default, linkgit:git-status[1] shows paths relative to the
889 current directory. Setting this variable to `false` shows paths
890 relative to the repository root (this was the default for git
891 prior to v1.5.4).
893 tar.umask::
894 This variable can be used to restrict the permission bits of
895 tar archive entries. The default is 0002, which turns off the
896 world write bit. The special value "user" indicates that the
897 archiving user's umask will be used instead. See umask(2) and
898 linkgit:git-archive[1].
901 Your email address to be recorded in any newly created commits.
902 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
903 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
906 Your full name to be recorded in any newly created commits.
907 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
908 environment variables. See linkgit:git-commit-tree[1].
910 user.signingkey::
911 If linkgit:git-tag[1] is not selecting the key you want it to
912 automatically when creating a signed tag, you can override the
913 default selection with this variable. This option is passed
914 unchanged to gpg's --local-user parameter, so you may specify a key
915 using any method that gpg supports.
917 whatchanged.difftree::
918 The default linkgit:git-diff-tree[1] arguments to be used
919 for linkgit:git-whatchanged[1].
921 imap::
922 The configuration variables in the 'imap' section are described
923 in linkgit:git-imap-send[1].
925 receive.unpackLimit::
926 If the number of objects received in a push is below this
927 limit then the objects will be unpacked into loose object
928 files. However if the number of received objects equals or
929 exceeds this limit then the received pack will be stored as
930 a pack, after adding any missing delta bases. Storing the
931 pack from a push can make the push operation complete faster,
932 especially on slow filesystems. If not set, the value of
933 `transfer.unpackLimit` is used instead.
935 receive.denyNonFastForwards::
936 If set to true, git-receive-pack will deny a ref update which is
937 not a fast forward. Use this to prevent such an update via a push,
938 even if that push is forced. This configuration variable is
939 set when initializing a shared repository.
941 transfer.unpackLimit::
942 When `fetch.unpackLimit` or `receive.unpackLimit` are
943 not set, the value of this variable is used instead.
944 The default value is 100.
946 web.browser::
947 Specify a web browser that may be used by some commands.
948 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
949 may use it.