Merge branch 'jn/gitweb-grep'
[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 the
383 starting point 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. The valid settings are: `false` -- no
386 automatic setup is done; `true` -- automatic setup is done when the
387 starting point is a remote branch; `always` -- automatic setup is
388 done when the starting point is either a local branch or remote
389 branch. This option defaults to true.
391 branch.<name>.remote::
392 When in branch <name>, it tells `git fetch` which remote to fetch.
393 If this option is not given, `git fetch` defaults to remote "origin".
395 branch.<name>.merge::
396 When in branch <name>, it tells `git fetch` the default
397 refspec to be marked for merging in FETCH_HEAD. The value is
398 handled like the remote part of a refspec, and must match a
399 ref which is fetched from the remote given by
400 "branch.<name>.remote".
401 The merge information is used by `git pull` (which at first calls
402 `git fetch`) to lookup the default branch for merging. Without
403 this option, `git pull` defaults to merge the first refspec fetched.
404 Specify multiple values to get an octopus merge.
405 If you wish to setup `git pull` so that it merges into <name> from
406 another branch in the local repository, you can point
407 branch.<name>.merge to the desired branch, and use the special setting
408 `.` (a period) for branch.<name>.remote.
410 branch.<name>.mergeoptions::
411 Sets default options for merging into branch <name>. The syntax and
412 supported options are equal to that of linkgit:git-merge[1], but
413 option values containing whitespace characters are currently not
414 supported.
416 branch.<name>.rebase::
417 When true, rebase the branch <name> on top of the fetched branch,
418 instead of merging the default branch from the default remote.
419 *NOTE*: this is a possibly dangerous operation; do *not* use
420 it unless you understand the implications (see linkgit:git-rebase[1]
421 for details).
423 browser.<tool>.path::
424 Override the path for the given tool that may be used to
425 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
426 working repository in gitweb (see linkgit:git-instaweb[1]).
428 clean.requireForce::
429 A boolean to make git-clean do nothing unless given -f
430 or -n. Defaults to true.
432 color.branch::
433 A boolean to enable/disable color in the output of
434 linkgit:git-branch[1]. May be set to `always`,
435 `false` (or `never`) or `auto` (or `true`), in which case colors are used
436 only when the output is to a terminal. Defaults to false.
438 color.branch.<slot>::
439 Use customized color for branch coloration. `<slot>` is one of
440 `current` (the current branch), `local` (a local branch),
441 `remote` (a tracking branch in refs/remotes/), `plain` (other
442 refs).
443 +
444 The value for these configuration variables is a list of colors (at most
445 two) and attributes (at most one), separated by spaces. The colors
446 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
447 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
448 `blink` and `reverse`. The first color given is the foreground; the
449 second is the background. The position of the attribute, if any,
450 doesn't matter.
452 color.diff::
453 When set to `always`, always use colors in patch.
454 When false (or `never`), never. When set to `true` or `auto`, use
455 colors only when the output is to the terminal. Defaults to false.
457 color.diff.<slot>::
458 Use customized color for diff colorization. `<slot>` specifies
459 which part of the patch to use the specified color, and is one
460 of `plain` (context text), `meta` (metainformation), `frag`
461 (hunk header), `old` (removed lines), `new` (added lines),
462 `commit` (commit headers), or `whitespace` (highlighting
463 whitespace errors). The values of these variables may be specified as
464 in color.branch.<slot>.
466 color.interactive::
467 When set to `always`, always use colors for interactive prompts
468 and displays (such as those used by "git add --interactive").
469 When false (or `never`), never. When set to `true` or `auto`, use
470 colors only when the output is to the terminal. Defaults to false.
472 color.interactive.<slot>::
473 Use customized color for `git add --interactive`
474 output. `<slot>` may be `prompt`, `header`, or `help`, for
475 three distinct types of normal output from interactive
476 programs. The values of these variables may be specified as
477 in color.branch.<slot>.
479 color.pager::
480 A boolean to enable/disable colored output when the pager is in
481 use (default is true).
483 color.status::
484 A boolean to enable/disable color in the output of
485 linkgit:git-status[1]. May be set to `always`,
486 `false` (or `never`) or `auto` (or `true`), in which case colors are used
487 only when the output is to a terminal. Defaults to false.
489 color.status.<slot>::
490 Use customized color for status colorization. `<slot>` is
491 one of `header` (the header text of the status message),
492 `added` or `updated` (files which are added but not committed),
493 `changed` (files which are changed but not added in the index),
494 or `untracked` (files which are not tracked by git). The values of
495 these variables may be specified as in color.branch.<slot>.
497 commit.template::
498 Specify a file to use as the template for new commit messages.
500 color.ui::
501 When set to `always`, always use colors in all git commands which
502 are capable of colored output. When false (or `never`), never. When
503 set to `true` or `auto`, use colors only when the output is to the
504 terminal. When more specific variables of color.* are set, they always
505 take precedence over this setting. Defaults to false.
507 diff.autorefreshindex::
508 When using `git diff` to compare with work tree
509 files, do not consider stat-only change as changed.
510 Instead, silently run `git update-index --refresh` to
511 update the cached stat information for paths whose
512 contents in the work tree match the contents in the
513 index. This option defaults to true. Note that this
514 affects only `git diff` Porcelain, and not lower level
515 `diff` commands, such as `git diff-files`.
517 diff.external::
518 If this config variable is set, diff generation is not
519 performed using the internal diff machinery, but using the
520 given command. Note: if you want to use an external diff
521 program only on a subset of your files, you might want to
522 use linkgit:gitattributes[5] instead.
524 diff.renameLimit::
525 The number of files to consider when performing the copy/rename
526 detection; equivalent to the git diff option '-l'.
528 diff.renames::
529 Tells git to detect renames. If set to any boolean value, it
530 will enable basic rename detection. If set to "copies" or
531 "copy", it will detect copies, as well.
533 fetch.unpackLimit::
534 If the number of objects fetched over the git native
535 transfer is below this
536 limit, then the objects will be unpacked into loose object
537 files. However if the number of received objects equals or
538 exceeds this limit then the received pack will be stored as
539 a pack, after adding any missing delta bases. Storing the
540 pack from a push can make the push operation complete faster,
541 especially on slow filesystems. If not set, the value of
542 `transfer.unpackLimit` is used instead.
544 format.numbered::
545 A boolean which can enable sequence numbers in patch subjects.
546 Setting this option to "auto" will enable it only if there is
547 more than one patch. See --numbered option in
548 linkgit:git-format-patch[1].
550 format.headers::
551 Additional email headers to include in a patch to be submitted
552 by mail. See linkgit:git-format-patch[1].
554 format.suffix::
555 The default for format-patch is to output files with the suffix
556 `.patch`. Use this variable to change that suffix (make sure to
557 include the dot if you want it).
559 gc.aggressiveWindow::
560 The window size parameter used in the delta compression
561 algorithm used by 'git gc --aggressive'. This defaults
562 to 10.
565 When there are approximately more than this many loose
566 objects in the repository, `git gc --auto` will pack them.
567 Some Porcelain commands use this command to perform a
568 light-weight garbage collection from time to time. The
569 default value is 6700. Setting this to 0 disables it.
571 gc.autopacklimit::
572 When there are more than this many packs that are not
573 marked with `*.keep` file in the repository, `git gc
574 --auto` consolidates them into one larger pack. The
575 default value is 20. Setting this to 0 disables it.
577 gc.packrefs::
578 `git gc` does not run `git pack-refs` in a bare repository by
579 default so that older dumb-transport clients can still fetch
580 from the repository. Setting this to `true` lets `git
581 gc` to run `git pack-refs`. Setting this to `false` tells
582 `git gc` never to run `git pack-refs`. The default setting is
583 `notbare`. Enable it only when you know you do not have to
584 support such clients. The default setting will change to `true`
585 at some stage, and setting this to `false` will continue to
586 prevent `git pack-refs` from being run from `git gc`.
588 gc.reflogexpire::
589 `git reflog expire` removes reflog entries older than
590 this time; defaults to 90 days.
592 gc.reflogexpireunreachable::
593 `git reflog expire` removes reflog entries older than
594 this time and are not reachable from the current tip;
595 defaults to 30 days.
597 gc.rerereresolved::
598 Records of conflicted merge you resolved earlier are
599 kept for this many days when `git rerere gc` is run.
600 The default is 60 days. See linkgit:git-rerere[1].
602 gc.rerereunresolved::
603 Records of conflicted merge you have not resolved are
604 kept for this many days when `git rerere gc` is run.
605 The default is 15 days. See linkgit:git-rerere[1].
607 rerere.enabled::
608 Activate recording of resolved conflicts, so that identical
609 conflict hunks can be resolved automatically, should they
610 be encountered again. linkgit:git-rerere[1] command is by
611 default enabled if you create `rr-cache` directory under
612 `$GIT_DIR`, but can be disabled by setting this option to false.
614 gitcvs.enabled::
615 Whether the CVS server interface is enabled for this repository.
616 See linkgit:git-cvsserver[1].
618 gitcvs.logfile::
619 Path to a log file where the CVS server interface well... logs
620 various stuff. See linkgit:git-cvsserver[1].
622 gitcvs.allbinary::
623 If true, all files are sent to the client in mode '-kb'. This
624 causes the client to treat all files as binary files which suppresses
625 any newline munging it otherwise might do. A work-around for the
626 fact that there is no way yet to set single files to mode '-kb'.
628 gitcvs.dbname::
629 Database used by git-cvsserver to cache revision information
630 derived from the git repository. The exact meaning depends on the
631 used database driver, for SQLite (which is the default driver) this
632 is a filename. Supports variable substitution (see
633 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
634 Default: '%Ggitcvs.%m.sqlite'
636 gitcvs.dbdriver::
637 Used Perl DBI driver. You can specify any available driver
638 for this here, but it might not work. git-cvsserver is tested
639 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
640 reported *not* to work with 'DBD::mysql'. Experimental feature.
641 May not contain double colons (`:`). Default: 'SQLite'.
642 See linkgit:git-cvsserver[1].
644 gitcvs.dbuser, gitcvs.dbpass::
645 Database user and password. Only useful if setting 'gitcvs.dbdriver',
646 since SQLite has no concept of database users and/or passwords.
647 'gitcvs.dbuser' supports variable substitution (see
648 linkgit:git-cvsserver[1] for details).
650 All gitcvs variables except for 'gitcvs.allbinary' can also be
651 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
652 is one of "ext" and "pserver") to make them apply only for the given
653 access method.
655 help.browser::
656 Specify the browser that will be used to display help in the
657 'web' format. See linkgit:git-help[1].
659 help.format::
660 Override the default help format used by linkgit:git-help[1].
661 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
662 the default. 'web' and 'html' are the same.
664 http.proxy::
665 Override the HTTP proxy, normally configured using the 'http_proxy'
666 environment variable (see linkgit:curl[1]). This can be overridden
667 on a per-remote basis; see remote.<name>.proxy
669 http.sslVerify::
670 Whether to verify the SSL certificate when fetching or pushing
671 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
672 variable.
674 http.sslCert::
675 File containing the SSL certificate when fetching or pushing
676 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
677 variable.
679 http.sslKey::
680 File containing the SSL private key when fetching or pushing
681 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
682 variable.
684 http.sslCAInfo::
685 File containing the certificates to verify the peer with when
686 fetching or pushing over HTTPS. Can be overridden by the
687 'GIT_SSL_CAINFO' environment variable.
689 http.sslCAPath::
690 Path containing files with the CA certificates to verify the peer
691 with when fetching or pushing over HTTPS. Can be overridden
692 by the 'GIT_SSL_CAPATH' environment variable.
694 http.maxRequests::
695 How many HTTP requests to launch in parallel. Can be overridden
696 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
698 http.lowSpeedLimit, http.lowSpeedTime::
699 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
700 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
701 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
702 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
704 http.noEPSV::
705 A boolean which disables using of EPSV ftp command by curl.
706 This can helpful with some "poor" ftp servers which don't
707 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
708 environment variable. Default is false (curl will use EPSV).
710 i18n.commitEncoding::
711 Character encoding the commit messages are stored in; git itself
712 does not care per se, but this information is necessary e.g. when
713 importing commits from emails or in the gitk graphical history
714 browser (and possibly at other places in the future or in other
715 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
717 i18n.logOutputEncoding::
718 Character encoding the commit messages are converted to when
719 running `git-log` and friends.
721 instaweb.browser::
722 Specify the program that will be used to browse your working
723 repository in gitweb. See linkgit:git-instaweb[1].
725 instaweb.httpd::
726 The HTTP daemon command-line to start gitweb on your working
727 repository. See linkgit:git-instaweb[1].
729 instaweb.local::
730 If true the web server started by linkgit:git-instaweb[1] will
731 be bound to the local IP (
733 instaweb.modulepath::
734 The module path for an apache httpd used by linkgit:git-instaweb[1].
736 instaweb.port::
737 The port number to bind the gitweb httpd to. See
738 linkgit:git-instaweb[1].
740 log.showroot::
741 If true, the initial commit will be shown as a big creation event.
742 This is equivalent to a diff against an empty tree.
743 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
744 normally hide the root commit will now show it. True by default.
746 merge.summary::
747 Whether to include summaries of merged commits in newly created
748 merge commit messages. False by default.
750 merge.tool::
751 Controls which merge resolution program is used by
752 linkgit:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff",
753 "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
755 merge.verbosity::
756 Controls the amount of output shown by the recursive merge
757 strategy. Level 0 outputs nothing except a final error
758 message if conflicts were detected. Level 1 outputs only
759 conflicts, 2 outputs conflicts and file changes. Level 5 and
760 above outputs debugging information. The default is level 2.
761 Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
763 merge.<driver>.name::
764 Defines a human readable name for a custom low-level
765 merge driver. See linkgit:gitattributes[5] for details.
767 merge.<driver>.driver::
768 Defines the command that implements a custom low-level
769 merge driver. See linkgit:gitattributes[5] for details.
771 merge.<driver>.recursive::
772 Names a low-level merge driver to be used when
773 performing an internal merge between common ancestors.
774 See linkgit:gitattributes[5] for details.
776 mergetool.<tool>.path::
777 Override the path for the given tool. This is useful in case
778 your tool is not in the PATH.
780 pack.window::
781 The size of the window used by linkgit:git-pack-objects[1] when no
782 window size is given on the command line. Defaults to 10.
784 pack.depth::
785 The maximum delta depth used by linkgit:git-pack-objects[1] when no
786 maximum depth is given on the command line. Defaults to 50.
788 pack.windowMemory::
789 The window memory size limit used by linkgit:git-pack-objects[1]
790 when no limit is given on the command line. The value can be
791 suffixed with "k", "m", or "g". Defaults to 0, meaning no
792 limit.
794 pack.compression::
795 An integer -1..9, indicating the compression level for objects
796 in a pack file. -1 is the zlib default. 0 means no
797 compression, and 1..9 are various speed/size tradeoffs, 9 being
798 slowest. If not set, defaults to core.compression. If that is
799 not set, defaults to -1, the zlib default, which is "a default
800 compromise between speed and compression (currently equivalent
801 to level 6)."
803 pack.deltaCacheSize::
804 The maximum memory in bytes used for caching deltas in
805 linkgit:git-pack-objects[1].
806 A value of 0 means no limit. Defaults to 0.
808 pack.deltaCacheLimit::
809 The maximum size of a delta, that is cached in
810 linkgit:git-pack-objects[1]. Defaults to 1000.
812 pack.threads::
813 Specifies the number of threads to spawn when searching for best
814 delta matches. This requires that linkgit:git-pack-objects[1]
815 be compiled with pthreads otherwise this option is ignored with a
816 warning. This is meant to reduce packing time on multiprocessor
817 machines. The required amount of memory for the delta search window
818 is however multiplied by the number of threads.
819 Specifying 0 will cause git to auto-detect the number of CPU's
820 and set the number of threads accordingly.
822 pack.indexVersion::
823 Specify the default pack index version. Valid values are 1 for
824 legacy pack index used by Git versions prior to 1.5.2, and 2 for
825 the new pack index with capabilities for packs larger than 4 GB
826 as well as proper protection against the repacking of corrupted
827 packs. Version 2 is selected and this config option ignored
828 whenever the corresponding pack is larger than 2 GB. Otherwise
829 the default is 1.
831 pack.packSizeLimit:
832 The default maximum size of a pack. This setting only affects
833 packing to a file, i.e. the git:// protocol is unaffected. It
834 can be overridden by the `\--max-pack-size` option of
835 linkgit:git-repack[1].
837 pull.octopus::
838 The default merge strategy to use when pulling multiple branches
839 at once.
841 pull.twohead::
842 The default merge strategy to use when pulling a single branch.
844 remote.<name>.url::
845 The URL of a remote repository. See linkgit:git-fetch[1] or
846 linkgit:git-push[1].
848 remote.<name>.proxy::
849 For remotes that require curl (http, https and ftp), the URL to
850 the proxy to use for that remote. Set to the empty string to
851 disable proxying for that remote.
853 remote.<name>.fetch::
854 The default set of "refspec" for linkgit:git-fetch[1]. See
855 linkgit:git-fetch[1].
857 remote.<name>.push::
858 The default set of "refspec" for linkgit:git-push[1]. See
859 linkgit:git-push[1].
861 remote.<name>.skipDefaultUpdate::
862 If true, this remote will be skipped by default when updating
863 using the update subcommand of linkgit:git-remote[1].
865 remote.<name>.receivepack::
866 The default program to execute on the remote side when pushing. See
867 option \--exec of linkgit:git-push[1].
869 remote.<name>.uploadpack::
870 The default program to execute on the remote side when fetching. See
871 option \--exec of linkgit:git-fetch-pack[1].
873 remote.<name>.tagopt::
874 Setting this value to --no-tags disables automatic tag following when fetching
875 from remote <name>
877 remotes.<group>::
878 The list of remotes which are fetched by "git remote update
879 <group>". See linkgit:git-remote[1].
881 repack.usedeltabaseoffset::
882 Allow linkgit:git-repack[1] to create packs that uses
883 delta-base offset. Defaults to false.
885 show.difftree::
886 The default linkgit:git-diff-tree[1] arguments to be used
887 for linkgit:git-show[1].
889 showbranch.default::
890 The default set of branches for linkgit:git-show-branch[1].
891 See linkgit:git-show-branch[1].
893 status.relativePaths::
894 By default, linkgit:git-status[1] shows paths relative to the
895 current directory. Setting this variable to `false` shows paths
896 relative to the repository root (this was the default for git
897 prior to v1.5.4).
899 tar.umask::
900 This variable can be used to restrict the permission bits of
901 tar archive entries. The default is 0002, which turns off the
902 world write bit. The special value "user" indicates that the
903 archiving user's umask will be used instead. See umask(2) and
904 linkgit:git-archive[1].
906 url.<base>.insteadOf::
907 Any URL that starts with this value will be rewritten to
908 start, instead, with <base>. In cases where some site serves a
909 large number of repositories, and serves them with multiple
910 access methods, and some users need to use different access
911 methods, this feature allows people to specify any of the
912 equivalent URLs and have git automatically rewrite the URL to
913 the best alternative for the particular user, even for a
914 never-before-seen repository on the site. When more than one
915 insteadOf strings match a given URL, the longest match is used.
918 Your email address to be recorded in any newly created commits.
919 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
920 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
923 Your full name to be recorded in any newly created commits.
924 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
925 environment variables. See linkgit:git-commit-tree[1].
927 user.signingkey::
928 If linkgit:git-tag[1] is not selecting the key you want it to
929 automatically when creating a signed tag, you can override the
930 default selection with this variable. This option is passed
931 unchanged to gpg's --local-user parameter, so you may specify a key
932 using any method that gpg supports.
934 whatchanged.difftree::
935 The default linkgit:git-diff-tree[1] arguments to be used
936 for linkgit:git-whatchanged[1].
938 imap::
939 The configuration variables in the 'imap' section are described
940 in linkgit:git-imap-send[1].
942 receive.fsckObjects::
943 If it is set to true, git-receive-pack will check all received
944 objects. It will abort in the case of a malformed object or a
945 broken link. The result of an abort are only dangling objects.
946 The default value is true.
948 receive.unpackLimit::
949 If the number of objects received in a push is below this
950 limit then the objects will be unpacked into loose object
951 files. However if the number of received objects equals or
952 exceeds this limit then the received pack will be stored as
953 a pack, after adding any missing delta bases. Storing the
954 pack from a push can make the push operation complete faster,
955 especially on slow filesystems. If not set, the value of
956 `transfer.unpackLimit` is used instead.
958 receive.denyNonFastForwards::
959 If set to true, git-receive-pack will deny a ref update which is
960 not a fast forward. Use this to prevent such an update via a push,
961 even if that push is forced. This configuration variable is
962 set when initializing a shared repository.
964 transfer.unpackLimit::
965 When `fetch.unpackLimit` or `receive.unpackLimit` are
966 not set, the value of this variable is used instead.
967 The default value is 100.
969 web.browser::
970 Specify a web browser that may be used by some commands.
971 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
972 may use it.