whitespace: fix off-by-one error in non-space-in-indent checking
[git/dscho.git] / Documentation / config.txt
blobfabe7f859f32aa53ae86244f014e58bd3aa5ee3d
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 gitlink: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. gitlink:git-update-index[1] and
145         gitlink: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 gitlink: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 gitlink:git-add[1] or gitlink:git-merge[1].
181 This setting is automatically guessed by gitlink:git-clone[1] or
182 gitlink: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 gitlink: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         gitlink: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 that can be replaced with tab characters.
312 alias.*::
313         Command aliases for the gitlink: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 gitlink:git-apply[1].
331 branch.autosetupmerge::
332         Tells `git-branch` and `git-checkout` to setup new branches
333         so that gitlink: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.
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 gitlink: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 gitlink:git-rebase[1]
368         for details).
370 clean.requireForce::
371         A boolean to make git-clean do nothing unless given -f
372         or -n.   Defaults to true.
374 color.branch::
375         A boolean to enable/disable color in the output of
376         gitlink: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.
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).
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.
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.
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>.
408 color.interactive::
409         When set to `always`, always use colors in `git add --interactive`.
410         When false (or `never`), never.  When set to `true` or `auto`, use
411         colors only when the output is to the terminal. Defaults to false.
413 color.interactive.<slot>::
414         Use customized color for `git add --interactive`
415         output. `<slot>` may be `prompt`, `header`, or `help`, for
416         three distinct types of normal output from interactive
417         programs.  The values of these variables may be specified as
418         in color.branch.<slot>.
420 color.pager::
421         A boolean to enable/disable colored output when the pager is in
422         use (default is true).
424 color.status::
425         A boolean to enable/disable color in the output of
426         gitlink:git-status[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.status.<slot>::
431         Use customized color for status colorization. `<slot>` is
432         one of `header` (the header text of the status message),
433         `added` or `updated` (files which are added but not committed),
434         `changed` (files which are changed but not added in the index),
435         or `untracked` (files which are not tracked by git). The values of
436         these variables may be specified as in color.branch.<slot>.
438 commit.template::
439         Specify a file to use as the template for new commit messages.
441 diff.autorefreshindex::
442         When using `git diff` to compare with work tree
443         files, do not consider stat-only change as changed.
444         Instead, silently run `git update-index --refresh` to
445         update the cached stat information for paths whose
446         contents in the work tree match the contents in the
447         index.  This option defaults to true.  Note that this
448         affects only `git diff` Porcelain, and not lower level
449         `diff` commands, such as `git diff-files`.
451 diff.renameLimit::
452         The number of files to consider when performing the copy/rename
453         detection; equivalent to the git diff option '-l'.
455 diff.renames::
456         Tells git to detect renames.  If set to any boolean value, it
457         will enable basic rename detection.  If set to "copies" or
458         "copy", it will detect copies, as well.
460 fetch.unpackLimit::
461         If the number of objects fetched over the git native
462         transfer is below this
463         limit, then the objects will be unpacked into loose object
464         files. However if the number of received objects equals or
465         exceeds this limit then the received pack will be stored as
466         a pack, after adding any missing delta bases.  Storing the
467         pack from a push can make the push operation complete faster,
468         especially on slow filesystems.
470 format.numbered::
471         A boolean which can enable sequence numbers in patch subjects.
472         Seting this option to "auto" will enable it only if there is
473         more than one patch.  See --numbered option in
474         gitlink:git-format-patch[1].
476 format.headers::
477         Additional email headers to include in a patch to be submitted
478         by mail.  See gitlink:git-format-patch[1].
480 format.suffix::
481         The default for format-patch is to output files with the suffix
482         `.patch`. Use this variable to change that suffix (make sure to
483         include the dot if you want it).
485 gc.aggressiveWindow::
486         The window size parameter used in the delta compression
487         algorithm used by 'git gc --aggressive'.  This defaults
488         to 10.
490 gc.auto::
491         When there are approximately more than this many loose
492         objects in the repository, `git gc --auto` will pack them.
493         Some Porcelain commands use this command to perform a
494         light-weight garbage collection from time to time.  Setting
495         this to 0 disables it.
497 gc.autopacklimit::
498         When there are more than this many packs that are not
499         marked with `*.keep` file in the repository, `git gc
500         --auto` consolidates them into one larger pack.  Setting
501         this to 0 disables this.
503 gc.packrefs::
504         `git gc` does not run `git pack-refs` in a bare repository by
505         default so that older dumb-transport clients can still fetch
506         from the repository.  Setting this to `true` lets `git
507         gc` to run `git pack-refs`.  Setting this to `false` tells
508         `git gc` never to run `git pack-refs`. The default setting is
509         `notbare`. Enable it only when you know you do not have to
510         support such clients.  The default setting will change to `true`
511         at some stage, and setting this to `false` will continue to
512         prevent `git pack-refs` from being run from `git gc`.
514 gc.reflogexpire::
515         `git reflog expire` removes reflog entries older than
516         this time; defaults to 90 days.
518 gc.reflogexpireunreachable::
519         `git reflog expire` removes reflog entries older than
520         this time and are not reachable from the current tip;
521         defaults to 30 days.
523 gc.rerereresolved::
524         Records of conflicted merge you resolved earlier are
525         kept for this many days when `git rerere gc` is run.
526         The default is 60 days.  See gitlink:git-rerere[1].
528 gc.rerereunresolved::
529         Records of conflicted merge you have not resolved are
530         kept for this many days when `git rerere gc` is run.
531         The default is 15 days.  See gitlink:git-rerere[1].
533 rerere.enabled::
534         Activate recording of resolved conflicts, so that identical
535         conflict hunks can be resolved automatically, should they
536         be encountered again.  gitlink:git-rerere[1] command is by
537         default enabled, but can be disabled by setting this option to
538         false.
540 gitcvs.enabled::
541         Whether the CVS server interface is enabled for this repository.
542         See gitlink:git-cvsserver[1].
544 gitcvs.logfile::
545         Path to a log file where the CVS server interface well... logs
546         various stuff. See gitlink:git-cvsserver[1].
548 gitcvs.allbinary::
549         If true, all files are sent to the client in mode '-kb'. This
550         causes the client to treat all files as binary files which suppresses
551         any newline munging it otherwise might do. A work-around for the
552         fact that there is no way yet to set single files to mode '-kb'.
554 gitcvs.dbname::
555         Database used by git-cvsserver to cache revision information
556         derived from the git repository. The exact meaning depends on the
557         used database driver, for SQLite (which is the default driver) this
558         is a filename. Supports variable substitution (see
559         gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`).
560         Default: '%Ggitcvs.%m.sqlite'
562 gitcvs.dbdriver::
563         Used Perl DBI driver. You can specify any available driver
564         for this here, but it might not work. git-cvsserver is tested
565         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
566         reported *not* to work with 'DBD::mysql'. Experimental feature.
567         May not contain double colons (`:`). Default: 'SQLite'.
568         See gitlink:git-cvsserver[1].
570 gitcvs.dbuser, gitcvs.dbpass::
571         Database user and password. Only useful if setting 'gitcvs.dbdriver',
572         since SQLite has no concept of database users and/or passwords.
573         'gitcvs.dbuser' supports variable substitution (see
574         gitlink:git-cvsserver[1] for details).
576 All gitcvs variables except for 'gitcvs.allbinary' can also be
577 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
578 is one of "ext" and "pserver") to make them apply only for the given
579 access method.
581 http.proxy::
582         Override the HTTP proxy, normally configured using the 'http_proxy'
583         environment variable (see gitlink:curl[1]).  This can be overridden
584         on a per-remote basis; see remote.<name>.proxy
586 http.sslVerify::
587         Whether to verify the SSL certificate when fetching or pushing
588         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
589         variable.
591 http.sslCert::
592         File containing the SSL certificate when fetching or pushing
593         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
594         variable.
596 http.sslKey::
597         File containing the SSL private key when fetching or pushing
598         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
599         variable.
601 http.sslCAInfo::
602         File containing the certificates to verify the peer with when
603         fetching or pushing over HTTPS. Can be overridden by the
604         'GIT_SSL_CAINFO' environment variable.
606 http.sslCAPath::
607         Path containing files with the CA certificates to verify the peer
608         with when fetching or pushing over HTTPS. Can be overridden
609         by the 'GIT_SSL_CAPATH' environment variable.
611 http.maxRequests::
612         How many HTTP requests to launch in parallel. Can be overridden
613         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
615 http.lowSpeedLimit, http.lowSpeedTime::
616         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
617         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
618         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
619         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
621 http.noEPSV::
622         A boolean which disables using of EPSV ftp command by curl.
623         This can helpful with some "poor" ftp servers which don't
624         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
625         environment variable. Default is false (curl will use EPSV).
627 i18n.commitEncoding::
628         Character encoding the commit messages are stored in; git itself
629         does not care per se, but this information is necessary e.g. when
630         importing commits from emails or in the gitk graphical history
631         browser (and possibly at other places in the future or in other
632         porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
634 i18n.logOutputEncoding::
635         Character encoding the commit messages are converted to when
636         running `git-log` and friends.
638 log.showroot::
639         If true, the initial commit will be shown as a big creation event.
640         This is equivalent to a diff against an empty tree.
641         Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
642         normally hide the root commit will now show it. True by default.
644 merge.summary::
645         Whether to include summaries of merged commits in newly created
646         merge commit messages. False by default.
648 merge.tool::
649         Controls which merge resolution program is used by
650         gitlink:git-mergetool[1].  Valid values are: "kdiff3", "tkdiff",
651         "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
653 merge.verbosity::
654         Controls the amount of output shown by the recursive merge
655         strategy.  Level 0 outputs nothing except a final error
656         message if conflicts were detected. Level 1 outputs only
657         conflicts, 2 outputs conflicts and file changes.  Level 5 and
658         above outputs debugging information.  The default is level 2.
659         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
661 merge.<driver>.name::
662         Defines a human readable name for a custom low-level
663         merge driver.  See gitlink:gitattributes[5] for details.
665 merge.<driver>.driver::
666         Defines the command that implements a custom low-level
667         merge driver.  See gitlink:gitattributes[5] for details.
669 merge.<driver>.recursive::
670         Names a low-level merge driver to be used when
671         performing an internal merge between common ancestors.
672         See gitlink:gitattributes[5] for details.
674 pack.window::
675         The size of the window used by gitlink:git-pack-objects[1] when no
676         window size is given on the command line. Defaults to 10.
678 pack.depth::
679         The maximum delta depth used by gitlink:git-pack-objects[1] when no
680         maximum depth is given on the command line. Defaults to 50.
682 pack.windowMemory::
683         The window memory size limit used by gitlink:git-pack-objects[1]
684         when no limit is given on the command line.  The value can be
685         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
686         limit.
688 pack.compression::
689         An integer -1..9, indicating the compression level for objects
690         in a pack file. -1 is the zlib default. 0 means no
691         compression, and 1..9 are various speed/size tradeoffs, 9 being
692         slowest.  If not set,  defaults to core.compression.  If that is
693         not set,  defaults to -1, the zlib default, which is "a default
694         compromise between speed and compression (currently equivalent
695         to level 6)."
697 pack.deltaCacheSize::
698         The maximum memory in bytes used for caching deltas in
699         gitlink:git-pack-objects[1].
700         A value of 0 means no limit. Defaults to 0.
702 pack.deltaCacheLimit::
703         The maximum size of a delta, that is cached in
704         gitlink:git-pack-objects[1]. Defaults to 1000.
706 pack.threads::
707         Specifies the number of threads to spawn when searching for best
708         delta matches.  This requires that gitlink:git-pack-objects[1]
709         be compiled with pthreads otherwise this option is ignored with a
710         warning. This is meant to reduce packing time on multiprocessor
711         machines. The required amount of memory for the delta search window
712         is however multiplied by the number of threads.
714 pack.indexVersion::
715         Specify the default pack index version.  Valid values are 1 for
716         legacy pack index used by Git versions prior to 1.5.2, and 2 for
717         the new pack index with capabilities for packs larger than 4 GB
718         as well as proper protection against the repacking of corrupted
719         packs.  Version 2 is selected and this config option ignored
720         whenever the corresponding pack is larger than 2 GB.  Otherwise
721         the default is 1.
723 pull.octopus::
724         The default merge strategy to use when pulling multiple branches
725         at once.
727 pull.twohead::
728         The default merge strategy to use when pulling a single branch.
730 remote.<name>.url::
731         The URL of a remote repository.  See gitlink:git-fetch[1] or
732         gitlink:git-push[1].
734 remote.<name>.proxy::
735         For remotes that require curl (http, https and ftp), the URL to
736         the proxy to use for that remote.  Set to the empty string to
737         disable proxying for that remote.
739 remote.<name>.fetch::
740         The default set of "refspec" for gitlink:git-fetch[1]. See
741         gitlink:git-fetch[1].
743 remote.<name>.push::
744         The default set of "refspec" for gitlink:git-push[1]. See
745         gitlink:git-push[1].
747 remote.<name>.skipDefaultUpdate::
748         If true, this remote will be skipped by default when updating
749         using the remote subcommand of gitlink:git-remote[1].
751 remote.<name>.receivepack::
752         The default program to execute on the remote side when pushing.  See
753         option \--exec of gitlink:git-push[1].
755 remote.<name>.uploadpack::
756         The default program to execute on the remote side when fetching.  See
757         option \--exec of gitlink:git-fetch-pack[1].
759 remote.<name>.tagopt::
760         Setting this value to --no-tags disables automatic tag following when fetching
761         from remote <name>
763 remotes.<group>::
764         The list of remotes which are fetched by "git remote update
765         <group>".  See gitlink:git-remote[1].
767 repack.usedeltabaseoffset::
768         Allow gitlink:git-repack[1] to create packs that uses
769         delta-base offset.  Defaults to false.
771 show.difftree::
772         The default gitlink:git-diff-tree[1] arguments to be used
773         for gitlink:git-show[1].
775 showbranch.default::
776         The default set of branches for gitlink:git-show-branch[1].
777         See gitlink:git-show-branch[1].
779 status.relativePaths::
780         By default, gitlink:git-status[1] shows paths relative to the
781         current directory. Setting this variable to `false` shows paths
782         relative to the repository root (this was the default for git
783         prior to v1.5.4).
785 tar.umask::
786         This variable can be used to restrict the permission bits of
787         tar archive entries.  The default is 0002, which turns off the
788         world write bit.  The special value "user" indicates that the
789         archiving user's umask will be used instead.  See umask(2) and
790         gitlink:git-archive[1].
792 user.email::
793         Your email address to be recorded in any newly created commits.
794         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
795         'EMAIL' environment variables.  See gitlink:git-commit-tree[1].
797 user.name::
798         Your full name to be recorded in any newly created commits.
799         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
800         environment variables.  See gitlink:git-commit-tree[1].
802 user.signingkey::
803         If gitlink:git-tag[1] is not selecting the key you want it to
804         automatically when creating a signed tag, you can override the
805         default selection with this variable.  This option is passed
806         unchanged to gpg's --local-user parameter, so you may specify a key
807         using any method that gpg supports.
809 whatchanged.difftree::
810         The default gitlink:git-diff-tree[1] arguments to be used
811         for gitlink:git-whatchanged[1].
813 imap::
814         The configuration variables in the 'imap' section are described
815         in gitlink:git-imap-send[1].
817 receive.unpackLimit::
818         If the number of objects received in a push is below this
819         limit then the objects will be unpacked into loose object
820         files. However if the number of received objects equals or
821         exceeds this limit then the received pack will be stored as
822         a pack, after adding any missing delta bases.  Storing the
823         pack from a push can make the push operation complete faster,
824         especially on slow filesystems.
826 receive.denyNonFastForwards::
827         If set to true, git-receive-pack will deny a ref update which is
828         not a fast forward. Use this to prevent such an update via a push,
829         even if that push is forced. This configuration variable is
830         set when initializing a shared repository.
832 transfer.unpackLimit::
833         When `fetch.unpackLimit` or `receive.unpackLimit` are
834         not set, the value of this variable is used instead.