blob: 4c36aa95b7d3fc0d456d42bbdfdf5a118931094b [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
131merge to avoid overwritting local changes.
132Default: 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 Hamano7df6dcf2009-09-13 09:51:17141--
142
Junio C Hamano07824ce2006-04-25 07:36:54143core.fileMode::
144If false, the executable bit differences between the index and
145the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27146See linkgit:git-update-index[1].
147+
148The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
149will probe and set core.fileMode false if appropriate when the
150repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54151
Junio C Hamanoa476efa2008-10-10 15:31:42152core.ignoreCygwinFSTricks::
153This option is only used by Cygwin implementation of Git. If false,
154the Cygwin stat() and lstat() functions are used. This may be useful
155if your repository consists of a few separate directories joined in
156one hierarchy using Cygwin mount. If true, Git uses native Win32 API
157whenever it is possible and falls back to Cygwin functions only to
158handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33159normal Cygwin l/stat() functions. True by default, unless core.filemode
160is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
161POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42162
Junio C Hamano9df0c662009-11-23 11:09:27163core.ignorecase::
164If true, this option enables various workarounds to enable
165git to work better on filesystems that are not case sensitive,
166like FAT. For example, if a directory listing finds
167"makefile" when git expects "Makefile", git will assume
168it is really the same file, and continue to remember it as
169"Makefile".
170+
171The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
172will probe and set core.ignorecase true if appropriate when the repository
173is created.
174
Junio C Hamano90ccff32008-07-29 08:17:24175core.trustctime::
176If false, the ctime differences between the index and the
177working copy are ignored; useful when the inode change time
178is regularly modified by something outside Git (file system
179crawlers and some backup systems).
180See linkgit:git-update-index[1]. True by default.
181
Junio C Hamanod526ba92007-07-02 00:17:42182core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31183The commands that output paths (e.g. 'ls-files',
184'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42185"unusual" characters in the pathname by enclosing the
186pathname in a double-quote pair and with backslashes the
187same way strings in C source code are quoted. If this
188variable is set to false, the bytes higher than 0x80 are
189not quoted but output as verbatim. Note that double
190quote, backslash and control characters are always
191quoted without `-z` regardless of the setting of this
192variable.
193
Junio C Hamanod9e0e5d2007-04-14 16:22:04194core.autocrlf::
195If true, makes git convert `CRLF` at the end of lines in text files to
196`LF` when reading from the filesystem, and convert in reverse when
197writing to the filesystem. The variable can be set to
198'input', in which case the conversion happens only while
199reading from the filesystem but files are written out with
Junio C Hamanobf984de2009-11-23 06:11:19200`LF` at the end of lines. A file is considered
201"text" (i.e. be subjected to the autocrlf mechanism) based on
202the file's `crlf` attribute, or if `crlf` is unspecified,
203based on the file's contents. See linkgit:gitattributes[5].
Junio C Hamanod9e0e5d2007-04-14 16:22:04204
Junio C Hamano26e590a2008-02-17 03:53:51205core.safecrlf::
206If true, makes git check if converting `CRLF` as controlled by
207`core.autocrlf` is reversible. Git will verify if a command
208modifies a file in the work tree either directly or indirectly.
209For example, committing a file followed by checking out the
210same file should yield the original file in the work tree. If
211this is not the case for the current setting of
212`core.autocrlf`, git will reject the file. The variable can
213be set to "warn", in which case git will only warn about an
214irreversible conversion but continue the operation.
215+
216CRLF conversion bears a slight chance of corrupting data.
217autocrlf=true will convert CRLF to LF during commit and LF to
218CRLF during checkout. A file that contains a mixture of LF and
219CRLF before the commit cannot be recreated by git. For text
220files this is the right thing to do: it corrects line endings
221such that we have only LF line endings in the repository.
222But for binary files that are accidentally classified as text the
223conversion can corrupt data.
224+
225If you recognize such corruption early you can easily fix it by
226setting the conversion type explicitly in .gitattributes. Right
227after committing you still have the original file in your work
228tree and this file is not yet corrupted. You can explicitly tell
229git that this file is binary and git will handle the file
230appropriately.
231+
232Unfortunately, the desired effect of cleaning up text files with
233mixed line endings and the undesired effect of corrupting binary
234files cannot be distinguished. In both cases CRLFs are removed
235in an irreversible way. For text files this is the right thing
236to do because CRLFs are line endings, while for binary files
237converting CRLFs corrupts data.
238+
239Note, this safety check does not mean that a checkout will generate a
240file identical to the original file for a different setting of
241`core.autocrlf`, but only for the current one. For example, a text
242file with `LF` would be accepted with `core.autocrlf=input` and could
243later be checked out with `core.autocrlf=true`, in which case the
244resulting file would contain `CRLF`, although the original file
245contained `LF`. However, in both work trees the line endings would be
246consistent, that is either all `LF` or all `CRLF`, but never mixed. A
247file with mixed line endings would be reported by the `core.safecrlf`
248mechanism.
249
Junio C Hamanoaa83a7d2007-03-05 02:37:29250core.symlinks::
251If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46252contain the link text. linkgit:git-update-index[1] and
253linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29254file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27255symbolic links.
256+
257The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
258will probe and set core.symlinks false if appropriate when the repository
259is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29260
Junio C Hamano07824ce2006-04-25 07:36:54261core.gitProxy::
262A "proxy command" to execute (as 'command host port') instead
263of establishing direct connection to the remote server when
264using the git protocol for fetching. If the variable value is
265in the "COMMAND for DOMAIN" format, the command is applied only
266on hostnames ending with the specified domain string. This variable
267may be set multiple times and is matched in the given order;
268the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17269+
270Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
271(which always applies universally, without the special "for"
272handling).
Junio C Hamanoea82cff2009-03-18 01:54:48273+
274The special string `none` can be used as the proxy command to
275specify that no proxy be used for a given domain pattern.
276This is useful for excluding servers inside a firewall from
277proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54278
279core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34280If true, commands which modify both the working tree and the index
281will mark the updated paths with the "assume unchanged" bit in the
282index. These marked files are then assumed to stay unchanged in the
283working copy, until you mark them otherwise manually - Git will not
284detect the file changes by lstat() calls. This is useful on systems
285where those are very slow, such as Microsoft Windows.
286See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54287False by default.
288
Junio C Hamano88a3a072006-05-04 08:01:43289core.preferSymlinkRefs::
290Instead of the default "symref" format for HEAD
291and other symbolic reference files, use symbolic links.
292This is sometimes needed to work with old scripts that
293expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54294
Junio C Hamano1025e752007-02-23 07:21:26295core.bare::
296If true this repository is assumed to be 'bare' and has no
297working directory associated with it. If this is the case a
298number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46299disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26300+
Junio C Hamano35738e82008-01-07 07:55:46301This setting is automatically guessed by linkgit:git-clone[1] or
302linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26303repository that ends in "/.git" is assumed to be not bare (bare =
304false), while all other repositories are assumed to be bare (bare
305= true).
306
Junio C Hamanod526ba92007-07-02 00:17:42307core.worktree::
Junio C Hamanodab291e2009-12-30 09:45:38308Set the path to the root of the work tree.
Junio C Hamano764a6672007-10-23 01:23:31309This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27310variable and the '--work-tree' command line option. It can be
Junio C Hamanodab291e2009-12-30 09:45:38311an absolute path or a relative path to the .git directory,
312either specified by --git-dir or GIT_DIR, or automatically
313discovered.
314If --git-dir or GIT_DIR are specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27315--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanodab291e2009-12-30 09:45:38316the current working directory is regarded as the root of the
317work tree.
318+
319Note that this variable is honored even when set in a configuration
320file in a ".git" subdirectory of a directory, and its value differs
321from the latter directory (e.g. "/path/to/.git/config" has
322core.worktree set to "/different/path"), which is most likely a
323misconfiguration. Running git commands in "/path/to" directory will
324still use "/different/path" as the root of the work tree and can cause
325great confusion to the users.
Junio C Hamanod526ba92007-07-02 00:17:42326
Junio C Hamano341071d2006-06-04 07:24:48327core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49328Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48329"$GIT_DIR/logs/<ref>", by appending the new and old
330SHA1, the date/time and the reason of the update, but
331only when the file exists. If this configuration
332variable is set to true, missing "$GIT_DIR/logs/<ref>"
333file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35334+
335This information can be used to determine what commit
336was the tip of a branch "2 days ago".
337+
338This value is true by default in a repository that has
339a working directory associated with it, and false by
340default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48341
Junio C Hamano07824ce2006-04-25 07:36:54342core.repositoryFormatVersion::
343Internal variable identifying the repository format and layout
344version.
345
346core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42347When 'group' (or 'true'), the repository is made shareable between
348several users in a group (making sure all the files and objects are
349group-writable). When 'all' (or 'world' or 'everybody'), the
350repository will be readable by all users, additionally to being
351group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37352reported by umask(2). When '0xxx', where '0xxx' is an octal number,
353files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00354user's umask value (whereas the other options will only override
355requested parts of the user's umask value). Examples: '0660' will make
356the repo read/write-able for the owner and group, but inaccessible to
357others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37358repository that is group-readable but not group-writable.
359See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54360
361core.warnAmbiguousRefs::
362If true, git will warn you if the ref name you passed it is ambiguous
363and might match multiple refs in the .git/refs/ tree. True by default.
364
Junio C Hamano7ec15722006-07-07 02:03:59365core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09366An integer -1..9, indicating a default compression level.
367-1 is the zlib default. 0 means no compression,
368and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42369If set, this provides a default to other compression variables,
370such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26371
Junio C Hamanof2ce2972007-05-20 19:12:09372core.loosecompression::
373An integer -1..9, indicating the compression level for objects that
374are not in a pack file. -1 is the zlib default. 0 means no
375compression, and 1..9 are various speed/size tradeoffs, 9 being
376slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42377not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49378
Junio C Hamanofc4d38c2007-01-08 06:53:32379core.packedGitWindowSize::
380Number of bytes of a pack file to map into memory in a
381single mapping operation. Larger window sizes may allow
382your system to process a smaller number of large pack files
383more quickly. Smaller window sizes will negatively affect
384performance due to increased calls to the operating system's
385memory manager, but may improve performance when accessing
386a large number of large pack files.
387+
388Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
389MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
390be reasonable for all users/operating systems. You probably do
391not need to adjust this value.
392+
393Common unit suffixes of 'k', 'm', or 'g' are supported.
394
395core.packedGitLimit::
396Maximum number of bytes to map simultaneously into memory
397from pack files. If Git needs to access more than this many
398bytes at once to complete an operation it will unmap existing
399regions to reclaim virtual address space within the process.
400+
401Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
402This should be reasonable for all users/operating systems, except on
403the largest projects. You probably do not need to adjust this value.
404+
405Common unit suffixes of 'k', 'm', or 'g' are supported.
406
Junio C Hamanob8c51282007-03-19 10:43:30407core.deltaBaseCacheLimit::
408Maximum number of bytes to reserve for caching base objects
409that multiple deltafied objects reference. By storing the
410entire decompressed base objects in a cache Git is able
411to avoid unpacking and decompressing frequently used base
412objects multiple times.
413+
414Default is 16 MiB on all platforms. This should be reasonable
415for all users/operating systems, except on the largest projects.
416You probably do not need to adjust this value.
417+
418Common unit suffixes of 'k', 'm', or 'g' are supported.
419
Junio C Hamano5c246f22010-02-03 07:34:53420core.bigFileThreshold::
421Files larger than this size are stored deflated, without
422attempting delta compression. Storing large files without
423delta compression avoids excessive memory usage, at the
424slight expense of increased disk usage.
425+
426Default is 512 MiB on all platforms. This should be reasonable
427for most projects as source code and other text files can still
428be delta compressed, but larger binary media files won't be.
429+
430Common unit suffixes of 'k', 'm', or 'g' are supported.
431+
432Currently only linkgit:git-fast-import[1] honors this setting.
433
Junio C Hamano1d90cb02007-07-03 07:05:31434core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37435In addition to '.gitignore' (per-directory) and
436'.git/info/exclude', git looks into this file for patterns
Junio C Hamanobf984de2009-11-23 06:11:19437of files which are not meant to be tracked. "{tilde}/" is expanded
438to the value of `$HOME` and "{tilde}user/" to the specified user's
439home directory. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37440
Junio C Hamanof6002a92007-07-20 10:28:22441core.editor::
442Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27443messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22444variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37445`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22446
Junio C Hamano28d8ede2007-07-05 05:51:38447core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33448The command that git will use to paginate output. Can
449be overridden with the `GIT_PAGER` environment
450variable. Note that git sets the `LESS` environment
451variable to `FRSX` if it is unset when it runs the
452pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42453`LESS` variable to some other value. Alternately,
454these settings can be overridden on a project or
455global basis by setting the `core.pager` option.
456Setting `core.pager` has no affect on the `LESS`
457environment variable behaviour above, so if you want
458to override git's default settings this way, you need
459to be explicit. For example, to disable the S option
460in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48461to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42462shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48463`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38464
Junio C Hamano942b35e2007-12-09 10:19:33465core.whitespace::
466A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43467notice. 'git diff' will use `color.diff.whitespace` to
468highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59469consider them as errors. You can prefix `-` to disable
470any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33471+
Junio C Hamanob71a22d2009-10-17 08:23:47472* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33473 as an error (enabled by default).
474* `space-before-tab` treats a space character that appears immediately
475 before a tab character in the initial indent part of the line as an
476 error (enabled by default).
477* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42478 space characters as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47479* `blank-at-eof` treats blank lines added at the end of file as an error
480 (enabled by default).
481* `trailing-space` is a short-hand to cover both `blank-at-eol` and
482 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42483* `cr-at-eol` treats a carriage-return at the end of line as
484 part of the line terminator, i.e. with it, `trailing-space`
485 does not trigger if the character before such a carriage-return
486 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33487
Junio C Hamano9eb57532008-06-26 06:33:46488core.fsyncobjectfiles::
489This boolean will enable 'fsync()' when writing object files.
490+
491This is a total waste of time and effort on a filesystem that orders
492data writes properly, but can be useful for filesystems that do not use
493journalling (traditional UNIX filesystems) or that only journal metadata
494and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
495
Junio C Hamano610d1762008-11-28 06:27:13496core.preloadindex::
497Enable parallel index preload for operations like 'git diff'
498+
499This can speed up operations like 'git diff' and 'git status' especially
500on filesystems like NFS that have weak caching semantics and thus
501relatively high IO latencies. With this set to 'true', git will do the
502index comparison to the filesystem data in parallel, allowing
503overlapping IO's.
504
Junio C Hamanoa9499de2009-04-30 03:38:48505core.createObject::
506You can set this to 'link', in which case a hardlink followed by
507a delete of the source are used to make sure that object creation
508will not overwrite existing objects.
509+
510On some file system/operating system combinations, this is unreliable.
511Set this config setting to 'rename' there; However, This will remove the
512check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41513
Junio C Hamano3b70d3c2009-11-21 17:37:37514core.notesRef::
515When showing commit messages, also show notes which are stored in
516the given ref. This ref is expected to contain files named
517after the full SHA-1 of the commit they annotate.
518+
519If such a file exists in the given ref, the referenced blob is read, and
520appended to the commit message, separated by a "Notes:" line. If the
521given ref itself does not exist, it is not an error, but means that no
522notes should be printed.
523+
524This setting defaults to "refs/notes/commits", and can be overridden by
525the `GIT_NOTES_REF` environment variable.
526
Junio C Hamano3c8d6702010-01-13 23:09:03527core.sparseCheckout::
528Enable "sparse checkout" feature. See section "Sparse checkout" in
529linkgit:git-read-tree[1] for more information.
530
Junio C Hamano3d141512009-06-01 01:22:40531add.ignore-errors::
Junio C Hamano1aa40d22010-01-21 17:46:43532Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40533added due to indexing errors. Equivalent to the '--ignore-errors'
534option of linkgit:git-add[1].
535
Junio C Hamano33db4372006-06-07 19:51:45536alias.*::
Junio C Hamano35738e82008-01-07 07:55:46537Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45538after defining "alias.last = cat-file commit HEAD", the invocation
539"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17540confusion and troubles with script usage, aliases that
541hide existing git commands are ignored. Arguments are split by
542spaces, the usual shell quoting and escaping is supported.
543quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39544+
545If the alias expansion is prefixed with an exclamation point,
546it will be treated as a shell command. For example, defining
547"alias.new = !gitk --all --not ORIG_HEAD", the invocation
548"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19549"gitk --all --not ORIG_HEAD". Note that shell commands will be
550executed from the top-level directory of a repository, which may
551not necessarily be the current directory.
Junio C Hamano9cb74f22007-02-12 04:15:05552
Junio C Hamanofe24db02009-08-22 05:10:47553apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43554When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47555whitespace, in the same way as the '--ignore-space-change'
556option.
Junio C Hamano1aa40d22010-01-21 17:46:43557When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47558respect all whitespace differences.
559See linkgit:git-apply[1].
560
Junio C Hamano07824ce2006-04-25 07:36:54561apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43562Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46563as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54564
Junio C Hamano7fd84172007-05-24 07:00:32565branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43566Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44567so that linkgit:git-pull[1] will appropriately merge from the
568starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32569this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44570and `--no-track` options. The valid settings are: `false` -- no
571automatic setup is done; `true` -- automatic setup is done when the
572starting point is a remote branch; `always` -- automatic setup is
573done when the starting point is either a local branch or remote
574branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32575
Junio C Hamano869bb802008-05-12 00:29:47576branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43577When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano869bb802008-05-12 00:29:47578that tracks another branch, this variable tells git to set
579up pull to rebase instead of merge (see "branch.<name>.rebase").
580When `never`, rebase is never automatically set to true.
581When `local`, rebase is set to true for tracked branches of
582other local branches.
583When `remote`, rebase is set to true for tracked branches of
584remote branches.
585When `always`, rebase will be set to true for all tracking
586branches.
587See "branch.autosetupmerge" for details on how to set up a
588branch to track another branch.
589This option defaults to never.
590
Junio C Hamano47c1e3c2006-09-25 04:45:55591branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43592When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19593remote to fetch from/push to. It defaults to `origin` if no remote is
594configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55595
596branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19597Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamano1aa40d22010-01-21 17:46:43598for the given branch. It tells 'git fetch'/'git pull' which
599branch to merge and can also affect 'git push' (see push.default).
600When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31601refspec to be marked for merging in FETCH_HEAD. The value is
602handled like the remote part of a refspec, and must match a
603ref which is fetched from the remote given by
604"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43605The merge information is used by 'git pull' (which at first calls
606'git fetch') to lookup the default branch for merging. Without
607this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46608Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43609If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07610another branch in the local repository, you can point
611branch.<name>.merge to the desired branch, and use the special setting
612`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55613
Junio C Hamano1b50ce92007-10-03 12:05:53614branch.<name>.mergeoptions::
615Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29616supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53617option values containing whitespace characters are currently not
618supported.
619
Junio C Hamano0c999702007-12-03 09:57:55620branch.<name>.rebase::
621When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08622instead of merging the default branch from the default remote when
623"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55624*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46625it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55626for details).
627
Junio C Hamano8760ea62008-03-14 08:58:45628browser.<tool>.cmd::
629Specify the command to invoke the specified browser. The
630specified command is evaluated in shell with the URLs passed
631as arguments. (See linkgit:git-web--browse[1].)
632
Junio C Hamanoe35a6fc2008-01-29 09:46:27633browser.<tool>.path::
634Override the path for the given tool that may be used to
635browse HTML help (see '-w' option in linkgit:git-help[1]) or a
636working repository in gitweb (see linkgit:git-instaweb[1]).
637
Junio C Hamano47b9acd2007-04-24 07:34:34638clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45639A boolean to make git-clean do nothing unless given -f
640or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34641
Junio C Hamanoeb692952007-01-03 22:02:12642color.branch::
643A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46644linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21645`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12646only when the output is to a terminal. Defaults to false.
647
648color.branch.<slot>::
649Use customized color for branch coloration. `<slot>` is one of
650`current` (the current branch), `local` (a local branch),
651`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22652refs).
653+
654The value for these configuration variables is a list of colors (at most
655two) and attributes (at most one), separated by spaces. The colors
656accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
657`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
658`blink` and `reverse`. The first color given is the foreground; the
659second is the background. The position of the attribute, if any,
660doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12661
Junio C Hamano3f403b02006-12-13 10:14:13662color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21663When set to `always`, always use colors in patch.
664When false (or `never`), never. When set to `true` or `auto`, use
665colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34666
Junio C Hamano3f403b02006-12-13 10:14:13667color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22668Use customized color for diff colorization. `<slot>` specifies
669which part of the patch to use the specified color, and is one
670of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59671(hunk header), 'func' (function in hunk header), `old` (removed lines),
672`new` (added lines), `commit` (commit headers), or `whitespace`
673(highlighting whitespace errors). The values of these variables may be
674specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34675
Junio C Hamanod257cff2009-03-18 05:27:16676color.grep::
677When set to `always`, always highlight matches. When `false` (or
678`never`), never. When set to `true` or `auto`, use color only
679when the output is written to the terminal. Defaults to `false`.
680
Junio C Hamanod257cff2009-03-18 05:27:16681color.grep.match::
682Use customized color for matches. The value of this variable
683may be specified as in color.branch.<slot>. It is passed using
684the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
685calling an external 'grep'.
686
Junio C Hamano00b8b632007-12-07 09:50:49687color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46688When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31689and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49690When false (or `never`), never. When set to `true` or `auto`, use
691colors only when the output is to the terminal. Defaults to false.
692
693color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43694Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10695output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
696four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00697commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49698in color.branch.<slot>.
699
Junio C Hamanoe7935c42006-12-13 21:32:17700color.pager::
701A boolean to enable/disable colored output when the pager is in
702use (default is true).
703
Junio C Hamano52ba2952009-05-18 17:43:02704color.showbranch::
705A boolean to enable/disable color in the output of
706linkgit:git-show-branch[1]. May be set to `always`,
707`false` (or `never`) or `auto` (or `true`), in which case colors are used
708only when the output is to a terminal. Defaults to false.
709
Junio C Hamanoe7935c42006-12-13 21:32:17710color.status::
711A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46712linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21713`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17714only when the output is to a terminal. Defaults to false.
715
716color.status.<slot>::
717Use customized color for status colorization. `<slot>` is
718one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04719`added` or `updated` (files which are added but not committed),
720`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30721`untracked` (files which are not tracked by git), or
722`nobranch` (the color the 'no branch' warning is shown in, defaulting
723to red). The values of these variables may be specified as in
724color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17725
Junio C Hamano83d46a22008-02-21 02:29:42726color.ui::
727When set to `always`, always use colors in all git commands which
728are capable of colored output. When false (or `never`), never. When
729set to `true` or `auto`, use colors only when the output is to the
730terminal. When more specific variables of color.* are set, they always
731take precedence over this setting. Defaults to false.
732
Junio C Hamanod0d892c2010-01-24 20:06:29733commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50734A boolean to enable/disable inclusion of status information in the
735commit message template when using an editor to prepare the commit
736message. Defaults to true.
737
Junio C Hamano4653c6f2008-11-26 22:50:20738commit.template::
739Specify a file to use as the template for new commit messages.
Junio C Hamanobf984de2009-11-23 06:11:19740"{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
741specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20742
Junio C Hamanodbb64592007-09-01 11:17:39743diff.autorefreshindex::
Junio C Hamano1aa40d22010-01-21 17:46:43744When using 'git diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39745files, do not consider stat-only change as changed.
746Instead, silently run `git update-index --refresh` to
747update the cached stat information for paths whose
748contents in the work tree match the contents in the
749index. This option defaults to true. Note that this
Junio C Hamano1aa40d22010-01-21 17:46:43750affects only 'git diff' Porcelain, and not lower level
751'diff' commands such as 'git diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39752
Junio C Hamano1fbbbc12007-12-18 07:01:27753diff.external::
754If this config variable is set, diff generation is not
755performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31756given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
757environment variable. The command is called with parameters
758as described under "git Diffs" in linkgit:git[1]. Note: if
759you want to use an external diff program only on a subset of
760your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27761
Junio C Hamano5e4d8de2008-09-19 06:27:02762diff.mnemonicprefix::
Junio C Hamano1aa40d22010-01-21 17:46:43763If set, 'git diff' uses a prefix pair that is different from the
Junio C Hamano5e4d8de2008-09-19 06:27:02764standard "a/" and "b/" depending on what is being compared. When
765this configuration is in effect, reverse diff output also swaps
766the order of the prefixes:
Junio C Hamano1aa40d22010-01-21 17:46:43767`git diff`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02768compares the (i)ndex and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43769`git diff HEAD`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02770 compares a (c)ommit and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43771`git diff --cached`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02772compares a (c)ommit and the (i)ndex;
Junio C Hamano1aa40d22010-01-21 17:46:43773`git diff HEAD:file1 file2`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02774compares an (o)bject and a (w)ork tree entity;
Junio C Hamano1aa40d22010-01-21 17:46:43775`git diff --no-index a b`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02776compares two non-git things (1) and (2).
777
Junio C Hamano07824ce2006-04-25 07:36:54778diff.renameLimit::
779The number of files to consider when performing the copy/rename
Junio C Hamano1aa40d22010-01-21 17:46:43780detection; equivalent to the 'git diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54781
Junio C Hamano9ae1a062006-07-10 08:12:34782diff.renames::
783Tells git to detect renames. If set to any boolean value, it
784will enable basic rename detection. If set to "copies" or
785"copy", it will detect copies, as well.
786
Junio C Hamanobc4852e2009-01-21 10:51:14787diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21788A boolean to inhibit the standard behavior of printing a space
789before each empty output line. Defaults to false.
790
Junio C Hamano3bd66e92009-04-18 06:17:56791diff.tool::
792Controls which diff tool is used. `diff.tool` overrides
793`merge.tool` when used by linkgit:git-difftool[1] and has
794the same valid values as `merge.tool` minus "tortoisemerge"
795and plus "kompare".
796
797difftool.<tool>.path::
798Override the path for the given tool. This is useful in case
799your tool is not in the PATH.
800
801difftool.<tool>.cmd::
802Specify the command to invoke the specified diff tool.
803The specified command is evaluated in shell with the following
804variables available: 'LOCAL' is set to the name of the temporary
805file containing the contents of the diff pre-image and 'REMOTE'
806is set to the name of the temporary file containing the contents
807of the diff post-image.
808
809difftool.prompt::
810Prompt before each invocation of the diff tool.
811
Junio C Hamano20d47e32009-01-26 06:36:02812diff.wordRegex::
813A POSIX Extended Regular Expression used to determine what is a "word"
814when performing word-by-word difference calculations. Character
815sequences that match the regular expression are "words", all other
816characters are *ignorable* whitespace.
817
Junio C Hamano54ea8d32007-01-25 07:59:48818fetch.unpackLimit::
819If the number of objects fetched over the git native
820transfer is below this
821limit, then the objects will be unpacked into loose object
822files. However if the number of received objects equals or
823exceeds this limit then the received pack will be stored as
824a pack, after adding any missing delta bases. Storing the
825pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17826especially on slow filesystems. If not set, the value of
827`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48828
Junio C Hamanof4581102009-04-25 08:29:59829format.attach::
830Enable multipart/mixed attachments as the default for
831'format-patch'. The value can also be a double quoted string
832which will enable attachments as the default and set the
833value as the boundary. See the --attach option in
834linkgit:git-format-patch[1].
835
Junio C Hamano8c5802d2007-11-15 00:13:36836format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33837A boolean which can enable or disable sequence numbers in patch
838subjects. It defaults to "auto" which enables it only if there
839is more than one patch. It can be enabled or disabled for all
840messages by setting it to "true" or "false". See --numbered
841option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36842
Junio C Hamano07824ce2006-04-25 07:36:54843format.headers::
844Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46845by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54846
Junio C Hamanof4581102009-04-25 08:29:59847format.cc::
848Additional "Cc:" headers to include in a patch to be submitted
849by mail. See the --cc option in linkgit:git-format-patch[1].
850
851format.subjectprefix::
852The default for format-patch is to output files with the '[PATCH]'
853subject prefix. Use this variable to change that prefix.
854
Junio C Hamanod4c8e112007-03-04 10:32:38855format.suffix::
856The default for format-patch is to output files with the suffix
857`.patch`. Use this variable to change that suffix (make sure to
858include the dot if you want it).
859
Junio C Hamano86bcccc2008-03-08 09:33:55860format.pretty::
861The default pretty format for log/show/whatchanged command,
862See linkgit:git-log[1], linkgit:git-show[1],
863linkgit:git-whatchanged[1].
864
Junio C Hamanoea6a7642009-03-11 23:56:19865format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:43866The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:14867a boolean value, or `shallow` or `deep`. `shallow` threading
868makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:19869where the head is chosen from the cover letter, the
870`\--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59871`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19872A true boolean value is the same as `shallow`, and a false
873value disables threading.
874
Junio C Hamano5f9a6f02009-04-06 08:26:56875format.signoff::
876 A boolean value which lets you enable the `-s/--signoff` option of
877 format-patch by default. *Note:* Adding the Signed-off-by: line to a
878 patch should be a conscious act and means that you certify you have
879 the rights to submit this work under the same open source license.
880 Please see the 'SubmittingPatches' document for further discussion.
881
Junio C Hamanof2ce2972007-05-20 19:12:09882gc.aggressiveWindow::
883The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:43884algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09885to 10.
886
Junio C Hamano1b50ce92007-10-03 12:05:53887gc.auto::
888When there are approximately more than this many loose
889objects in the repository, `git gc --auto` will pack them.
890Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17891light-weight garbage collection from time to time. The
892default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53893
894gc.autopacklimit::
895When there are more than this many packs that are not
896marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17897--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37898default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53899
Junio C Hamano9d52e572007-02-13 23:48:20900gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:14901Running `git pack-refs` in a repository renders it
902unclonable by Git versions prior to 1.5.1.2 over dumb
903transports such as HTTP. This variable determines whether
Junio C Hamano1aa40d22010-01-21 17:46:43904'git gc' runs `git pack-refs`. This can be set to `nobare`
Junio C Hamanob141a922010-01-10 19:55:14905to enable it within all non-bare repos or it can be set to a
906boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:20907
Junio C Hamano09a926d2008-03-13 07:55:29908gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:43909When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:57910Override the grace period with this config variable. The value
911"now" may be used to disable this grace period and always prune
912unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:29913
Junio C Hamano74640642006-12-27 10:59:55914gc.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:43915'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55916this time; defaults to 90 days.
917
918gc.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:43919'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55920this time and are not reachable from the current tip;
921defaults to 30 days.
922
923gc.rerereresolved::
924Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:43925kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46926The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55927
928gc.rerereunresolved::
929Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:43930kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46931The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55932
Junio C Hamanoa3148f52009-01-14 08:49:57933gitcvs.commitmsgannotation::
934Append this string to each commit message. Set to empty string
935to disable this feature. Defaults to "via git-CVS emulator".
936
Junio C Hamano07824ce2006-04-25 07:36:54937gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27938Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46939See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54940
941gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27942Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46943various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54944
Junio C Hamano17bd2272008-09-01 06:11:17945gitcvs.usecrlfattr::
Junio C Hamanodfccbb02008-05-26 01:16:14946If true, the server will look up the `crlf` attribute for
947files to determine the '-k' modes to use. If `crlf` is set,
948the '-k' mode will be left blank, so cvs clients will
949treat it as text. If `crlf` is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33950will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:14951the client might otherwise do. If `crlf` is not specified,
Junio C Hamanod32738e2008-07-09 19:53:42952then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:14953
Junio C Hamanod9e0e5d2007-04-14 16:22:04954gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14955This is used if 'gitcvs.usecrlfattr' does not resolve
956the correct '-kb' mode to use. If true, all
957unresolved files are sent to the client in
958mode '-kb'. This causes the client to treat them
959as binary files, which suppresses any newline munging it
960otherwise might do. Alternatively, if it is set to "guess",
961then the contents of the file are examined to decide if
962it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04963
964gitcvs.dbname::
965Database used by git-cvsserver to cache revision information
966derived from the git repository. The exact meaning depends on the
967used database driver, for SQLite (which is the default driver) this
968is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46969linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04970Default: '%Ggitcvs.%m.sqlite'
971
972gitcvs.dbdriver::
973Used Perl DBI driver. You can specify any available driver
974 for this here, but it might not work. git-cvsserver is tested
975with 'DBD::SQLite', reported to work with 'DBD::Pg', and
976reported *not* to work with 'DBD::mysql'. Experimental feature.
977May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46978See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04979
Junio C Hamanoa2ad99e2007-04-18 09:57:04980gitcvs.dbuser, gitcvs.dbpass::
981Database user and password. Only useful if setting 'gitcvs.dbdriver',
982since SQLite has no concept of database users and/or passwords.
983'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46984linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04985
Junio C Hamanoa74efce2008-04-02 08:39:08986gitcvs.dbTableNamePrefix::
987Database table name prefix. Prepended to the names of any
988database tables used, allowing a single database to be used
989for several repositories. Supports variable substitution (see
990linkgit:git-cvsserver[1] for details). Any non-alphabetic
991characters will be replaced with underscores.
992
Junio C Hamanodfccbb02008-05-26 01:16:14993All gitcvs variables except for 'gitcvs.usecrlfattr' and
994'gitcvs.allbinary' can also be specified as
995'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27996is one of "ext" and "pserver") to make them apply only for the given
997access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04998
Junio C Hamano6d76d612008-05-09 05:46:08999gui.commitmsgwidth::
1000Defines how wide the commit message window is in the
1001linkgit:git-gui[1]. "75" is the default.
1002
1003gui.diffcontext::
1004Specifies how many context lines should be used in calls to diff
1005made by the linkgit:git-gui[1]. The default is "5".
1006
Junio C Hamanod3452a02008-11-15 08:07:551007gui.encoding::
1008Specifies the default encoding to use for displaying of
1009file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1010It can be overridden by setting the 'encoding' attribute
1011for relevant files (see linkgit:gitattributes[5]).
1012If this option is not set, the tools default to the
1013locale encoding.
1014
Junio C Hamano6d76d612008-05-09 05:46:081015gui.matchtrackingbranch::
1016Determines if new branches created with linkgit:git-gui[1] should
1017default to tracking remote branches with matching names or
1018not. Default: "false".
1019
1020gui.newbranchtemplate::
1021Is used as suggested name when creating new branches using the
1022linkgit:git-gui[1].
1023
1024gui.pruneduringfetch::
1025"true" if linkgit:git-gui[1] should prune tracking branches when
1026performing a fetch. The default value is "false".
1027
1028gui.trustmtime::
1029Determines if linkgit:git-gui[1] should trust the file modification
1030timestamp or not. By default the timestamps are not trusted.
1031
1032gui.spellingdictionary::
1033Specifies the dictionary used for spell checking commit messages in
1034the linkgit:git-gui[1]. When set to "none" spell checking is turned
1035off.
1036
Junio C Hamanod3452a02008-11-15 08:07:551037gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431038If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551039location detection. It makes blame significantly faster on huge
1040repositories at the expense of less thorough copy detection.
1041
1042gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131043Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551044detection, measured in alphanumeric characters. See the
1045linkgit:git-blame[1] manual for more information on copy detection.
1046
1047gui.blamehistoryctx::
1048Specifies the radius of history context in days to show in
1049linkgit:gitk[1] for the selected commit, when the `Show History
1050Context` menu item is invoked from 'git gui blame'. If this
1051variable is set to zero, the whole history is shown.
1052
Junio C Hamano92d312a2008-12-15 07:22:201053guitool.<name>.cmd::
1054Specifies the shell command line to execute when the corresponding item
1055of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1056mandatory for every tool. The command is executed from the root of
1057the working directory, and in the environment it receives the name of
1058the tool as 'GIT_GUITOOL', the name of the currently selected file as
1059'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1060the head is detached, 'CUR_BRANCH' is empty).
1061
1062guitool.<name>.needsfile::
1063Run the tool only if a diff is selected in the GUI. It guarantees
1064that 'FILENAME' is not empty.
1065
1066guitool.<name>.noconsole::
1067Run the command silently, without creating a window to display its
1068output.
1069
1070guitool.<name>.norescan::
1071Don't rescan the working directory for changes after the tool
1072finishes execution.
1073
1074guitool.<name>.confirm::
1075Show a confirmation dialog before actually running the tool.
1076
1077guitool.<name>.argprompt::
1078Request a string argument from the user, and pass it to the tool
1079through the 'ARGS' environment variable. Since requesting an
1080argument implies confirmation, the 'confirm' option has no effect
1081if this is enabled. If the option is set to 'true', 'yes', or '1',
1082the dialog uses a built-in generic prompt; otherwise the exact
1083value of the variable is used.
1084
1085guitool.<name>.revprompt::
1086Request a single valid revision from the user, and set the
1087'REVISION' environment variable. In other aspects this option
1088is similar to 'argprompt', and can be used together with it.
1089
1090guitool.<name>.revunmerged::
1091Show only unmerged branches in the 'revprompt' subdialog.
1092This is useful for tools similar to merge or rebase, but not
1093for things like checkout or reset.
1094
1095guitool.<name>.title::
1096Specifies the title to use for the prompt dialog. The default
1097is the tool name.
1098
1099guitool.<name>.prompt::
1100Specifies the general prompt string to display at the top of
1101the dialog, before subsections for 'argprompt' and 'revprompt'.
1102The default value includes the actual command.
1103
Junio C Hamano4e272312008-01-08 09:13:211104help.browser::
1105Specify the browser that will be used to display help in the
1106'web' format. See linkgit:git-help[1].
1107
1108help.format::
1109Override the default help format used by linkgit:git-help[1].
1110Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1111the default. 'web' and 'html' are the same.
1112
Junio C Hamanof24b8062008-09-09 01:34:391113help.autocorrect::
1114Automatically correct and execute mistyped commands after
1115waiting for the given number of deciseconds (0.1 sec). If more
1116than one command can be deduced from the entered text, nothing
1117will be executed. If the value of this option is negative,
1118the corrected command will be executed immediately. If the
1119value is 0 - the command will be just shown but not executed.
1120This is the default.
1121
Junio C Hamano58256872007-12-04 08:31:131122http.proxy::
1123Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:461124environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:131125on a per-remote basis; see remote.<name>.proxy
1126
Junio C Hamano07824ce2006-04-25 07:36:541127http.sslVerify::
1128Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451129over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541130variable.
1131
1132http.sslCert::
1133File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451134over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541135variable.
1136
1137http.sslKey::
1138File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481139over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541140variable.
1141
Junio C Hamano48bc1ce2009-07-09 16:49:191142http.sslCertPasswordProtected::
1143Enable git's password prompt for the SSL certificate. Otherwise
1144OpenSSL will prompt the user, possibly many times, if the
1145certificate or private key is encrypted. Can be overridden by the
1146'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1147
Junio C Hamano07824ce2006-04-25 07:36:541148http.sslCAInfo::
1149File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481150fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541151'GIT_SSL_CAINFO' environment variable.
1152
1153http.sslCAPath::
1154Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451155with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541156by the 'GIT_SSL_CAPATH' environment variable.
1157
1158http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481159How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541160by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1161
Junio C Hamanob141a922010-01-10 19:55:141162http.minSessions::
1163The number of curl sessions (counted across slots) to be kept across
1164requests. They will not be ended with curl_easy_cleanup() until
1165http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1166value will be capped at 1. Defaults to 1.
1167
Junio C Hamano3b70d3c2009-11-21 17:37:371168http.postBuffer::
1169Maximum size in bytes of the buffer used by smart HTTP
1170transports when POSTing data to the remote system.
1171For requests larger than this buffer size, HTTP/1.1 and
1172Transfer-Encoding: chunked is used to avoid creating a
1173massive pack file locally. Default is 1 MiB, which is
1174sufficient for most requests.
1175
Junio C Hamano07824ce2006-04-25 07:36:541176http.lowSpeedLimit, http.lowSpeedTime::
1177If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1178for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481179Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541180'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1181
Junio C Hamanof1dcdfe2006-09-29 08:10:511182http.noEPSV::
1183A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041184This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511185support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1186environment variable. Default is false (curl will use EPSV).
1187
Junio C Hamano07824ce2006-04-25 07:36:541188i18n.commitEncoding::
1189Character encoding the commit messages are stored in; git itself
1190does not care per se, but this information is necessary e.g. when
1191importing commits from emails or in the gitk graphical history
1192browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461193porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541194
Junio C Hamano51f92e22006-12-29 05:18:281195i18n.logOutputEncoding::
1196Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431197running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281198
Junio C Hamano4653c6f2008-11-26 22:50:201199imap::
1200The configuration variables in the 'imap' section are described
1201in linkgit:git-imap-send[1].
1202
Junio C Hamano4e272312008-01-08 09:13:211203instaweb.browser::
1204Specify the program that will be used to browse your working
1205repository in gitweb. See linkgit:git-instaweb[1].
1206
1207instaweb.httpd::
1208The HTTP daemon command-line to start gitweb on your working
1209repository. See linkgit:git-instaweb[1].
1210
1211instaweb.local::
1212If true the web server started by linkgit:git-instaweb[1] will
1213be bound to the local IP (127.0.0.1).
1214
1215instaweb.modulepath::
1216The module path for an apache httpd used by linkgit:git-instaweb[1].
1217
1218instaweb.port::
1219The port number to bind the gitweb httpd to. See
1220linkgit:git-instaweb[1].
1221
Junio C Hamanoe5bf6c12009-02-07 21:43:101222interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001223In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101224input with a single key (i.e., without hitting enter).
1225Currently this is used only by the `\--patch` mode of
1226linkgit:git-add[1]. Note that this setting is silently
1227ignored if portable keystroke input is not available.
1228
Junio C Hamanob713ff12008-05-24 01:12:301229log.date::
1230Set default date-time mode for the log command. Setting log.date
Junio C Hamano1aa40d22010-01-21 17:46:431231value is similar to using 'git log'\'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:301232following alternatives: {relative,local,default,iso,rfc,short}.
1233See linkgit:git-log[1].
1234
Junio C Hamanofe9acab2006-11-24 12:10:551235log.showroot::
1236If true, the initial commit will be shown as a big creation event.
1237This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461238Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551239normally hide the root commit will now show it. True by default.
1240
Junio C Hamano8bc410e2009-02-15 10:38:191241mailmap.file::
1242The location of an augmenting mailmap file. The default
1243mailmap, located in the root of the repository, is loaded
1244first, then the mailmap file pointed to by this variable.
1245The location of the mailmap file may be in a repository
1246subdirectory, or somewhere outside of the repository itself.
1247See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1248
Junio C Hamano8b588d52008-03-15 09:48:371249man.viewer::
1250Specify the programs that may be used to display help in the
1251'man' format. See linkgit:git-help[1].
1252
Junio C Hamano6d76d612008-05-09 05:46:081253man.<tool>.cmd::
1254Specify the command to invoke the specified man viewer. The
1255specified command is evaluated in shell with the man page
1256passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261257
Junio C Hamano6d76d612008-05-09 05:46:081258man.<tool>.path::
1259Override the path for the given tool that may be used to
1260display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131261
Junio C Hamano4653c6f2008-11-26 22:50:201262include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421263
Junio C Hamano1fbbbc12007-12-18 07:01:271264mergetool.<tool>.path::
1265Override the path for the given tool. This is useful in case
1266your tool is not in the PATH.
1267
Junio C Hamano86bcccc2008-03-08 09:33:551268mergetool.<tool>.cmd::
1269Specify the command to invoke the specified merge tool. The
1270specified command is evaluated in shell with the following
1271variables available: 'BASE' is the name of a temporary file
1272containing the common base of the files to be merged, if available;
1273'LOCAL' is the name of a temporary file containing the contents of
1274the file on the current branch; 'REMOTE' is the name of a temporary
1275file containing the contents of the file from the branch being
1276merged; 'MERGED' contains the name of the file to which the merge
1277tool should write the results of a successful merge.
1278
1279mergetool.<tool>.trustExitCode::
1280For a custom merge command, specify whether the exit code of
1281the merge command can be used to determine whether the merge was
1282successful. If this is not set to true then the merge target file
1283timestamp is checked and the merge assumed to have been successful
1284if the file has been updated, otherwise the user is prompted to
1285indicate the success of the merge.
1286
1287mergetool.keepBackup::
1288After performing a merge, the original file with conflict markers
1289can be saved as a file with a `.orig` extension. If this variable
1290is set to `false` then this file is not preserved. Defaults to
1291`true` (i.e. keep the backup files).
1292
Junio C Hamano10b7a342009-01-01 22:05:171293mergetool.keepTemporaries::
1294When invoking a custom merge tool, git uses a set of temporary
1295files to pass to the tool. If the tool returns an error and this
1296variable is set to `true`, then these temporary files will be
1297preserved, otherwise they will be removed after the tool has
1298exited. Defaults to `false`.
1299
1300mergetool.prompt::
1301Prompt before each invocation of the merge resolution program.
1302
Junio C Hamano75cc4c92006-07-24 08:25:031303pack.window::
Junio C Hamano35738e82008-01-07 07:55:461304The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031305window size is given on the command line. Defaults to 10.
1306
Junio C Hamano91d44c52007-05-09 07:16:071307pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461308The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071309maximum depth is given on the command line. Defaults to 50.
1310
Junio C Hamano235d53f2007-07-13 00:25:151311pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461312The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151313when no limit is given on the command line. The value can be
1314suffixed with "k", "m", or "g". Defaults to 0, meaning no
1315limit.
1316
Junio C Hamanof2ce2972007-05-20 19:12:091317pack.compression::
1318An integer -1..9, indicating the compression level for objects
1319in a pack file. -1 is the zlib default. 0 means no
1320compression, and 1..9 are various speed/size tradeoffs, 9 being
1321slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421322not set, defaults to -1, the zlib default, which is "a default
1323compromise between speed and compression (currently equivalent
1324to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:091325
Junio C Hamano679d22d2007-06-02 21:13:441326pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271327The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521328linkgit:git-pack-objects[1] before writing them out to a pack.
1329This cache is used to speed up the writing object phase by not
1330having to recompute the final delta result once the best match
1331for all objects is found. Repacking large repositories on machines
1332which are tight with memory might be badly impacted by this though,
1333especially if this cache pushes the system into swapping.
1334A value of 0 means no limit. The smallest size of 1 byte may be
1335used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441336
1337pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141338The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521339linkgit:git-pack-objects[1]. This cache is used to speed up the
1340writing object phase by not having to recompute the final delta
1341result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441342
Junio C Hamano58155b42007-09-15 07:46:141343pack.threads::
1344Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461345delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141346be compiled with pthreads otherwise this option is ignored with a
1347warning. This is meant to reduce packing time on multiprocessor
1348machines. The required amount of memory for the delta search window
1349is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441350Specifying 0 will cause git to auto-detect the number of CPU's
1351and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141352
Junio C Hamanod814b6d2007-11-04 11:13:491353pack.indexVersion::
1354Specify the default pack index version. Valid values are 1 for
1355legacy pack index used by Git versions prior to 1.5.2, and 2 for
1356the new pack index with capabilities for packs larger than 4 GB
1357as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381358packs. Version 2 is the default. Note that version 2 is enforced
1359and this config option ignored whenever the corresponding pack is
1360larger than 2 GB.
1361+
1362If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1363cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1364that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1365other side may give you a repository that cannot be accessed with your
1366older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1367you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1368the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491369
Junio C Hamano09a926d2008-03-13 07:55:291370pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291371The maximum size of a pack. This setting only affects
1372packing to a file when repacking, i.e. the git:// protocol
1373is unaffected. It can be overridden by the `\--max-pack-size`
1374option of linkgit:git-repack[1]. The minimum size allowed is
1375limited to 1 MiB. The default is unlimited.
1376Common unit suffixes of 'k', 'm', or 'g' are
1377supported.
Junio C Hamano49dccaf2008-02-10 10:48:011378
Junio C Hamano9e96a1a2008-08-16 10:23:181379pager.<cmd>::
Junio C Hamano0551f6a2008-08-25 00:33:331380Allows turning on or off pagination of the output of a
1381particular git subcommand when writing to a tty. If
1382`\--paginate` or `\--no-pager` is specified on the command line,
1383it takes precedence over this option. To disable pagination for
Junio C Hamanoea82cff2009-03-18 01:54:481384all commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181385
Junio C Hamano07824ce2006-04-25 07:36:541386pull.octopus::
1387The default merge strategy to use when pulling multiple branches
1388at once.
1389
1390pull.twohead::
1391The default merge strategy to use when pulling a single branch.
1392
Junio C Hamano1de75722009-03-26 08:39:381393push.default::
1394Defines the action git push should take if no refspec is given
1395on the command line, no refspec is configured in the remote, and
1396no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191397line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381398+
1399* `nothing` do not push anything.
Junio C Hamano0706c802009-03-30 22:34:191400* `matching` push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381401 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191402 matching. This is the default.
Junio C Hamano98e32c32009-04-13 02:39:531403* `tracking` push the current branch to its upstream branch.
Junio C Hamano0706c802009-03-30 22:34:191404* `current` push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381405
Junio C Hamanoea6a7642009-03-11 23:56:191406rebase.stat::
1407Whether to show a diffstat of what changed upstream since the last
1408rebase. False by default.
1409
Junio C Hamano621e1232009-10-26 05:16:471410receive.autogc::
1411By default, git-receive-pack will run "git-gc --auto" after
1412receiving data from git-push and updating refs. You can stop
1413it by setting this variable to false.
1414
Junio C Hamano4653c6f2008-11-26 22:50:201415receive.fsckObjects::
1416If it is set to true, git-receive-pack will check all received
1417objects. It will abort in the case of a malformed object or a
1418broken link. The result of an abort are only dangling objects.
1419Defaults to false.
1420
1421receive.unpackLimit::
1422If the number of objects received in a push is below this
1423limit then the objects will be unpacked into loose object
1424files. However if the number of received objects equals or
1425exceeds this limit then the received pack will be stored as
1426a pack, after adding any missing delta bases. Storing the
1427pack from a push can make the push operation complete faster,
1428especially on slow filesystems. If not set, the value of
1429`transfer.unpackLimit` is used instead.
1430
1431receive.denyDeletes::
1432If set to true, git-receive-pack will deny a ref update that deletes
1433the ref. Use this to prevent such a ref deletion via a push.
1434
1435receive.denyCurrentBranch::
1436If set to true or "refuse", receive-pack will deny a ref update
1437to the currently checked out branch of a non-bare repository.
1438Such a push is potentially dangerous because it brings the HEAD
1439out of sync with the index and working tree. If set to "warn",
1440print a warning of such a push to stderr, but allow the push to
1441proceed. If set to false or "ignore", allow such pushes with no
1442message. Defaults to "warn".
1443
1444receive.denyNonFastForwards::
1445If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541446not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201447even if that push is forced. This configuration variable is
1448set when initializing a shared repository.
1449
Junio C Hamano621e1232009-10-26 05:16:471450receive.updateserverinfo::
1451If set to true, git-receive-pack will run git-update-server-info
1452after receiving data from git-push and updating refs.
1453
Junio C Hamano249572f2006-10-24 05:44:081454remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461455The URL of a remote repository. See linkgit:git-fetch[1] or
1456linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081457
Junio C Hamano0e88f3e2009-06-21 08:03:251458remote.<name>.pushurl::
1459The push URL of a remote repository. See linkgit:git-push[1].
1460
Junio C Hamano58256872007-12-04 08:31:131461remote.<name>.proxy::
1462For remotes that require curl (http, https and ftp), the URL to
1463the proxy to use for that remote. Set to the empty string to
1464disable proxying for that remote.
1465
Junio C Hamano249572f2006-10-24 05:44:081466remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461467The default set of "refspec" for linkgit:git-fetch[1]. See
1468linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081469
1470remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461471The default set of "refspec" for linkgit:git-push[1]. See
1472linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081473
Junio C Hamano47d68a52008-05-06 06:35:401474remote.<name>.mirror::
1475If true, pushing to this remote will automatically behave
1476as if the `\--mirror` option was given on the command line.
1477
Junio C Hamano118d2772007-02-21 20:24:101478remote.<name>.skipDefaultUpdate::
1479If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271480using linkgit:git-fetch[1] or the `update` subcommand of
1481linkgit:git-remote[1].
1482
1483remote.<name>.skipFetchAll::
1484If true, this remote will be skipped by default when updating
1485using linkgit:git-fetch[1] or the `update` subcommand of
1486linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101487
Junio C Hamano4ad294b2007-01-20 02:22:501488remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481489The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551490option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501491
Junio C Hamano54ea8d32007-01-25 07:59:481492remote.<name>.uploadpack::
1493The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551494option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481495
Junio C Hamano17dde0e2007-02-26 09:50:211496remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551497Setting this value to \--no-tags disables automatic tag following when
1498fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211499
Junio C Hamano096dde22009-12-26 23:14:111500remote.<name>.vcs::
1501Setting this to a value <vcs> will cause git to interact with
1502the remote with the git-remote-<vcs> helper.
1503
Junio C Hamano118d2772007-02-21 20:24:101504remotes.<group>::
1505The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461506<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101507
Junio C Hamano77b7e902006-10-23 07:18:501508repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381509By default, linkgit:git-repack[1] creates packs that use
1510delta-base offset. If you need to share your repository with
1511git older than version 1.4.4, either directly or via a dumb
1512protocol such as http, then you need to set this option to
1513"false" and repack. Access from old git versions over the
1514native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501515
Junio C Hamano4653c6f2008-11-26 22:50:201516rerere.autoupdate::
1517When set to true, `git-rerere` updates the index with the
1518resulting contents after it cleanly resolves conflicts using
1519previously recorded resolution. Defaults to false.
1520
1521rerere.enabled::
1522Activate recording of resolved conflicts, so that identical
1523conflict hunks can be resolved automatically, should they
1524be encountered again. linkgit:git-rerere[1] command is by
1525default enabled if you create `rr-cache` directory under
1526`$GIT_DIR`, but can be disabled by setting this option to false.
1527
Junio C Hamano1bbd0f42009-07-23 06:20:291528sendemail.identity::
1529A configuration identity. When given, causes values in the
1530'sendemail.<identity>' subsection to take precedence over
1531values in the 'sendemail' section. The default identity is
1532the value of 'sendemail.identity'.
1533
1534sendemail.smtpencryption::
1535See linkgit:git-send-email[1] for description. Note that this
1536setting is not subject to the 'identity' mechanism.
1537
1538sendemail.smtpssl::
1539Deprecated alias for 'sendemail.smtpencryption = ssl'.
1540
1541sendemail.<identity>.*::
1542Identity-specific versions of the 'sendemail.*' parameters
1543found below, taking precedence over those when the this
1544identity is selected, through command-line or
1545'sendemail.identity'.
1546
1547sendemail.aliasesfile::
1548sendemail.aliasfiletype::
1549sendemail.bcc::
1550sendemail.cc::
1551sendemail.cccmd::
1552sendemail.chainreplyto::
1553sendemail.confirm::
1554sendemail.envelopesender::
1555sendemail.from::
1556sendemail.multiedit::
1557sendemail.signedoffbycc::
1558sendemail.smtppass::
1559sendemail.suppresscc::
1560sendemail.suppressfrom::
1561sendemail.to::
1562sendemail.smtpserver::
1563sendemail.smtpserverport::
1564sendemail.smtpuser::
1565sendemail.thread::
1566sendemail.validate::
1567See linkgit:git-send-email[1] for description.
1568
1569sendemail.signedoffcc::
1570Deprecated alias for 'sendemail.signedoffbycc'.
1571
Junio C Hamano07824ce2006-04-25 07:36:541572showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461573The default set of branches for linkgit:git-show-branch[1].
1574See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541575
Junio C Hamano942b35e2007-12-09 10:19:331576status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461577By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331578current directory. Setting this variable to `false` shows paths
1579relative to the repository root (this was the default for git
1580prior to v1.5.4).
1581
Junio C Hamano4224f992008-06-23 07:14:081582status.showUntrackedFiles::
1583By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1584files which are not currently tracked by Git. Directories which
1585contain only untracked files, are shown with the directory name
1586only. Showing untracked files means that Git needs to lstat() all
1587all the files in the whole repository, which might be slow on some
1588systems. So, this variable controls how the commands displays
1589the untracked files. Possible values are:
1590+
1591--
1592- 'no' - Show no untracked files
1593- 'normal' - Shows untracked files and directories
1594- 'all' - Shows also individual files in untracked directories.
1595--
1596+
1597If this variable is not specified, it defaults to 'normal'.
1598This variable can be overridden with the -u|--untracked-files option
1599of linkgit:git-status[1] and linkgit:git-commit[1].
1600
Junio C Hamano75cc4c92006-07-24 08:25:031601tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091602This variable can be used to restrict the permission bits of
1603tar archive entries. The default is 0002, which turns off the
1604world write bit. The special value "user" indicates that the
1605archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461606linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031607
Junio C Hamano4653c6f2008-11-26 22:50:201608transfer.unpackLimit::
1609When `fetch.unpackLimit` or `receive.unpackLimit` are
1610not set, the value of this variable is used instead.
1611The default value is 100.
1612
Junio C Hamano24bc09a2008-02-28 00:27:441613url.<base>.insteadOf::
1614Any URL that starts with this value will be rewritten to
1615start, instead, with <base>. In cases where some site serves a
1616large number of repositories, and serves them with multiple
1617access methods, and some users need to use different access
1618methods, this feature allows people to specify any of the
1619equivalent URLs and have git automatically rewrite the URL to
1620the best alternative for the particular user, even for a
1621never-before-seen repository on the site. When more than one
1622insteadOf strings match a given URL, the longest match is used.
1623
Junio C Hamano7df6dcf2009-09-13 09:51:171624url.<base>.pushInsteadOf::
1625Any URL that starts with this value will not be pushed to;
1626instead, it will be rewritten to start with <base>, and the
1627resulting URL will be pushed to. In cases where some site serves
1628a large number of repositories, and serves them with multiple
1629access methods, some of which do not allow push, this feature
1630allows people to specify a pull-only URL and have git
1631automatically use an appropriate URL to push, even for a
1632never-before-seen repository on the site. When more than one
1633pushInsteadOf strings match a given URL, the longest match is
1634used. If a remote has an explicit pushurl, git will ignore this
1635setting for that remote.
1636
Junio C Hamano07824ce2006-04-25 07:36:541637user.email::
1638Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341639Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461640'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541641
1642user.name::
1643Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481644Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461645environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541646
Junio C Hamanoa890c4f2007-01-28 10:29:211647user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461648If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211649automatically when creating a signed tag, you can override the
1650default selection with this variable. This option is passed
1651unchanged to gpg's --local-user parameter, so you may specify a key
1652using any method that gpg supports.
1653
Junio C Hamano4e272312008-01-08 09:13:211654web.browser::
1655Specify a web browser that may be used by some commands.
1656Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1657may use it.