safecrlf: Add mechanism to warn about irreversible crlf conversions
[git.git] / Documentation / config.txt
blob7b8cae1541ea6987699472b1b44d593fbddd5dac
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. `.git/config` file for each repository
6 is used to store the information for that repository, and
7 `$HOME/.gitconfig` is used to store per user information to give
8 fallback values for `.git/config` file. The file `/etc/gitconfig`
9 can be used to store system-wide defaults.
11 They can be used by both the git plumbing
12 and the porcelains. The variables are divided into sections, where
13 in the fully qualified variable name the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
18 Syntax
19 ~~~~~~
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored.  The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables.  A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins.  Section names are not case sensitive.  Only alphanumeric
28 characters, '`-`' and '`.`' are allowed in section names.  Each variable
29 must belong to some section, which means that there must be section
30 header before first setting of a variable.
32 Sections can be further divided into subsections.  To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names can contain any characters except newline (doublequote
42 '`"`' and backslash have to be escaped as '`\"`' and '`\\`',
43 respectively) and are case sensitive.  Section header cannot span multiple
44 lines.  Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
48 There is also (case insensitive) alternative `[section.subsection]` syntax.
49 In this syntax subsection names follow the same restrictions as for section
50 name.
52 All the other lines are recognized as setting variables, in the form
53 'name = value'.  If there is no equal sign on the line, the entire line
54 is taken as 'name' and the variable is recognized as boolean "true".
55 The variable names are case-insensitive and only alphanumeric
56 characters and '`-`' are allowed.  There can be more than one value
57 for a given variable; we say then that variable is multivalued.
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
62 The values following the equals sign in variable assign are all either
63 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
64 0/1 or true/false.  Case is not significant in boolean values, when
65 converting value to the canonical form using '--bool' type specifier;
66 `git-config` will ensure that the output is "true" or "false".
68 String values may be entirely or partially enclosed in double quotes.
69 You need to enclose variable value in double quotes if you want to
70 preserve leading or trailing whitespace, or if variable value contains
71 beginning of comment characters (if it contains '#' or ';').
72 Double quote '`"`' and backslash '`\`' characters in variable value must
73 be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
75 The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76 '`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77 and '`\b`' for backspace (BS).  No other char escape sequence, nor octal
78 char sequences are valid.
80 Variable value ending in a '`\`' is continued on the next line in the
81 customary UNIX fashion.
83 Some variables may require special value format.
85 Example
86 ~~~~~~~
88         # Core variables
89         [core]
90                 ; Don't trust file modes
91                 filemode = false
93         # Our diff algorithm
94         [diff]
95                 external = "/usr/local/bin/gnu-diff -u"
96                 renames = true
98         [branch "devel"]
99                 remote = origin
100                 merge = refs/heads/devel
102         # Proxy settings
103         [core]
104                 gitProxy="ssh" for "kernel.org"
105                 gitProxy=default-proxy ; for the rest
107 Variables
108 ~~~~~~~~~
110 Note that this list is non-comprehensive and not necessarily complete.
111 For command-specific variables, you will find a more detailed description
112 in the appropriate manual page. You will find a description of non-core
113 porcelain configuration variables in the respective porcelain documentation.
115 core.fileMode::
116         If false, the executable bit differences between the index and
117         the working copy are ignored; useful on broken filesystems like FAT.
118         See linkgit:git-update-index[1]. True by default.
120 core.quotepath::
121         The commands that output paths (e.g. `ls-files`,
122         `diff`), when not given the `-z` option, will quote
123         "unusual" characters in the pathname by enclosing the
124         pathname in a double-quote pair and with backslashes the
125         same way strings in C source code are quoted.  If this
126         variable is set to false, the bytes higher than 0x80 are
127         not quoted but output as verbatim.  Note that double
128         quote, backslash and control characters are always
129         quoted without `-z` regardless of the setting of this
130         variable.
132 core.autocrlf::
133         If true, makes git convert `CRLF` at the end of lines in text files to
134         `LF` when reading from the filesystem, and convert in reverse when
135         writing to the filesystem.  The variable can be set to
136         'input', in which case the conversion happens only while
137         reading from the filesystem but files are written out with
138         `LF` at the end of lines.  Currently, which paths to consider
139         "text" (i.e. be subjected to the autocrlf mechanism) is
140         decided purely based on the contents.
142 core.safecrlf::
143         If true, makes git check if converting `CRLF` as controlled by
144         `core.autocrlf` is reversible.  Git will verify if a command
145         modifies a file in the work tree either directly or indirectly.
146         For example, committing a file followed by checking out the
147         same file should yield the original file in the work tree.  If
148         this is not the case for the current setting of
149         `core.autocrlf`, git will reject the file.  The variable can
150         be set to "warn", in which case git will only warn about an
151         irreversible conversion but continue the operation.
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.
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.
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.
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.
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].
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.
247 This information can be used to determine what commit
248 was the tip of a branch "2 days ago".
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.
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.
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.
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.
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.
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.
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:
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).
357 alias.*::
358         Command aliases for the linkgit:git[1] command wrapper - e.g.
359         after defining "alias.last = cat-file commit HEAD", the invocation
360         "git last" is equivalent to "git cat-file commit HEAD". To avoid
361         confusion and troubles with script usage, aliases that
362         hide existing git commands are ignored. Arguments are split by
363         spaces, the usual shell quoting and escaping is supported.
364         quote pair and a backslash can be used to quote them.
366 If the alias expansion is prefixed with an exclamation point,
367 it will be treated as a shell command.  For example, defining
368 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
369 "git new" is equivalent to running the shell command
370 "gitk --all --not ORIG_HEAD".
372 apply.whitespace::
373         Tells `git-apply` how to handle whitespaces, in the same way
374         as the '--whitespace' option. See linkgit:git-apply[1].
376 branch.autosetupmerge::
377         Tells `git-branch` and `git-checkout` to setup new branches
378         so that linkgit:git-pull[1] will appropriately merge from that
379         remote branch.  Note that even if this option is not set,
380         this behavior can be chosen per-branch using the `--track`
381         and `--no-track` options.  This option defaults to false.
383 branch.<name>.remote::
384         When in branch <name>, it tells `git fetch` which remote to fetch.
385         If this option is not given, `git fetch` defaults to remote "origin".
387 branch.<name>.merge::
388         When in branch <name>, it tells `git fetch` the default
389         refspec to be marked for merging in FETCH_HEAD. The value is
390         handled like the remote part of a refspec, and must match a
391         ref which is fetched from the remote given by
392         "branch.<name>.remote".
393         The merge information is used by `git pull` (which at first calls
394         `git fetch`) to lookup the default branch for merging. Without
395         this option, `git pull` defaults to merge the first refspec fetched.
396         Specify multiple values to get an octopus merge.
397         If you wish to setup `git pull` so that it merges into <name> from
398         another branch in the local repository, you can point
399         branch.<name>.merge to the desired branch, and use the special setting
400         `.` (a period) for branch.<name>.remote.
402 branch.<name>.mergeoptions::
403         Sets default options for merging into branch <name>. The syntax and
404         supported options are equal to that of linkgit:git-merge[1], but
405         option values containing whitespace characters are currently not
406         supported.
408 branch.<name>.rebase::
409         When true, rebase the branch <name> on top of the fetched branch,
410         instead of merging the default branch from the default remote.
411         *NOTE*: this is a possibly dangerous operation; do *not* use
412         it unless you understand the implications (see linkgit:git-rebase[1]
413         for details).
415 browser.<tool>.path::
416         Override the path for the given tool that may be used to
417         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
418         working repository in gitweb (see linkgit:git-instaweb[1]).
420 clean.requireForce::
421         A boolean to make git-clean do nothing unless given -f
422         or -n.   Defaults to true.
424 color.branch::
425         A boolean to enable/disable color in the output of
426         linkgit:git-branch[1]. May be set to `always`,
427         `false` (or `never`) or `auto` (or `true`), in which case colors are used
428         only when the output is to a terminal. Defaults to false.
430 color.branch.<slot>::
431         Use customized color for branch coloration. `<slot>` is one of
432         `current` (the current branch), `local` (a local branch),
433         `remote` (a tracking branch in refs/remotes/), `plain` (other
434         refs).
436 The value for these configuration variables is a list of colors (at most
437 two) and attributes (at most one), separated by spaces.  The colors
438 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
439 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
440 `blink` and `reverse`.  The first color given is the foreground; the
441 second is the background.  The position of the attribute, if any,
442 doesn't matter.
444 color.diff::
445         When set to `always`, always use colors in patch.
446         When false (or `never`), never.  When set to `true` or `auto`, use
447         colors only when the output is to the terminal. Defaults to false.
449 color.diff.<slot>::
450         Use customized color for diff colorization.  `<slot>` specifies
451         which part of the patch to use the specified color, and is one
452         of `plain` (context text), `meta` (metainformation), `frag`
453         (hunk header), `old` (removed lines), `new` (added lines),
454         `commit` (commit headers), or `whitespace` (highlighting
455         whitespace errors). The values of these variables may be specified as
456         in color.branch.<slot>.
458 color.interactive::
459         When set to `always`, always use colors for interactive prompts
460         and displays (such as those used by "git add --interactive").
461         When false (or `never`), never.  When set to `true` or `auto`, use
462         colors only when the output is to the terminal. Defaults to false.
464 color.interactive.<slot>::
465         Use customized color for `git add --interactive`
466         output. `<slot>` may be `prompt`, `header`, or `help`, for
467         three distinct types of normal output from interactive
468         programs.  The values of these variables may be specified as
469         in color.branch.<slot>.
471 color.pager::
472         A boolean to enable/disable colored output when the pager is in
473         use (default is true).
475 color.status::
476         A boolean to enable/disable color in the output of
477         linkgit:git-status[1]. May be set to `always`,
478         `false` (or `never`) or `auto` (or `true`), in which case colors are used
479         only when the output is to a terminal. Defaults to false.
481 color.status.<slot>::
482         Use customized color for status colorization. `<slot>` is
483         one of `header` (the header text of the status message),
484         `added` or `updated` (files which are added but not committed),
485         `changed` (files which are changed but not added in the index),
486         or `untracked` (files which are not tracked by git). The values of
487         these variables may be specified as in color.branch.<slot>.
489 commit.template::
490         Specify a file to use as the template for new commit messages.
492 diff.autorefreshindex::
493         When using `git diff` to compare with work tree
494         files, do not consider stat-only change as changed.
495         Instead, silently run `git update-index --refresh` to
496         update the cached stat information for paths whose
497         contents in the work tree match the contents in the
498         index.  This option defaults to true.  Note that this
499         affects only `git diff` Porcelain, and not lower level
500         `diff` commands, such as `git diff-files`.
502 diff.external::
503         If this config variable is set, diff generation is not
504         performed using the internal diff machinery, but using the
505         given command.  Note: if you want to use an external diff
506         program only on a subset of your files, you might want to
507         use linkgit:gitattributes[5] instead.
509 diff.renameLimit::
510         The number of files to consider when performing the copy/rename
511         detection; equivalent to the git diff option '-l'.
513 diff.renames::
514         Tells git to detect renames.  If set to any boolean value, it
515         will enable basic rename detection.  If set to "copies" or
516         "copy", it will detect copies, as well.
518 fetch.unpackLimit::
519         If the number of objects fetched over the git native
520         transfer is below this
521         limit, then the objects will be unpacked into loose object
522         files. However if the number of received objects equals or
523         exceeds this limit then the received pack will be stored as
524         a pack, after adding any missing delta bases.  Storing the
525         pack from a push can make the push operation complete faster,
526         especially on slow filesystems.  If not set, the value of
527         `transfer.unpackLimit` is used instead.
529 format.numbered::
530         A boolean which can enable sequence numbers in patch subjects.
531         Setting this option to "auto" will enable it only if there is
532         more than one patch.  See --numbered option in
533         linkgit:git-format-patch[1].
535 format.headers::
536         Additional email headers to include in a patch to be submitted
537         by mail.  See linkgit:git-format-patch[1].
539 format.suffix::
540         The default for format-patch is to output files with the suffix
541         `.patch`. Use this variable to change that suffix (make sure to
542         include the dot if you want it).
544 gc.aggressiveWindow::
545         The window size parameter used in the delta compression
546         algorithm used by 'git gc --aggressive'.  This defaults
547         to 10.
549 gc.auto::
550         When there are approximately more than this many loose
551         objects in the repository, `git gc --auto` will pack them.
552         Some Porcelain commands use this command to perform a
553         light-weight garbage collection from time to time.  The
554         default value is 6700.  Setting this to 0 disables it.
556 gc.autopacklimit::
557         When there are more than this many packs that are not
558         marked with `*.keep` file in the repository, `git gc
559         --auto` consolidates them into one larger pack.  The
560         default value is 20.  Setting this to 0 disables it.
562 gc.packrefs::
563         `git gc` does not run `git pack-refs` in a bare repository by
564         default so that older dumb-transport clients can still fetch
565         from the repository.  Setting this to `true` lets `git
566         gc` to run `git pack-refs`.  Setting this to `false` tells
567         `git gc` never to run `git pack-refs`. The default setting is
568         `notbare`. Enable it only when you know you do not have to
569         support such clients.  The default setting will change to `true`
570         at some stage, and setting this to `false` will continue to
571         prevent `git pack-refs` from being run from `git gc`.
573 gc.reflogexpire::
574         `git reflog expire` removes reflog entries older than
575         this time; defaults to 90 days.
577 gc.reflogexpireunreachable::
578         `git reflog expire` removes reflog entries older than
579         this time and are not reachable from the current tip;
580         defaults to 30 days.
582 gc.rerereresolved::
583         Records of conflicted merge you resolved earlier are
584         kept for this many days when `git rerere gc` is run.
585         The default is 60 days.  See linkgit:git-rerere[1].
587 gc.rerereunresolved::
588         Records of conflicted merge you have not resolved are
589         kept for this many days when `git rerere gc` is run.
590         The default is 15 days.  See linkgit:git-rerere[1].
592 rerere.enabled::
593         Activate recording of resolved conflicts, so that identical
594         conflict hunks can be resolved automatically, should they
595         be encountered again.  linkgit:git-rerere[1] command is by
596         default enabled if you create `rr-cache` directory under
597         `$GIT_DIR`, but can be disabled by setting this option to false.
599 gitcvs.enabled::
600         Whether the CVS server interface is enabled for this repository.
601         See linkgit:git-cvsserver[1].
603 gitcvs.logfile::
604         Path to a log file where the CVS server interface well... logs
605         various stuff. See linkgit:git-cvsserver[1].
607 gitcvs.allbinary::
608         If true, all files are sent to the client in mode '-kb'. This
609         causes the client to treat all files as binary files which suppresses
610         any newline munging it otherwise might do. A work-around for the
611         fact that there is no way yet to set single files to mode '-kb'.
613 gitcvs.dbname::
614         Database used by git-cvsserver to cache revision information
615         derived from the git repository. The exact meaning depends on the
616         used database driver, for SQLite (which is the default driver) this
617         is a filename. Supports variable substitution (see
618         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
619         Default: '%Ggitcvs.%m.sqlite'
621 gitcvs.dbdriver::
622         Used Perl DBI driver. You can specify any available driver
623         for this here, but it might not work. git-cvsserver is tested
624         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
625         reported *not* to work with 'DBD::mysql'. Experimental feature.
626         May not contain double colons (`:`). Default: 'SQLite'.
627         See linkgit:git-cvsserver[1].
629 gitcvs.dbuser, gitcvs.dbpass::
630         Database user and password. Only useful if setting 'gitcvs.dbdriver',
631         since SQLite has no concept of database users and/or passwords.
632         'gitcvs.dbuser' supports variable substitution (see
633         linkgit:git-cvsserver[1] for details).
635 All gitcvs variables except for 'gitcvs.allbinary' can also be
636 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
637 is one of "ext" and "pserver") to make them apply only for the given
638 access method.
640 help.browser::
641         Specify the browser that will be used to display help in the
642         'web' format. See linkgit:git-help[1].
644 help.format::
645         Override the default help format used by linkgit:git-help[1].
646         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
647         the default. 'web' and 'html' are the same.
649 http.proxy::
650         Override the HTTP proxy, normally configured using the 'http_proxy'
651         environment variable (see linkgit:curl[1]).  This can be overridden
652         on a per-remote basis; see remote.<name>.proxy
654 http.sslVerify::
655         Whether to verify the SSL certificate when fetching or pushing
656         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
657         variable.
659 http.sslCert::
660         File containing the SSL certificate when fetching or pushing
661         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
662         variable.
664 http.sslKey::
665         File containing the SSL private key when fetching or pushing
666         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
667         variable.
669 http.sslCAInfo::
670         File containing the certificates to verify the peer with when
671         fetching or pushing over HTTPS. Can be overridden by the
672         'GIT_SSL_CAINFO' environment variable.
674 http.sslCAPath::
675         Path containing files with the CA certificates to verify the peer
676         with when fetching or pushing over HTTPS. Can be overridden
677         by the 'GIT_SSL_CAPATH' environment variable.
679 http.maxRequests::
680         How many HTTP requests to launch in parallel. Can be overridden
681         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
683 http.lowSpeedLimit, http.lowSpeedTime::
684         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
685         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
686         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
687         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
689 http.noEPSV::
690         A boolean which disables using of EPSV ftp command by curl.
691         This can helpful with some "poor" ftp servers which don't
692         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
693         environment variable. Default is false (curl will use EPSV).
695 i18n.commitEncoding::
696         Character encoding the commit messages are stored in; git itself
697         does not care per se, but this information is necessary e.g. when
698         importing commits from emails or in the gitk graphical history
699         browser (and possibly at other places in the future or in other
700         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
702 i18n.logOutputEncoding::
703         Character encoding the commit messages are converted to when
704         running `git-log` and friends.
706 instaweb.browser::
707         Specify the program that will be used to browse your working
708         repository in gitweb. See linkgit:git-instaweb[1].
710 instaweb.httpd::
711         The HTTP daemon command-line to start gitweb on your working
712         repository. See linkgit:git-instaweb[1].
714 instaweb.local::
715         If true the web server started by linkgit:git-instaweb[1] will
716         be bound to the local IP (127.0.0.1).
718 instaweb.modulepath::
719         The module path for an apache httpd used by linkgit:git-instaweb[1].
721 instaweb.port::
722         The port number to bind the gitweb httpd to. See
723         linkgit:git-instaweb[1].
725 log.showroot::
726         If true, the initial commit will be shown as a big creation event.
727         This is equivalent to a diff against an empty tree.
728         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
729         normally hide the root commit will now show it. True by default.
731 merge.summary::
732         Whether to include summaries of merged commits in newly created
733         merge commit messages. False by default.
735 merge.tool::
736         Controls which merge resolution program is used by
737         linkgit:git-mergetool[1].  Valid values are: "kdiff3", "tkdiff",
738         "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
740 merge.verbosity::
741         Controls the amount of output shown by the recursive merge
742         strategy.  Level 0 outputs nothing except a final error
743         message if conflicts were detected. Level 1 outputs only
744         conflicts, 2 outputs conflicts and file changes.  Level 5 and
745         above outputs debugging information.  The default is level 2.
746         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
748 merge.<driver>.name::
749         Defines a human readable name for a custom low-level
750         merge driver.  See linkgit:gitattributes[5] for details.
752 merge.<driver>.driver::
753         Defines the command that implements a custom low-level
754         merge driver.  See linkgit:gitattributes[5] for details.
756 merge.<driver>.recursive::
757         Names a low-level merge driver to be used when
758         performing an internal merge between common ancestors.
759         See linkgit:gitattributes[5] for details.
761 mergetool.<tool>.path::
762         Override the path for the given tool.  This is useful in case
763         your tool is not in the PATH.
765 pack.window::
766         The size of the window used by linkgit:git-pack-objects[1] when no
767         window size is given on the command line. Defaults to 10.
769 pack.depth::
770         The maximum delta depth used by linkgit:git-pack-objects[1] when no
771         maximum depth is given on the command line. Defaults to 50.
773 pack.windowMemory::
774         The window memory size limit used by linkgit:git-pack-objects[1]
775         when no limit is given on the command line.  The value can be
776         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
777         limit.
779 pack.compression::
780         An integer -1..9, indicating the compression level for objects
781         in a pack file. -1 is the zlib default. 0 means no
782         compression, and 1..9 are various speed/size tradeoffs, 9 being
783         slowest.  If not set,  defaults to core.compression.  If that is
784         not set,  defaults to -1, the zlib default, which is "a default
785         compromise between speed and compression (currently equivalent
786         to level 6)."
788 pack.deltaCacheSize::
789         The maximum memory in bytes used for caching deltas in
790         linkgit:git-pack-objects[1].
791         A value of 0 means no limit. Defaults to 0.
793 pack.deltaCacheLimit::
794         The maximum size of a delta, that is cached in
795         linkgit:git-pack-objects[1]. Defaults to 1000.
797 pack.threads::
798         Specifies the number of threads to spawn when searching for best
799         delta matches.  This requires that linkgit:git-pack-objects[1]
800         be compiled with pthreads otherwise this option is ignored with a
801         warning. This is meant to reduce packing time on multiprocessor
802         machines. The required amount of memory for the delta search window
803         is however multiplied by the number of threads.
805 pack.indexVersion::
806         Specify the default pack index version.  Valid values are 1 for
807         legacy pack index used by Git versions prior to 1.5.2, and 2 for
808         the new pack index with capabilities for packs larger than 4 GB
809         as well as proper protection against the repacking of corrupted
810         packs.  Version 2 is selected and this config option ignored
811         whenever the corresponding pack is larger than 2 GB.  Otherwise
812         the default is 1.
814 pull.octopus::
815         The default merge strategy to use when pulling multiple branches
816         at once.
818 pull.twohead::
819         The default merge strategy to use when pulling a single branch.
821 remote.<name>.url::
822         The URL of a remote repository.  See linkgit:git-fetch[1] or
823         linkgit:git-push[1].
825 remote.<name>.proxy::
826         For remotes that require curl (http, https and ftp), the URL to
827         the proxy to use for that remote.  Set to the empty string to
828         disable proxying for that remote.
830 remote.<name>.fetch::
831         The default set of "refspec" for linkgit:git-fetch[1]. See
832         linkgit:git-fetch[1].
834 remote.<name>.push::
835         The default set of "refspec" for linkgit:git-push[1]. See
836         linkgit:git-push[1].
838 remote.<name>.skipDefaultUpdate::
839         If true, this remote will be skipped by default when updating
840         using the update subcommand of linkgit:git-remote[1].
842 remote.<name>.receivepack::
843         The default program to execute on the remote side when pushing.  See
844         option \--exec of linkgit:git-push[1].
846 remote.<name>.uploadpack::
847         The default program to execute on the remote side when fetching.  See
848         option \--exec of linkgit:git-fetch-pack[1].
850 remote.<name>.tagopt::
851         Setting this value to --no-tags disables automatic tag following when fetching
852         from remote <name>
854 remotes.<group>::
855         The list of remotes which are fetched by "git remote update
856         <group>".  See linkgit:git-remote[1].
858 repack.usedeltabaseoffset::
859         Allow linkgit:git-repack[1] to create packs that uses
860         delta-base offset.  Defaults to false.
862 show.difftree::
863         The default linkgit:git-diff-tree[1] arguments to be used
864         for linkgit:git-show[1].
866 showbranch.default::
867         The default set of branches for linkgit:git-show-branch[1].
868         See linkgit:git-show-branch[1].
870 status.relativePaths::
871         By default, linkgit:git-status[1] shows paths relative to the
872         current directory. Setting this variable to `false` shows paths
873         relative to the repository root (this was the default for git
874         prior to v1.5.4).
876 tar.umask::
877         This variable can be used to restrict the permission bits of
878         tar archive entries.  The default is 0002, which turns off the
879         world write bit.  The special value "user" indicates that the
880         archiving user's umask will be used instead.  See umask(2) and
881         linkgit:git-archive[1].
883 user.email::
884         Your email address to be recorded in any newly created commits.
885         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
886         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
888 user.name::
889         Your full name to be recorded in any newly created commits.
890         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
891         environment variables.  See linkgit:git-commit-tree[1].
893 user.signingkey::
894         If linkgit:git-tag[1] is not selecting the key you want it to
895         automatically when creating a signed tag, you can override the
896         default selection with this variable.  This option is passed
897         unchanged to gpg's --local-user parameter, so you may specify a key
898         using any method that gpg supports.
900 whatchanged.difftree::
901         The default linkgit:git-diff-tree[1] arguments to be used
902         for linkgit:git-whatchanged[1].
904 imap::
905         The configuration variables in the 'imap' section are described
906         in linkgit:git-imap-send[1].
908 receive.unpackLimit::
909         If the number of objects received in a push is below this
910         limit then the objects will be unpacked into loose object
911         files. However if the number of received objects equals or
912         exceeds this limit then the received pack will be stored as
913         a pack, after adding any missing delta bases.  Storing the
914         pack from a push can make the push operation complete faster,
915         especially on slow filesystems.  If not set, the value of
916         `transfer.unpackLimit` is used instead.
918 receive.denyNonFastForwards::
919         If set to true, git-receive-pack will deny a ref update which is
920         not a fast forward. Use this to prevent such an update via a push,
921         even if that push is forced. This configuration variable is
922         set when initializing a shared repository.
924 transfer.unpackLimit::
925         When `fetch.unpackLimit` or `receive.unpackLimit` are
926         not set, the value of this variable is used instead.
927         The default value is 100.
929 web.browser::
930         Specify a web browser that may be used by some commands.
931         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
932         may use it.