blob: 6b7279f88303e2d7a45baa27022cb9e53cf387be [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 Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-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
Junio C Hamanoea82cff2009-03-18 01:54:4828characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5929must belong to some section, which means that there must be a section
30header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1831
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5934in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1835
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanof4581102009-04-25 08:29:5941Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers 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
Junio C Hamanof4581102009-04-25 08:29:5948There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
Junio C Hamanobee172f2007-01-23 08:44:1851
Junio C Hamanoaa2cd762009-07-26 08:14:0152All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1854'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4857characters and `-` are allowed. There can be more than one value
Junio C Hamanobee172f2007-01-23 08:44:1858for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano4cfa5362009-04-18 23:01:01650/1, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1866converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4367'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1868
69String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5970You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4874be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1875
Junio C Hamanoea82cff2009-03-18 01:54:4876The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1879char sequences are valid.
80
Junio C Hamanof4581102009-04-25 08:29:5981Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1882customary UNIX fashion.
83
Junio C Hamanof4581102009-04-25 08:29:5984Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5485
86Example
87~~~~~~~
88
89# Core variables
90[core]
91; Don't trust file modes
92filemode = false
93
94# Our diff algorithm
95[diff]
Junio C Hamano85c71572008-07-28 00:03:3196external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:5497renames = true
98
Junio C Hamano52401ef2006-12-19 00:54:3899[branch "devel"]
100remote = origin
101merge = refs/heads/devel
102
Junio C Hamanobee172f2007-01-23 08:44:18103# Proxy settings
104[core]
Junio C Hamanoc71a8732007-08-04 00:27:26105gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18106gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38107
Junio C Hamano07824ce2006-04-25 07:36:54108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54114porcelain configuration variables in the respective porcelain documentation.
115
Junio C Hamano7df6dcf2009-09-13 09:51:17116advice.*::
117When set to 'true', display the given optional help message.
118When set to 'false', do not display. The configuration variables
119are:
120+
121--
122pushNonFastForward::
123Advice shown when linkgit:git-push[1] refuses
124non-fast-forward refs. Default: true.
125statusHints::
126Directions on how to stage/unstage/add shown in the
127output of linkgit:git-status[1] and the template shown
128when writing commit messages. Default: true.
Junio C Hamano5706e0b2009-11-24 10:54:16129commitBeforeMerge::
130Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35131merge to avoid overwriting local changes.
Junio C Hamano5706e0b2009-11-24 10:54:16132Default: true.
Junio C Hamanoa9701f02010-01-21 00:42:16133resolveConflict::
134Advices shown by various commands when conflicts
135prevent the operation from being performed.
136Default: true.
137implicitIdentity::
138Advice on how to set your identity configuration when
139your information is guessed from the system username and
140domain name. Default: true.
Junio C Hamano74a198f2010-02-22 00:13:31141
142detachedHead::
143Advice shown when you used linkgit::git-checkout[1] to
144move to the detach HEAD state, to instruct how to create
145a local branch after the fact. Default: true.
Junio C Hamano7df6dcf2009-09-13 09:51:17146--
147
Junio C Hamano07824ce2006-04-25 07:36:54148core.fileMode::
149If false, the executable bit differences between the index and
150the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27151See linkgit:git-update-index[1].
152+
153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154will probe and set core.fileMode false if appropriate when the
155repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54156
Junio C Hamanoa476efa2008-10-10 15:31:42157core.ignoreCygwinFSTricks::
158This option is only used by Cygwin implementation of Git. If false,
159the Cygwin stat() and lstat() functions are used. This may be useful
160if your repository consists of a few separate directories joined in
161one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162whenever it is possible and falls back to Cygwin functions only to
163handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33164normal Cygwin l/stat() functions. True by default, unless core.filemode
165is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42167
Junio C Hamano9df0c662009-11-23 11:09:27168core.ignorecase::
169If true, this option enables various workarounds to enable
170git to work better on filesystems that are not case sensitive,
171like FAT. For example, if a directory listing finds
172"makefile" when git expects "Makefile", git will assume
173it is really the same file, and continue to remember it as
174"Makefile".
175+
176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177will probe and set core.ignorecase true if appropriate when the repository
178is created.
179
Junio C Hamano90ccff32008-07-29 08:17:24180core.trustctime::
181If false, the ctime differences between the index and the
182working copy are ignored; useful when the inode change time
183is regularly modified by something outside Git (file system
184crawlers and some backup systems).
185See linkgit:git-update-index[1]. True by default.
186
Junio C Hamanod526ba92007-07-02 00:17:42187core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31188The commands that output paths (e.g. 'ls-files',
189'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42190"unusual" characters in the pathname by enclosing the
191pathname in a double-quote pair and with backslashes the
192same way strings in C source code are quoted. If this
193variable is set to false, the bytes higher than 0x80 are
194not quoted but output as verbatim. Note that double
195quote, backslash and control characters are always
196quoted without `-z` regardless of the setting of this
197variable.
198
Junio C Hamanobb88cf42010-06-21 15:23:55199core.eol::
200Sets the line ending type to use in the working directory for
201files that have the `text` property set. Alternatives are
202'lf', 'crlf' and 'native', which uses the platform's native
203line ending. The default value is `native`. See
204linkgit:gitattributes[5] for more information on end-of-line
205conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04206
Junio C Hamano26e590a2008-02-17 03:53:51207core.safecrlf::
Junio C Hamanobb88cf42010-06-21 15:23:55208If true, makes git check if converting `CRLF` is reversible when
209end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51210modifies a file in the work tree either directly or indirectly.
211For example, committing a file followed by checking out the
212same file should yield the original file in the work tree. If
213this is not the case for the current setting of
214`core.autocrlf`, git will reject the file. The variable can
215be set to "warn", in which case git will only warn about an
216irreversible conversion but continue the operation.
217+
218CRLF conversion bears a slight chance of corrupting data.
Junio C Hamanobb88cf42010-06-21 15:23:55219When it is enabled, git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51220CRLF during checkout. A file that contains a mixture of LF and
221CRLF before the commit cannot be recreated by git. For text
222files this is the right thing to do: it corrects line endings
223such that we have only LF line endings in the repository.
224But for binary files that are accidentally classified as text the
225conversion can corrupt data.
226+
227If you recognize such corruption early you can easily fix it by
228setting the conversion type explicitly in .gitattributes. Right
229after committing you still have the original file in your work
230tree and this file is not yet corrupted. You can explicitly tell
231git that this file is binary and git will handle the file
232appropriately.
233+
234Unfortunately, the desired effect of cleaning up text files with
235mixed line endings and the undesired effect of corrupting binary
236files cannot be distinguished. In both cases CRLFs are removed
237in an irreversible way. For text files this is the right thing
238to do because CRLFs are line endings, while for binary files
239converting CRLFs corrupts data.
240+
241Note, this safety check does not mean that a checkout will generate a
242file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55243`core.eol` and `core.autocrlf`, but only for the current one. For
244example, a text file with `LF` would be accepted with `core.eol=lf`
245and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51246resulting file would contain `CRLF`, although the original file
247contained `LF`. However, in both work trees the line endings would be
248consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249file with mixed line endings would be reported by the `core.safecrlf`
250mechanism.
251
Junio C Hamanobb88cf42010-06-21 15:23:55252core.autocrlf::
253Setting this variable to "true" is almost the same as setting
254the `text` attribute to "auto" on all files except that text
255files are not guaranteed to be normalized: files that contain
256`CRLF` in the repository will not be touched. Use this
257setting if you want to have `CRLF` line endings in your
258working directory even though the repository does not have
259normalized line endings. This variable can be set to 'input',
260in which case no output conversion is performed.
261
Junio C Hamanoaa83a7d2007-03-05 02:37:29262core.symlinks::
263If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46264contain the link text. linkgit:git-update-index[1] and
265linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29266file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27267symbolic links.
268+
269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270will probe and set core.symlinks false if appropriate when the repository
271is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29272
Junio C Hamano07824ce2006-04-25 07:36:54273core.gitProxy::
274A "proxy command" to execute (as 'command host port') instead
275of establishing direct connection to the remote server when
276using the git protocol for fetching. If the variable value is
277in the "COMMAND for DOMAIN" format, the command is applied only
278on hostnames ending with the specified domain string. This variable
279may be set multiple times and is matched in the given order;
280the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17281+
282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283(which always applies universally, without the special "for"
284handling).
Junio C Hamanoea82cff2009-03-18 01:54:48285+
286The special string `none` can be used as the proxy command to
287specify that no proxy be used for a given domain pattern.
288This is useful for excluding servers inside a firewall from
289proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54290
291core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34292If true, commands which modify both the working tree and the index
293will mark the updated paths with the "assume unchanged" bit in the
294index. These marked files are then assumed to stay unchanged in the
295working copy, until you mark them otherwise manually - Git will not
296detect the file changes by lstat() calls. This is useful on systems
297where those are very slow, such as Microsoft Windows.
298See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54299False by default.
300
Junio C Hamano88a3a072006-05-04 08:01:43301core.preferSymlinkRefs::
302Instead of the default "symref" format for HEAD
303and other symbolic reference files, use symbolic links.
304This is sometimes needed to work with old scripts that
305expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54306
Junio C Hamano1025e752007-02-23 07:21:26307core.bare::
308If true this repository is assumed to be 'bare' and has no
309working directory associated with it. If this is the case a
310number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46311disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26312+
Junio C Hamano35738e82008-01-07 07:55:46313This setting is automatically guessed by linkgit:git-clone[1] or
314linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26315repository that ends in "/.git" is assumed to be not bare (bare =
316false), while all other repositories are assumed to be bare (bare
317= true).
318
Junio C Hamanod526ba92007-07-02 00:17:42319core.worktree::
Junio C Hamanodab291e2009-12-30 09:45:38320Set the path to the root of the work tree.
Junio C Hamano764a6672007-10-23 01:23:31321This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27322variable and the '--work-tree' command line option. It can be
Junio C Hamanodab291e2009-12-30 09:45:38323an absolute path or a relative path to the .git directory,
324either specified by --git-dir or GIT_DIR, or automatically
325discovered.
326If --git-dir or GIT_DIR are specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27327--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanodab291e2009-12-30 09:45:38328the current working directory is regarded as the root of the
329work tree.
330+
331Note that this variable is honored even when set in a configuration
332file in a ".git" subdirectory of a directory, and its value differs
333from the latter directory (e.g. "/path/to/.git/config" has
334core.worktree set to "/different/path"), which is most likely a
335misconfiguration. Running git commands in "/path/to" directory will
336still use "/different/path" as the root of the work tree and can cause
337great confusion to the users.
Junio C Hamanod526ba92007-07-02 00:17:42338
Junio C Hamano341071d2006-06-04 07:24:48339core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49340Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48341"$GIT_DIR/logs/<ref>", by appending the new and old
342SHA1, the date/time and the reason of the update, but
343only when the file exists. If this configuration
344variable is set to true, missing "$GIT_DIR/logs/<ref>"
345file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35346+
347This information can be used to determine what commit
348was the tip of a branch "2 days ago".
349+
350This value is true by default in a repository that has
351a working directory associated with it, and false by
352default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48353
Junio C Hamano07824ce2006-04-25 07:36:54354core.repositoryFormatVersion::
355Internal variable identifying the repository format and layout
356version.
357
358core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42359When 'group' (or 'true'), the repository is made shareable between
360several users in a group (making sure all the files and objects are
361group-writable). When 'all' (or 'world' or 'everybody'), the
362repository will be readable by all users, additionally to being
363group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37364reported by umask(2). When '0xxx', where '0xxx' is an octal number,
365files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00366user's umask value (whereas the other options will only override
367requested parts of the user's umask value). Examples: '0660' will make
368the repo read/write-able for the owner and group, but inaccessible to
369others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37370repository that is group-readable but not group-writable.
371See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54372
373core.warnAmbiguousRefs::
374If true, git will warn you if the ref name you passed it is ambiguous
375and might match multiple refs in the .git/refs/ tree. True by default.
376
Junio C Hamano7ec15722006-07-07 02:03:59377core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09378An integer -1..9, indicating a default compression level.
379-1 is the zlib default. 0 means no compression,
380and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42381If set, this provides a default to other compression variables,
382such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26383
Junio C Hamanof2ce2972007-05-20 19:12:09384core.loosecompression::
385An integer -1..9, indicating the compression level for objects that
386are not in a pack file. -1 is the zlib default. 0 means no
387compression, and 1..9 are various speed/size tradeoffs, 9 being
388slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42389not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49390
Junio C Hamanofc4d38c2007-01-08 06:53:32391core.packedGitWindowSize::
392Number of bytes of a pack file to map into memory in a
393single mapping operation. Larger window sizes may allow
394your system to process a smaller number of large pack files
395more quickly. Smaller window sizes will negatively affect
396performance due to increased calls to the operating system's
397memory manager, but may improve performance when accessing
398a large number of large pack files.
399+
400Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
401MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
402be reasonable for all users/operating systems. You probably do
403not need to adjust this value.
404+
405Common unit suffixes of 'k', 'm', or 'g' are supported.
406
407core.packedGitLimit::
408Maximum number of bytes to map simultaneously into memory
409from pack files. If Git needs to access more than this many
410bytes at once to complete an operation it will unmap existing
411regions to reclaim virtual address space within the process.
412+
413Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
414This should be reasonable for all users/operating systems, except on
415the largest projects. You probably do not need to adjust this value.
416+
417Common unit suffixes of 'k', 'm', or 'g' are supported.
418
Junio C Hamanob8c51282007-03-19 10:43:30419core.deltaBaseCacheLimit::
420Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35421that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30422entire decompressed base objects in a cache Git is able
423to avoid unpacking and decompressing frequently used base
424objects multiple times.
425+
426Default is 16 MiB on all platforms. This should be reasonable
427for all users/operating systems, except on the largest projects.
428You probably do not need to adjust this value.
429+
430Common unit suffixes of 'k', 'm', or 'g' are supported.
431
Junio C Hamano5c246f22010-02-03 07:34:53432core.bigFileThreshold::
433Files larger than this size are stored deflated, without
434attempting delta compression. Storing large files without
435delta compression avoids excessive memory usage, at the
436slight expense of increased disk usage.
437+
438Default is 512 MiB on all platforms. This should be reasonable
439for most projects as source code and other text files can still
440be delta compressed, but larger binary media files won't be.
441+
442Common unit suffixes of 'k', 'm', or 'g' are supported.
443+
444Currently only linkgit:git-fast-import[1] honors this setting.
445
Junio C Hamano1d90cb02007-07-03 07:05:31446core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37447In addition to '.gitignore' (per-directory) and
448'.git/info/exclude', git looks into this file for patterns
Junio C Hamanobf984de2009-11-23 06:11:19449of files which are not meant to be tracked. "{tilde}/" is expanded
450to the value of `$HOME` and "{tilde}user/" to the specified user's
451home directory. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37452
Junio C Hamano3fd7b262010-09-08 22:44:20453core.askpass::
454Some commands (e.g. svn and http interfaces) that interactively
455ask for a password can be told to use an external program given
456via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
457environment variable. If not set, fall back to the value of the
458'SSH_ASKPASS' environment variable or, failing that, a simple password
459prompt. The external program shall be given a suitable prompt as
460command line argument and write the password on its STDOUT.
461
Junio C Hamano3b4609d2010-09-30 00:04:34462core.attributesfile::
463In addition to '.gitattributes' (per-directory) and
464'.git/info/attributes', git looks into this file for attributes
465(see linkgit:gitattributes[5]). Path expansions are made the same
466way as for `core.excludesfile`.
467
Junio C Hamanof6002a92007-07-20 10:28:22468core.editor::
469Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27470messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22471variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37472`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22473
Junio C Hamano28d8ede2007-07-05 05:51:38474core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33475The command that git will use to paginate output. Can
476be overridden with the `GIT_PAGER` environment
477variable. Note that git sets the `LESS` environment
478variable to `FRSX` if it is unset when it runs the
479pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42480`LESS` variable to some other value. Alternately,
481these settings can be overridden on a project or
482global basis by setting the `core.pager` option.
483Setting `core.pager` has no affect on the `LESS`
484environment variable behaviour above, so if you want
485to override git's default settings this way, you need
486to be explicit. For example, to disable the S option
487in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48488to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42489shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48490`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38491
Junio C Hamano942b35e2007-12-09 10:19:33492core.whitespace::
493A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43494notice. 'git diff' will use `color.diff.whitespace` to
495highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59496consider them as errors. You can prefix `-` to disable
497any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33498+
Junio C Hamanob71a22d2009-10-17 08:23:47499* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33500 as an error (enabled by default).
501* `space-before-tab` treats a space character that appears immediately
502 before a tab character in the initial indent part of the line as an
503 error (enabled by default).
504* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42505 space characters as an error (not enabled by default).
Junio C Hamanocb39aea2010-05-09 07:24:48506* `tab-in-indent` treats a tab character in the initial indent part of
507 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47508* `blank-at-eof` treats blank lines added at the end of file as an error
509 (enabled by default).
510* `trailing-space` is a short-hand to cover both `blank-at-eol` and
511 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42512* `cr-at-eol` treats a carriage-return at the end of line as
513 part of the line terminator, i.e. with it, `trailing-space`
514 does not trigger if the character before such a carriage-return
515 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33516
Junio C Hamano9eb57532008-06-26 06:33:46517core.fsyncobjectfiles::
518This boolean will enable 'fsync()' when writing object files.
519+
520This is a total waste of time and effort on a filesystem that orders
521data writes properly, but can be useful for filesystems that do not use
522journalling (traditional UNIX filesystems) or that only journal metadata
523and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
524
Junio C Hamano610d1762008-11-28 06:27:13525core.preloadindex::
526Enable parallel index preload for operations like 'git diff'
527+
528This can speed up operations like 'git diff' and 'git status' especially
529on filesystems like NFS that have weak caching semantics and thus
530relatively high IO latencies. With this set to 'true', git will do the
531index comparison to the filesystem data in parallel, allowing
532overlapping IO's.
533
Junio C Hamanoa9499de2009-04-30 03:38:48534core.createObject::
535You can set this to 'link', in which case a hardlink followed by
536a delete of the source are used to make sure that object creation
537will not overwrite existing objects.
538+
539On some file system/operating system combinations, this is unreliable.
540Set this config setting to 'rename' there; However, This will remove the
541check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41542
Junio C Hamano3b70d3c2009-11-21 17:37:37543core.notesRef::
544When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10545the given ref. The ref must be fully qualified. If the given
546ref does not exist, it is not an error but means that no
547notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37548+
Junio C Hamanoa574a092010-06-13 19:57:10549This setting defaults to "refs/notes/commits", and it can be overridden by
550the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37551
Junio C Hamano3c8d6702010-01-13 23:09:03552core.sparseCheckout::
553Enable "sparse checkout" feature. See section "Sparse checkout" in
554linkgit:git-read-tree[1] for more information.
555
Junio C Hamano3d141512009-06-01 01:22:40556add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26557add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43558Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40559added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano60186642010-12-02 14:18:26560option of linkgit:git-add[1]. Older versions of git accept only
561`add.ignore-errors`, which does not follow the usual naming
562convention for configuration variables. Newer versions of git
563honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40564
Junio C Hamano33db4372006-06-07 19:51:45565alias.*::
Junio C Hamano35738e82008-01-07 07:55:46566Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45567after defining "alias.last = cat-file commit HEAD", the invocation
568"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17569confusion and troubles with script usage, aliases that
570hide existing git commands are ignored. Arguments are split by
571spaces, the usual shell quoting and escaping is supported.
572quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39573+
574If the alias expansion is prefixed with an exclamation point,
575it will be treated as a shell command. For example, defining
576"alias.new = !gitk --all --not ORIG_HEAD", the invocation
577"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19578"gitk --all --not ORIG_HEAD". Note that shell commands will be
579executed from the top-level directory of a repository, which may
580not necessarily be the current directory.
Junio C Hamano9cb74f22007-02-12 04:15:05581
Junio C Hamanocaa712a2010-03-11 01:17:35582am.keepcr::
583If true, git-am will call git-mailsplit for patches in mbox format
584with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35585not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35586by giving '--no-keep-cr' from the command line.
587See linkgit:git-am[1], linkgit:git-mailsplit[1].
588
Junio C Hamanofe24db02009-08-22 05:10:47589apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43590When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47591whitespace, in the same way as the '--ignore-space-change'
592option.
Junio C Hamano1aa40d22010-01-21 17:46:43593When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47594respect all whitespace differences.
595See linkgit:git-apply[1].
596
Junio C Hamano07824ce2006-04-25 07:36:54597apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43598Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46599as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54600
Junio C Hamano7fd84172007-05-24 07:00:32601branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43602Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44603so that linkgit:git-pull[1] will appropriately merge from the
604starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32605this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44606and `--no-track` options. The valid settings are: `false` -- no
607automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07608starting point is a remote-tracking branch; `always` --
609automatic setup is done when the starting point is either a
610local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44611branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32612
Junio C Hamano869bb802008-05-12 00:29:47613branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43614When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano869bb802008-05-12 00:29:47615that tracks another branch, this variable tells git to set
616up pull to rebase instead of merge (see "branch.<name>.rebase").
617When `never`, rebase is never automatically set to true.
618When `local`, rebase is set to true for tracked branches of
619other local branches.
620When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07621remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47622When `always`, rebase will be set to true for all tracking
623branches.
624See "branch.autosetupmerge" for details on how to set up a
625branch to track another branch.
626This option defaults to never.
627
Junio C Hamano47c1e3c2006-09-25 04:45:55628branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43629When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19630remote to fetch from/push to. It defaults to `origin` if no remote is
631configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55632
633branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19634Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamano1aa40d22010-01-21 17:46:43635for the given branch. It tells 'git fetch'/'git pull' which
636branch to merge and can also affect 'git push' (see push.default).
637When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31638refspec to be marked for merging in FETCH_HEAD. The value is
639handled like the remote part of a refspec, and must match a
640ref which is fetched from the remote given by
641"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43642The merge information is used by 'git pull' (which at first calls
643'git fetch') to lookup the default branch for merging. Without
644this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46645Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43646If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07647another branch in the local repository, you can point
648branch.<name>.merge to the desired branch, and use the special setting
649`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55650
Junio C Hamano1b50ce92007-10-03 12:05:53651branch.<name>.mergeoptions::
652Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29653supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53654option values containing whitespace characters are currently not
655supported.
656
Junio C Hamano0c999702007-12-03 09:57:55657branch.<name>.rebase::
658When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08659instead of merging the default branch from the default remote when
660"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55661*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46662it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55663for details).
664
Junio C Hamano8760ea62008-03-14 08:58:45665browser.<tool>.cmd::
666Specify the command to invoke the specified browser. The
667specified command is evaluated in shell with the URLs passed
668as arguments. (See linkgit:git-web--browse[1].)
669
Junio C Hamanoe35a6fc2008-01-29 09:46:27670browser.<tool>.path::
671Override the path for the given tool that may be used to
672browse HTML help (see '-w' option in linkgit:git-help[1]) or a
673working repository in gitweb (see linkgit:git-instaweb[1]).
674
Junio C Hamano47b9acd2007-04-24 07:34:34675clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45676A boolean to make git-clean do nothing unless given -f
677or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34678
Junio C Hamanoeb692952007-01-03 22:02:12679color.branch::
680A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46681linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21682`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12683only when the output is to a terminal. Defaults to false.
684
685color.branch.<slot>::
686Use customized color for branch coloration. `<slot>` is one of
687`current` (the current branch), `local` (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07688`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22689refs).
690+
691The value for these configuration variables is a list of colors (at most
692two) and attributes (at most one), separated by spaces. The colors
693accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
694`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
695`blink` and `reverse`. The first color given is the foreground; the
696second is the background. The position of the attribute, if any,
697doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12698
Junio C Hamano3f403b02006-12-13 10:14:13699color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21700When set to `always`, always use colors in patch.
701When false (or `never`), never. When set to `true` or `auto`, use
702colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34703
Junio C Hamano3f403b02006-12-13 10:14:13704color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22705Use customized color for diff colorization. `<slot>` specifies
706which part of the patch to use the specified color, and is one
707of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59708(hunk header), 'func' (function in hunk header), `old` (removed lines),
709`new` (added lines), `commit` (commit headers), or `whitespace`
710(highlighting whitespace errors). The values of these variables may be
711specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34712
Junio C Hamano7d449522010-07-01 00:08:51713color.decorate.<slot>::
714Use customized color for 'git log --decorate' output. `<slot>` is one
715of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07716branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51717
Junio C Hamanod257cff2009-03-18 05:27:16718color.grep::
719When set to `always`, always highlight matches. When `false` (or
720`never`), never. When set to `true` or `auto`, use color only
721when the output is written to the terminal. Defaults to `false`.
722
Junio C Hamano0299d922010-03-20 20:59:31723color.grep.<slot>::
724Use customized color for grep colorization. `<slot>` specifies which
725part of the line to use the specified color, and is one of
726+
727--
728`context`;;
729non-matching text in context lines (when using `-A`, `-B`, or `-C`)
730`filename`;;
731filename prefix (when not using `-h`)
732`function`;;
733function name lines (when using `-p`)
734`linenumber`;;
735line number prefix (when using `-n`)
736`match`;;
737matching text
738`selected`;;
739non-matching text in selected lines
740`separator`;;
741separators between fields on a line (`:`, `-`, and `=`)
742and between hunks (`--`)
743--
744+
745The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16746
Junio C Hamano00b8b632007-12-07 09:50:49747color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46748When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31749and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49750When false (or `never`), never. When set to `true` or `auto`, use
751colors only when the output is to the terminal. Defaults to false.
752
753color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43754Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10755output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
756four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00757commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49758in color.branch.<slot>.
759
Junio C Hamanoe7935c42006-12-13 21:32:17760color.pager::
761A boolean to enable/disable colored output when the pager is in
762use (default is true).
763
Junio C Hamano52ba2952009-05-18 17:43:02764color.showbranch::
765A boolean to enable/disable color in the output of
766linkgit:git-show-branch[1]. May be set to `always`,
767`false` (or `never`) or `auto` (or `true`), in which case colors are used
768only when the output is to a terminal. Defaults to false.
769
Junio C Hamanoe7935c42006-12-13 21:32:17770color.status::
771A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46772linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21773`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17774only when the output is to a terminal. Defaults to false.
775
776color.status.<slot>::
777Use customized color for status colorization. `<slot>` is
778one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04779`added` or `updated` (files which are added but not committed),
780`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30781`untracked` (files which are not tracked by git), or
782`nobranch` (the color the 'no branch' warning is shown in, defaulting
783to red). The values of these variables may be specified as in
784color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17785
Junio C Hamano83d46a22008-02-21 02:29:42786color.ui::
787When set to `always`, always use colors in all git commands which
788are capable of colored output. When false (or `never`), never. When
789set to `true` or `auto`, use colors only when the output is to the
790terminal. When more specific variables of color.* are set, they always
791take precedence over this setting. Defaults to false.
792
Junio C Hamanod0d892c2010-01-24 20:06:29793commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50794A boolean to enable/disable inclusion of status information in the
795commit message template when using an editor to prepare the commit
796message. Defaults to true.
797
Junio C Hamano4653c6f2008-11-26 22:50:20798commit.template::
799Specify a file to use as the template for new commit messages.
Junio C Hamanobf984de2009-11-23 06:11:19800"{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
801specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20802
Junio C Hamanodbb64592007-09-01 11:17:39803diff.autorefreshindex::
Junio C Hamano1aa40d22010-01-21 17:46:43804When using 'git diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39805files, do not consider stat-only change as changed.
806Instead, silently run `git update-index --refresh` to
807update the cached stat information for paths whose
808contents in the work tree match the contents in the
809index. This option defaults to true. Note that this
Junio C Hamano1aa40d22010-01-21 17:46:43810affects only 'git diff' Porcelain, and not lower level
811'diff' commands such as 'git diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39812
Junio C Hamano1fbbbc12007-12-18 07:01:27813diff.external::
814If this config variable is set, diff generation is not
815performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31816given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
817environment variable. The command is called with parameters
818as described under "git Diffs" in linkgit:git[1]. Note: if
819you want to use an external diff program only on a subset of
820your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27821
Junio C Hamano5e4d8de2008-09-19 06:27:02822diff.mnemonicprefix::
Junio C Hamano1aa40d22010-01-21 17:46:43823If set, 'git diff' uses a prefix pair that is different from the
Junio C Hamano5e4d8de2008-09-19 06:27:02824standard "a/" and "b/" depending on what is being compared. When
825this configuration is in effect, reverse diff output also swaps
826the order of the prefixes:
Junio C Hamano1aa40d22010-01-21 17:46:43827`git diff`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02828compares the (i)ndex and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43829`git diff HEAD`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02830 compares a (c)ommit and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43831`git diff --cached`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02832compares a (c)ommit and the (i)ndex;
Junio C Hamano1aa40d22010-01-21 17:46:43833`git diff HEAD:file1 file2`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02834compares an (o)bject and a (w)ork tree entity;
Junio C Hamano1aa40d22010-01-21 17:46:43835`git diff --no-index a b`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02836compares two non-git things (1) and (2).
837
Junio C Hamano21c2d142010-09-10 18:09:27838diff.noprefix::
839If set, 'git diff' does not show any source or destination prefix.
840
Junio C Hamano07824ce2006-04-25 07:36:54841diff.renameLimit::
842The number of files to consider when performing the copy/rename
Junio C Hamano1aa40d22010-01-21 17:46:43843detection; equivalent to the 'git diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54844
Junio C Hamano9ae1a062006-07-10 08:12:34845diff.renames::
846Tells git to detect renames. If set to any boolean value, it
847will enable basic rename detection. If set to "copies" or
848"copy", it will detect copies, as well.
849
Junio C Hamano619596a2010-08-18 22:15:35850diff.ignoreSubmodules::
851Sets the default value of --ignore-submodules. Note that this
852affects only 'git diff' Porcelain, and not lower level 'diff'
Junio C Hamanof0f41ba2010-09-04 16:23:06853commands such as 'git diff-files'. 'git checkout' also honors
854this setting when reporting uncommitted changes.
Junio C Hamano619596a2010-08-18 22:15:35855
Junio C Hamanobc4852e2009-01-21 10:51:14856diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21857A boolean to inhibit the standard behavior of printing a space
858before each empty output line. Defaults to false.
859
Junio C Hamano3bd66e92009-04-18 06:17:56860diff.tool::
861Controls which diff tool is used. `diff.tool` overrides
862`merge.tool` when used by linkgit:git-difftool[1] and has
863the same valid values as `merge.tool` minus "tortoisemerge"
864and plus "kompare".
865
866difftool.<tool>.path::
867Override the path for the given tool. This is useful in case
868your tool is not in the PATH.
869
870difftool.<tool>.cmd::
871Specify the command to invoke the specified diff tool.
872The specified command is evaluated in shell with the following
873variables available: 'LOCAL' is set to the name of the temporary
874file containing the contents of the diff pre-image and 'REMOTE'
875is set to the name of the temporary file containing the contents
876of the diff post-image.
877
878difftool.prompt::
879Prompt before each invocation of the diff tool.
880
Junio C Hamano20d47e32009-01-26 06:36:02881diff.wordRegex::
882A POSIX Extended Regular Expression used to determine what is a "word"
883when performing word-by-word difference calculations. Character
884sequences that match the regular expression are "words", all other
885characters are *ignorable* whitespace.
886
Junio C Hamano54ea8d32007-01-25 07:59:48887fetch.unpackLimit::
888If the number of objects fetched over the git native
889transfer is below this
890limit, then the objects will be unpacked into loose object
891files. However if the number of received objects equals or
892exceeds this limit then the received pack will be stored as
893a pack, after adding any missing delta bases. Storing the
894pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17895especially on slow filesystems. If not set, the value of
896`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48897
Junio C Hamanof4581102009-04-25 08:29:59898format.attach::
899Enable multipart/mixed attachments as the default for
900'format-patch'. The value can also be a double quoted string
901which will enable attachments as the default and set the
902value as the boundary. See the --attach option in
903linkgit:git-format-patch[1].
904
Junio C Hamano8c5802d2007-11-15 00:13:36905format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33906A boolean which can enable or disable sequence numbers in patch
907subjects. It defaults to "auto" which enables it only if there
908is more than one patch. It can be enabled or disabled for all
909messages by setting it to "true" or "false". See --numbered
910option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36911
Junio C Hamano07824ce2006-04-25 07:36:54912format.headers::
913Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46914by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54915
Junio C Hamano70664a02010-07-13 22:48:05916format.to::
Junio C Hamanof4581102009-04-25 08:29:59917format.cc::
Junio C Hamano70664a02010-07-13 22:48:05918Additional recipients to include in a patch to be submitted
919by mail. See the --to and --cc options in
920linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:59921
922format.subjectprefix::
923The default for format-patch is to output files with the '[PATCH]'
924subject prefix. Use this variable to change that prefix.
925
Junio C Hamano89a57342010-06-22 23:22:55926format.signature::
927The default for format-patch is to output a signature containing
928the git version number. Use this variable to change that default.
929Set this variable to the empty string ("") to suppress
930signature generation.
931
Junio C Hamanod4c8e112007-03-04 10:32:38932format.suffix::
933The default for format-patch is to output files with the suffix
934`.patch`. Use this variable to change that suffix (make sure to
935include the dot if you want it).
936
Junio C Hamano86bcccc2008-03-08 09:33:55937format.pretty::
938The default pretty format for log/show/whatchanged command,
939See linkgit:git-log[1], linkgit:git-show[1],
940linkgit:git-whatchanged[1].
941
Junio C Hamanoea6a7642009-03-11 23:56:19942format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:43943The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:14944a boolean value, or `shallow` or `deep`. `shallow` threading
945makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:19946where the head is chosen from the cover letter, the
947`\--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59948`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19949A true boolean value is the same as `shallow`, and a false
950value disables threading.
951
Junio C Hamano5f9a6f02009-04-06 08:26:56952format.signoff::
953 A boolean value which lets you enable the `-s/--signoff` option of
954 format-patch by default. *Note:* Adding the Signed-off-by: line to a
955 patch should be a conscious act and means that you certify you have
956 the rights to submit this work under the same open source license.
957 Please see the 'SubmittingPatches' document for further discussion.
958
Junio C Hamanof2ce2972007-05-20 19:12:09959gc.aggressiveWindow::
960The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:43961algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:36962to 250.
Junio C Hamanof2ce2972007-05-20 19:12:09963
Junio C Hamano1b50ce92007-10-03 12:05:53964gc.auto::
965When there are approximately more than this many loose
966objects in the repository, `git gc --auto` will pack them.
967Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17968light-weight garbage collection from time to time. The
969default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53970
971gc.autopacklimit::
972When there are more than this many packs that are not
973marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17974--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37975default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53976
Junio C Hamano9d52e572007-02-13 23:48:20977gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:14978Running `git pack-refs` in a repository renders it
979unclonable by Git versions prior to 1.5.1.2 over dumb
980transports such as HTTP. This variable determines whether
Junio C Hamano1aa40d22010-01-21 17:46:43981'git gc' runs `git pack-refs`. This can be set to `nobare`
Junio C Hamanob141a922010-01-10 19:55:14982to enable it within all non-bare repos or it can be set to a
983boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:20984
Junio C Hamano09a926d2008-03-13 07:55:29985gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:43986When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:57987Override the grace period with this config variable. The value
988"now" may be used to disable this grace period and always prune
989unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:29990
Junio C Hamano74640642006-12-27 10:59:55991gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:53992gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:43993'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:53994this time; defaults to 90 days. With "<pattern>" (e.g.
995"refs/stash") in the middle the setting applies only to
996the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:55997
998gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:53999gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431000'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551001this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531002defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1003in the middle, the setting applies only to the refs that
1004match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551005
1006gc.rerereresolved::
1007Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431008kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461009The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551010
1011gc.rerereunresolved::
1012Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431013kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461014The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551015
Junio C Hamanoa3148f52009-01-14 08:49:571016gitcvs.commitmsgannotation::
1017Append this string to each commit message. Set to empty string
1018to disable this feature. Defaults to "via git-CVS emulator".
1019
Junio C Hamano07824ce2006-04-25 07:36:541020gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271021Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461022See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541023
1024gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271025Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461026various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541027
Junio C Hamano17bd2272008-09-01 06:11:171028gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551029If true, the server will look up the end-of-line conversion
1030attributes for files to determine the '-k' modes to use. If
1031the attributes force git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351032the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551033treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331034will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551035the client might otherwise do. If the attributes do not allow
1036the file type to be determined, then 'gitcvs.allbinary' is
1037used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141038
Junio C Hamanod9e0e5d2007-04-14 16:22:041039gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141040This is used if 'gitcvs.usecrlfattr' does not resolve
1041the correct '-kb' mode to use. If true, all
1042unresolved files are sent to the client in
1043mode '-kb'. This causes the client to treat them
1044as binary files, which suppresses any newline munging it
1045otherwise might do. Alternatively, if it is set to "guess",
1046then the contents of the file are examined to decide if
1047it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041048
1049gitcvs.dbname::
1050Database used by git-cvsserver to cache revision information
1051derived from the git repository. The exact meaning depends on the
1052used database driver, for SQLite (which is the default driver) this
1053is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461054linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041055Default: '%Ggitcvs.%m.sqlite'
1056
1057gitcvs.dbdriver::
1058Used Perl DBI driver. You can specify any available driver
1059 for this here, but it might not work. git-cvsserver is tested
1060with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1061reported *not* to work with 'DBD::mysql'. Experimental feature.
1062May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461063See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041064
Junio C Hamanoa2ad99e2007-04-18 09:57:041065gitcvs.dbuser, gitcvs.dbpass::
1066Database user and password. Only useful if setting 'gitcvs.dbdriver',
1067since SQLite has no concept of database users and/or passwords.
1068'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461069linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041070
Junio C Hamanoa74efce2008-04-02 08:39:081071gitcvs.dbTableNamePrefix::
1072Database table name prefix. Prepended to the names of any
1073database tables used, allowing a single database to be used
1074for several repositories. Supports variable substitution (see
1075linkgit:git-cvsserver[1] for details). Any non-alphabetic
1076characters will be replaced with underscores.
1077
Junio C Hamanodfccbb02008-05-26 01:16:141078All gitcvs variables except for 'gitcvs.usecrlfattr' and
1079'gitcvs.allbinary' can also be specified as
1080'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271081is one of "ext" and "pserver") to make them apply only for the given
1082access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041083
Junio C Hamano6d76d612008-05-09 05:46:081084gui.commitmsgwidth::
1085Defines how wide the commit message window is in the
1086linkgit:git-gui[1]. "75" is the default.
1087
1088gui.diffcontext::
1089Specifies how many context lines should be used in calls to diff
1090made by the linkgit:git-gui[1]. The default is "5".
1091
Junio C Hamanod3452a02008-11-15 08:07:551092gui.encoding::
1093Specifies the default encoding to use for displaying of
1094file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1095It can be overridden by setting the 'encoding' attribute
1096for relevant files (see linkgit:gitattributes[5]).
1097If this option is not set, the tools default to the
1098locale encoding.
1099
Junio C Hamano6d76d612008-05-09 05:46:081100gui.matchtrackingbranch::
1101Determines if new branches created with linkgit:git-gui[1] should
1102default to tracking remote branches with matching names or
1103not. Default: "false".
1104
1105gui.newbranchtemplate::
1106Is used as suggested name when creating new branches using the
1107linkgit:git-gui[1].
1108
1109gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071110"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081111performing a fetch. The default value is "false".
1112
1113gui.trustmtime::
1114Determines if linkgit:git-gui[1] should trust the file modification
1115timestamp or not. By default the timestamps are not trusted.
1116
1117gui.spellingdictionary::
1118Specifies the dictionary used for spell checking commit messages in
1119the linkgit:git-gui[1]. When set to "none" spell checking is turned
1120off.
1121
Junio C Hamanod3452a02008-11-15 08:07:551122gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431123If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551124location detection. It makes blame significantly faster on huge
1125repositories at the expense of less thorough copy detection.
1126
1127gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131128Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551129detection, measured in alphanumeric characters. See the
1130linkgit:git-blame[1] manual for more information on copy detection.
1131
1132gui.blamehistoryctx::
1133Specifies the radius of history context in days to show in
1134linkgit:gitk[1] for the selected commit, when the `Show History
1135Context` menu item is invoked from 'git gui blame'. If this
1136variable is set to zero, the whole history is shown.
1137
Junio C Hamano92d312a2008-12-15 07:22:201138guitool.<name>.cmd::
1139Specifies the shell command line to execute when the corresponding item
1140of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1141mandatory for every tool. The command is executed from the root of
1142the working directory, and in the environment it receives the name of
1143the tool as 'GIT_GUITOOL', the name of the currently selected file as
1144'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1145the head is detached, 'CUR_BRANCH' is empty).
1146
1147guitool.<name>.needsfile::
1148Run the tool only if a diff is selected in the GUI. It guarantees
1149that 'FILENAME' is not empty.
1150
1151guitool.<name>.noconsole::
1152Run the command silently, without creating a window to display its
1153output.
1154
1155guitool.<name>.norescan::
1156Don't rescan the working directory for changes after the tool
1157finishes execution.
1158
1159guitool.<name>.confirm::
1160Show a confirmation dialog before actually running the tool.
1161
1162guitool.<name>.argprompt::
1163Request a string argument from the user, and pass it to the tool
1164through the 'ARGS' environment variable. Since requesting an
1165argument implies confirmation, the 'confirm' option has no effect
1166if this is enabled. If the option is set to 'true', 'yes', or '1',
1167the dialog uses a built-in generic prompt; otherwise the exact
1168value of the variable is used.
1169
1170guitool.<name>.revprompt::
1171Request a single valid revision from the user, and set the
1172'REVISION' environment variable. In other aspects this option
1173is similar to 'argprompt', and can be used together with it.
1174
1175guitool.<name>.revunmerged::
1176Show only unmerged branches in the 'revprompt' subdialog.
1177This is useful for tools similar to merge or rebase, but not
1178for things like checkout or reset.
1179
1180guitool.<name>.title::
1181Specifies the title to use for the prompt dialog. The default
1182is the tool name.
1183
1184guitool.<name>.prompt::
1185Specifies the general prompt string to display at the top of
1186the dialog, before subsections for 'argprompt' and 'revprompt'.
1187The default value includes the actual command.
1188
Junio C Hamano4e272312008-01-08 09:13:211189help.browser::
1190Specify the browser that will be used to display help in the
1191'web' format. See linkgit:git-help[1].
1192
1193help.format::
1194Override the default help format used by linkgit:git-help[1].
1195Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1196the default. 'web' and 'html' are the same.
1197
Junio C Hamanof24b8062008-09-09 01:34:391198help.autocorrect::
1199Automatically correct and execute mistyped commands after
1200waiting for the given number of deciseconds (0.1 sec). If more
1201than one command can be deduced from the entered text, nothing
1202will be executed. If the value of this option is negative,
1203the corrected command will be executed immediately. If the
1204value is 0 - the command will be just shown but not executed.
1205This is the default.
1206
Junio C Hamano58256872007-12-04 08:31:131207http.proxy::
1208Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:461209environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:131210on a per-remote basis; see remote.<name>.proxy
1211
Junio C Hamano07824ce2006-04-25 07:36:541212http.sslVerify::
1213Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451214over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541215variable.
1216
1217http.sslCert::
1218File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451219over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541220variable.
1221
1222http.sslKey::
1223File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481224over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541225variable.
1226
Junio C Hamano48bc1ce2009-07-09 16:49:191227http.sslCertPasswordProtected::
1228Enable git's password prompt for the SSL certificate. Otherwise
1229OpenSSL will prompt the user, possibly many times, if the
1230certificate or private key is encrypted. Can be overridden by the
1231'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1232
Junio C Hamano07824ce2006-04-25 07:36:541233http.sslCAInfo::
1234File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481235fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541236'GIT_SSL_CAINFO' environment variable.
1237
1238http.sslCAPath::
1239Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451240with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541241by the 'GIT_SSL_CAPATH' environment variable.
1242
1243http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481244How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541245by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1246
Junio C Hamanob141a922010-01-10 19:55:141247http.minSessions::
1248The number of curl sessions (counted across slots) to be kept across
1249requests. They will not be ended with curl_easy_cleanup() until
1250http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1251value will be capped at 1. Defaults to 1.
1252
Junio C Hamano3b70d3c2009-11-21 17:37:371253http.postBuffer::
1254Maximum size in bytes of the buffer used by smart HTTP
1255transports when POSTing data to the remote system.
1256For requests larger than this buffer size, HTTP/1.1 and
1257Transfer-Encoding: chunked is used to avoid creating a
1258massive pack file locally. Default is 1 MiB, which is
1259sufficient for most requests.
1260
Junio C Hamano07824ce2006-04-25 07:36:541261http.lowSpeedLimit, http.lowSpeedTime::
1262If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1263for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481264Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541265'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1266
Junio C Hamanof1dcdfe2006-09-29 08:10:511267http.noEPSV::
1268A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041269This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511270support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1271environment variable. Default is false (curl will use EPSV).
1272
Junio C Hamano53ba6d02010-08-22 07:25:121273http.useragent::
1274The HTTP USER_AGENT string presented to an HTTP server. The default
1275value represents the version of the client git such as git/1.7.1.
1276This option allows you to override this value to a more common value
1277such as Mozilla/4.0. This may be necessary, for instance, if
1278connecting through a firewall that restricts HTTP connections to a set
1279of common USER_AGENT strings (but not including those like git/1.7.1).
1280Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1281
Junio C Hamano07824ce2006-04-25 07:36:541282i18n.commitEncoding::
1283Character encoding the commit messages are stored in; git itself
1284does not care per se, but this information is necessary e.g. when
1285importing commits from emails or in the gitk graphical history
1286browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461287porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541288
Junio C Hamano51f92e22006-12-29 05:18:281289i18n.logOutputEncoding::
1290Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431291running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281292
Junio C Hamano4653c6f2008-11-26 22:50:201293imap::
1294The configuration variables in the 'imap' section are described
1295in linkgit:git-imap-send[1].
1296
Junio C Hamanocaa712a2010-03-11 01:17:351297init.templatedir::
1298Specify the directory from which templates will be copied.
1299(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1300
Junio C Hamano4e272312008-01-08 09:13:211301instaweb.browser::
1302Specify the program that will be used to browse your working
1303repository in gitweb. See linkgit:git-instaweb[1].
1304
1305instaweb.httpd::
1306The HTTP daemon command-line to start gitweb on your working
1307repository. See linkgit:git-instaweb[1].
1308
1309instaweb.local::
1310If true the web server started by linkgit:git-instaweb[1] will
1311be bound to the local IP (127.0.0.1).
1312
1313instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351314The default module path for linkgit:git-instaweb[1] to use
1315instead of /usr/lib/apache2/modules. Only used if httpd
1316is Apache.
Junio C Hamano4e272312008-01-08 09:13:211317
1318instaweb.port::
1319The port number to bind the gitweb httpd to. See
1320linkgit:git-instaweb[1].
1321
Junio C Hamanoe5bf6c12009-02-07 21:43:101322interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001323In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101324input with a single key (i.e., without hitting enter).
1325Currently this is used only by the `\--patch` mode of
1326linkgit:git-add[1]. Note that this setting is silently
1327ignored if portable keystroke input is not available.
1328
Junio C Hamanob713ff12008-05-24 01:12:301329log.date::
Junio C Hamano2db3e752010-09-03 21:33:061330Set the default date-time mode for the 'log' command.
1331Setting a value for log.date is similar to using 'git log''s
1332`\--date` option. Possible values are `relative`, `local`,
1333`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1334for details.
Junio C Hamanob713ff12008-05-24 01:12:301335
Junio C Hamanocb39aea2010-05-09 07:24:481336log.decorate::
1337Print out the ref names of any commits that are shown by the log
1338command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1339'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1340specified, the full ref name (including prefix) will be printed.
1341This is the same as the log commands '--decorate' option.
1342
Junio C Hamanofe9acab2006-11-24 12:10:551343log.showroot::
1344If true, the initial commit will be shown as a big creation event.
1345This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461346Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551347normally hide the root commit will now show it. True by default.
1348
Junio C Hamano8bc410e2009-02-15 10:38:191349mailmap.file::
1350The location of an augmenting mailmap file. The default
1351mailmap, located in the root of the repository, is loaded
1352first, then the mailmap file pointed to by this variable.
1353The location of the mailmap file may be in a repository
1354subdirectory, or somewhere outside of the repository itself.
1355See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1356
Junio C Hamano8b588d52008-03-15 09:48:371357man.viewer::
1358Specify the programs that may be used to display help in the
1359'man' format. See linkgit:git-help[1].
1360
Junio C Hamano6d76d612008-05-09 05:46:081361man.<tool>.cmd::
1362Specify the command to invoke the specified man viewer. The
1363specified command is evaluated in shell with the man page
1364passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261365
Junio C Hamano6d76d612008-05-09 05:46:081366man.<tool>.path::
1367Override the path for the given tool that may be used to
1368display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131369
Junio C Hamano4653c6f2008-11-26 22:50:201370include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421371
Junio C Hamano1fbbbc12007-12-18 07:01:271372mergetool.<tool>.path::
1373Override the path for the given tool. This is useful in case
1374your tool is not in the PATH.
1375
Junio C Hamano86bcccc2008-03-08 09:33:551376mergetool.<tool>.cmd::
1377Specify the command to invoke the specified merge tool. The
1378specified command is evaluated in shell with the following
1379variables available: 'BASE' is the name of a temporary file
1380containing the common base of the files to be merged, if available;
1381'LOCAL' is the name of a temporary file containing the contents of
1382the file on the current branch; 'REMOTE' is the name of a temporary
1383file containing the contents of the file from the branch being
1384merged; 'MERGED' contains the name of the file to which the merge
1385tool should write the results of a successful merge.
1386
1387mergetool.<tool>.trustExitCode::
1388For a custom merge command, specify whether the exit code of
1389the merge command can be used to determine whether the merge was
1390successful. If this is not set to true then the merge target file
1391timestamp is checked and the merge assumed to have been successful
1392if the file has been updated, otherwise the user is prompted to
1393indicate the success of the merge.
1394
1395mergetool.keepBackup::
1396After performing a merge, the original file with conflict markers
1397can be saved as a file with a `.orig` extension. If this variable
1398is set to `false` then this file is not preserved. Defaults to
1399`true` (i.e. keep the backup files).
1400
Junio C Hamano10b7a342009-01-01 22:05:171401mergetool.keepTemporaries::
1402When invoking a custom merge tool, git uses a set of temporary
1403files to pass to the tool. If the tool returns an error and this
1404variable is set to `true`, then these temporary files will be
1405preserved, otherwise they will be removed after the tool has
1406exited. Defaults to `false`.
1407
1408mergetool.prompt::
1409Prompt before each invocation of the merge resolution program.
1410
Junio C Hamano31667362010-03-25 00:38:531411notes.displayRef::
1412The (fully qualified) refname from which to show notes when
1413showing commit messages. The value of this variable can be set
1414to a glob, in which case notes from all matching refs will be
1415shown. You may also specify this configuration variable
1416several times. A warning will be issued for refs that do not
1417exist, but a glob that does not match any refs is silently
1418ignored.
1419+
1420This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1421environment variable, which must be a colon separated list of refs or
1422globs.
1423+
1424The effective value of "core.notesRef" (possibly overridden by
1425GIT_NOTES_REF) is also implicitly added to the list of refs to be
1426displayed.
1427
1428notes.rewrite.<command>::
1429When rewriting commits with <command> (currently `amend` or
1430`rebase`) and this variable is set to `true`, git
1431automatically copies your notes from the original to the
1432rewritten commit. Defaults to `true`, but see
1433"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531434
1435notes.rewriteMode::
1436When copying notes during a rewrite (see the
1437"notes.rewrite.<command>" option), determines what to do if
1438the target commit already has a note. Must be one of
1439`overwrite`, `concatenate`, or `ignore`. Defaults to
1440`concatenate`.
1441+
1442This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1443environment variable.
1444
1445notes.rewriteRef::
1446When copying notes during a rewrite, specifies the (fully
1447qualified) ref whose notes should be copied. The ref may be a
1448glob, in which case notes in all matching refs will be copied.
1449You may also specify this configuration several times.
1450+
1451Does not have a default value; you must configure this variable to
1452enable note rewriting.
Junio C Hamano2b3ee5d2010-05-08 05:41:181453+
1454This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1455environment variable, which must be a colon separated list of refs or
1456globs.
Junio C Hamano31667362010-03-25 00:38:531457
Junio C Hamano75cc4c92006-07-24 08:25:031458pack.window::
Junio C Hamano35738e82008-01-07 07:55:461459The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031460window size is given on the command line. Defaults to 10.
1461
Junio C Hamano91d44c52007-05-09 07:16:071462pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461463The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071464maximum depth is given on the command line. Defaults to 50.
1465
Junio C Hamano235d53f2007-07-13 00:25:151466pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461467The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151468when no limit is given on the command line. The value can be
1469suffixed with "k", "m", or "g". Defaults to 0, meaning no
1470limit.
1471
Junio C Hamanof2ce2972007-05-20 19:12:091472pack.compression::
1473An integer -1..9, indicating the compression level for objects
1474in a pack file. -1 is the zlib default. 0 means no
1475compression, and 1..9 are various speed/size tradeoffs, 9 being
1476slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421477not set, defaults to -1, the zlib default, which is "a default
1478compromise between speed and compression (currently equivalent
1479to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241480+
1481Note that changing the compression level will not automatically recompress
1482all existing objects. You can force recompression by passing the -F option
1483to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091484
Junio C Hamano679d22d2007-06-02 21:13:441485pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271486The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521487linkgit:git-pack-objects[1] before writing them out to a pack.
1488This cache is used to speed up the writing object phase by not
1489having to recompute the final delta result once the best match
1490for all objects is found. Repacking large repositories on machines
1491which are tight with memory might be badly impacted by this though,
1492especially if this cache pushes the system into swapping.
1493A value of 0 means no limit. The smallest size of 1 byte may be
1494used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441495
1496pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141497The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521498linkgit:git-pack-objects[1]. This cache is used to speed up the
1499writing object phase by not having to recompute the final delta
1500result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441501
Junio C Hamano58155b42007-09-15 07:46:141502pack.threads::
1503Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461504delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141505be compiled with pthreads otherwise this option is ignored with a
1506warning. This is meant to reduce packing time on multiprocessor
1507machines. The required amount of memory for the delta search window
1508is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441509Specifying 0 will cause git to auto-detect the number of CPU's
1510and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141511
Junio C Hamanod814b6d2007-11-04 11:13:491512pack.indexVersion::
1513Specify the default pack index version. Valid values are 1 for
1514legacy pack index used by Git versions prior to 1.5.2, and 2 for
1515the new pack index with capabilities for packs larger than 4 GB
1516as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381517packs. Version 2 is the default. Note that version 2 is enforced
1518and this config option ignored whenever the corresponding pack is
1519larger than 2 GB.
1520+
1521If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1522cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1523that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1524other side may give you a repository that cannot be accessed with your
1525older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1526you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1527the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491528
Junio C Hamano09a926d2008-03-13 07:55:291529pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291530The maximum size of a pack. This setting only affects
1531packing to a file when repacking, i.e. the git:// protocol
1532is unaffected. It can be overridden by the `\--max-pack-size`
1533option of linkgit:git-repack[1]. The minimum size allowed is
1534limited to 1 MiB. The default is unlimited.
1535Common unit suffixes of 'k', 'm', or 'g' are
1536supported.
Junio C Hamano49dccaf2008-02-10 10:48:011537
Junio C Hamano9e96a1a2008-08-16 10:23:181538pager.<cmd>::
Junio C Hamano0551f6a2008-08-25 00:33:331539Allows turning on or off pagination of the output of a
1540particular git subcommand when writing to a tty. If
1541`\--paginate` or `\--no-pager` is specified on the command line,
1542it takes precedence over this option. To disable pagination for
Junio C Hamanoea82cff2009-03-18 01:54:481543all commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181544
Junio C Hamanoa574a092010-06-13 19:57:101545pretty.<name>::
1546Alias for a --pretty= format string, as specified in
1547linkgit:git-log[1]. Any aliases defined here can be used just
1548as the built-in pretty formats could. For example,
1549running `git config pretty.changelog "format:{asterisk} %H %s"`
1550would cause the invocation `git log --pretty=changelog`
1551to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1552Note that an alias with the same name as a built-in format
1553will be silently ignored.
1554
Junio C Hamano07824ce2006-04-25 07:36:541555pull.octopus::
1556The default merge strategy to use when pulling multiple branches
1557at once.
1558
1559pull.twohead::
1560The default merge strategy to use when pulling a single branch.
1561
Junio C Hamano1de75722009-03-26 08:39:381562push.default::
1563Defines the action git push should take if no refspec is given
1564on the command line, no refspec is configured in the remote, and
1565no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191566line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381567+
Junio C Hamano7f9fa862010-10-19 23:51:141568* `nothing` - do not push anything.
1569* `matching` - push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381570 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191571 matching. This is the default.
Junio C Hamano7f9fa862010-10-19 23:51:141572* `tracking` - push the current branch to its upstream branch.
1573* `current` - push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381574
Junio C Hamanoea6a7642009-03-11 23:56:191575rebase.stat::
1576Whether to show a diffstat of what changed upstream since the last
1577rebase. False by default.
1578
Junio C Hamano075ae872010-09-01 18:43:071579rebase.autosquash::
1580If set to true enable '--autosquash' option by default.
1581
Junio C Hamano621e1232009-10-26 05:16:471582receive.autogc::
1583By default, git-receive-pack will run "git-gc --auto" after
1584receiving data from git-push and updating refs. You can stop
1585it by setting this variable to false.
1586
Junio C Hamano4653c6f2008-11-26 22:50:201587receive.fsckObjects::
1588If it is set to true, git-receive-pack will check all received
1589objects. It will abort in the case of a malformed object or a
1590broken link. The result of an abort are only dangling objects.
1591Defaults to false.
1592
1593receive.unpackLimit::
1594If the number of objects received in a push is below this
1595limit then the objects will be unpacked into loose object
1596files. However if the number of received objects equals or
1597exceeds this limit then the received pack will be stored as
1598a pack, after adding any missing delta bases. Storing the
1599pack from a push can make the push operation complete faster,
1600especially on slow filesystems. If not set, the value of
1601`transfer.unpackLimit` is used instead.
1602
1603receive.denyDeletes::
1604If set to true, git-receive-pack will deny a ref update that deletes
1605the ref. Use this to prevent such a ref deletion via a push.
1606
Junio C Hamanob4448a82010-07-26 09:02:321607receive.denyDeleteCurrent::
1608If set to true, git-receive-pack will deny a ref update that
1609deletes the currently checked out branch of a non-bare repository.
1610
Junio C Hamano4653c6f2008-11-26 22:50:201611receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:581612If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:201613to the currently checked out branch of a non-bare repository.
1614Such a push is potentially dangerous because it brings the HEAD
1615out of sync with the index and working tree. If set to "warn",
1616print a warning of such a push to stderr, but allow the push to
1617proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:151618message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:201619
1620receive.denyNonFastForwards::
1621If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541622not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201623even if that push is forced. This configuration variable is
1624set when initializing a shared repository.
1625
Junio C Hamano621e1232009-10-26 05:16:471626receive.updateserverinfo::
1627If set to true, git-receive-pack will run git-update-server-info
1628after receiving data from git-push and updating refs.
1629
Junio C Hamano249572f2006-10-24 05:44:081630remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461631The URL of a remote repository. See linkgit:git-fetch[1] or
1632linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081633
Junio C Hamano0e88f3e2009-06-21 08:03:251634remote.<name>.pushurl::
1635The push URL of a remote repository. See linkgit:git-push[1].
1636
Junio C Hamano58256872007-12-04 08:31:131637remote.<name>.proxy::
1638For remotes that require curl (http, https and ftp), the URL to
1639the proxy to use for that remote. Set to the empty string to
1640disable proxying for that remote.
1641
Junio C Hamano249572f2006-10-24 05:44:081642remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461643The default set of "refspec" for linkgit:git-fetch[1]. See
1644linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081645
1646remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461647The default set of "refspec" for linkgit:git-push[1]. See
1648linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081649
Junio C Hamano47d68a52008-05-06 06:35:401650remote.<name>.mirror::
1651If true, pushing to this remote will automatically behave
1652as if the `\--mirror` option was given on the command line.
1653
Junio C Hamano118d2772007-02-21 20:24:101654remote.<name>.skipDefaultUpdate::
1655If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271656using linkgit:git-fetch[1] or the `update` subcommand of
1657linkgit:git-remote[1].
1658
1659remote.<name>.skipFetchAll::
1660If true, this remote will be skipped by default when updating
1661using linkgit:git-fetch[1] or the `update` subcommand of
1662linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101663
Junio C Hamano4ad294b2007-01-20 02:22:501664remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481665The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551666option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501667
Junio C Hamano54ea8d32007-01-25 07:59:481668remote.<name>.uploadpack::
1669The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551670option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481671
Junio C Hamano17dde0e2007-02-26 09:50:211672remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551673Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:531674fetching from remote <name>. Setting it to \--tags will fetch every
1675tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:071676branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1677override this setting. See options \--tags and \--no-tags of
1678linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:211679
Junio C Hamano096dde22009-12-26 23:14:111680remote.<name>.vcs::
1681Setting this to a value <vcs> will cause git to interact with
1682the remote with the git-remote-<vcs> helper.
1683
Junio C Hamano118d2772007-02-21 20:24:101684remotes.<group>::
1685The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461686<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101687
Junio C Hamano77b7e902006-10-23 07:18:501688repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381689By default, linkgit:git-repack[1] creates packs that use
1690delta-base offset. If you need to share your repository with
1691git older than version 1.4.4, either directly or via a dumb
1692protocol such as http, then you need to set this option to
1693"false" and repack. Access from old git versions over the
1694native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501695
Junio C Hamano4653c6f2008-11-26 22:50:201696rerere.autoupdate::
1697When set to true, `git-rerere` updates the index with the
1698resulting contents after it cleanly resolves conflicts using
1699previously recorded resolution. Defaults to false.
1700
1701rerere.enabled::
1702Activate recording of resolved conflicts, so that identical
1703conflict hunks can be resolved automatically, should they
1704be encountered again. linkgit:git-rerere[1] command is by
1705default enabled if you create `rr-cache` directory under
1706`$GIT_DIR`, but can be disabled by setting this option to false.
1707
Junio C Hamano1bbd0f42009-07-23 06:20:291708sendemail.identity::
1709A configuration identity. When given, causes values in the
1710'sendemail.<identity>' subsection to take precedence over
1711values in the 'sendemail' section. The default identity is
1712the value of 'sendemail.identity'.
1713
1714sendemail.smtpencryption::
1715See linkgit:git-send-email[1] for description. Note that this
1716setting is not subject to the 'identity' mechanism.
1717
1718sendemail.smtpssl::
1719Deprecated alias for 'sendemail.smtpencryption = ssl'.
1720
1721sendemail.<identity>.*::
1722Identity-specific versions of the 'sendemail.*' parameters
1723found below, taking precedence over those when the this
1724identity is selected, through command-line or
1725'sendemail.identity'.
1726
1727sendemail.aliasesfile::
1728sendemail.aliasfiletype::
1729sendemail.bcc::
1730sendemail.cc::
1731sendemail.cccmd::
1732sendemail.chainreplyto::
1733sendemail.confirm::
1734sendemail.envelopesender::
1735sendemail.from::
1736sendemail.multiedit::
1737sendemail.signedoffbycc::
1738sendemail.smtppass::
1739sendemail.suppresscc::
1740sendemail.suppressfrom::
1741sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:481742sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:291743sendemail.smtpserver::
1744sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:541745sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:291746sendemail.smtpuser::
1747sendemail.thread::
1748sendemail.validate::
1749See linkgit:git-send-email[1] for description.
1750
1751sendemail.signedoffcc::
1752Deprecated alias for 'sendemail.signedoffbycc'.
1753
Junio C Hamano07824ce2006-04-25 07:36:541754showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461755The default set of branches for linkgit:git-show-branch[1].
1756See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541757
Junio C Hamano942b35e2007-12-09 10:19:331758status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461759By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331760current directory. Setting this variable to `false` shows paths
1761relative to the repository root (this was the default for git
1762prior to v1.5.4).
1763
Junio C Hamano4224f992008-06-23 07:14:081764status.showUntrackedFiles::
1765By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1766files which are not currently tracked by Git. Directories which
1767contain only untracked files, are shown with the directory name
1768only. Showing untracked files means that Git needs to lstat() all
1769all the files in the whole repository, which might be slow on some
1770systems. So, this variable controls how the commands displays
1771the untracked files. Possible values are:
1772+
1773--
Junio C Hamano7f9fa862010-10-19 23:51:141774* `no` - Show no untracked files.
1775* `normal` - Show untracked files and directories.
1776* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:081777--
1778+
1779If this variable is not specified, it defaults to 'normal'.
1780This variable can be overridden with the -u|--untracked-files option
1781of linkgit:git-status[1] and linkgit:git-commit[1].
1782
Junio C Hamanob671fb52010-06-01 05:06:141783status.submodulesummary::
1784Defaults to false.
1785If this is set to a non zero number or true (identical to -1 or an
1786unlimited number), the submodule summary will be enabled and a
1787summary of commits for modified submodules will be shown (see
1788--summary-limit option of linkgit:git-submodule[1]).
1789
Junio C Hamano78e3a782010-07-15 22:24:451790submodule.<name>.path::
1791submodule.<name>.url::
1792submodule.<name>.update::
1793The path within this project, URL, and the updating strategy
1794for a submodule. These variables are initially populated
1795by 'git submodule init'; edit them to override the
1796URL and other values found in the `.gitmodules` file. See
1797linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1798
Junio C Hamano619596a2010-08-18 22:15:351799submodule.<name>.ignore::
1800Defines under what circumstances "git status" and the diff family show
1801a submodule as modified. When set to "all", it will never be considered
1802modified, "dirty" will ignore all changes to the submodules work tree and
1803takes only differences between the HEAD of the submodule and the commit
1804recorded in the superproject into account. "untracked" will additionally
1805let submodules with modified tracked files in their work tree show up.
1806Using "none" (the default when this option is not set) also shows
1807submodules that have untracked files in their work tree as changed.
1808This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:181809both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:351810"--ignore-submodules" option.
1811
Junio C Hamano75cc4c92006-07-24 08:25:031812tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091813This variable can be used to restrict the permission bits of
1814tar archive entries. The default is 0002, which turns off the
1815world write bit. The special value "user" indicates that the
1816archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461817linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031818
Junio C Hamano4653c6f2008-11-26 22:50:201819transfer.unpackLimit::
1820When `fetch.unpackLimit` or `receive.unpackLimit` are
1821not set, the value of this variable is used instead.
1822The default value is 100.
1823
Junio C Hamano24bc09a2008-02-28 00:27:441824url.<base>.insteadOf::
1825Any URL that starts with this value will be rewritten to
1826start, instead, with <base>. In cases where some site serves a
1827large number of repositories, and serves them with multiple
1828access methods, and some users need to use different access
1829methods, this feature allows people to specify any of the
1830equivalent URLs and have git automatically rewrite the URL to
1831the best alternative for the particular user, even for a
1832never-before-seen repository on the site. When more than one
1833insteadOf strings match a given URL, the longest match is used.
1834
Junio C Hamano7df6dcf2009-09-13 09:51:171835url.<base>.pushInsteadOf::
1836Any URL that starts with this value will not be pushed to;
1837instead, it will be rewritten to start with <base>, and the
1838resulting URL will be pushed to. In cases where some site serves
1839a large number of repositories, and serves them with multiple
1840access methods, some of which do not allow push, this feature
1841allows people to specify a pull-only URL and have git
1842automatically use an appropriate URL to push, even for a
1843never-before-seen repository on the site. When more than one
1844pushInsteadOf strings match a given URL, the longest match is
1845used. If a remote has an explicit pushurl, git will ignore this
1846setting for that remote.
1847
Junio C Hamano07824ce2006-04-25 07:36:541848user.email::
1849Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341850Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461851'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541852
1853user.name::
1854Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481855Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461856environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541857
Junio C Hamanoa890c4f2007-01-28 10:29:211858user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461859If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211860automatically when creating a signed tag, you can override the
1861default selection with this variable. This option is passed
1862unchanged to gpg's --local-user parameter, so you may specify a key
1863using any method that gpg supports.
1864
Junio C Hamano4e272312008-01-08 09:13:211865web.browser::
1866Specify a web browser that may be used by some commands.
1867Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1868may use it.