Documentation cherry-pick: Fix cut-and-paste error
[git/platforms/storm.git] / Documentation / config.txt
blob6d8cca46ab934826a84647cbd6e441fee286f330
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.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.
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.
158 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
159 (which always applies universally, without the special "for"
160 handling).
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.
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.
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].
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).
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.
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.
202 This information can be used to determine what commit
203 was the tip of a branch "2 days ago".
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.
209 core.repositoryFormatVersion::
210         Internal variable identifying the repository format and layout
211         version.
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.
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.
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'.
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).
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.
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.
253 Common unit suffixes of 'k', 'm', or 'g' are supported.
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.
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.
265 Common unit suffixes of 'k', 'm', or 'g' are supported.
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.
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.
278 Common unit suffixes of 'k', 'm', or 'g' are supported.
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].
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`.
294 core.pager::
295         The command that git will use to paginate output.  Can be overridden
296         with the `GIT_PAGER` environment variable.
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:
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).
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.
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".
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].
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 true.
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".
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.
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.
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).
370 browser.<tool>.path::
371         Override the path for the given tool that may be used to
372         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
373         working repository in gitweb (see linkgit:git-instaweb[1]).
375 clean.requireForce::
376         A boolean to make git-clean do nothing unless given -f
377         or -n.   Defaults to true.
379 color.branch::
380         A boolean to enable/disable color in the output of
381         linkgit:git-branch[1]. May be set to `always`,
382         `false` (or `never`) or `auto` (or `true`), in which case colors are used
383         only when the output is to a terminal. Defaults to false.
385 color.branch.<slot>::
386         Use customized color for branch coloration. `<slot>` is one of
387         `current` (the current branch), `local` (a local branch),
388         `remote` (a tracking branch in refs/remotes/), `plain` (other
389         refs).
391 The value for these configuration variables is a list of colors (at most
392 two) and attributes (at most one), separated by spaces.  The colors
393 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
394 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
395 `blink` and `reverse`.  The first color given is the foreground; the
396 second is the background.  The position of the attribute, if any,
397 doesn't matter.
399 color.diff::
400         When set to `always`, always use colors in patch.
401         When false (or `never`), never.  When set to `true` or `auto`, use
402         colors only when the output is to the terminal. Defaults to false.
404 color.diff.<slot>::
405         Use customized color for diff colorization.  `<slot>` specifies
406         which part of the patch to use the specified color, and is one
407         of `plain` (context text), `meta` (metainformation), `frag`
408         (hunk header), `old` (removed lines), `new` (added lines),
409         `commit` (commit headers), or `whitespace` (highlighting
410         whitespace errors). The values of these variables may be specified as
411         in color.branch.<slot>.
413 color.interactive::
414         When set to `always`, always use colors for interactive prompts
415         and displays (such as those used by "git add --interactive").
416         When false (or `never`), never.  When set to `true` or `auto`, use
417         colors only when the output is to the terminal. Defaults to false.
419 color.interactive.<slot>::
420         Use customized color for `git add --interactive`
421         output. `<slot>` may be `prompt`, `header`, or `help`, for
422         three distinct types of normal output from interactive
423         programs.  The values of these variables may be specified as
424         in color.branch.<slot>.
426 color.pager::
427         A boolean to enable/disable colored output when the pager is in
428         use (default is true).
430 color.status::
431         A boolean to enable/disable color in the output of
432         linkgit:git-status[1]. May be set to `always`,
433         `false` (or `never`) or `auto` (or `true`), in which case colors are used
434         only when the output is to a terminal. Defaults to false.
436 color.status.<slot>::
437         Use customized color for status colorization. `<slot>` is
438         one of `header` (the header text of the status message),
439         `added` or `updated` (files which are added but not committed),
440         `changed` (files which are changed but not added in the index),
441         or `untracked` (files which are not tracked by git). The values of
442         these variables may be specified as in color.branch.<slot>.
444 commit.template::
445         Specify a file to use as the template for new commit messages.
447 diff.autorefreshindex::
448         When using `git diff` to compare with work tree
449         files, do not consider stat-only change as changed.
450         Instead, silently run `git update-index --refresh` to
451         update the cached stat information for paths whose
452         contents in the work tree match the contents in the
453         index.  This option defaults to true.  Note that this
454         affects only `git diff` Porcelain, and not lower level
455         `diff` commands, such as `git diff-files`.
457 diff.external::
458         If this config variable is set, diff generation is not
459         performed using the internal diff machinery, but using the
460         given command.  Note: if you want to use an external diff
461         program only on a subset of your files, you might want to
462         use linkgit:gitattributes[5] instead.
464 diff.renameLimit::
465         The number of files to consider when performing the copy/rename
466         detection; equivalent to the git diff option '-l'.
468 diff.renames::
469         Tells git to detect renames.  If set to any boolean value, it
470         will enable basic rename detection.  If set to "copies" or
471         "copy", it will detect copies, as well.
473 fetch.unpackLimit::
474         If the number of objects fetched over the git native
475         transfer is below this
476         limit, then the objects will be unpacked into loose object
477         files. However if the number of received objects equals or
478         exceeds this limit then the received pack will be stored as
479         a pack, after adding any missing delta bases.  Storing the
480         pack from a push can make the push operation complete faster,
481         especially on slow filesystems.  If not set, the value of
482         `transfer.unpackLimit` is used instead.
484 format.numbered::
485         A boolean which can enable sequence numbers in patch subjects.
486         Setting this option to "auto" will enable it only if there is
487         more than one patch.  See --numbered option in
488         linkgit:git-format-patch[1].
490 format.headers::
491         Additional email headers to include in a patch to be submitted
492         by mail.  See linkgit:git-format-patch[1].
494 format.suffix::
495         The default for format-patch is to output files with the suffix
496         `.patch`. Use this variable to change that suffix (make sure to
497         include the dot if you want it).
499 gc.aggressiveWindow::
500         The window size parameter used in the delta compression
501         algorithm used by 'git gc --aggressive'.  This defaults
502         to 10.
504 gc.auto::
505         When there are approximately more than this many loose
506         objects in the repository, `git gc --auto` will pack them.
507         Some Porcelain commands use this command to perform a
508         light-weight garbage collection from time to time.  The
509         default value is 6700.  Setting this to 0 disables it.
511 gc.autopacklimit::
512         When there are more than this many packs that are not
513         marked with `*.keep` file in the repository, `git gc
514         --auto` consolidates them into one larger pack.  The
515         default value is 20.  Setting this to 0 disables it.
517 gc.packrefs::
518         `git gc` does not run `git pack-refs` in a bare repository by
519         default so that older dumb-transport clients can still fetch
520         from the repository.  Setting this to `true` lets `git
521         gc` to run `git pack-refs`.  Setting this to `false` tells
522         `git gc` never to run `git pack-refs`. The default setting is
523         `notbare`. Enable it only when you know you do not have to
524         support such clients.  The default setting will change to `true`
525         at some stage, and setting this to `false` will continue to
526         prevent `git pack-refs` from being run from `git gc`.
528 gc.reflogexpire::
529         `git reflog expire` removes reflog entries older than
530         this time; defaults to 90 days.
532 gc.reflogexpireunreachable::
533         `git reflog expire` removes reflog entries older than
534         this time and are not reachable from the current tip;
535         defaults to 30 days.
537 gc.rerereresolved::
538         Records of conflicted merge you resolved earlier are
539         kept for this many days when `git rerere gc` is run.
540         The default is 60 days.  See linkgit:git-rerere[1].
542 gc.rerereunresolved::
543         Records of conflicted merge you have not resolved are
544         kept for this many days when `git rerere gc` is run.
545         The default is 15 days.  See linkgit:git-rerere[1].
547 rerere.enabled::
548         Activate recording of resolved conflicts, so that identical
549         conflict hunks can be resolved automatically, should they
550         be encountered again.  linkgit:git-rerere[1] command is by
551         default enabled if you create `rr-cache` directory under
552         `$GIT_DIR`, but can be disabled by setting this option to false.
554 gitcvs.enabled::
555         Whether the CVS server interface is enabled for this repository.
556         See linkgit:git-cvsserver[1].
558 gitcvs.logfile::
559         Path to a log file where the CVS server interface well... logs
560         various stuff. See linkgit:git-cvsserver[1].
562 gitcvs.allbinary::
563         If true, all files are sent to the client in mode '-kb'. This
564         causes the client to treat all files as binary files which suppresses
565         any newline munging it otherwise might do. A work-around for the
566         fact that there is no way yet to set single files to mode '-kb'.
568 gitcvs.dbname::
569         Database used by git-cvsserver to cache revision information
570         derived from the git repository. The exact meaning depends on the
571         used database driver, for SQLite (which is the default driver) this
572         is a filename. Supports variable substitution (see
573         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
574         Default: '%Ggitcvs.%m.sqlite'
576 gitcvs.dbdriver::
577         Used Perl DBI driver. You can specify any available driver
578         for this here, but it might not work. git-cvsserver is tested
579         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
580         reported *not* to work with 'DBD::mysql'. Experimental feature.
581         May not contain double colons (`:`). Default: 'SQLite'.
582         See linkgit:git-cvsserver[1].
584 gitcvs.dbuser, gitcvs.dbpass::
585         Database user and password. Only useful if setting 'gitcvs.dbdriver',
586         since SQLite has no concept of database users and/or passwords.
587         'gitcvs.dbuser' supports variable substitution (see
588         linkgit:git-cvsserver[1] for details).
590 All gitcvs variables except for 'gitcvs.allbinary' can also be
591 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
592 is one of "ext" and "pserver") to make them apply only for the given
593 access method.
595 help.browser::
596         Specify the browser that will be used to display help in the
597         'web' format. See linkgit:git-help[1].
599 help.format::
600         Override the default help format used by linkgit:git-help[1].
601         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
602         the default. 'web' and 'html' are the same.
604 http.proxy::
605         Override the HTTP proxy, normally configured using the 'http_proxy'
606         environment variable (see linkgit:curl[1]).  This can be overridden
607         on a per-remote basis; see remote.<name>.proxy
609 http.sslVerify::
610         Whether to verify the SSL certificate when fetching or pushing
611         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
612         variable.
614 http.sslCert::
615         File containing the SSL certificate when fetching or pushing
616         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
617         variable.
619 http.sslKey::
620         File containing the SSL private key when fetching or pushing
621         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
622         variable.
624 http.sslCAInfo::
625         File containing the certificates to verify the peer with when
626         fetching or pushing over HTTPS. Can be overridden by the
627         'GIT_SSL_CAINFO' environment variable.
629 http.sslCAPath::
630         Path containing files with the CA certificates to verify the peer
631         with when fetching or pushing over HTTPS. Can be overridden
632         by the 'GIT_SSL_CAPATH' environment variable.
634 http.maxRequests::
635         How many HTTP requests to launch in parallel. Can be overridden
636         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
638 http.lowSpeedLimit, http.lowSpeedTime::
639         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
640         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
641         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
642         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
644 http.noEPSV::
645         A boolean which disables using of EPSV ftp command by curl.
646         This can helpful with some "poor" ftp servers which don't
647         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
648         environment variable. Default is false (curl will use EPSV).
650 i18n.commitEncoding::
651         Character encoding the commit messages are stored in; git itself
652         does not care per se, but this information is necessary e.g. when
653         importing commits from emails or in the gitk graphical history
654         browser (and possibly at other places in the future or in other
655         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
657 i18n.logOutputEncoding::
658         Character encoding the commit messages are converted to when
659         running `git-log` and friends.
661 instaweb.browser::
662         Specify the program that will be used to browse your working
663         repository in gitweb. See linkgit:git-instaweb[1].
665 instaweb.httpd::
666         The HTTP daemon command-line to start gitweb on your working
667         repository. See linkgit:git-instaweb[1].
669 instaweb.local::
670         If true the web server started by linkgit:git-instaweb[1] will
671         be bound to the local IP (127.0.0.1).
673 instaweb.modulepath::
674         The module path for an apache httpd used by linkgit:git-instaweb[1].
676 instaweb.port::
677         The port number to bind the gitweb httpd to. See
678         linkgit:git-instaweb[1].
680 log.showroot::
681         If true, the initial commit will be shown as a big creation event.
682         This is equivalent to a diff against an empty tree.
683         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
684         normally hide the root commit will now show it. True by default.
686 merge.summary::
687         Whether to include summaries of merged commits in newly created
688         merge commit messages. False by default.
690 merge.tool::
691         Controls which merge resolution program is used by
692         linkgit:git-mergetool[1].  Valid values are: "kdiff3", "tkdiff",
693         "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
695 merge.verbosity::
696         Controls the amount of output shown by the recursive merge
697         strategy.  Level 0 outputs nothing except a final error
698         message if conflicts were detected. Level 1 outputs only
699         conflicts, 2 outputs conflicts and file changes.  Level 5 and
700         above outputs debugging information.  The default is level 2.
701         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
703 merge.<driver>.name::
704         Defines a human readable name for a custom low-level
705         merge driver.  See linkgit:gitattributes[5] for details.
707 merge.<driver>.driver::
708         Defines the command that implements a custom low-level
709         merge driver.  See linkgit:gitattributes[5] for details.
711 merge.<driver>.recursive::
712         Names a low-level merge driver to be used when
713         performing an internal merge between common ancestors.
714         See linkgit:gitattributes[5] for details.
716 mergetool.<tool>.path::
717         Override the path for the given tool.  This is useful in case
718         your tool is not in the PATH.
720 pack.window::
721         The size of the window used by linkgit:git-pack-objects[1] when no
722         window size is given on the command line. Defaults to 10.
724 pack.depth::
725         The maximum delta depth used by linkgit:git-pack-objects[1] when no
726         maximum depth is given on the command line. Defaults to 50.
728 pack.windowMemory::
729         The window memory size limit used by linkgit:git-pack-objects[1]
730         when no limit is given on the command line.  The value can be
731         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
732         limit.
734 pack.compression::
735         An integer -1..9, indicating the compression level for objects
736         in a pack file. -1 is the zlib default. 0 means no
737         compression, and 1..9 are various speed/size tradeoffs, 9 being
738         slowest.  If not set,  defaults to core.compression.  If that is
739         not set,  defaults to -1, the zlib default, which is "a default
740         compromise between speed and compression (currently equivalent
741         to level 6)."
743 pack.deltaCacheSize::
744         The maximum memory in bytes used for caching deltas in
745         linkgit:git-pack-objects[1].
746         A value of 0 means no limit. Defaults to 0.
748 pack.deltaCacheLimit::
749         The maximum size of a delta, that is cached in
750         linkgit:git-pack-objects[1]. Defaults to 1000.
752 pack.threads::
753         Specifies the number of threads to spawn when searching for best
754         delta matches.  This requires that linkgit:git-pack-objects[1]
755         be compiled with pthreads otherwise this option is ignored with a
756         warning. This is meant to reduce packing time on multiprocessor
757         machines. The required amount of memory for the delta search window
758         is however multiplied by the number of threads.
760 pack.indexVersion::
761         Specify the default pack index version.  Valid values are 1 for
762         legacy pack index used by Git versions prior to 1.5.2, and 2 for
763         the new pack index with capabilities for packs larger than 4 GB
764         as well as proper protection against the repacking of corrupted
765         packs.  Version 2 is selected and this config option ignored
766         whenever the corresponding pack is larger than 2 GB.  Otherwise
767         the default is 1.
769 pull.octopus::
770         The default merge strategy to use when pulling multiple branches
771         at once.
773 pull.twohead::
774         The default merge strategy to use when pulling a single branch.
776 remote.<name>.url::
777         The URL of a remote repository.  See linkgit:git-fetch[1] or
778         linkgit:git-push[1].
780 remote.<name>.proxy::
781         For remotes that require curl (http, https and ftp), the URL to
782         the proxy to use for that remote.  Set to the empty string to
783         disable proxying for that remote.
785 remote.<name>.fetch::
786         The default set of "refspec" for linkgit:git-fetch[1]. See
787         linkgit:git-fetch[1].
789 remote.<name>.push::
790         The default set of "refspec" for linkgit:git-push[1]. See
791         linkgit:git-push[1].
793 remote.<name>.skipDefaultUpdate::
794         If true, this remote will be skipped by default when updating
795         using the update subcommand of linkgit:git-remote[1].
797 remote.<name>.receivepack::
798         The default program to execute on the remote side when pushing.  See
799         option \--exec of linkgit:git-push[1].
801 remote.<name>.uploadpack::
802         The default program to execute on the remote side when fetching.  See
803         option \--exec of linkgit:git-fetch-pack[1].
805 remote.<name>.tagopt::
806         Setting this value to --no-tags disables automatic tag following when fetching
807         from remote <name>
809 remotes.<group>::
810         The list of remotes which are fetched by "git remote update
811         <group>".  See linkgit:git-remote[1].
813 repack.usedeltabaseoffset::
814         Allow linkgit:git-repack[1] to create packs that uses
815         delta-base offset.  Defaults to false.
817 show.difftree::
818         The default linkgit:git-diff-tree[1] arguments to be used
819         for linkgit:git-show[1].
821 showbranch.default::
822         The default set of branches for linkgit:git-show-branch[1].
823         See linkgit:git-show-branch[1].
825 status.relativePaths::
826         By default, linkgit:git-status[1] shows paths relative to the
827         current directory. Setting this variable to `false` shows paths
828         relative to the repository root (this was the default for git
829         prior to v1.5.4).
831 tar.umask::
832         This variable can be used to restrict the permission bits of
833         tar archive entries.  The default is 0002, which turns off the
834         world write bit.  The special value "user" indicates that the
835         archiving user's umask will be used instead.  See umask(2) and
836         linkgit:git-archive[1].
838 user.email::
839         Your email address to be recorded in any newly created commits.
840         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
841         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
843 user.name::
844         Your full name to be recorded in any newly created commits.
845         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
846         environment variables.  See linkgit:git-commit-tree[1].
848 user.signingkey::
849         If linkgit:git-tag[1] is not selecting the key you want it to
850         automatically when creating a signed tag, you can override the
851         default selection with this variable.  This option is passed
852         unchanged to gpg's --local-user parameter, so you may specify a key
853         using any method that gpg supports.
855 whatchanged.difftree::
856         The default linkgit:git-diff-tree[1] arguments to be used
857         for linkgit:git-whatchanged[1].
859 imap::
860         The configuration variables in the 'imap' section are described
861         in linkgit:git-imap-send[1].
863 receive.unpackLimit::
864         If the number of objects received in a push is below this
865         limit then the objects will be unpacked into loose object
866         files. However if the number of received objects equals or
867         exceeds this limit then the received pack will be stored as
868         a pack, after adding any missing delta bases.  Storing the
869         pack from a push can make the push operation complete faster,
870         especially on slow filesystems.  If not set, the value of
871         `transfer.unpackLimit` is used instead.
873 receive.denyNonFastForwards::
874         If set to true, git-receive-pack will deny a ref update which is
875         not a fast forward. Use this to prevent such an update via a push,
876         even if that push is forced. This configuration variable is
877         set when initializing a shared repository.
879 transfer.unpackLimit::
880         When `fetch.unpackLimit` or `receive.unpackLimit` are
881         not set, the value of this variable is used instead.
882         The default value is 100.
884 web.browser::
885         Specify a web browser that may be used by some commands.
886         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
887         may use it.