add status.relativePaths config variable
[git/dscho.git] / Documentation / config.txt
blob79d51f26ccfa69a3785e6bebcbdce9b320d96e6d
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 alias.*::
299         Command aliases for the gitlink:git[1] command wrapper - e.g.
300         after defining "alias.last = cat-file commit HEAD", the invocation
301         "git last" is equivalent to "git cat-file commit HEAD". To avoid
302         confusion and troubles with script usage, aliases that
303         hide existing git commands are ignored. Arguments are split by
304         spaces, the usual shell quoting and escaping is supported.
305         quote pair and a backslash can be used to quote them.
307 If the alias expansion is prefixed with an exclamation point,
308 it will be treated as a shell command.  For example, defining
309 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
310 "git new" is equivalent to running the shell command
311 "gitk --all --not ORIG_HEAD".
313 apply.whitespace::
314         Tells `git-apply` how to handle whitespaces, in the same way
315         as the '--whitespace' option. See gitlink:git-apply[1].
317 branch.autosetupmerge::
318         Tells `git-branch` and `git-checkout` to setup new branches
319         so that gitlink:git-pull[1] will appropriately merge from that
320         remote branch.  Note that even if this option is not set,
321         this behavior can be chosen per-branch using the `--track`
322         and `--no-track` options.  This option defaults to false.
324 branch.<name>.remote::
325         When in branch <name>, it tells `git fetch` which remote to fetch.
326         If this option is not given, `git fetch` defaults to remote "origin".
328 branch.<name>.merge::
329         When in branch <name>, it tells `git fetch` the default
330         refspec to be marked for merging in FETCH_HEAD. The value is
331         handled like the remote part of a refspec, and must match a
332         ref which is fetched from the remote given by
333         "branch.<name>.remote".
334         The merge information is used by `git pull` (which at first calls
335         `git fetch`) to lookup the default branch for merging. Without
336         this option, `git pull` defaults to merge the first refspec fetched.
337         Specify multiple values to get an octopus merge.
338         If you wish to setup `git pull` so that it merges into <name> from
339         another branch in the local repository, you can point
340         branch.<name>.merge to the desired branch, and use the special setting
341         `.` (a period) for branch.<name>.remote.
343 branch.<name>.mergeoptions::
344         Sets default options for merging into branch <name>. The syntax and
345         supported options are equal to that of gitlink:git-merge[1], but
346         option values containing whitespace characters are currently not
347         supported.
349 branch.<name>.rebase::
350         When true, rebase the branch <name> on top of the fetched branch,
351         instead of merging the default branch from the default remote.
352         *NOTE*: this is a possibly dangerous operation; do *not* use
353         it unless you understand the implications (see gitlink:git-rebase[1]
354         for details).
356 clean.requireForce::
357         A boolean to make git-clean do nothing unless given -f
358         or -n.   Defaults to true.
360 color.branch::
361         A boolean to enable/disable color in the output of
362         gitlink:git-branch[1]. May be set to `always`,
363         `false` (or `never`) or `auto` (or `true`), in which case colors are used
364         only when the output is to a terminal. Defaults to false.
366 color.branch.<slot>::
367         Use customized color for branch coloration. `<slot>` is one of
368         `current` (the current branch), `local` (a local branch),
369         `remote` (a tracking branch in refs/remotes/), `plain` (other
370         refs).
372 The value for these configuration variables is a list of colors (at most
373 two) and attributes (at most one), separated by spaces.  The colors
374 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
375 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
376 `blink` and `reverse`.  The first color given is the foreground; the
377 second is the background.  The position of the attribute, if any,
378 doesn't matter.
380 color.diff::
381         When set to `always`, always use colors in patch.
382         When false (or `never`), never.  When set to `true` or `auto`, use
383         colors only when the output is to the terminal. Defaults to false.
385 color.diff.<slot>::
386         Use customized color for diff colorization.  `<slot>` specifies
387         which part of the patch to use the specified color, and is one
388         of `plain` (context text), `meta` (metainformation), `frag`
389         (hunk header), `old` (removed lines), `new` (added lines),
390         `commit` (commit headers), or `whitespace` (highlighting dubious
391         whitespace).  The values of these variables may be specified as
392         in color.branch.<slot>.
394 color.interactive::
395         When set to `always`, always use colors in `git add --interactive`.
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.interactive.<slot>::
400         Use customized color for `git add --interactive`
401         output. `<slot>` may be `prompt`, `header`, or `help`, for
402         three distinct types of normal output from interactive
403         programs.  The values of these variables may be specified as
404         in color.branch.<slot>.
406 color.pager::
407         A boolean to enable/disable colored output when the pager is in
408         use (default is true).
410 color.status::
411         A boolean to enable/disable color in the output of
412         gitlink:git-status[1]. May be set to `always`,
413         `false` (or `never`) or `auto` (or `true`), in which case colors are used
414         only when the output is to a terminal. Defaults to false.
416 color.status.<slot>::
417         Use customized color for status colorization. `<slot>` is
418         one of `header` (the header text of the status message),
419         `added` or `updated` (files which are added but not committed),
420         `changed` (files which are changed but not added in the index),
421         or `untracked` (files which are not tracked by git). The values of
422         these variables may be specified as in color.branch.<slot>.
424 commit.template::
425         Specify a file to use as the template for new commit messages.
427 diff.autorefreshindex::
428         When using `git diff` to compare with work tree
429         files, do not consider stat-only change as changed.
430         Instead, silently run `git update-index --refresh` to
431         update the cached stat information for paths whose
432         contents in the work tree match the contents in the
433         index.  This option defaults to true.  Note that this
434         affects only `git diff` Porcelain, and not lower level
435         `diff` commands, such as `git diff-files`.
437 diff.renameLimit::
438         The number of files to consider when performing the copy/rename
439         detection; equivalent to the git diff option '-l'.
441 diff.renames::
442         Tells git to detect renames.  If set to any boolean value, it
443         will enable basic rename detection.  If set to "copies" or
444         "copy", it will detect copies, as well.
446 fetch.unpackLimit::
447         If the number of objects fetched over the git native
448         transfer is below this
449         limit, then the objects will be unpacked into loose object
450         files. However if the number of received objects equals or
451         exceeds this limit then the received pack will be stored as
452         a pack, after adding any missing delta bases.  Storing the
453         pack from a push can make the push operation complete faster,
454         especially on slow filesystems.
456 format.numbered::
457         A boolean which can enable sequence numbers in patch subjects.
458         Seting this option to "auto" will enable it only if there is
459         more than one patch.  See --numbered option in
460         gitlink:git-format-patch[1].
462 format.headers::
463         Additional email headers to include in a patch to be submitted
464         by mail.  See gitlink:git-format-patch[1].
466 format.suffix::
467         The default for format-patch is to output files with the suffix
468         `.patch`. Use this variable to change that suffix (make sure to
469         include the dot if you want it).
471 gc.aggressiveWindow::
472         The window size parameter used in the delta compression
473         algorithm used by 'git gc --aggressive'.  This defaults
474         to 10.
476 gc.auto::
477         When there are approximately more than this many loose
478         objects in the repository, `git gc --auto` will pack them.
479         Some Porcelain commands use this command to perform a
480         light-weight garbage collection from time to time.  Setting
481         this to 0 disables it.
483 gc.autopacklimit::
484         When there are more than this many packs that are not
485         marked with `*.keep` file in the repository, `git gc
486         --auto` consolidates them into one larger pack.  Setting
487         this to 0 disables this.
489 gc.packrefs::
490         `git gc` does not run `git pack-refs` in a bare repository by
491         default so that older dumb-transport clients can still fetch
492         from the repository.  Setting this to `true` lets `git
493         gc` to run `git pack-refs`.  Setting this to `false` tells
494         `git gc` never to run `git pack-refs`. The default setting is
495         `notbare`. Enable it only when you know you do not have to
496         support such clients.  The default setting will change to `true`
497         at some stage, and setting this to `false` will continue to
498         prevent `git pack-refs` from being run from `git gc`.
500 gc.reflogexpire::
501         `git reflog expire` removes reflog entries older than
502         this time; defaults to 90 days.
504 gc.reflogexpireunreachable::
505         `git reflog expire` removes reflog entries older than
506         this time and are not reachable from the current tip;
507         defaults to 30 days.
509 gc.rerereresolved::
510         Records of conflicted merge you resolved earlier are
511         kept for this many days when `git rerere gc` is run.
512         The default is 60 days.  See gitlink:git-rerere[1].
514 gc.rerereunresolved::
515         Records of conflicted merge you have not resolved are
516         kept for this many days when `git rerere gc` is run.
517         The default is 15 days.  See gitlink:git-rerere[1].
519 rerere.enabled::
520         Activate recording of resolved conflicts, so that identical
521         conflict hunks can be resolved automatically, should they
522         be encountered again.  gitlink:git-rerere[1] command is by
523         default enabled, but can be disabled by setting this option to
524         false.
526 gitcvs.enabled::
527         Whether the CVS server interface is enabled for this repository.
528         See gitlink:git-cvsserver[1].
530 gitcvs.logfile::
531         Path to a log file where the CVS server interface well... logs
532         various stuff. See gitlink:git-cvsserver[1].
534 gitcvs.allbinary::
535         If true, all files are sent to the client in mode '-kb'. This
536         causes the client to treat all files as binary files which suppresses
537         any newline munging it otherwise might do. A work-around for the
538         fact that there is no way yet to set single files to mode '-kb'.
540 gitcvs.dbname::
541         Database used by git-cvsserver to cache revision information
542         derived from the git repository. The exact meaning depends on the
543         used database driver, for SQLite (which is the default driver) this
544         is a filename. Supports variable substitution (see
545         gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`).
546         Default: '%Ggitcvs.%m.sqlite'
548 gitcvs.dbdriver::
549         Used Perl DBI driver. You can specify any available driver
550         for this here, but it might not work. git-cvsserver is tested
551         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
552         reported *not* to work with 'DBD::mysql'. Experimental feature.
553         May not contain double colons (`:`). Default: 'SQLite'.
554         See gitlink:git-cvsserver[1].
556 gitcvs.dbuser, gitcvs.dbpass::
557         Database user and password. Only useful if setting 'gitcvs.dbdriver',
558         since SQLite has no concept of database users and/or passwords.
559         'gitcvs.dbuser' supports variable substitution (see
560         gitlink:git-cvsserver[1] for details).
562 All gitcvs variables except for 'gitcvs.allbinary' can also be
563 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
564 is one of "ext" and "pserver") to make them apply only for the given
565 access method.
567 http.proxy::
568         Override the HTTP proxy, normally configured using the 'http_proxy'
569         environment variable (see gitlink:curl[1]).  This can be overridden
570         on a per-remote basis; see remote.<name>.proxy
572 http.sslVerify::
573         Whether to verify the SSL certificate when fetching or pushing
574         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
575         variable.
577 http.sslCert::
578         File containing the SSL certificate when fetching or pushing
579         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
580         variable.
582 http.sslKey::
583         File containing the SSL private key when fetching or pushing
584         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
585         variable.
587 http.sslCAInfo::
588         File containing the certificates to verify the peer with when
589         fetching or pushing over HTTPS. Can be overridden by the
590         'GIT_SSL_CAINFO' environment variable.
592 http.sslCAPath::
593         Path containing files with the CA certificates to verify the peer
594         with when fetching or pushing over HTTPS. Can be overridden
595         by the 'GIT_SSL_CAPATH' environment variable.
597 http.maxRequests::
598         How many HTTP requests to launch in parallel. Can be overridden
599         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
601 http.lowSpeedLimit, http.lowSpeedTime::
602         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
603         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
604         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
605         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
607 http.noEPSV::
608         A boolean which disables using of EPSV ftp command by curl.
609         This can helpful with some "poor" ftp servers which don't
610         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
611         environment variable. Default is false (curl will use EPSV).
613 i18n.commitEncoding::
614         Character encoding the commit messages are stored in; git itself
615         does not care per se, but this information is necessary e.g. when
616         importing commits from emails or in the gitk graphical history
617         browser (and possibly at other places in the future or in other
618         porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
620 i18n.logOutputEncoding::
621         Character encoding the commit messages are converted to when
622         running `git-log` and friends.
624 log.showroot::
625         If true, the initial commit will be shown as a big creation event.
626         This is equivalent to a diff against an empty tree.
627         Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
628         normally hide the root commit will now show it. True by default.
630 merge.summary::
631         Whether to include summaries of merged commits in newly created
632         merge commit messages. False by default.
634 merge.tool::
635         Controls which merge resolution program is used by
636         gitlink:git-mergetool[1].  Valid values are: "kdiff3", "tkdiff",
637         "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
639 merge.verbosity::
640         Controls the amount of output shown by the recursive merge
641         strategy.  Level 0 outputs nothing except a final error
642         message if conflicts were detected. Level 1 outputs only
643         conflicts, 2 outputs conflicts and file changes.  Level 5 and
644         above outputs debugging information.  The default is level 2.
645         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
647 merge.<driver>.name::
648         Defines a human readable name for a custom low-level
649         merge driver.  See gitlink:gitattributes[5] for details.
651 merge.<driver>.driver::
652         Defines the command that implements a custom low-level
653         merge driver.  See gitlink:gitattributes[5] for details.
655 merge.<driver>.recursive::
656         Names a low-level merge driver to be used when
657         performing an internal merge between common ancestors.
658         See gitlink:gitattributes[5] for details.
660 pack.window::
661         The size of the window used by gitlink:git-pack-objects[1] when no
662         window size is given on the command line. Defaults to 10.
664 pack.depth::
665         The maximum delta depth used by gitlink:git-pack-objects[1] when no
666         maximum depth is given on the command line. Defaults to 50.
668 pack.windowMemory::
669         The window memory size limit used by gitlink:git-pack-objects[1]
670         when no limit is given on the command line.  The value can be
671         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
672         limit.
674 pack.compression::
675         An integer -1..9, indicating the compression level for objects
676         in a pack file. -1 is the zlib default. 0 means no
677         compression, and 1..9 are various speed/size tradeoffs, 9 being
678         slowest.  If not set,  defaults to core.compression.  If that is
679         not set,  defaults to -1, the zlib default, which is "a default
680         compromise between speed and compression (currently equivalent
681         to level 6)."
683 pack.deltaCacheSize::
684         The maximum memory in bytes used for caching deltas in
685         gitlink:git-pack-objects[1].
686         A value of 0 means no limit. Defaults to 0.
688 pack.deltaCacheLimit::
689         The maximum size of a delta, that is cached in
690         gitlink:git-pack-objects[1]. Defaults to 1000.
692 pack.threads::
693         Specifies the number of threads to spawn when searching for best
694         delta matches.  This requires that gitlink:git-pack-objects[1]
695         be compiled with pthreads otherwise this option is ignored with a
696         warning. This is meant to reduce packing time on multiprocessor
697         machines. The required amount of memory for the delta search window
698         is however multiplied by the number of threads.
700 pack.indexVersion::
701         Specify the default pack index version.  Valid values are 1 for
702         legacy pack index used by Git versions prior to 1.5.2, and 2 for
703         the new pack index with capabilities for packs larger than 4 GB
704         as well as proper protection against the repacking of corrupted
705         packs.  Version 2 is selected and this config option ignored
706         whenever the corresponding pack is larger than 2 GB.  Otherwise
707         the default is 1.
709 pull.octopus::
710         The default merge strategy to use when pulling multiple branches
711         at once.
713 pull.twohead::
714         The default merge strategy to use when pulling a single branch.
716 remote.<name>.url::
717         The URL of a remote repository.  See gitlink:git-fetch[1] or
718         gitlink:git-push[1].
720 remote.<name>.proxy::
721         For remotes that require curl (http, https and ftp), the URL to
722         the proxy to use for that remote.  Set to the empty string to
723         disable proxying for that remote.
725 remote.<name>.fetch::
726         The default set of "refspec" for gitlink:git-fetch[1]. See
727         gitlink:git-fetch[1].
729 remote.<name>.push::
730         The default set of "refspec" for gitlink:git-push[1]. See
731         gitlink:git-push[1].
733 remote.<name>.skipDefaultUpdate::
734         If true, this remote will be skipped by default when updating
735         using the remote subcommand of gitlink:git-remote[1].
737 remote.<name>.receivepack::
738         The default program to execute on the remote side when pushing.  See
739         option \--exec of gitlink:git-push[1].
741 remote.<name>.uploadpack::
742         The default program to execute on the remote side when fetching.  See
743         option \--exec of gitlink:git-fetch-pack[1].
745 remote.<name>.tagopt::
746         Setting this value to --no-tags disables automatic tag following when fetching
747         from remote <name>
749 remotes.<group>::
750         The list of remotes which are fetched by "git remote update
751         <group>".  See gitlink:git-remote[1].
753 repack.usedeltabaseoffset::
754         Allow gitlink:git-repack[1] to create packs that uses
755         delta-base offset.  Defaults to false.
757 show.difftree::
758         The default gitlink:git-diff-tree[1] arguments to be used
759         for gitlink:git-show[1].
761 showbranch.default::
762         The default set of branches for gitlink:git-show-branch[1].
763         See gitlink:git-show-branch[1].
765 status.relativePaths::
766         By default, gitlink:git-status[1] shows paths relative to the
767         current directory. Setting this variable to `false` shows paths
768         relative to the repository root (this was the default for git
769         prior to v1.5.4).
771 tar.umask::
772         This variable can be used to restrict the permission bits of
773         tar archive entries.  The default is 0002, which turns off the
774         world write bit.  The special value "user" indicates that the
775         archiving user's umask will be used instead.  See umask(2) and
776         gitlink:git-archive[1].
778 user.email::
779         Your email address to be recorded in any newly created commits.
780         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
781         'EMAIL' environment variables.  See gitlink:git-commit-tree[1].
783 user.name::
784         Your full name to be recorded in any newly created commits.
785         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
786         environment variables.  See gitlink:git-commit-tree[1].
788 user.signingkey::
789         If gitlink:git-tag[1] is not selecting the key you want it to
790         automatically when creating a signed tag, you can override the
791         default selection with this variable.  This option is passed
792         unchanged to gpg's --local-user parameter, so you may specify a key
793         using any method that gpg supports.
795 whatchanged.difftree::
796         The default gitlink:git-diff-tree[1] arguments to be used
797         for gitlink:git-whatchanged[1].
799 imap::
800         The configuration variables in the 'imap' section are described
801         in gitlink:git-imap-send[1].
803 receive.unpackLimit::
804         If the number of objects received in a push is below this
805         limit then the objects will be unpacked into loose object
806         files. However if the number of received objects equals or
807         exceeds this limit then the received pack will be stored as
808         a pack, after adding any missing delta bases.  Storing the
809         pack from a push can make the push operation complete faster,
810         especially on slow filesystems.
812 receive.denyNonFastForwards::
813         If set to true, git-receive-pack will deny a ref update which is
814         not a fast forward. Use this to prevent such an update via a push,
815         even if that push is forced. This configuration variable is
816         set when initializing a shared repository.
818 transfer.unpackLimit::
819         When `fetch.unpackLimit` or `receive.unpackLimit` are
820         not set, the value of this variable is used instead.