blob: edf50cd2113e73daa0a05c16a416424441f010f3 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamano8f76dc62007-01-17 07:24:255the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
Junio C Hamano79556902007-02-24 11:15:548fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
Junio C Hamano8f76dc62007-01-17 07:24:2510
11They can be used by both the git plumbing
Junio C Hamanof1d14802006-06-08 00:48:1712and the porcelains. The variables are divided into sections, where
Junio C Hamano07824ce2006-04-25 07:36:5413in the fully qualified variable name the variable itself is the last
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Junio C Hamanobee172f2007-01-23 08:44:1818Syntax
19~~~~~~
20
Junio C Hamano07824ce2006-04-25 07:36:5421The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1822ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must belong to some section, which means that there must be section
30header before first setting of a variable.
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
34in the section header, like in example below:
35
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanofa0d4cf2007-01-25 02:23:5841Subsection names can contain any characters except newline (doublequote
42'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
Junio C Hamanoee1e4282007-02-04 08:32:0443respectively) and are case sensitive. Section header cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1844lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
51
52All 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
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
56characters and '`-`' are allowed. There can be more than one value
57for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
640/1 or true/false. Case is not significant in boolean values, when
65converting value to the canonical form using '--bool' type specifier;
Junio C Hamano7ad22dc2007-01-29 02:55:4866`git-config` will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1867
68String values may be entirely or partially enclosed in double quotes.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
75The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77and '`\b`' for backspace (BS). No other char escape sequence, nor octal
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary UNIX fashion.
82
83Some variables may require special value format.
Junio C Hamano07824ce2006-04-25 07:36:5484
85Example
86~~~~~~~
87
88# Core variables
89[core]
90; Don't trust file modes
91filemode = false
92
93# Our diff algorithm
94[diff]
95external = "/usr/local/bin/gnu-diff -u"
96renames = true
97
Junio C Hamano52401ef2006-12-19 00:54:3898[branch "devel"]
99remote = origin
100merge = refs/heads/devel
101
Junio C Hamanobee172f2007-01-23 08:44:18102# Proxy settings
103[core]
Junio C Hamanoc71a8732007-08-04 00:27:26104gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18105gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38106
Junio C Hamano07824ce2006-04-25 07:36:54107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116If false, the executable bit differences between the index and
117the working copy are ignored; useful on broken filesystems like FAT.
118See gitlink:git-update-index[1]. True by default.
119
Junio C Hamanod526ba92007-07-02 00:17:42120core.quotepath::
121The 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
124pathname in a double-quote pair and with backslashes the
125same way strings in C source code are quoted. If this
126variable is set to false, the bytes higher than 0x80 are
127not quoted but output as verbatim. Note that double
128quote, backslash and control characters are always
129quoted without `-z` regardless of the setting of this
130variable.
131
Junio C Hamanod9e0e5d2007-04-14 16:22:04132core.autocrlf::
133If 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
135writing to the filesystem. The variable can be set to
136'input', in which case the conversion happens only while
137reading 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
140decided purely based on the contents.
141
Junio C Hamanoaa83a7d2007-03-05 02:37:29142core.symlinks::
143If false, symbolic links are checked out as small plain files that
144contain the link text. gitlink:git-update-index[1] and
145gitlink:git-add[1] will not change the recorded type to regular
146file. Useful on filesystems like FAT that do not support
147symbolic links. True by default.
148
Junio C Hamano07824ce2006-04-25 07:36:54149core.gitProxy::
150A "proxy command" to execute (as 'command host port') instead
151of establishing direct connection to the remote server when
152using the git protocol for fetching. If the variable value is
153in the "COMMAND for DOMAIN" format, the command is applied only
154on hostnames ending with the specified domain string. This variable
155may be set multiple times and is matched in the given order;
156the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17157+
158Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
159(which always applies universally, without the special "for"
160handling).
Junio C Hamano07824ce2006-04-25 07:36:54161
162core.ignoreStat::
163The working copy files are assumed to stay unchanged until you
164mark them otherwise manually - Git will not detect the file changes
165by lstat() calls. This is useful on systems where those are very
166slow, such as Microsoft Windows. See gitlink:git-update-index[1].
167False by default.
168
Junio C Hamano88a3a072006-05-04 08:01:43169core.preferSymlinkRefs::
170Instead of the default "symref" format for HEAD
171and other symbolic reference files, use symbolic links.
172This is sometimes needed to work with old scripts that
173expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54174
Junio C Hamano1025e752007-02-23 07:21:26175core.bare::
176If true this repository is assumed to be 'bare' and has no
177working directory associated with it. If this is the case a
178number of commands that require a working directory will be
179disabled, such as gitlink:git-add[1] or gitlink:git-merge[1].
180+
181This setting is automatically guessed by gitlink:git-clone[1] or
182gitlink:git-init[1] when the repository was created. By default a
183repository that ends in "/.git" is assumed to be not bare (bare =
184false), while all other repositories are assumed to be bare (bare
185= true).
186
Junio C Hamanod526ba92007-07-02 00:17:42187core.worktree::
188Set the path to the working tree. The value will not be
189used in combination with repositories found automatically in
190a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31191This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanod526ba92007-07-02 00:17:42192variable and the '--work-tree' command line option.
193
Junio C Hamano341071d2006-06-04 07:24:48194core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49195Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48196"$GIT_DIR/logs/<ref>", by appending the new and old
197SHA1, the date/time and the reason of the update, but
198only when the file exists. If this configuration
199variable is set to true, missing "$GIT_DIR/logs/<ref>"
200file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35201+
202This information can be used to determine what commit
203was the tip of a branch "2 days ago".
204+
205This value is true by default in a repository that has
206a working directory associated with it, and false by
207default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48208
Junio C Hamano07824ce2006-04-25 07:36:54209core.repositoryFormatVersion::
210Internal variable identifying the repository format and layout
211version.
212
213core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42214When 'group' (or 'true'), the repository is made shareable between
215several users in a group (making sure all the files and objects are
216group-writable). When 'all' (or 'world' or 'everybody'), the
217repository will be readable by all users, additionally to being
218group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano24351a82007-01-13 08:09:17219reported by umask(2). See gitlink:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54220
221core.warnAmbiguousRefs::
222If true, git will warn you if the ref name you passed it is ambiguous
223and might match multiple refs in the .git/refs/ tree. True by default.
224
Junio C Hamano7ec15722006-07-07 02:03:59225core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09226An integer -1..9, indicating a default compression level.
227-1 is the zlib default. 0 means no compression,
228and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamanoa126a3b2006-07-04 04:55:26229
Junio C Hamanof2ce2972007-05-20 19:12:09230core.loosecompression::
231An integer -1..9, indicating the compression level for objects that
232are not in a pack file. -1 is the zlib default. 0 means no
233compression, and 1..9 are various speed/size tradeoffs, 9 being
234slowest. If not set, defaults to core.compression. If that is
235not set, defaults to 0 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49236
Junio C Hamanofc4d38c2007-01-08 06:53:32237core.packedGitWindowSize::
238Number of bytes of a pack file to map into memory in a
239single mapping operation. Larger window sizes may allow
240your system to process a smaller number of large pack files
241more quickly. Smaller window sizes will negatively affect
242performance due to increased calls to the operating system's
243memory manager, but may improve performance when accessing
244a large number of large pack files.
245+
246Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
247MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
248be reasonable for all users/operating systems. You probably do
249not need to adjust this value.
250+
251Common unit suffixes of 'k', 'm', or 'g' are supported.
252
253core.packedGitLimit::
254Maximum number of bytes to map simultaneously into memory
255from pack files. If Git needs to access more than this many
256bytes at once to complete an operation it will unmap existing
257regions to reclaim virtual address space within the process.
258+
259Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
260This should be reasonable for all users/operating systems, except on
261the largest projects. You probably do not need to adjust this value.
262+
263Common unit suffixes of 'k', 'm', or 'g' are supported.
264
Junio C Hamanob8c51282007-03-19 10:43:30265core.deltaBaseCacheLimit::
266Maximum number of bytes to reserve for caching base objects
267that multiple deltafied objects reference. By storing the
268entire decompressed base objects in a cache Git is able
269to avoid unpacking and decompressing frequently used base
270objects multiple times.
271+
272Default is 16 MiB on all platforms. This should be reasonable
273for all users/operating systems, except on the largest projects.
274You probably do not need to adjust this value.
275+
276Common unit suffixes of 'k', 'm', or 'g' are supported.
277
Junio C Hamano1d90cb02007-07-03 07:05:31278core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37279In addition to '.gitignore' (per-directory) and
280'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44281of files which are not meant to be tracked. See
282gitlink:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37283
Junio C Hamanof6002a92007-07-20 10:28:22284core.editor::
285Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27286messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22287variable when it is set, and the environment variable
288`GIT_EDITOR` is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42289`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
290`EDITOR` environment variables and then finally `vi`.
Junio C Hamanof6002a92007-07-20 10:28:22291
Junio C Hamano28d8ede2007-07-05 05:51:38292core.pager::
293The command that git will use to paginate output. Can be overridden
294with the `GIT_PAGER` environment variable.
295
Junio C Hamano33db4372006-06-07 19:51:45296alias.*::
297Command aliases for the gitlink:git[1] command wrapper - e.g.
298after defining "alias.last = cat-file commit HEAD", the invocation
299"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17300confusion and troubles with script usage, aliases that
301hide existing git commands are ignored. Arguments are split by
302spaces, the usual shell quoting and escaping is supported.
303quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39304+
305If the alias expansion is prefixed with an exclamation point,
306it will be treated as a shell command. For example, defining
307"alias.new = !gitk --all --not ORIG_HEAD", the invocation
308"git new" is equivalent to running the shell command
309"gitk --all --not ORIG_HEAD".
Junio C Hamano9cb74f22007-02-12 04:15:05310
Junio C Hamano07824ce2006-04-25 07:36:54311apply.whitespace::
312Tells `git-apply` how to handle whitespaces, in the same way
313as the '--whitespace' option. See gitlink:git-apply[1].
314
Junio C Hamano7fd84172007-05-24 07:00:32315branch.autosetupmerge::
316Tells `git-branch` and `git-checkout` to setup new branches
317so that gitlink:git-pull[1] will appropriately merge from that
318remote branch. Note that even if this option is not set,
319this behavior can be chosen per-branch using the `--track`
Junio C Hamano9cb39172007-07-12 06:45:37320and `--no-track` options. This option defaults to false.
Junio C Hamano7fd84172007-05-24 07:00:32321
Junio C Hamano47c1e3c2006-09-25 04:45:55322branch.<name>.remote::
323When in branch <name>, it tells `git fetch` which remote to fetch.
Junio C Hamano96010b22006-12-09 21:15:46324If this option is not given, `git fetch` defaults to remote "origin".
Junio C Hamano47c1e3c2006-09-25 04:45:55325
326branch.<name>.merge::
Junio C Hamanoc2b47092007-10-25 06:50:31327When in branch <name>, it tells `git fetch` the default
328refspec to be marked for merging in FETCH_HEAD. The value is
329handled like the remote part of a refspec, and must match a
330ref which is fetched from the remote given by
331"branch.<name>.remote".
Junio C Hamano96010b22006-12-09 21:15:46332The merge information is used by `git pull` (which at first calls
333`git fetch`) to lookup the default branch for merging. Without
334this option, `git pull` defaults to merge the first refspec fetched.
335Specify multiple values to get an octopus merge.
Junio C Hamano6e149c02007-03-16 10:21:07336If you wish to setup `git pull` so that it merges into <name> from
337another branch in the local repository, you can point
338branch.<name>.merge to the desired branch, and use the special setting
339`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55340
Junio C Hamano1b50ce92007-10-03 12:05:53341branch.<name>.mergeoptions::
342Sets default options for merging into branch <name>. The syntax and
343supported options are equal to that of gitlink:git-merge[1], but
344option values containing whitespace characters are currently not
345supported.
346
Junio C Hamano47b9acd2007-04-24 07:34:34347clean.requireForce::
348A boolean to make git-clean do nothing unless given -f or -n. Defaults
349to false.
350
Junio C Hamanoeb692952007-01-03 22:02:12351color.branch::
352A boolean to enable/disable color in the output of
353gitlink:git-branch[1]. May be set to `true` (or `always`),
354`false` (or `never`) or `auto`, in which case colors are used
355only when the output is to a terminal. Defaults to false.
356
357color.branch.<slot>::
358Use customized color for branch coloration. `<slot>` is one of
359`current` (the current branch), `local` (a local branch),
360`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22361refs).
362+
363The value for these configuration variables is a list of colors (at most
364two) and attributes (at most one), separated by spaces. The colors
365accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
366`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
367`blink` and `reverse`. The first color given is the foreground; the
368second is the background. The position of the attribute, if any,
369doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12370
Junio C Hamano3f403b02006-12-13 10:14:13371color.diff::
Junio C Hamano9ae1a062006-07-10 08:12:34372When true (or `always`), always use colors in patch.
373When false (or `never`), never. When set to `auto`, use
374colors only when the output is to the terminal.
375
Junio C Hamano3f403b02006-12-13 10:14:13376color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22377Use customized color for diff colorization. `<slot>` specifies
378which part of the patch to use the specified color, and is one
379of `plain` (context text), `meta` (metainformation), `frag`
380(hunk header), `old` (removed lines), `new` (added lines),
381`commit` (commit headers), or `whitespace` (highlighting dubious
382whitespace). The values of these variables may be specified as
383in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34384
Junio C Hamanoe7935c42006-12-13 21:32:17385color.pager::
386A boolean to enable/disable colored output when the pager is in
387use (default is true).
388
389color.status::
390A boolean to enable/disable color in the output of
391gitlink:git-status[1]. May be set to `true` (or `always`),
392`false` (or `never`) or `auto`, in which case colors are used
393only when the output is to a terminal. Defaults to false.
394
395color.status.<slot>::
396Use customized color for status colorization. `<slot>` is
397one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04398`added` or `updated` (files which are added but not committed),
399`changed` (files which are changed but not added in the index),
Junio C Hamanoe7935c42006-12-13 21:32:17400or `untracked` (files which are not tracked by git). The values of
Junio C Hamanoeb692952007-01-03 22:02:12401these variables may be specified as in color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17402
Junio C Hamanob968dbb2007-07-27 07:26:40403commit.template::
404Specify a file to use as the template for new commit messages.
405
Junio C Hamanodbb64592007-09-01 11:17:39406diff.autorefreshindex::
407When using `git diff` to compare with work tree
408files, do not consider stat-only change as changed.
409Instead, silently run `git update-index --refresh` to
410update the cached stat information for paths whose
411contents in the work tree match the contents in the
412index. This option defaults to true. Note that this
413affects only `git diff` Porcelain, and not lower level
414`diff` commands, such as `git diff-files`.
415
Junio C Hamano07824ce2006-04-25 07:36:54416diff.renameLimit::
417The number of files to consider when performing the copy/rename
418detection; equivalent to the git diff option '-l'.
419
Junio C Hamano9ae1a062006-07-10 08:12:34420diff.renames::
421Tells git to detect renames. If set to any boolean value, it
422will enable basic rename detection. If set to "copies" or
423"copy", it will detect copies, as well.
424
Junio C Hamano54ea8d32007-01-25 07:59:48425fetch.unpackLimit::
426If the number of objects fetched over the git native
427transfer is below this
428limit, then the objects will be unpacked into loose object
429files. However if the number of received objects equals or
430exceeds this limit then the received pack will be stored as
431a pack, after adding any missing delta bases. Storing the
432pack from a push can make the push operation complete faster,
433especially on slow filesystems.
434
Junio C Hamano07824ce2006-04-25 07:36:54435format.headers::
436Additional email headers to include in a patch to be submitted
437by mail. See gitlink:git-format-patch[1].
438
Junio C Hamanod4c8e112007-03-04 10:32:38439format.suffix::
440The default for format-patch is to output files with the suffix
441`.patch`. Use this variable to change that suffix (make sure to
442include the dot if you want it).
443
Junio C Hamanof2ce2972007-05-20 19:12:09444gc.aggressiveWindow::
445The window size parameter used in the delta compression
446algorithm used by 'git gc --aggressive'. This defaults
447to 10.
448
Junio C Hamano1b50ce92007-10-03 12:05:53449gc.auto::
450When there are approximately more than this many loose
451objects in the repository, `git gc --auto` will pack them.
452Some Porcelain commands use this command to perform a
453light-weight garbage collection from time to time. Setting
454this to 0 disables it.
455
456gc.autopacklimit::
457When there are more than this many packs that are not
458marked with `*.keep` file in the repository, `git gc
459--auto` consolidates them into one larger pack. Setting
460this to 0 disables this.
461
Junio C Hamano9d52e572007-02-13 23:48:20462gc.packrefs::
463`git gc` does not run `git pack-refs` in a bare repository by
464default so that older dumb-transport clients can still fetch
465from the repository. Setting this to `true` lets `git
466gc` to run `git pack-refs`. Setting this to `false` tells
467`git gc` never to run `git pack-refs`. The default setting is
468`notbare`. Enable it only when you know you do not have to
469support such clients. The default setting will change to `true`
470at some stage, and setting this to `false` will continue to
471prevent `git pack-refs` from being run from `git gc`.
472
Junio C Hamano74640642006-12-27 10:59:55473gc.reflogexpire::
474`git reflog expire` removes reflog entries older than
475this time; defaults to 90 days.
476
477gc.reflogexpireunreachable::
478`git reflog expire` removes reflog entries older than
479this time and are not reachable from the current tip;
480defaults to 30 days.
481
482gc.rerereresolved::
483Records of conflicted merge you resolved earlier are
484kept for this many days when `git rerere gc` is run.
485The default is 60 days. See gitlink:git-rerere[1].
486
487gc.rerereunresolved::
488Records of conflicted merge you have not resolved are
489kept for this many days when `git rerere gc` is run.
490The default is 15 days. See gitlink:git-rerere[1].
491
Junio C Hamano7a4a2832007-07-07 21:53:22492rerere.enabled::
493Activate recording of resolved conflicts, so that identical
494conflict hunks can be resolved automatically, should they
495be encountered again. See gitlink:git-rerere[1].
496
Junio C Hamano07824ce2006-04-25 07:36:54497gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27498Whether the CVS server interface is enabled for this repository.
Junio C Hamano07824ce2006-04-25 07:36:54499See gitlink:git-cvsserver[1].
500
501gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27502Path to a log file where the CVS server interface well... logs
Junio C Hamano07824ce2006-04-25 07:36:54503various stuff. See gitlink:git-cvsserver[1].
504
Junio C Hamanod9e0e5d2007-04-14 16:22:04505gitcvs.allbinary::
506If true, all files are sent to the client in mode '-kb'. This
507causes the client to treat all files as binary files which suppresses
508any newline munging it otherwise might do. A work-around for the
509fact that there is no way yet to set single files to mode '-kb'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04510
511gitcvs.dbname::
512Database used by git-cvsserver to cache revision information
513derived from the git repository. The exact meaning depends on the
514used database driver, for SQLite (which is the default driver) this
515is a filename. Supports variable substitution (see
516gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`).
517Default: '%Ggitcvs.%m.sqlite'
518
519gitcvs.dbdriver::
520Used Perl DBI driver. You can specify any available driver
521 for this here, but it might not work. git-cvsserver is tested
522with 'DBD::SQLite', reported to work with 'DBD::Pg', and
523reported *not* to work with 'DBD::mysql'. Experimental feature.
524May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamanod9e0e5d2007-04-14 16:22:04525See gitlink:git-cvsserver[1].
526
Junio C Hamanoa2ad99e2007-04-18 09:57:04527gitcvs.dbuser, gitcvs.dbpass::
528Database user and password. Only useful if setting 'gitcvs.dbdriver',
529since SQLite has no concept of database users and/or passwords.
530'gitcvs.dbuser' supports variable substitution (see
531gitlink:git-cvsserver[1] for details).
532
Junio C Hamanoa6387422007-08-25 03:54:27533All gitcvs variables except for 'gitcvs.allbinary' can also be
534specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
535is one of "ext" and "pserver") to make them apply only for the given
536access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04537
Junio C Hamano07824ce2006-04-25 07:36:54538http.sslVerify::
539Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45540over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54541variable.
542
543http.sslCert::
544File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45545over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:54546variable.
547
548http.sslKey::
549File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:48550over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:54551variable.
552
553http.sslCAInfo::
554File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:48555fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:54556'GIT_SSL_CAINFO' environment variable.
557
558http.sslCAPath::
559Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:45560with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54561by the 'GIT_SSL_CAPATH' environment variable.
562
563http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:48564How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54565by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
566
567http.lowSpeedLimit, http.lowSpeedTime::
568If the HTTP transfer speed is less than 'http.lowSpeedLimit'
569for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:48570Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:54571'GIT_HTTP_LOW_SPEED_TIME' environment variables.
572
Junio C Hamanof1dcdfe2006-09-29 08:10:51573http.noEPSV::
574A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:04575This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:51576support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
577environment variable. Default is false (curl will use EPSV).
578
Junio C Hamano07824ce2006-04-25 07:36:54579i18n.commitEncoding::
580Character encoding the commit messages are stored in; git itself
581does not care per se, but this information is necessary e.g. when
582importing commits from emails or in the gitk graphical history
583browser (and possibly at other places in the future or in other
584porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
585
Junio C Hamano51f92e22006-12-29 05:18:28586i18n.logOutputEncoding::
587Character encoding the commit messages are converted to when
588running `git-log` and friends.
589
Junio C Hamanofe9acab2006-11-24 12:10:55590log.showroot::
591If true, the initial commit will be shown as a big creation event.
592This is equivalent to a diff against an empty tree.
593Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
594normally hide the root commit will now show it. True by default.
595
Junio C Hamano07824ce2006-04-25 07:36:54596merge.summary::
597Whether to include summaries of merged commits in newly created
598merge commit messages. False by default.
599
Junio C Hamano103ad7f2007-03-14 11:19:26600merge.tool::
601Controls which merge resolution program is used by
Junio C Hamano1b50ce92007-10-03 12:05:53602gitlink:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff",
Junio C Hamanof614c642007-06-11 01:21:54603"meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
Junio C Hamano103ad7f2007-03-14 11:19:26604
Junio C Hamanoedd2b0a2007-01-15 06:12:45605merge.verbosity::
606Controls the amount of output shown by the recursive merge
607strategy. Level 0 outputs nothing except a final error
608message if conflicts were detected. Level 1 outputs only
609conflicts, 2 outputs conflicts and file changes. Level 5 and
610above outputs debugging information. The default is level 2.
Junio C Hamano764a6672007-10-23 01:23:31611Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
Junio C Hamanoedd2b0a2007-01-15 06:12:45612
Junio C Hamanoe90436a2007-04-22 07:22:13613merge.<driver>.name::
614Defines a human readable name for a custom low-level
615merge driver. See gitlink:gitattributes[5] for details.
616
617merge.<driver>.driver::
618Defines the command that implements a custom low-level
619merge driver. See gitlink:gitattributes[5] for details.
620
621merge.<driver>.recursive::
622Names a low-level merge driver to be used when
623performing an internal merge between common ancestors.
624See gitlink:gitattributes[5] for details.
625
Junio C Hamano75cc4c92006-07-24 08:25:03626pack.window::
627The size of the window used by gitlink:git-pack-objects[1] when no
628window size is given on the command line. Defaults to 10.
629
Junio C Hamano91d44c52007-05-09 07:16:07630pack.depth::
631The maximum delta depth used by gitlink:git-pack-objects[1] when no
632maximum depth is given on the command line. Defaults to 50.
633
Junio C Hamano235d53f2007-07-13 00:25:15634pack.windowMemory::
635The window memory size limit used by gitlink:git-pack-objects[1]
636when no limit is given on the command line. The value can be
637suffixed with "k", "m", or "g". Defaults to 0, meaning no
638limit.
639
Junio C Hamanof2ce2972007-05-20 19:12:09640pack.compression::
641An integer -1..9, indicating the compression level for objects
642in a pack file. -1 is the zlib default. 0 means no
643compression, and 1..9 are various speed/size tradeoffs, 9 being
644slowest. If not set, defaults to core.compression. If that is
645not set, defaults to -1.
646
Junio C Hamano679d22d2007-06-02 21:13:44647pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:27648The maximum memory in bytes used for caching deltas in
Junio C Hamano679d22d2007-06-02 21:13:44649gitlink:git-pack-objects[1].
650A value of 0 means no limit. Defaults to 0.
651
652pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:14653The maximum size of a delta, that is cached in
Junio C Hamano679d22d2007-06-02 21:13:44654gitlink:git-pack-objects[1]. Defaults to 1000.
655
Junio C Hamano58155b42007-09-15 07:46:14656pack.threads::
657Specifies the number of threads to spawn when searching for best
658delta matches. This requires that gitlink:git-pack-objects[1]
659be compiled with pthreads otherwise this option is ignored with a
660warning. This is meant to reduce packing time on multiprocessor
661machines. The required amount of memory for the delta search window
662is however multiplied by the number of threads.
663
Junio C Hamano07824ce2006-04-25 07:36:54664pull.octopus::
665The default merge strategy to use when pulling multiple branches
666at once.
667
668pull.twohead::
669The default merge strategy to use when pulling a single branch.
670
Junio C Hamano249572f2006-10-24 05:44:08671remote.<name>.url::
672The URL of a remote repository. See gitlink:git-fetch[1] or
673gitlink:git-push[1].
674
675remote.<name>.fetch::
676The default set of "refspec" for gitlink:git-fetch[1]. See
677gitlink:git-fetch[1].
678
679remote.<name>.push::
680The default set of "refspec" for gitlink:git-push[1]. See
681gitlink:git-push[1].
682
Junio C Hamano118d2772007-02-21 20:24:10683remote.<name>.skipDefaultUpdate::
684If true, this remote will be skipped by default when updating
685using the remote subcommand of gitlink:git-remote[1].
686
Junio C Hamano4ad294b2007-01-20 02:22:50687remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:48688The default program to execute on the remote side when pushing. See
Junio C Hamano4ad294b2007-01-20 02:22:50689option \--exec of gitlink:git-push[1].
690
Junio C Hamano54ea8d32007-01-25 07:59:48691remote.<name>.uploadpack::
692The default program to execute on the remote side when fetching. See
693option \--exec of gitlink:git-fetch-pack[1].
694
Junio C Hamano17dde0e2007-02-26 09:50:21695remote.<name>.tagopt::
696Setting this value to --no-tags disables automatic tag following when fetching
697from remote <name>
698
Junio C Hamano118d2772007-02-21 20:24:10699remotes.<group>::
700The list of remotes which are fetched by "git remote update
701<group>". See gitlink:git-remote[1].
702
Junio C Hamano77b7e902006-10-23 07:18:50703repack.usedeltabaseoffset::
704Allow gitlink:git-repack[1] to create packs that uses
705delta-base offset. Defaults to false.
706
Junio C Hamano07824ce2006-04-25 07:36:54707show.difftree::
708The default gitlink:git-diff-tree[1] arguments to be used
709for gitlink:git-show[1].
710
711showbranch.default::
712The default set of branches for gitlink:git-show-branch[1].
713See gitlink:git-show-branch[1].
714
Junio C Hamano75cc4c92006-07-24 08:25:03715tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:09716This variable can be used to restrict the permission bits of
717tar archive entries. The default is 0002, which turns off the
718world write bit. The special value "user" indicates that the
719archiving user's umask will be used instead. See umask(2) and
720gitlink:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:03721
Junio C Hamano07824ce2006-04-25 07:36:54722user.email::
723Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:34724Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
725'EMAIL' environment variables. See gitlink:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:54726
727user.name::
728Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:48729Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano07824ce2006-04-25 07:36:54730environment variables. See gitlink:git-commit-tree[1].
731
Junio C Hamanoa890c4f2007-01-28 10:29:21732user.signingkey::
733If gitlink:git-tag[1] is not selecting the key you want it to
734automatically when creating a signed tag, you can override the
735default selection with this variable. This option is passed
736unchanged to gpg's --local-user parameter, so you may specify a key
737using any method that gpg supports.
738
Junio C Hamano07824ce2006-04-25 07:36:54739whatchanged.difftree::
740The default gitlink:git-diff-tree[1] arguments to be used
741for gitlink:git-whatchanged[1].
742
743imap::
744The configuration variables in the 'imap' section are described
745in gitlink:git-imap-send[1].
Junio C Hamano459ee222006-09-21 08:13:28746
Junio C Hamano0d3c8152006-11-08 01:33:41747receive.unpackLimit::
748If the number of objects received in a push is below this
749limit then the objects will be unpacked into loose object
750files. However if the number of received objects equals or
751exceeds this limit then the received pack will be stored as
752a pack, after adding any missing delta bases. Storing the
753pack from a push can make the push operation complete faster,
754especially on slow filesystems.
755
756receive.denyNonFastForwards::
Junio C Hamano459ee222006-09-21 08:13:28757If set to true, git-receive-pack will deny a ref update which is
758not a fast forward. Use this to prevent such an update via a push,
759even if that push is forced. This configuration variable is
760set when initializing a shared repository.
761
Junio C Hamano54ea8d32007-01-25 07:59:48762transfer.unpackLimit::
763When `fetch.unpackLimit` or `receive.unpackLimit` are
764not set, the value of this variable is used instead.