git-submodule: rename shell functions for consistency
[git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
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.
10
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.
17
18 Syntax
19 ~~~~~~
20
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.
24
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.
31
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:
35
36 --------
37         [section "subsection"]
38
39 --------
40
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.
47
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.
51
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.
58
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
61
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".
67
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 '`\`'.
74
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.
79
80 Variable value ending in a '`\`' is continued on the next line in the
81 customary UNIX fashion.
82
83 Some variables may require special value format.
84
85 Example
86 ~~~~~~~
87
88         # Core variables
89         [core]
90                 ; Don't trust file modes
91                 filemode = false
92
93         # Our diff algorithm
94         [diff]
95                 external = "/usr/local/bin/gnu-diff -u"
96                 renames = true
97
98         [branch "devel"]
99                 remote = origin
100                 merge = refs/heads/devel
101
102         # Proxy settings
103         [core]
104                 gitProxy="ssh" for "kernel.org"
105                 gitProxy=default-proxy ; for the rest
106
107 Variables
108 ~~~~~~~~~
109
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.
114
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.
119
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.
131
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.
141
142 core.symlinks::
143         If false, symbolic links are checked out as small plain files that
144         contain the link text. linkgit:git-update-index[1] and
145         linkgit:git-add[1] will not change the recorded type to regular
146         file. Useful on filesystems like FAT that do not support
147         symbolic links. True by default.
148
149 core.gitProxy::
150         A "proxy command" to execute (as 'command host port') instead
151         of establishing direct connection to the remote server when
152         using the git protocol for fetching. If the variable value is
153         in the "COMMAND for DOMAIN" format, the command is applied only
154         on hostnames ending with the specified domain string. This variable
155         may be set multiple times and is matched in the given order;
156         the first match wins.
157 +
158 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
159 (which always applies universally, without the special "for"
160 handling).
161
162 core.ignoreStat::
163         The working copy files are assumed to stay unchanged until you
164         mark them otherwise manually - Git will not detect the file changes
165         by lstat() calls. This is useful on systems where those are very
166         slow, such as Microsoft Windows.  See linkgit:git-update-index[1].
167         False by default.
168
169 core.preferSymlinkRefs::
170         Instead of the default "symref" format for HEAD
171         and other symbolic reference files, use symbolic links.
172         This is sometimes needed to work with old scripts that
173         expect HEAD to be a symbolic link.
174
175 core.bare::
176         If true this repository is assumed to be 'bare' and has no
177         working directory associated with it.  If this is the case a
178         number of commands that require a working directory will be
179         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
180 +
181 This setting is automatically guessed by linkgit:git-clone[1] or
182 linkgit:git-init[1] when the repository was created.  By default a
183 repository that ends in "/.git" is assumed to be not bare (bare =
184 false), while all other repositories are assumed to be bare (bare
185 = true).
186
187 core.worktree::
188         Set the path to the working tree.  The value will not be
189         used in combination with repositories found automatically in
190         a .git directory (i.e. $GIT_DIR is not set).
191         This can be overridden by the GIT_WORK_TREE environment
192         variable and the '--work-tree' command line option.
193
194 core.logAllRefUpdates::
195         Enable the reflog. Updates to a ref <ref> is logged to the file
196         "$GIT_DIR/logs/<ref>", by appending the new and old
197         SHA1, the date/time and the reason of the update, but
198         only when the file exists.  If this configuration
199         variable is set to true, missing "$GIT_DIR/logs/<ref>"
200         file is automatically created for branch heads.
201 +
202 This information can be used to determine what commit
203 was the tip of a branch "2 days ago".
204 +
205 This value is true by default in a repository that has
206 a working directory associated with it, and false by
207 default in a bare repository.
208
209 core.repositoryFormatVersion::
210         Internal variable identifying the repository format and layout
211         version.
212
213 core.sharedRepository::
214         When 'group' (or 'true'), the repository is made shareable between
215         several users in a group (making sure all the files and objects are
216         group-writable). When 'all' (or 'world' or 'everybody'), the
217         repository will be readable by all users, additionally to being
218         group-shareable. When 'umask' (or 'false'), git will use permissions
219         reported by umask(2). See linkgit:git-init[1]. False by default.
220
221 core.warnAmbiguousRefs::
222         If true, git will warn you if the ref name you passed it is ambiguous
223         and might match multiple refs in the .git/refs/ tree. True by default.
224
225 core.compression::
226         An integer -1..9, indicating a default compression level.
227         -1 is the zlib default. 0 means no compression,
228         and 1..9 are various speed/size tradeoffs, 9 being slowest.
229         If set, this provides a default to other compression variables,
230         such as 'core.loosecompression' and 'pack.compression'.
231
232 core.loosecompression::
233         An integer -1..9, indicating the compression level for objects that
234         are not in a pack file. -1 is the zlib default. 0 means no
235         compression, and 1..9 are various speed/size tradeoffs, 9 being
236         slowest.  If not set,  defaults to core.compression.  If that is
237         not set,  defaults to 1 (best speed).
238
239 core.packedGitWindowSize::
240         Number of bytes of a pack file to map into memory in a
241         single mapping operation.  Larger window sizes may allow
242         your system to process a smaller number of large pack files
243         more quickly.  Smaller window sizes will negatively affect
244         performance due to increased calls to the operating system's
245         memory manager, but may improve performance when accessing
246         a large number of large pack files.
247 +
248 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
249 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
250 be reasonable for all users/operating systems.  You probably do
251 not need to adjust this value.
252 +
253 Common unit suffixes of 'k', 'm', or 'g' are supported.
254
255 core.packedGitLimit::
256         Maximum number of bytes to map simultaneously into memory
257         from pack files.  If Git needs to access more than this many
258         bytes at once to complete an operation it will unmap existing
259         regions to reclaim virtual address space within the process.
260 +
261 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
262 This should be reasonable for all users/operating systems, except on
263 the largest projects.  You probably do not need to adjust this value.
264 +
265 Common unit suffixes of 'k', 'm', or 'g' are supported.
266
267 core.deltaBaseCacheLimit::
268         Maximum number of bytes to reserve for caching base objects
269         that multiple deltafied objects reference.  By storing the
270         entire decompressed base objects in a cache Git is able
271         to avoid unpacking and decompressing frequently used base
272         objects multiple times.
273 +
274 Default is 16 MiB on all platforms.  This should be reasonable
275 for all users/operating systems, except on the largest projects.
276 You probably do not need to adjust this value.
277 +
278 Common unit suffixes of 'k', 'm', or 'g' are supported.
279
280 core.excludesfile::
281         In addition to '.gitignore' (per-directory) and
282         '.git/info/exclude', git looks into this file for patterns
283         of files which are not meant to be tracked.  See
284         linkgit:gitignore[5].
285
286 core.editor::
287         Commands such as `commit` and `tag` that lets you edit
288         messages by launching an editor uses the value of this
289         variable when it is set, and the environment variable
290         `GIT_EDITOR` is not set.  The order of preference is
291         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
292         `EDITOR` environment variables and then finally `vi`.
293
294 core.pager::
295         The command that git will use to paginate output.  Can be overridden
296         with the `GIT_PAGER` environment variable.
297
298 core.whitespace::
299         A comma separated list of common whitespace problems to
300         notice.  `git diff` will use `color.diff.whitespace` to
301         highlight them, and `git apply --whitespace=error` will
302         consider them as errors:
303 +
304 * `trailing-space` treats trailing whitespaces at the end of the line
305   as an error (enabled by default).
306 * `space-before-tab` treats a space character that appears immediately
307   before a tab character in the initial indent part of the line as an
308   error (enabled by default).
309 * `indent-with-non-tab` treats a line that is indented with 8 or more
310   space characters as an error (not enabled by default).
311
312 alias.*::
313         Command aliases for the linkgit:git[1] command wrapper - e.g.
314         after defining "alias.last = cat-file commit HEAD", the invocation
315         "git last" is equivalent to "git cat-file commit HEAD". To avoid
316         confusion and troubles with script usage, aliases that
317         hide existing git commands are ignored. Arguments are split by
318         spaces, the usual shell quoting and escaping is supported.
319         quote pair and a backslash can be used to quote them.
320 +
321 If the alias expansion is prefixed with an exclamation point,
322 it will be treated as a shell command.  For example, defining
323 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
324 "git new" is equivalent to running the shell command
325 "gitk --all --not ORIG_HEAD".
326
327 apply.whitespace::
328         Tells `git-apply` how to handle whitespaces, in the same way
329         as the '--whitespace' option. See linkgit:git-apply[1].
330
331 branch.autosetupmerge::
332         Tells `git-branch` and `git-checkout` to setup new branches
333         so that linkgit:git-pull[1] will appropriately merge from that
334         remote branch.  Note that even if this option is not set,
335         this behavior can be chosen per-branch using the `--track`
336         and `--no-track` options.  This option defaults to false.
337
338 branch.<name>.remote::
339         When in branch <name>, it tells `git fetch` which remote to fetch.
340         If this option is not given, `git fetch` defaults to remote "origin".
341
342 branch.<name>.merge::
343         When in branch <name>, it tells `git fetch` the default
344         refspec to be marked for merging in FETCH_HEAD. The value is
345         handled like the remote part of a refspec, and must match a
346         ref which is fetched from the remote given by
347         "branch.<name>.remote".
348         The merge information is used by `git pull` (which at first calls
349         `git fetch`) to lookup the default branch for merging. Without
350         this option, `git pull` defaults to merge the first refspec fetched.
351         Specify multiple values to get an octopus merge.
352         If you wish to setup `git pull` so that it merges into <name> from
353         another branch in the local repository, you can point
354         branch.<name>.merge to the desired branch, and use the special setting
355         `.` (a period) for branch.<name>.remote.
356
357 branch.<name>.mergeoptions::
358         Sets default options for merging into branch <name>. The syntax and
359         supported options are equal to that of linkgit:git-merge[1], but
360         option values containing whitespace characters are currently not
361         supported.
362
363 branch.<name>.rebase::
364         When true, rebase the branch <name> on top of the fetched branch,
365         instead of merging the default branch from the default remote.
366         *NOTE*: this is a possibly dangerous operation; do *not* use
367         it unless you understand the implications (see linkgit:git-rebase[1]
368         for details).
369
370 clean.requireForce::
371         A boolean to make git-clean do nothing unless given -f
372         or -n.   Defaults to true.
373
374 color.branch::
375         A boolean to enable/disable color in the output of
376         linkgit:git-branch[1]. May be set to `always`,
377         `false` (or `never`) or `auto` (or `true`), in which case colors are used
378         only when the output is to a terminal. Defaults to false.
379
380 color.branch.<slot>::
381         Use customized color for branch coloration. `<slot>` is one of
382         `current` (the current branch), `local` (a local branch),
383         `remote` (a tracking branch in refs/remotes/), `plain` (other
384         refs).
385 +
386 The value for these configuration variables is a list of colors (at most
387 two) and attributes (at most one), separated by spaces.  The colors
388 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
389 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
390 `blink` and `reverse`.  The first color given is the foreground; the
391 second is the background.  The position of the attribute, if any,
392 doesn't matter.
393
394 color.diff::
395         When set to `always`, always use colors in patch.
396         When false (or `never`), never.  When set to `true` or `auto`, use
397         colors only when the output is to the terminal. Defaults to false.
398
399 color.diff.<slot>::
400         Use customized color for diff colorization.  `<slot>` specifies
401         which part of the patch to use the specified color, and is one
402         of `plain` (context text), `meta` (metainformation), `frag`
403         (hunk header), `old` (removed lines), `new` (added lines),
404         `commit` (commit headers), or `whitespace` (highlighting
405         whitespace errors). The values of these variables may be specified as
406         in color.branch.<slot>.
407
408 color.interactive::
409         When set to `always`, always use colors for interactive prompts
410         and displays (such as those used by "git add --interactive").
411         When false (or `never`), never.  When set to `true` or `auto`, use
412         colors only when the output is to the terminal. Defaults to false.
413
414 color.interactive.<slot>::
415         Use customized color for `git add --interactive`
416         output. `<slot>` may be `prompt`, `header`, or `help`, for
417         three distinct types of normal output from interactive
418         programs.  The values of these variables may be specified as
419         in color.branch.<slot>.
420
421 color.pager::
422         A boolean to enable/disable colored output when the pager is in
423         use (default is true).
424
425 color.status::
426         A boolean to enable/disable color in the output of
427         linkgit:git-status[1]. May be set to `always`,
428         `false` (or `never`) or `auto` (or `true`), in which case colors are used
429         only when the output is to a terminal. Defaults to false.
430
431 color.status.<slot>::
432         Use customized color for status colorization. `<slot>` is
433         one of `header` (the header text of the status message),
434         `added` or `updated` (files which are added but not committed),
435         `changed` (files which are changed but not added in the index),
436         or `untracked` (files which are not tracked by git). The values of
437         these variables may be specified as in color.branch.<slot>.
438
439 commit.template::
440         Specify a file to use as the template for new commit messages.
441
442 diff.autorefreshindex::
443         When using `git diff` to compare with work tree
444         files, do not consider stat-only change as changed.
445         Instead, silently run `git update-index --refresh` to
446         update the cached stat information for paths whose
447         contents in the work tree match the contents in the
448         index.  This option defaults to true.  Note that this
449         affects only `git diff` Porcelain, and not lower level
450         `diff` commands, such as `git diff-files`.
451
452 diff.external::
453         If this config variable is set, diff generation is not
454         performed using the internal diff machinery, but using the
455         given command.  Note: if you want to use an external diff
456         program only on a subset of your files, you might want to
457         use linkgit:gitattributes[5] instead.
458
459 diff.renameLimit::
460         The number of files to consider when performing the copy/rename
461         detection; equivalent to the git diff option '-l'.
462
463 diff.renames::
464         Tells git to detect renames.  If set to any boolean value, it
465         will enable basic rename detection.  If set to "copies" or
466         "copy", it will detect copies, as well.
467
468 fetch.unpackLimit::
469         If the number of objects fetched over the git native
470         transfer is below this
471         limit, then the objects will be unpacked into loose object
472         files. However if the number of received objects equals or
473         exceeds this limit then the received pack will be stored as
474         a pack, after adding any missing delta bases.  Storing the
475         pack from a push can make the push operation complete faster,
476         especially on slow filesystems.  If not set, the value of
477         `transfer.unpackLimit` is used instead.
478
479 format.numbered::
480         A boolean which can enable sequence numbers in patch subjects.
481         Setting this option to "auto" will enable it only if there is
482         more than one patch.  See --numbered option in
483         linkgit:git-format-patch[1].
484
485 format.headers::
486         Additional email headers to include in a patch to be submitted
487         by mail.  See linkgit:git-format-patch[1].
488
489 format.suffix::
490         The default for format-patch is to output files with the suffix
491         `.patch`. Use this variable to change that suffix (make sure to
492         include the dot if you want it).
493
494 gc.aggressiveWindow::
495         The window size parameter used in the delta compression
496         algorithm used by 'git gc --aggressive'.  This defaults
497         to 10.
498
499 gc.auto::
500         When there are approximately more than this many loose
501         objects in the repository, `git gc --auto` will pack them.
502         Some Porcelain commands use this command to perform a
503         light-weight garbage collection from time to time.  The
504         default value is 6700.  Setting this to 0 disables it.
505
506 gc.autopacklimit::
507         When there are more than this many packs that are not
508         marked with `*.keep` file in the repository, `git gc
509         --auto` consolidates them into one larger pack.  The
510         default value is 20.  Setting this to 0 disables it.
511
512 gc.packrefs::
513         `git gc` does not run `git pack-refs` in a bare repository by
514         default so that older dumb-transport clients can still fetch
515         from the repository.  Setting this to `true` lets `git
516         gc` to run `git pack-refs`.  Setting this to `false` tells
517         `git gc` never to run `git pack-refs`. The default setting is
518         `notbare`. Enable it only when you know you do not have to
519         support such clients.  The default setting will change to `true`
520         at some stage, and setting this to `false` will continue to
521         prevent `git pack-refs` from being run from `git gc`.
522
523 gc.reflogexpire::
524         `git reflog expire` removes reflog entries older than
525         this time; defaults to 90 days.
526
527 gc.reflogexpireunreachable::
528         `git reflog expire` removes reflog entries older than
529         this time and are not reachable from the current tip;
530         defaults to 30 days.
531
532 gc.rerereresolved::
533         Records of conflicted merge you resolved earlier are
534         kept for this many days when `git rerere gc` is run.
535         The default is 60 days.  See linkgit:git-rerere[1].
536
537 gc.rerereunresolved::
538         Records of conflicted merge you have not resolved are
539         kept for this many days when `git rerere gc` is run.
540         The default is 15 days.  See linkgit:git-rerere[1].
541
542 rerere.enabled::
543         Activate recording of resolved conflicts, so that identical
544         conflict hunks can be resolved automatically, should they
545         be encountered again.  linkgit:git-rerere[1] command is by
546         default enabled if you create `rr-cache` directory under
547         `$GIT_DIR`, but can be disabled by setting this option to false.
548
549 gitcvs.enabled::
550         Whether the CVS server interface is enabled for this repository.
551         See linkgit:git-cvsserver[1].
552
553 gitcvs.logfile::
554         Path to a log file where the CVS server interface well... logs
555         various stuff. See linkgit:git-cvsserver[1].
556
557 gitcvs.allbinary::
558         If true, all files are sent to the client in mode '-kb'. This
559         causes the client to treat all files as binary files which suppresses
560         any newline munging it otherwise might do. A work-around for the
561         fact that there is no way yet to set single files to mode '-kb'.
562
563 gitcvs.dbname::
564         Database used by git-cvsserver to cache revision information
565         derived from the git repository. The exact meaning depends on the
566         used database driver, for SQLite (which is the default driver) this
567         is a filename. Supports variable substitution (see
568         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
569         Default: '%Ggitcvs.%m.sqlite'
570
571 gitcvs.dbdriver::
572         Used Perl DBI driver. You can specify any available driver
573         for this here, but it might not work. git-cvsserver is tested
574         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
575         reported *not* to work with 'DBD::mysql'. Experimental feature.
576         May not contain double colons (`:`). Default: 'SQLite'.
577         See linkgit:git-cvsserver[1].
578
579 gitcvs.dbuser, gitcvs.dbpass::
580         Database user and password. Only useful if setting 'gitcvs.dbdriver',
581         since SQLite has no concept of database users and/or passwords.
582         'gitcvs.dbuser' supports variable substitution (see
583         linkgit:git-cvsserver[1] for details).
584
585 All gitcvs variables except for 'gitcvs.allbinary' can also be
586 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
587 is one of "ext" and "pserver") to make them apply only for the given
588 access method.
589
590 help.browser::
591         Specify the browser that will be used to display help in the
592         'web' format. See linkgit:git-help[1].
593
594 help.format::
595         Override the default help format used by linkgit:git-help[1].
596         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
597         the default. 'web' and 'html' are the same.
598
599 http.proxy::
600         Override the HTTP proxy, normally configured using the 'http_proxy'
601         environment variable (see linkgit:curl[1]).  This can be overridden
602         on a per-remote basis; see remote.<name>.proxy
603
604 http.sslVerify::
605         Whether to verify the SSL certificate when fetching or pushing
606         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
607         variable.
608
609 http.sslCert::
610         File containing the SSL certificate when fetching or pushing
611         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
612         variable.
613
614 http.sslKey::
615         File containing the SSL private key when fetching or pushing
616         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
617         variable.
618
619 http.sslCAInfo::
620         File containing the certificates to verify the peer with when
621         fetching or pushing over HTTPS. Can be overridden by the
622         'GIT_SSL_CAINFO' environment variable.
623
624 http.sslCAPath::
625         Path containing files with the CA certificates to verify the peer
626         with when fetching or pushing over HTTPS. Can be overridden
627         by the 'GIT_SSL_CAPATH' environment variable.
628
629 http.maxRequests::
630         How many HTTP requests to launch in parallel. Can be overridden
631         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
632
633 http.lowSpeedLimit, http.lowSpeedTime::
634         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
635         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
636         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
637         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
638
639 http.noEPSV::
640         A boolean which disables using of EPSV ftp command by curl.
641         This can helpful with some "poor" ftp servers which don't
642         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
643         environment variable. Default is false (curl will use EPSV).
644
645 i18n.commitEncoding::
646         Character encoding the commit messages are stored in; git itself
647         does not care per se, but this information is necessary e.g. when
648         importing commits from emails or in the gitk graphical history
649         browser (and possibly at other places in the future or in other
650         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
651
652 i18n.logOutputEncoding::
653         Character encoding the commit messages are converted to when
654         running `git-log` and friends.
655
656 instaweb.browser::
657         Specify the program that will be used to browse your working
658         repository in gitweb. See linkgit:git-instaweb[1].
659
660 instaweb.httpd::
661         The HTTP daemon command-line to start gitweb on your working
662         repository. See linkgit:git-instaweb[1].
663
664 instaweb.local::
665         If true the web server started by linkgit:git-instaweb[1] will
666         be bound to the local IP (127.0.0.1).
667
668 instaweb.modulepath::
669         The module path for an apache httpd used by linkgit:git-instaweb[1].
670
671 instaweb.port::
672         The port number to bind the gitweb httpd to. See
673         linkgit:git-instaweb[1].
674
675 log.showroot::
676         If true, the initial commit will be shown as a big creation event.
677         This is equivalent to a diff against an empty tree.
678         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
679         normally hide the root commit will now show it. True by default.
680
681 merge.summary::
682         Whether to include summaries of merged commits in newly created
683         merge commit messages. False by default.
684
685 merge.tool::
686         Controls which merge resolution program is used by
687         linkgit:git-mergetool[1].  Valid values are: "kdiff3", "tkdiff",
688         "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
689
690 merge.verbosity::
691         Controls the amount of output shown by the recursive merge
692         strategy.  Level 0 outputs nothing except a final error
693         message if conflicts were detected. Level 1 outputs only
694         conflicts, 2 outputs conflicts and file changes.  Level 5 and
695         above outputs debugging information.  The default is level 2.
696         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
697
698 merge.<driver>.name::
699         Defines a human readable name for a custom low-level
700         merge driver.  See linkgit:gitattributes[5] for details.
701
702 merge.<driver>.driver::
703         Defines the command that implements a custom low-level
704         merge driver.  See linkgit:gitattributes[5] for details.
705
706 merge.<driver>.recursive::
707         Names a low-level merge driver to be used when
708         performing an internal merge between common ancestors.
709         See linkgit:gitattributes[5] for details.
710
711 mergetool.<tool>.path::
712         Override the path for the given tool.  This is useful in case
713         your tool is not in the PATH.
714
715 pack.window::
716         The size of the window used by linkgit:git-pack-objects[1] when no
717         window size is given on the command line. Defaults to 10.
718
719 pack.depth::
720         The maximum delta depth used by linkgit:git-pack-objects[1] when no
721         maximum depth is given on the command line. Defaults to 50.
722
723 pack.windowMemory::
724         The window memory size limit used by linkgit:git-pack-objects[1]
725         when no limit is given on the command line.  The value can be
726         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
727         limit.
728
729 pack.compression::
730         An integer -1..9, indicating the compression level for objects
731         in a pack file. -1 is the zlib default. 0 means no
732         compression, and 1..9 are various speed/size tradeoffs, 9 being
733         slowest.  If not set,  defaults to core.compression.  If that is
734         not set,  defaults to -1, the zlib default, which is "a default
735         compromise between speed and compression (currently equivalent
736         to level 6)."
737
738 pack.deltaCacheSize::
739         The maximum memory in bytes used for caching deltas in
740         linkgit:git-pack-objects[1].
741         A value of 0 means no limit. Defaults to 0.
742
743 pack.deltaCacheLimit::
744         The maximum size of a delta, that is cached in
745         linkgit:git-pack-objects[1]. Defaults to 1000.
746
747 pack.threads::
748         Specifies the number of threads to spawn when searching for best
749         delta matches.  This requires that linkgit:git-pack-objects[1]
750         be compiled with pthreads otherwise this option is ignored with a
751         warning. This is meant to reduce packing time on multiprocessor
752         machines. The required amount of memory for the delta search window
753         is however multiplied by the number of threads.
754
755 pack.indexVersion::
756         Specify the default pack index version.  Valid values are 1 for
757         legacy pack index used by Git versions prior to 1.5.2, and 2 for
758         the new pack index with capabilities for packs larger than 4 GB
759         as well as proper protection against the repacking of corrupted
760         packs.  Version 2 is selected and this config option ignored
761         whenever the corresponding pack is larger than 2 GB.  Otherwise
762         the default is 1.
763
764 pull.octopus::
765         The default merge strategy to use when pulling multiple branches
766         at once.
767
768 pull.twohead::
769         The default merge strategy to use when pulling a single branch.
770
771 remote.<name>.url::
772         The URL of a remote repository.  See linkgit:git-fetch[1] or
773         linkgit:git-push[1].
774
775 remote.<name>.proxy::
776         For remotes that require curl (http, https and ftp), the URL to
777         the proxy to use for that remote.  Set to the empty string to
778         disable proxying for that remote.
779
780 remote.<name>.fetch::
781         The default set of "refspec" for linkgit:git-fetch[1]. See
782         linkgit:git-fetch[1].
783
784 remote.<name>.push::
785         The default set of "refspec" for linkgit:git-push[1]. See
786         linkgit:git-push[1].
787
788 remote.<name>.skipDefaultUpdate::
789         If true, this remote will be skipped by default when updating
790         using the update subcommand of linkgit:git-remote[1].
791
792 remote.<name>.receivepack::
793         The default program to execute on the remote side when pushing.  See
794         option \--exec of linkgit:git-push[1].
795
796 remote.<name>.uploadpack::
797         The default program to execute on the remote side when fetching.  See
798         option \--exec of linkgit:git-fetch-pack[1].
799
800 remote.<name>.tagopt::
801         Setting this value to --no-tags disables automatic tag following when fetching
802         from remote <name>
803
804 remotes.<group>::
805         The list of remotes which are fetched by "git remote update
806         <group>".  See linkgit:git-remote[1].
807
808 repack.usedeltabaseoffset::
809         Allow linkgit:git-repack[1] to create packs that uses
810         delta-base offset.  Defaults to false.
811
812 show.difftree::
813         The default linkgit:git-diff-tree[1] arguments to be used
814         for linkgit:git-show[1].
815
816 showbranch.default::
817         The default set of branches for linkgit:git-show-branch[1].
818         See linkgit:git-show-branch[1].
819
820 status.relativePaths::
821         By default, linkgit:git-status[1] shows paths relative to the
822         current directory. Setting this variable to `false` shows paths
823         relative to the repository root (this was the default for git
824         prior to v1.5.4).
825
826 tar.umask::
827         This variable can be used to restrict the permission bits of
828         tar archive entries.  The default is 0002, which turns off the
829         world write bit.  The special value "user" indicates that the
830         archiving user's umask will be used instead.  See umask(2) and
831         linkgit:git-archive[1].
832
833 user.email::
834         Your email address to be recorded in any newly created commits.
835         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
836         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
837
838 user.name::
839         Your full name to be recorded in any newly created commits.
840         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
841         environment variables.  See linkgit:git-commit-tree[1].
842
843 user.signingkey::
844         If linkgit:git-tag[1] is not selecting the key you want it to
845         automatically when creating a signed tag, you can override the
846         default selection with this variable.  This option is passed
847         unchanged to gpg's --local-user parameter, so you may specify a key
848         using any method that gpg supports.
849
850 whatchanged.difftree::
851         The default linkgit:git-diff-tree[1] arguments to be used
852         for linkgit:git-whatchanged[1].
853
854 imap::
855         The configuration variables in the 'imap' section are described
856         in linkgit:git-imap-send[1].
857
858 receive.unpackLimit::
859         If the number of objects received in a push is below this
860         limit then the objects will be unpacked into loose object
861         files. However if the number of received objects equals or
862         exceeds this limit then the received pack will be stored as
863         a pack, after adding any missing delta bases.  Storing the
864         pack from a push can make the push operation complete faster,
865         especially on slow filesystems.  If not set, the value of
866         `transfer.unpackLimit` is used instead.
867
868 receive.denyNonFastForwards::
869         If set to true, git-receive-pack will deny a ref update which is
870         not a fast forward. Use this to prevent such an update via a push,
871         even if that push is forced. This configuration variable is
872         set when initializing a shared repository.
873
874 transfer.unpackLimit::
875         When `fetch.unpackLimit` or `receive.unpackLimit` are
876         not set, the value of this variable is used instead.
877         The default value is 100.
878
879 web.browser::
880         Specify a web browser that may be used by some commands.
881         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
882         may use it.