blob: c995a1a47b3cfb99a2bebbadf4f7a5360cbe3d1a [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Junio C Hamanobee172f2007-01-23 08:44:1818Syntax
19~~~~~~
20
Junio C Hamano07824ce2006-04-25 07:36:5421The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1822ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4828characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5929must belong to some section, which means that there must be a section
30header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1831
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5934in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1835
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanof4581102009-04-25 08:29:5941Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1844lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
Junio C Hamanof4581102009-04-25 08:29:5948There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
Junio C Hamanobee172f2007-01-23 08:44:1851
Junio C Hamanoaa2cd762009-07-26 08:14:0152All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1854'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4857characters and `-` are allowed. There can be more than one value
Junio C Hamanobee172f2007-01-23 08:44:1858for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano4cfa5362009-04-18 23:01:01650/1, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1866converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4367'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1868
69String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5970You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4874be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1875
Junio C Hamanoea82cff2009-03-18 01:54:4876The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1879char sequences are valid.
80
Junio C Hamanof4581102009-04-25 08:29:5981Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1882customary UNIX fashion.
83
Junio C Hamanof4581102009-04-25 08:29:5984Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5485
86Example
87~~~~~~~
88
89# Core variables
90[core]
91; Don't trust file modes
92filemode = false
93
94# Our diff algorithm
95[diff]
Junio C Hamano85c71572008-07-28 00:03:3196external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:5497renames = true
98
Junio C Hamano52401ef2006-12-19 00:54:3899[branch "devel"]
100remote = origin
101merge = refs/heads/devel
102
Junio C Hamanobee172f2007-01-23 08:44:18103# Proxy settings
104[core]
Junio C Hamanoc71a8732007-08-04 00:27:26105gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18106gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38107
Junio C Hamano07824ce2006-04-25 07:36:54108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54114porcelain configuration variables in the respective porcelain documentation.
115
Junio C Hamano7df6dcf2009-09-13 09:51:17116advice.*::
117When set to 'true', display the given optional help message.
118When set to 'false', do not display. The configuration variables
119are:
120+
121--
122pushNonFastForward::
123Advice shown when linkgit:git-push[1] refuses
124non-fast-forward refs. Default: true.
125statusHints::
126Directions on how to stage/unstage/add shown in the
127output of linkgit:git-status[1] and the template shown
128when writing commit messages. Default: true.
Junio C Hamano5706e0b2009-11-24 10:54:16129commitBeforeMerge::
130Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35131merge to avoid overwriting local changes.
Junio C Hamano5706e0b2009-11-24 10:54:16132Default: true.
Junio C Hamanoa9701f02010-01-21 00:42:16133resolveConflict::
134Advices shown by various commands when conflicts
135prevent the operation from being performed.
136Default: true.
137implicitIdentity::
138Advice on how to set your identity configuration when
139your information is guessed from the system username and
140domain name. Default: true.
Junio C Hamano74a198f2010-02-22 00:13:31141
142detachedHead::
143Advice shown when you used linkgit::git-checkout[1] to
144move to the detach HEAD state, to instruct how to create
145a local branch after the fact. Default: true.
Junio C Hamano7df6dcf2009-09-13 09:51:17146--
147
Junio C Hamano07824ce2006-04-25 07:36:54148core.fileMode::
149If false, the executable bit differences between the index and
150the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27151See linkgit:git-update-index[1].
152+
153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154will probe and set core.fileMode false if appropriate when the
155repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54156
Junio C Hamanoa476efa2008-10-10 15:31:42157core.ignoreCygwinFSTricks::
158This option is only used by Cygwin implementation of Git. If false,
159the Cygwin stat() and lstat() functions are used. This may be useful
160if your repository consists of a few separate directories joined in
161one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162whenever it is possible and falls back to Cygwin functions only to
163handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33164normal Cygwin l/stat() functions. True by default, unless core.filemode
165is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42167
Junio C Hamano9df0c662009-11-23 11:09:27168core.ignorecase::
169If true, this option enables various workarounds to enable
170git to work better on filesystems that are not case sensitive,
171like FAT. For example, if a directory listing finds
172"makefile" when git expects "Makefile", git will assume
173it is really the same file, and continue to remember it as
174"Makefile".
175+
176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177will probe and set core.ignorecase true if appropriate when the repository
178is created.
179
Junio C Hamano90ccff32008-07-29 08:17:24180core.trustctime::
181If false, the ctime differences between the index and the
182working copy are ignored; useful when the inode change time
183is regularly modified by something outside Git (file system
184crawlers and some backup systems).
185See linkgit:git-update-index[1]. True by default.
186
Junio C Hamanod526ba92007-07-02 00:17:42187core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31188The commands that output paths (e.g. 'ls-files',
189'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42190"unusual" characters in the pathname by enclosing the
191pathname in a double-quote pair and with backslashes the
192same way strings in C source code are quoted. If this
193variable is set to false, the bytes higher than 0x80 are
194not quoted but output as verbatim. Note that double
195quote, backslash and control characters are always
196quoted without `-z` regardless of the setting of this
197variable.
198
Junio C Hamanobb88cf42010-06-21 15:23:55199core.eol::
200Sets the line ending type to use in the working directory for
201files that have the `text` property set. Alternatives are
202'lf', 'crlf' and 'native', which uses the platform's native
203line ending. The default value is `native`. See
204linkgit:gitattributes[5] for more information on end-of-line
205conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04206
Junio C Hamano26e590a2008-02-17 03:53:51207core.safecrlf::
Junio C Hamanobb88cf42010-06-21 15:23:55208If true, makes git check if converting `CRLF` is reversible when
209end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51210modifies a file in the work tree either directly or indirectly.
211For example, committing a file followed by checking out the
212same file should yield the original file in the work tree. If
213this is not the case for the current setting of
214`core.autocrlf`, git will reject the file. The variable can
215be set to "warn", in which case git will only warn about an
216irreversible conversion but continue the operation.
217+
218CRLF conversion bears a slight chance of corrupting data.
Junio C Hamanobb88cf42010-06-21 15:23:55219When it is enabled, git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51220CRLF during checkout. A file that contains a mixture of LF and
221CRLF before the commit cannot be recreated by git. For text
222files this is the right thing to do: it corrects line endings
223such that we have only LF line endings in the repository.
224But for binary files that are accidentally classified as text the
225conversion can corrupt data.
226+
227If you recognize such corruption early you can easily fix it by
228setting the conversion type explicitly in .gitattributes. Right
229after committing you still have the original file in your work
230tree and this file is not yet corrupted. You can explicitly tell
231git that this file is binary and git will handle the file
232appropriately.
233+
234Unfortunately, the desired effect of cleaning up text files with
235mixed line endings and the undesired effect of corrupting binary
236files cannot be distinguished. In both cases CRLFs are removed
237in an irreversible way. For text files this is the right thing
238to do because CRLFs are line endings, while for binary files
239converting CRLFs corrupts data.
240+
241Note, this safety check does not mean that a checkout will generate a
242file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55243`core.eol` and `core.autocrlf`, but only for the current one. For
244example, a text file with `LF` would be accepted with `core.eol=lf`
245and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51246resulting file would contain `CRLF`, although the original file
247contained `LF`. However, in both work trees the line endings would be
248consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249file with mixed line endings would be reported by the `core.safecrlf`
250mechanism.
251
Junio C Hamanobb88cf42010-06-21 15:23:55252core.autocrlf::
253Setting this variable to "true" is almost the same as setting
254the `text` attribute to "auto" on all files except that text
255files are not guaranteed to be normalized: files that contain
256`CRLF` in the repository will not be touched. Use this
257setting if you want to have `CRLF` line endings in your
258working directory even though the repository does not have
259normalized line endings. This variable can be set to 'input',
260in which case no output conversion is performed.
261
Junio C Hamanoaa83a7d2007-03-05 02:37:29262core.symlinks::
263If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46264contain the link text. linkgit:git-update-index[1] and
265linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29266file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27267symbolic links.
268+
269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270will probe and set core.symlinks false if appropriate when the repository
271is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29272
Junio C Hamano07824ce2006-04-25 07:36:54273core.gitProxy::
274A "proxy command" to execute (as 'command host port') instead
275of establishing direct connection to the remote server when
276using the git protocol for fetching. If the variable value is
277in the "COMMAND for DOMAIN" format, the command is applied only
278on hostnames ending with the specified domain string. This variable
279may be set multiple times and is matched in the given order;
280the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17281+
282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283(which always applies universally, without the special "for"
284handling).
Junio C Hamanoea82cff2009-03-18 01:54:48285+
286The special string `none` can be used as the proxy command to
287specify that no proxy be used for a given domain pattern.
288This is useful for excluding servers inside a firewall from
289proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54290
291core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34292If true, commands which modify both the working tree and the index
293will mark the updated paths with the "assume unchanged" bit in the
294index. These marked files are then assumed to stay unchanged in the
295working copy, until you mark them otherwise manually - Git will not
296detect the file changes by lstat() calls. This is useful on systems
297where those are very slow, such as Microsoft Windows.
298See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54299False by default.
300
Junio C Hamano88a3a072006-05-04 08:01:43301core.preferSymlinkRefs::
302Instead of the default "symref" format for HEAD
303and other symbolic reference files, use symbolic links.
304This is sometimes needed to work with old scripts that
305expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54306
Junio C Hamano1025e752007-02-23 07:21:26307core.bare::
308If true this repository is assumed to be 'bare' and has no
309working directory associated with it. If this is the case a
310number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46311disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26312+
Junio C Hamano35738e82008-01-07 07:55:46313This setting is automatically guessed by linkgit:git-clone[1] or
314linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26315repository that ends in "/.git" is assumed to be not bare (bare =
316false), while all other repositories are assumed to be bare (bare
317= true).
318
Junio C Hamanod526ba92007-07-02 00:17:42319core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52320Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31321This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52322variable and the '--work-tree' command line option.
323The value can an absolute path or relative to the path to
324the .git directory, which is either specified by --git-dir
325or GIT_DIR, or automatically discovered.
326If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27327--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52328the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52329of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52330+
331Note that this variable is honored even when set in a configuration
332file in a ".git" subdirectory of a directory and its value differs
333from the latter directory (e.g. "/path/to/.git/config" has
334core.worktree set to "/different/path"), which is most likely a
335misconfiguration. Running git commands in the "/path/to" directory will
336still use "/different/path" as the root of the work tree and can cause
337confusion unless you know what you are doing (e.g. you are creating a
338read-only snapshot of the same index to a location different from the
339repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42340
Junio C Hamano341071d2006-06-04 07:24:48341core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49342Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48343"$GIT_DIR/logs/<ref>", by appending the new and old
344SHA1, the date/time and the reason of the update, but
345only when the file exists. If this configuration
346variable is set to true, missing "$GIT_DIR/logs/<ref>"
347file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35348+
349This information can be used to determine what commit
350was the tip of a branch "2 days ago".
351+
352This value is true by default in a repository that has
353a working directory associated with it, and false by
354default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48355
Junio C Hamano07824ce2006-04-25 07:36:54356core.repositoryFormatVersion::
357Internal variable identifying the repository format and layout
358version.
359
360core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42361When 'group' (or 'true'), the repository is made shareable between
362several users in a group (making sure all the files and objects are
363group-writable). When 'all' (or 'world' or 'everybody'), the
364repository will be readable by all users, additionally to being
365group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37366reported by umask(2). When '0xxx', where '0xxx' is an octal number,
367files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00368user's umask value (whereas the other options will only override
369requested parts of the user's umask value). Examples: '0660' will make
370the repo read/write-able for the owner and group, but inaccessible to
371others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37372repository that is group-readable but not group-writable.
373See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54374
375core.warnAmbiguousRefs::
376If true, git will warn you if the ref name you passed it is ambiguous
377and might match multiple refs in the .git/refs/ tree. True by default.
378
Junio C Hamano2e6ded82010-12-05 06:20:48379core.abbrevguard::
380Even though git makes sure that it uses enough hexdigits to show
381an abbreviated object name unambiguously, as more objects are
382added to the repository over time, a short name that used to be
383unique will stop being unique. Git uses this many extra hexdigits
384that are more than necessary to make the object name currently
385unique, in the hope that its output will stay unique a bit longer.
386Defaults to 0.
387
Junio C Hamano7ec15722006-07-07 02:03:59388core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09389An integer -1..9, indicating a default compression level.
390-1 is the zlib default. 0 means no compression,
391and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42392If set, this provides a default to other compression variables,
393such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26394
Junio C Hamanof2ce2972007-05-20 19:12:09395core.loosecompression::
396An integer -1..9, indicating the compression level for objects that
397are not in a pack file. -1 is the zlib default. 0 means no
398compression, and 1..9 are various speed/size tradeoffs, 9 being
399slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42400not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49401
Junio C Hamanofc4d38c2007-01-08 06:53:32402core.packedGitWindowSize::
403Number of bytes of a pack file to map into memory in a
404single mapping operation. Larger window sizes may allow
405your system to process a smaller number of large pack files
406more quickly. Smaller window sizes will negatively affect
407performance due to increased calls to the operating system's
408memory manager, but may improve performance when accessing
409a large number of large pack files.
410+
411Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
412MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
413be reasonable for all users/operating systems. You probably do
414not need to adjust this value.
415+
416Common unit suffixes of 'k', 'm', or 'g' are supported.
417
418core.packedGitLimit::
419Maximum number of bytes to map simultaneously into memory
420from pack files. If Git needs to access more than this many
421bytes at once to complete an operation it will unmap existing
422regions to reclaim virtual address space within the process.
423+
424Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
425This should be reasonable for all users/operating systems, except on
426the largest projects. You probably do not need to adjust this value.
427+
428Common unit suffixes of 'k', 'm', or 'g' are supported.
429
Junio C Hamanob8c51282007-03-19 10:43:30430core.deltaBaseCacheLimit::
431Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35432that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30433entire decompressed base objects in a cache Git is able
434to avoid unpacking and decompressing frequently used base
435objects multiple times.
436+
437Default is 16 MiB on all platforms. This should be reasonable
438for all users/operating systems, except on the largest projects.
439You probably do not need to adjust this value.
440+
441Common unit suffixes of 'k', 'm', or 'g' are supported.
442
Junio C Hamano5c246f22010-02-03 07:34:53443core.bigFileThreshold::
444Files larger than this size are stored deflated, without
445attempting delta compression. Storing large files without
446delta compression avoids excessive memory usage, at the
447slight expense of increased disk usage.
448+
449Default is 512 MiB on all platforms. This should be reasonable
450for most projects as source code and other text files can still
451be delta compressed, but larger binary media files won't be.
452+
453Common unit suffixes of 'k', 'm', or 'g' are supported.
454+
455Currently only linkgit:git-fast-import[1] honors this setting.
456
Junio C Hamano1d90cb02007-07-03 07:05:31457core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37458In addition to '.gitignore' (per-directory) and
459'.git/info/exclude', git looks into this file for patterns
Junio C Hamanobf984de2009-11-23 06:11:19460of files which are not meant to be tracked. "{tilde}/" is expanded
461to the value of `$HOME` and "{tilde}user/" to the specified user's
462home directory. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37463
Junio C Hamano3fd7b262010-09-08 22:44:20464core.askpass::
465Some commands (e.g. svn and http interfaces) that interactively
466ask for a password can be told to use an external program given
467via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
468environment variable. If not set, fall back to the value of the
469'SSH_ASKPASS' environment variable or, failing that, a simple password
470prompt. The external program shall be given a suitable prompt as
471command line argument and write the password on its STDOUT.
472
Junio C Hamano3b4609d2010-09-30 00:04:34473core.attributesfile::
474In addition to '.gitattributes' (per-directory) and
475'.git/info/attributes', git looks into this file for attributes
476(see linkgit:gitattributes[5]). Path expansions are made the same
477way as for `core.excludesfile`.
478
Junio C Hamanof6002a92007-07-20 10:28:22479core.editor::
480Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27481messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22482variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37483`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22484
Junio C Hamano28d8ede2007-07-05 05:51:38485core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33486The command that git will use to paginate output. Can
487be overridden with the `GIT_PAGER` environment
488variable. Note that git sets the `LESS` environment
489variable to `FRSX` if it is unset when it runs the
490pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42491`LESS` variable to some other value. Alternately,
492these settings can be overridden on a project or
493global basis by setting the `core.pager` option.
494Setting `core.pager` has no affect on the `LESS`
495environment variable behaviour above, so if you want
496to override git's default settings this way, you need
497to be explicit. For example, to disable the S option
498in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48499to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42500shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48501`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38502
Junio C Hamano942b35e2007-12-09 10:19:33503core.whitespace::
504A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43505notice. 'git diff' will use `color.diff.whitespace` to
506highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59507consider them as errors. You can prefix `-` to disable
508any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33509+
Junio C Hamanob71a22d2009-10-17 08:23:47510* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33511 as an error (enabled by default).
512* `space-before-tab` treats a space character that appears immediately
513 before a tab character in the initial indent part of the line as an
514 error (enabled by default).
515* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42516 space characters as an error (not enabled by default).
Junio C Hamanocb39aea2010-05-09 07:24:48517* `tab-in-indent` treats a tab character in the initial indent part of
518 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47519* `blank-at-eof` treats blank lines added at the end of file as an error
520 (enabled by default).
521* `trailing-space` is a short-hand to cover both `blank-at-eol` and
522 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42523* `cr-at-eol` treats a carriage-return at the end of line as
524 part of the line terminator, i.e. with it, `trailing-space`
525 does not trigger if the character before such a carriage-return
526 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58527* `tabwidth=<n>` tells how many character positions a tab occupies; this
528 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
529 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33530
Junio C Hamano9eb57532008-06-26 06:33:46531core.fsyncobjectfiles::
532This boolean will enable 'fsync()' when writing object files.
533+
534This is a total waste of time and effort on a filesystem that orders
535data writes properly, but can be useful for filesystems that do not use
536journalling (traditional UNIX filesystems) or that only journal metadata
537and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
538
Junio C Hamano610d1762008-11-28 06:27:13539core.preloadindex::
540Enable parallel index preload for operations like 'git diff'
541+
542This can speed up operations like 'git diff' and 'git status' especially
543on filesystems like NFS that have weak caching semantics and thus
544relatively high IO latencies. With this set to 'true', git will do the
545index comparison to the filesystem data in parallel, allowing
546overlapping IO's.
547
Junio C Hamanoa9499de2009-04-30 03:38:48548core.createObject::
549You can set this to 'link', in which case a hardlink followed by
550a delete of the source are used to make sure that object creation
551will not overwrite existing objects.
552+
553On some file system/operating system combinations, this is unreliable.
554Set this config setting to 'rename' there; However, This will remove the
555check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41556
Junio C Hamano3b70d3c2009-11-21 17:37:37557core.notesRef::
558When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10559the given ref. The ref must be fully qualified. If the given
560ref does not exist, it is not an error but means that no
561notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37562+
Junio C Hamanoa574a092010-06-13 19:57:10563This setting defaults to "refs/notes/commits", and it can be overridden by
564the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37565
Junio C Hamano3c8d6702010-01-13 23:09:03566core.sparseCheckout::
567Enable "sparse checkout" feature. See section "Sparse checkout" in
568linkgit:git-read-tree[1] for more information.
569
Junio C Hamano3d141512009-06-01 01:22:40570add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26571add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43572Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40573added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano60186642010-12-02 14:18:26574option of linkgit:git-add[1]. Older versions of git accept only
575`add.ignore-errors`, which does not follow the usual naming
576convention for configuration variables. Newer versions of git
577honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40578
Junio C Hamano33db4372006-06-07 19:51:45579alias.*::
Junio C Hamano35738e82008-01-07 07:55:46580Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45581after defining "alias.last = cat-file commit HEAD", the invocation
582"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17583confusion and troubles with script usage, aliases that
584hide existing git commands are ignored. Arguments are split by
585spaces, the usual shell quoting and escaping is supported.
586quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39587+
588If the alias expansion is prefixed with an exclamation point,
589it will be treated as a shell command. For example, defining
590"alias.new = !gitk --all --not ORIG_HEAD", the invocation
591"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19592"gitk --all --not ORIG_HEAD". Note that shell commands will be
593executed from the top-level directory of a repository, which may
594not necessarily be the current directory.
Junio C Hamano9cb74f22007-02-12 04:15:05595
Junio C Hamanocaa712a2010-03-11 01:17:35596am.keepcr::
597If true, git-am will call git-mailsplit for patches in mbox format
598with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35599not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35600by giving '--no-keep-cr' from the command line.
601See linkgit:git-am[1], linkgit:git-mailsplit[1].
602
Junio C Hamanofe24db02009-08-22 05:10:47603apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43604When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47605whitespace, in the same way as the '--ignore-space-change'
606option.
Junio C Hamano1aa40d22010-01-21 17:46:43607When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47608respect all whitespace differences.
609See linkgit:git-apply[1].
610
Junio C Hamano07824ce2006-04-25 07:36:54611apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43612Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46613as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54614
Junio C Hamano7fd84172007-05-24 07:00:32615branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43616Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44617so that linkgit:git-pull[1] will appropriately merge from the
618starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32619this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44620and `--no-track` options. The valid settings are: `false` -- no
621automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07622starting point is a remote-tracking branch; `always` --
623automatic setup is done when the starting point is either a
624local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44625branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32626
Junio C Hamano869bb802008-05-12 00:29:47627branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43628When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano869bb802008-05-12 00:29:47629that tracks another branch, this variable tells git to set
630up pull to rebase instead of merge (see "branch.<name>.rebase").
631When `never`, rebase is never automatically set to true.
632When `local`, rebase is set to true for tracked branches of
633other local branches.
634When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07635remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47636When `always`, rebase will be set to true for all tracking
637branches.
638See "branch.autosetupmerge" for details on how to set up a
639branch to track another branch.
640This option defaults to never.
641
Junio C Hamano47c1e3c2006-09-25 04:45:55642branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43643When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19644remote to fetch from/push to. It defaults to `origin` if no remote is
645configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55646
647branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19648Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamano1aa40d22010-01-21 17:46:43649for the given branch. It tells 'git fetch'/'git pull' which
650branch to merge and can also affect 'git push' (see push.default).
651When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31652refspec to be marked for merging in FETCH_HEAD. The value is
653handled like the remote part of a refspec, and must match a
654ref which is fetched from the remote given by
655"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43656The merge information is used by 'git pull' (which at first calls
657'git fetch') to lookup the default branch for merging. Without
658this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46659Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43660If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07661another branch in the local repository, you can point
662branch.<name>.merge to the desired branch, and use the special setting
663`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55664
Junio C Hamano1b50ce92007-10-03 12:05:53665branch.<name>.mergeoptions::
666Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29667supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53668option values containing whitespace characters are currently not
669supported.
670
Junio C Hamano0c999702007-12-03 09:57:55671branch.<name>.rebase::
672When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08673instead of merging the default branch from the default remote when
674"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55675*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46676it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55677for details).
678
Junio C Hamano8760ea62008-03-14 08:58:45679browser.<tool>.cmd::
680Specify the command to invoke the specified browser. The
681specified command is evaluated in shell with the URLs passed
682as arguments. (See linkgit:git-web--browse[1].)
683
Junio C Hamanoe35a6fc2008-01-29 09:46:27684browser.<tool>.path::
685Override the path for the given tool that may be used to
686browse HTML help (see '-w' option in linkgit:git-help[1]) or a
687working repository in gitweb (see linkgit:git-instaweb[1]).
688
Junio C Hamano47b9acd2007-04-24 07:34:34689clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45690A boolean to make git-clean do nothing unless given -f
691or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34692
Junio C Hamanoeb692952007-01-03 22:02:12693color.branch::
694A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46695linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21696`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12697only when the output is to a terminal. Defaults to false.
698
699color.branch.<slot>::
700Use customized color for branch coloration. `<slot>` is one of
701`current` (the current branch), `local` (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07702`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22703refs).
704+
705The value for these configuration variables is a list of colors (at most
706two) and attributes (at most one), separated by spaces. The colors
707accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
708`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
709`blink` and `reverse`. The first color given is the foreground; the
710second is the background. The position of the attribute, if any,
711doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12712
Junio C Hamano3f403b02006-12-13 10:14:13713color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21714When set to `always`, always use colors in patch.
715When false (or `never`), never. When set to `true` or `auto`, use
716colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34717
Junio C Hamano3f403b02006-12-13 10:14:13718color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22719Use customized color for diff colorization. `<slot>` specifies
720which part of the patch to use the specified color, and is one
721of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59722(hunk header), 'func' (function in hunk header), `old` (removed lines),
723`new` (added lines), `commit` (commit headers), or `whitespace`
724(highlighting whitespace errors). The values of these variables may be
725specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34726
Junio C Hamano7d449522010-07-01 00:08:51727color.decorate.<slot>::
728Use customized color for 'git log --decorate' output. `<slot>` is one
729of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07730branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51731
Junio C Hamanod257cff2009-03-18 05:27:16732color.grep::
733When set to `always`, always highlight matches. When `false` (or
734`never`), never. When set to `true` or `auto`, use color only
735when the output is written to the terminal. Defaults to `false`.
736
Junio C Hamano0299d922010-03-20 20:59:31737color.grep.<slot>::
738Use customized color for grep colorization. `<slot>` specifies which
739part of the line to use the specified color, and is one of
740+
741--
742`context`;;
743non-matching text in context lines (when using `-A`, `-B`, or `-C`)
744`filename`;;
745filename prefix (when not using `-h`)
746`function`;;
747function name lines (when using `-p`)
748`linenumber`;;
749line number prefix (when using `-n`)
750`match`;;
751matching text
752`selected`;;
753non-matching text in selected lines
754`separator`;;
755separators between fields on a line (`:`, `-`, and `=`)
756and between hunks (`--`)
757--
758+
759The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16760
Junio C Hamano00b8b632007-12-07 09:50:49761color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46762When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31763and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49764When false (or `never`), never. When set to `true` or `auto`, use
765colors only when the output is to the terminal. Defaults to false.
766
767color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43768Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10769output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
770four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00771commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49772in color.branch.<slot>.
773
Junio C Hamanoe7935c42006-12-13 21:32:17774color.pager::
775A boolean to enable/disable colored output when the pager is in
776use (default is true).
777
Junio C Hamano52ba2952009-05-18 17:43:02778color.showbranch::
779A boolean to enable/disable color in the output of
780linkgit:git-show-branch[1]. May be set to `always`,
781`false` (or `never`) or `auto` (or `true`), in which case colors are used
782only when the output is to a terminal. Defaults to false.
783
Junio C Hamanoe7935c42006-12-13 21:32:17784color.status::
785A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46786linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21787`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17788only when the output is to a terminal. Defaults to false.
789
790color.status.<slot>::
791Use customized color for status colorization. `<slot>` is
792one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04793`added` or `updated` (files which are added but not committed),
794`changed` (files which are changed but not added in the index),
Junio C Hamano0d75e872010-12-17 06:57:26795`untracked` (files which are not tracked by git),
796`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30797`nobranch` (the color the 'no branch' warning is shown in, defaulting
798to red). The values of these variables may be specified as in
799color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17800
Junio C Hamano83d46a22008-02-21 02:29:42801color.ui::
802When set to `always`, always use colors in all git commands which
803are capable of colored output. When false (or `never`), never. When
804set to `true` or `auto`, use colors only when the output is to the
805terminal. When more specific variables of color.* are set, they always
806take precedence over this setting. Defaults to false.
807
Junio C Hamanod0d892c2010-01-24 20:06:29808commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50809A boolean to enable/disable inclusion of status information in the
810commit message template when using an editor to prepare the commit
811message. Defaults to true.
812
Junio C Hamano4653c6f2008-11-26 22:50:20813commit.template::
814Specify a file to use as the template for new commit messages.
Junio C Hamanobf984de2009-11-23 06:11:19815"{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
816specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20817
Junio C Hamanodbb64592007-09-01 11:17:39818diff.autorefreshindex::
Junio C Hamano1aa40d22010-01-21 17:46:43819When using 'git diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39820files, do not consider stat-only change as changed.
821Instead, silently run `git update-index --refresh` to
822update the cached stat information for paths whose
823contents in the work tree match the contents in the
824index. This option defaults to true. Note that this
Junio C Hamano1aa40d22010-01-21 17:46:43825affects only 'git diff' Porcelain, and not lower level
826'diff' commands such as 'git diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39827
Junio C Hamano1fbbbc12007-12-18 07:01:27828diff.external::
829If this config variable is set, diff generation is not
830performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31831given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
832environment variable. The command is called with parameters
833as described under "git Diffs" in linkgit:git[1]. Note: if
834you want to use an external diff program only on a subset of
835your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27836
Junio C Hamano5e4d8de2008-09-19 06:27:02837diff.mnemonicprefix::
Junio C Hamano1aa40d22010-01-21 17:46:43838If set, 'git diff' uses a prefix pair that is different from the
Junio C Hamano5e4d8de2008-09-19 06:27:02839standard "a/" and "b/" depending on what is being compared. When
840this configuration is in effect, reverse diff output also swaps
841the order of the prefixes:
Junio C Hamano1aa40d22010-01-21 17:46:43842`git diff`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02843compares the (i)ndex and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43844`git diff HEAD`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02845 compares a (c)ommit and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43846`git diff --cached`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02847compares a (c)ommit and the (i)ndex;
Junio C Hamano1aa40d22010-01-21 17:46:43848`git diff HEAD:file1 file2`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02849compares an (o)bject and a (w)ork tree entity;
Junio C Hamano1aa40d22010-01-21 17:46:43850`git diff --no-index a b`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02851compares two non-git things (1) and (2).
852
Junio C Hamano21c2d142010-09-10 18:09:27853diff.noprefix::
854If set, 'git diff' does not show any source or destination prefix.
855
Junio C Hamano07824ce2006-04-25 07:36:54856diff.renameLimit::
857The number of files to consider when performing the copy/rename
Junio C Hamano1aa40d22010-01-21 17:46:43858detection; equivalent to the 'git diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54859
Junio C Hamano9ae1a062006-07-10 08:12:34860diff.renames::
861Tells git to detect renames. If set to any boolean value, it
862will enable basic rename detection. If set to "copies" or
863"copy", it will detect copies, as well.
864
Junio C Hamano619596a2010-08-18 22:15:35865diff.ignoreSubmodules::
866Sets the default value of --ignore-submodules. Note that this
867affects only 'git diff' Porcelain, and not lower level 'diff'
Junio C Hamanof0f41ba2010-09-04 16:23:06868commands such as 'git diff-files'. 'git checkout' also honors
869this setting when reporting uncommitted changes.
Junio C Hamano619596a2010-08-18 22:15:35870
Junio C Hamanobc4852e2009-01-21 10:51:14871diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21872A boolean to inhibit the standard behavior of printing a space
873before each empty output line. Defaults to false.
874
Junio C Hamano3bd66e92009-04-18 06:17:56875diff.tool::
876Controls which diff tool is used. `diff.tool` overrides
877`merge.tool` when used by linkgit:git-difftool[1] and has
878the same valid values as `merge.tool` minus "tortoisemerge"
879and plus "kompare".
880
881difftool.<tool>.path::
882Override the path for the given tool. This is useful in case
883your tool is not in the PATH.
884
885difftool.<tool>.cmd::
886Specify the command to invoke the specified diff tool.
887The specified command is evaluated in shell with the following
888variables available: 'LOCAL' is set to the name of the temporary
889file containing the contents of the diff pre-image and 'REMOTE'
890is set to the name of the temporary file containing the contents
891of the diff post-image.
892
893difftool.prompt::
894Prompt before each invocation of the diff tool.
895
Junio C Hamano20d47e32009-01-26 06:36:02896diff.wordRegex::
897A POSIX Extended Regular Expression used to determine what is a "word"
898when performing word-by-word difference calculations. Character
899sequences that match the regular expression are "words", all other
900characters are *ignorable* whitespace.
901
Junio C Hamano0d75e872010-12-17 06:57:26902fetch.recurseSubmodules::
903A boolean value which changes the behavior for fetch and pull, the
Junio C Hamano7165bf72011-01-04 22:06:18904default is to not recursively fetch populated submodules unless
Junio C Hamano0d75e872010-12-17 06:57:26905configured otherwise.
906
Junio C Hamano54ea8d32007-01-25 07:59:48907fetch.unpackLimit::
908If the number of objects fetched over the git native
909transfer is below this
910limit, then the objects will be unpacked into loose object
911files. However if the number of received objects equals or
912exceeds this limit then the received pack will be stored as
913a pack, after adding any missing delta bases. Storing the
914pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17915especially on slow filesystems. If not set, the value of
916`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48917
Junio C Hamanof4581102009-04-25 08:29:59918format.attach::
919Enable multipart/mixed attachments as the default for
920'format-patch'. The value can also be a double quoted string
921which will enable attachments as the default and set the
922value as the boundary. See the --attach option in
923linkgit:git-format-patch[1].
924
Junio C Hamano8c5802d2007-11-15 00:13:36925format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33926A boolean which can enable or disable sequence numbers in patch
927subjects. It defaults to "auto" which enables it only if there
928is more than one patch. It can be enabled or disabled for all
929messages by setting it to "true" or "false". See --numbered
930option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36931
Junio C Hamano07824ce2006-04-25 07:36:54932format.headers::
933Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46934by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54935
Junio C Hamano70664a02010-07-13 22:48:05936format.to::
Junio C Hamanof4581102009-04-25 08:29:59937format.cc::
Junio C Hamano70664a02010-07-13 22:48:05938Additional recipients to include in a patch to be submitted
939by mail. See the --to and --cc options in
940linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:59941
942format.subjectprefix::
943The default for format-patch is to output files with the '[PATCH]'
944subject prefix. Use this variable to change that prefix.
945
Junio C Hamano89a57342010-06-22 23:22:55946format.signature::
947The default for format-patch is to output a signature containing
948the git version number. Use this variable to change that default.
949Set this variable to the empty string ("") to suppress
950signature generation.
951
Junio C Hamanod4c8e112007-03-04 10:32:38952format.suffix::
953The default for format-patch is to output files with the suffix
954`.patch`. Use this variable to change that suffix (make sure to
955include the dot if you want it).
956
Junio C Hamano86bcccc2008-03-08 09:33:55957format.pretty::
958The default pretty format for log/show/whatchanged command,
959See linkgit:git-log[1], linkgit:git-show[1],
960linkgit:git-whatchanged[1].
961
Junio C Hamanoea6a7642009-03-11 23:56:19962format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:43963The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:14964a boolean value, or `shallow` or `deep`. `shallow` threading
965makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:19966where the head is chosen from the cover letter, the
967`\--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59968`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19969A true boolean value is the same as `shallow`, and a false
970value disables threading.
971
Junio C Hamano5f9a6f02009-04-06 08:26:56972format.signoff::
973 A boolean value which lets you enable the `-s/--signoff` option of
974 format-patch by default. *Note:* Adding the Signed-off-by: line to a
975 patch should be a conscious act and means that you certify you have
976 the rights to submit this work under the same open source license.
977 Please see the 'SubmittingPatches' document for further discussion.
978
Junio C Hamanof2ce2972007-05-20 19:12:09979gc.aggressiveWindow::
980The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:43981algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:36982to 250.
Junio C Hamanof2ce2972007-05-20 19:12:09983
Junio C Hamano1b50ce92007-10-03 12:05:53984gc.auto::
985When there are approximately more than this many loose
986objects in the repository, `git gc --auto` will pack them.
987Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17988light-weight garbage collection from time to time. The
989default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53990
991gc.autopacklimit::
992When there are more than this many packs that are not
993marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17994--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37995default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53996
Junio C Hamano9d52e572007-02-13 23:48:20997gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:14998Running `git pack-refs` in a repository renders it
999unclonable by Git versions prior to 1.5.1.2 over dumb
1000transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001001'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141002to enable it within all non-bare repos or it can be set to a
1003boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201004
Junio C Hamano09a926d2008-03-13 07:55:291005gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431006When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571007Override the grace period with this config variable. The value
1008"now" may be used to disable this grace period and always prune
1009unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291010
Junio C Hamano74640642006-12-27 10:59:551011gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531012gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431013'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531014this time; defaults to 90 days. With "<pattern>" (e.g.
1015"refs/stash") in the middle the setting applies only to
1016the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551017
1018gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531019gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431020'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551021this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531022defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1023in the middle, the setting applies only to the refs that
1024match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551025
1026gc.rerereresolved::
1027Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431028kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461029The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551030
1031gc.rerereunresolved::
1032Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431033kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461034The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551035
Junio C Hamanoa3148f52009-01-14 08:49:571036gitcvs.commitmsgannotation::
1037Append this string to each commit message. Set to empty string
1038to disable this feature. Defaults to "via git-CVS emulator".
1039
Junio C Hamano07824ce2006-04-25 07:36:541040gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271041Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461042See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541043
1044gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271045Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461046various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541047
Junio C Hamano17bd2272008-09-01 06:11:171048gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551049If true, the server will look up the end-of-line conversion
1050attributes for files to determine the '-k' modes to use. If
1051the attributes force git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351052the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551053treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331054will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551055the client might otherwise do. If the attributes do not allow
1056the file type to be determined, then 'gitcvs.allbinary' is
1057used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141058
Junio C Hamanod9e0e5d2007-04-14 16:22:041059gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141060This is used if 'gitcvs.usecrlfattr' does not resolve
1061the correct '-kb' mode to use. If true, all
1062unresolved files are sent to the client in
1063mode '-kb'. This causes the client to treat them
1064as binary files, which suppresses any newline munging it
1065otherwise might do. Alternatively, if it is set to "guess",
1066then the contents of the file are examined to decide if
1067it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041068
1069gitcvs.dbname::
1070Database used by git-cvsserver to cache revision information
1071derived from the git repository. The exact meaning depends on the
1072used database driver, for SQLite (which is the default driver) this
1073is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461074linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041075Default: '%Ggitcvs.%m.sqlite'
1076
1077gitcvs.dbdriver::
1078Used Perl DBI driver. You can specify any available driver
1079 for this here, but it might not work. git-cvsserver is tested
1080with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1081reported *not* to work with 'DBD::mysql'. Experimental feature.
1082May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461083See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041084
Junio C Hamanoa2ad99e2007-04-18 09:57:041085gitcvs.dbuser, gitcvs.dbpass::
1086Database user and password. Only useful if setting 'gitcvs.dbdriver',
1087since SQLite has no concept of database users and/or passwords.
1088'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461089linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041090
Junio C Hamanoa74efce2008-04-02 08:39:081091gitcvs.dbTableNamePrefix::
1092Database table name prefix. Prepended to the names of any
1093database tables used, allowing a single database to be used
1094for several repositories. Supports variable substitution (see
1095linkgit:git-cvsserver[1] for details). Any non-alphabetic
1096characters will be replaced with underscores.
1097
Junio C Hamanodfccbb02008-05-26 01:16:141098All gitcvs variables except for 'gitcvs.usecrlfattr' and
1099'gitcvs.allbinary' can also be specified as
1100'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271101is one of "ext" and "pserver") to make them apply only for the given
1102access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041103
Junio C Hamano6d76d612008-05-09 05:46:081104gui.commitmsgwidth::
1105Defines how wide the commit message window is in the
1106linkgit:git-gui[1]. "75" is the default.
1107
1108gui.diffcontext::
1109Specifies how many context lines should be used in calls to diff
1110made by the linkgit:git-gui[1]. The default is "5".
1111
Junio C Hamanod3452a02008-11-15 08:07:551112gui.encoding::
1113Specifies the default encoding to use for displaying of
1114file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1115It can be overridden by setting the 'encoding' attribute
1116for relevant files (see linkgit:gitattributes[5]).
1117If this option is not set, the tools default to the
1118locale encoding.
1119
Junio C Hamano6d76d612008-05-09 05:46:081120gui.matchtrackingbranch::
1121Determines if new branches created with linkgit:git-gui[1] should
1122default to tracking remote branches with matching names or
1123not. Default: "false".
1124
1125gui.newbranchtemplate::
1126Is used as suggested name when creating new branches using the
1127linkgit:git-gui[1].
1128
1129gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071130"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081131performing a fetch. The default value is "false".
1132
1133gui.trustmtime::
1134Determines if linkgit:git-gui[1] should trust the file modification
1135timestamp or not. By default the timestamps are not trusted.
1136
1137gui.spellingdictionary::
1138Specifies the dictionary used for spell checking commit messages in
1139the linkgit:git-gui[1]. When set to "none" spell checking is turned
1140off.
1141
Junio C Hamanod3452a02008-11-15 08:07:551142gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431143If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551144location detection. It makes blame significantly faster on huge
1145repositories at the expense of less thorough copy detection.
1146
1147gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131148Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551149detection, measured in alphanumeric characters. See the
1150linkgit:git-blame[1] manual for more information on copy detection.
1151
1152gui.blamehistoryctx::
1153Specifies the radius of history context in days to show in
1154linkgit:gitk[1] for the selected commit, when the `Show History
1155Context` menu item is invoked from 'git gui blame'. If this
1156variable is set to zero, the whole history is shown.
1157
Junio C Hamano92d312a2008-12-15 07:22:201158guitool.<name>.cmd::
1159Specifies the shell command line to execute when the corresponding item
1160of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1161mandatory for every tool. The command is executed from the root of
1162the working directory, and in the environment it receives the name of
1163the tool as 'GIT_GUITOOL', the name of the currently selected file as
1164'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1165the head is detached, 'CUR_BRANCH' is empty).
1166
1167guitool.<name>.needsfile::
1168Run the tool only if a diff is selected in the GUI. It guarantees
1169that 'FILENAME' is not empty.
1170
1171guitool.<name>.noconsole::
1172Run the command silently, without creating a window to display its
1173output.
1174
1175guitool.<name>.norescan::
1176Don't rescan the working directory for changes after the tool
1177finishes execution.
1178
1179guitool.<name>.confirm::
1180Show a confirmation dialog before actually running the tool.
1181
1182guitool.<name>.argprompt::
1183Request a string argument from the user, and pass it to the tool
1184through the 'ARGS' environment variable. Since requesting an
1185argument implies confirmation, the 'confirm' option has no effect
1186if this is enabled. If the option is set to 'true', 'yes', or '1',
1187the dialog uses a built-in generic prompt; otherwise the exact
1188value of the variable is used.
1189
1190guitool.<name>.revprompt::
1191Request a single valid revision from the user, and set the
1192'REVISION' environment variable. In other aspects this option
1193is similar to 'argprompt', and can be used together with it.
1194
1195guitool.<name>.revunmerged::
1196Show only unmerged branches in the 'revprompt' subdialog.
1197This is useful for tools similar to merge or rebase, but not
1198for things like checkout or reset.
1199
1200guitool.<name>.title::
1201Specifies the title to use for the prompt dialog. The default
1202is the tool name.
1203
1204guitool.<name>.prompt::
1205Specifies the general prompt string to display at the top of
1206the dialog, before subsections for 'argprompt' and 'revprompt'.
1207The default value includes the actual command.
1208
Junio C Hamano4e272312008-01-08 09:13:211209help.browser::
1210Specify the browser that will be used to display help in the
1211'web' format. See linkgit:git-help[1].
1212
1213help.format::
1214Override the default help format used by linkgit:git-help[1].
1215Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1216the default. 'web' and 'html' are the same.
1217
Junio C Hamanof24b8062008-09-09 01:34:391218help.autocorrect::
1219Automatically correct and execute mistyped commands after
1220waiting for the given number of deciseconds (0.1 sec). If more
1221than one command can be deduced from the entered text, nothing
1222will be executed. If the value of this option is negative,
1223the corrected command will be executed immediately. If the
1224value is 0 - the command will be just shown but not executed.
1225This is the default.
1226
Junio C Hamano58256872007-12-04 08:31:131227http.proxy::
1228Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:461229environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:131230on a per-remote basis; see remote.<name>.proxy
1231
Junio C Hamano07824ce2006-04-25 07:36:541232http.sslVerify::
1233Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451234over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541235variable.
1236
1237http.sslCert::
1238File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451239over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541240variable.
1241
1242http.sslKey::
1243File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481244over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541245variable.
1246
Junio C Hamano48bc1ce2009-07-09 16:49:191247http.sslCertPasswordProtected::
1248Enable git's password prompt for the SSL certificate. Otherwise
1249OpenSSL will prompt the user, possibly many times, if the
1250certificate or private key is encrypted. Can be overridden by the
1251'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1252
Junio C Hamano07824ce2006-04-25 07:36:541253http.sslCAInfo::
1254File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481255fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541256'GIT_SSL_CAINFO' environment variable.
1257
1258http.sslCAPath::
1259Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451260with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541261by the 'GIT_SSL_CAPATH' environment variable.
1262
1263http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481264How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541265by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1266
Junio C Hamanob141a922010-01-10 19:55:141267http.minSessions::
1268The number of curl sessions (counted across slots) to be kept across
1269requests. They will not be ended with curl_easy_cleanup() until
1270http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1271value will be capped at 1. Defaults to 1.
1272
Junio C Hamano3b70d3c2009-11-21 17:37:371273http.postBuffer::
1274Maximum size in bytes of the buffer used by smart HTTP
1275transports when POSTing data to the remote system.
1276For requests larger than this buffer size, HTTP/1.1 and
1277Transfer-Encoding: chunked is used to avoid creating a
1278massive pack file locally. Default is 1 MiB, which is
1279sufficient for most requests.
1280
Junio C Hamano07824ce2006-04-25 07:36:541281http.lowSpeedLimit, http.lowSpeedTime::
1282If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1283for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481284Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541285'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1286
Junio C Hamanof1dcdfe2006-09-29 08:10:511287http.noEPSV::
1288A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041289This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511290support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1291environment variable. Default is false (curl will use EPSV).
1292
Junio C Hamano53ba6d02010-08-22 07:25:121293http.useragent::
1294The HTTP USER_AGENT string presented to an HTTP server. The default
1295value represents the version of the client git such as git/1.7.1.
1296This option allows you to override this value to a more common value
1297such as Mozilla/4.0. This may be necessary, for instance, if
1298connecting through a firewall that restricts HTTP connections to a set
1299of common USER_AGENT strings (but not including those like git/1.7.1).
1300Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1301
Junio C Hamano07824ce2006-04-25 07:36:541302i18n.commitEncoding::
1303Character encoding the commit messages are stored in; git itself
1304does not care per se, but this information is necessary e.g. when
1305importing commits from emails or in the gitk graphical history
1306browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461307porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541308
Junio C Hamano51f92e22006-12-29 05:18:281309i18n.logOutputEncoding::
1310Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431311running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281312
Junio C Hamano4653c6f2008-11-26 22:50:201313imap::
1314The configuration variables in the 'imap' section are described
1315in linkgit:git-imap-send[1].
1316
Junio C Hamanocaa712a2010-03-11 01:17:351317init.templatedir::
1318Specify the directory from which templates will be copied.
1319(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1320
Junio C Hamano4e272312008-01-08 09:13:211321instaweb.browser::
1322Specify the program that will be used to browse your working
1323repository in gitweb. See linkgit:git-instaweb[1].
1324
1325instaweb.httpd::
1326The HTTP daemon command-line to start gitweb on your working
1327repository. See linkgit:git-instaweb[1].
1328
1329instaweb.local::
1330If true the web server started by linkgit:git-instaweb[1] will
1331be bound to the local IP (127.0.0.1).
1332
1333instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351334The default module path for linkgit:git-instaweb[1] to use
1335instead of /usr/lib/apache2/modules. Only used if httpd
1336is Apache.
Junio C Hamano4e272312008-01-08 09:13:211337
1338instaweb.port::
1339The port number to bind the gitweb httpd to. See
1340linkgit:git-instaweb[1].
1341
Junio C Hamanoe5bf6c12009-02-07 21:43:101342interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001343In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101344input with a single key (i.e., without hitting enter).
1345Currently this is used only by the `\--patch` mode of
1346linkgit:git-add[1]. Note that this setting is silently
1347ignored if portable keystroke input is not available.
1348
Junio C Hamanob713ff12008-05-24 01:12:301349log.date::
Junio C Hamano2db3e752010-09-03 21:33:061350Set the default date-time mode for the 'log' command.
1351Setting a value for log.date is similar to using 'git log''s
1352`\--date` option. Possible values are `relative`, `local`,
1353`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1354for details.
Junio C Hamanob713ff12008-05-24 01:12:301355
Junio C Hamanocb39aea2010-05-09 07:24:481356log.decorate::
1357Print out the ref names of any commits that are shown by the log
1358command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1359'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1360specified, the full ref name (including prefix) will be printed.
1361This is the same as the log commands '--decorate' option.
1362
Junio C Hamanofe9acab2006-11-24 12:10:551363log.showroot::
1364If true, the initial commit will be shown as a big creation event.
1365This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461366Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551367normally hide the root commit will now show it. True by default.
1368
Junio C Hamano8bc410e2009-02-15 10:38:191369mailmap.file::
1370The location of an augmenting mailmap file. The default
1371mailmap, located in the root of the repository, is loaded
1372first, then the mailmap file pointed to by this variable.
1373The location of the mailmap file may be in a repository
1374subdirectory, or somewhere outside of the repository itself.
1375See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1376
Junio C Hamano8b588d52008-03-15 09:48:371377man.viewer::
1378Specify the programs that may be used to display help in the
1379'man' format. See linkgit:git-help[1].
1380
Junio C Hamano6d76d612008-05-09 05:46:081381man.<tool>.cmd::
1382Specify the command to invoke the specified man viewer. The
1383specified command is evaluated in shell with the man page
1384passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261385
Junio C Hamano6d76d612008-05-09 05:46:081386man.<tool>.path::
1387Override the path for the given tool that may be used to
1388display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131389
Junio C Hamano4653c6f2008-11-26 22:50:201390include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421391
Junio C Hamano1fbbbc12007-12-18 07:01:271392mergetool.<tool>.path::
1393Override the path for the given tool. This is useful in case
1394your tool is not in the PATH.
1395
Junio C Hamano86bcccc2008-03-08 09:33:551396mergetool.<tool>.cmd::
1397Specify the command to invoke the specified merge tool. The
1398specified command is evaluated in shell with the following
1399variables available: 'BASE' is the name of a temporary file
1400containing the common base of the files to be merged, if available;
1401'LOCAL' is the name of a temporary file containing the contents of
1402the file on the current branch; 'REMOTE' is the name of a temporary
1403file containing the contents of the file from the branch being
1404merged; 'MERGED' contains the name of the file to which the merge
1405tool should write the results of a successful merge.
1406
1407mergetool.<tool>.trustExitCode::
1408For a custom merge command, specify whether the exit code of
1409the merge command can be used to determine whether the merge was
1410successful. If this is not set to true then the merge target file
1411timestamp is checked and the merge assumed to have been successful
1412if the file has been updated, otherwise the user is prompted to
1413indicate the success of the merge.
1414
1415mergetool.keepBackup::
1416After performing a merge, the original file with conflict markers
1417can be saved as a file with a `.orig` extension. If this variable
1418is set to `false` then this file is not preserved. Defaults to
1419`true` (i.e. keep the backup files).
1420
Junio C Hamano10b7a342009-01-01 22:05:171421mergetool.keepTemporaries::
1422When invoking a custom merge tool, git uses a set of temporary
1423files to pass to the tool. If the tool returns an error and this
1424variable is set to `true`, then these temporary files will be
1425preserved, otherwise they will be removed after the tool has
1426exited. Defaults to `false`.
1427
1428mergetool.prompt::
1429Prompt before each invocation of the merge resolution program.
1430
Junio C Hamano31667362010-03-25 00:38:531431notes.displayRef::
1432The (fully qualified) refname from which to show notes when
1433showing commit messages. The value of this variable can be set
1434to a glob, in which case notes from all matching refs will be
1435shown. You may also specify this configuration variable
1436several times. A warning will be issued for refs that do not
1437exist, but a glob that does not match any refs is silently
1438ignored.
1439+
1440This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1441environment variable, which must be a colon separated list of refs or
1442globs.
1443+
1444The effective value of "core.notesRef" (possibly overridden by
1445GIT_NOTES_REF) is also implicitly added to the list of refs to be
1446displayed.
1447
1448notes.rewrite.<command>::
1449When rewriting commits with <command> (currently `amend` or
1450`rebase`) and this variable is set to `true`, git
1451automatically copies your notes from the original to the
1452rewritten commit. Defaults to `true`, but see
1453"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531454
1455notes.rewriteMode::
1456When copying notes during a rewrite (see the
1457"notes.rewrite.<command>" option), determines what to do if
1458the target commit already has a note. Must be one of
1459`overwrite`, `concatenate`, or `ignore`. Defaults to
1460`concatenate`.
1461+
1462This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1463environment variable.
1464
1465notes.rewriteRef::
1466When copying notes during a rewrite, specifies the (fully
1467qualified) ref whose notes should be copied. The ref may be a
1468glob, in which case notes in all matching refs will be copied.
1469You may also specify this configuration several times.
1470+
1471Does not have a default value; you must configure this variable to
1472enable note rewriting.
Junio C Hamano2b3ee5d2010-05-08 05:41:181473+
1474This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1475environment variable, which must be a colon separated list of refs or
1476globs.
Junio C Hamano31667362010-03-25 00:38:531477
Junio C Hamano75cc4c92006-07-24 08:25:031478pack.window::
Junio C Hamano35738e82008-01-07 07:55:461479The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031480window size is given on the command line. Defaults to 10.
1481
Junio C Hamano91d44c52007-05-09 07:16:071482pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461483The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071484maximum depth is given on the command line. Defaults to 50.
1485
Junio C Hamano235d53f2007-07-13 00:25:151486pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461487The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151488when no limit is given on the command line. The value can be
1489suffixed with "k", "m", or "g". Defaults to 0, meaning no
1490limit.
1491
Junio C Hamanof2ce2972007-05-20 19:12:091492pack.compression::
1493An integer -1..9, indicating the compression level for objects
1494in a pack file. -1 is the zlib default. 0 means no
1495compression, and 1..9 are various speed/size tradeoffs, 9 being
1496slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421497not set, defaults to -1, the zlib default, which is "a default
1498compromise between speed and compression (currently equivalent
1499to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241500+
1501Note that changing the compression level will not automatically recompress
1502all existing objects. You can force recompression by passing the -F option
1503to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091504
Junio C Hamano679d22d2007-06-02 21:13:441505pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271506The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521507linkgit:git-pack-objects[1] before writing them out to a pack.
1508This cache is used to speed up the writing object phase by not
1509having to recompute the final delta result once the best match
1510for all objects is found. Repacking large repositories on machines
1511which are tight with memory might be badly impacted by this though,
1512especially if this cache pushes the system into swapping.
1513A value of 0 means no limit. The smallest size of 1 byte may be
1514used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441515
1516pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141517The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521518linkgit:git-pack-objects[1]. This cache is used to speed up the
1519writing object phase by not having to recompute the final delta
1520result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441521
Junio C Hamano58155b42007-09-15 07:46:141522pack.threads::
1523Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461524delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141525be compiled with pthreads otherwise this option is ignored with a
1526warning. This is meant to reduce packing time on multiprocessor
1527machines. The required amount of memory for the delta search window
1528is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441529Specifying 0 will cause git to auto-detect the number of CPU's
1530and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141531
Junio C Hamanod814b6d2007-11-04 11:13:491532pack.indexVersion::
1533Specify the default pack index version. Valid values are 1 for
1534legacy pack index used by Git versions prior to 1.5.2, and 2 for
1535the new pack index with capabilities for packs larger than 4 GB
1536as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381537packs. Version 2 is the default. Note that version 2 is enforced
1538and this config option ignored whenever the corresponding pack is
1539larger than 2 GB.
1540+
1541If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1542cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1543that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1544other side may give you a repository that cannot be accessed with your
1545older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1546you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1547the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491548
Junio C Hamano09a926d2008-03-13 07:55:291549pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291550The maximum size of a pack. This setting only affects
1551packing to a file when repacking, i.e. the git:// protocol
1552is unaffected. It can be overridden by the `\--max-pack-size`
1553option of linkgit:git-repack[1]. The minimum size allowed is
1554limited to 1 MiB. The default is unlimited.
1555Common unit suffixes of 'k', 'm', or 'g' are
1556supported.
Junio C Hamano49dccaf2008-02-10 10:48:011557
Junio C Hamano9e96a1a2008-08-16 10:23:181558pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431559If the value is boolean, turns on or off pagination of the
1560output of a particular git subcommand when writing to a tty.
1561Otherwise, turns on pagination for the subcommand using the
1562pager specified by the value of `pager.<cmd>`. If `\--paginate`
1563or `\--no-pager` is specified on the command line, it takes
1564precedence over this option. To disable pagination for all
1565commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181566
Junio C Hamanoa574a092010-06-13 19:57:101567pretty.<name>::
1568Alias for a --pretty= format string, as specified in
1569linkgit:git-log[1]. Any aliases defined here can be used just
1570as the built-in pretty formats could. For example,
1571running `git config pretty.changelog "format:{asterisk} %H %s"`
1572would cause the invocation `git log --pretty=changelog`
1573to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1574Note that an alias with the same name as a built-in format
1575will be silently ignored.
1576
Junio C Hamano07824ce2006-04-25 07:36:541577pull.octopus::
1578The default merge strategy to use when pulling multiple branches
1579at once.
1580
1581pull.twohead::
1582The default merge strategy to use when pulling a single branch.
1583
Junio C Hamano1de75722009-03-26 08:39:381584push.default::
1585Defines the action git push should take if no refspec is given
1586on the command line, no refspec is configured in the remote, and
1587no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191588line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381589+
Junio C Hamano7f9fa862010-10-19 23:51:141590* `nothing` - do not push anything.
1591* `matching` - push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381592 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191593 matching. This is the default.
Junio C Hamano63c2bc92011-02-28 06:41:281594* `upstream` - push the current branch to its upstream branch.
1595* `tracking` - deprecated synonym for `upstream`.
Junio C Hamano7f9fa862010-10-19 23:51:141596* `current` - push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381597
Junio C Hamanoea6a7642009-03-11 23:56:191598rebase.stat::
1599Whether to show a diffstat of what changed upstream since the last
1600rebase. False by default.
1601
Junio C Hamano075ae872010-09-01 18:43:071602rebase.autosquash::
1603If set to true enable '--autosquash' option by default.
1604
Junio C Hamano621e1232009-10-26 05:16:471605receive.autogc::
1606By default, git-receive-pack will run "git-gc --auto" after
1607receiving data from git-push and updating refs. You can stop
1608it by setting this variable to false.
1609
Junio C Hamano4653c6f2008-11-26 22:50:201610receive.fsckObjects::
1611If it is set to true, git-receive-pack will check all received
1612objects. It will abort in the case of a malformed object or a
1613broken link. The result of an abort are only dangling objects.
1614Defaults to false.
1615
1616receive.unpackLimit::
1617If the number of objects received in a push is below this
1618limit then the objects will be unpacked into loose object
1619files. However if the number of received objects equals or
1620exceeds this limit then the received pack will be stored as
1621a pack, after adding any missing delta bases. Storing the
1622pack from a push can make the push operation complete faster,
1623especially on slow filesystems. If not set, the value of
1624`transfer.unpackLimit` is used instead.
1625
1626receive.denyDeletes::
1627If set to true, git-receive-pack will deny a ref update that deletes
1628the ref. Use this to prevent such a ref deletion via a push.
1629
Junio C Hamanob4448a82010-07-26 09:02:321630receive.denyDeleteCurrent::
1631If set to true, git-receive-pack will deny a ref update that
1632deletes the currently checked out branch of a non-bare repository.
1633
Junio C Hamano4653c6f2008-11-26 22:50:201634receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:581635If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:201636to the currently checked out branch of a non-bare repository.
1637Such a push is potentially dangerous because it brings the HEAD
1638out of sync with the index and working tree. If set to "warn",
1639print a warning of such a push to stderr, but allow the push to
1640proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:151641message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:201642
1643receive.denyNonFastForwards::
1644If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541645not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201646even if that push is forced. This configuration variable is
1647set when initializing a shared repository.
1648
Junio C Hamano621e1232009-10-26 05:16:471649receive.updateserverinfo::
1650If set to true, git-receive-pack will run git-update-server-info
1651after receiving data from git-push and updating refs.
1652
Junio C Hamano249572f2006-10-24 05:44:081653remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461654The URL of a remote repository. See linkgit:git-fetch[1] or
1655linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081656
Junio C Hamano0e88f3e2009-06-21 08:03:251657remote.<name>.pushurl::
1658The push URL of a remote repository. See linkgit:git-push[1].
1659
Junio C Hamano58256872007-12-04 08:31:131660remote.<name>.proxy::
1661For remotes that require curl (http, https and ftp), the URL to
1662the proxy to use for that remote. Set to the empty string to
1663disable proxying for that remote.
1664
Junio C Hamano249572f2006-10-24 05:44:081665remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461666The default set of "refspec" for linkgit:git-fetch[1]. See
1667linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081668
1669remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461670The default set of "refspec" for linkgit:git-push[1]. See
1671linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081672
Junio C Hamano47d68a52008-05-06 06:35:401673remote.<name>.mirror::
1674If true, pushing to this remote will automatically behave
1675as if the `\--mirror` option was given on the command line.
1676
Junio C Hamano118d2772007-02-21 20:24:101677remote.<name>.skipDefaultUpdate::
1678If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271679using linkgit:git-fetch[1] or the `update` subcommand of
1680linkgit:git-remote[1].
1681
1682remote.<name>.skipFetchAll::
1683If true, this remote will be skipped by default when updating
1684using linkgit:git-fetch[1] or the `update` subcommand of
1685linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101686
Junio C Hamano4ad294b2007-01-20 02:22:501687remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481688The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551689option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501690
Junio C Hamano54ea8d32007-01-25 07:59:481691remote.<name>.uploadpack::
1692The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551693option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481694
Junio C Hamano17dde0e2007-02-26 09:50:211695remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551696Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:531697fetching from remote <name>. Setting it to \--tags will fetch every
1698tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:071699branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1700override this setting. See options \--tags and \--no-tags of
1701linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:211702
Junio C Hamano096dde22009-12-26 23:14:111703remote.<name>.vcs::
1704Setting this to a value <vcs> will cause git to interact with
1705the remote with the git-remote-<vcs> helper.
1706
Junio C Hamano118d2772007-02-21 20:24:101707remotes.<group>::
1708The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461709<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101710
Junio C Hamano77b7e902006-10-23 07:18:501711repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381712By default, linkgit:git-repack[1] creates packs that use
1713delta-base offset. If you need to share your repository with
1714git older than version 1.4.4, either directly or via a dumb
1715protocol such as http, then you need to set this option to
1716"false" and repack. Access from old git versions over the
1717native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501718
Junio C Hamano4653c6f2008-11-26 22:50:201719rerere.autoupdate::
1720When set to true, `git-rerere` updates the index with the
1721resulting contents after it cleanly resolves conflicts using
1722previously recorded resolution. Defaults to false.
1723
1724rerere.enabled::
1725Activate recording of resolved conflicts, so that identical
1726conflict hunks can be resolved automatically, should they
1727be encountered again. linkgit:git-rerere[1] command is by
1728default enabled if you create `rr-cache` directory under
1729`$GIT_DIR`, but can be disabled by setting this option to false.
1730
Junio C Hamano1bbd0f42009-07-23 06:20:291731sendemail.identity::
1732A configuration identity. When given, causes values in the
1733'sendemail.<identity>' subsection to take precedence over
1734values in the 'sendemail' section. The default identity is
1735the value of 'sendemail.identity'.
1736
1737sendemail.smtpencryption::
1738See linkgit:git-send-email[1] for description. Note that this
1739setting is not subject to the 'identity' mechanism.
1740
1741sendemail.smtpssl::
1742Deprecated alias for 'sendemail.smtpencryption = ssl'.
1743
1744sendemail.<identity>.*::
1745Identity-specific versions of the 'sendemail.*' parameters
1746found below, taking precedence over those when the this
1747identity is selected, through command-line or
1748'sendemail.identity'.
1749
1750sendemail.aliasesfile::
1751sendemail.aliasfiletype::
1752sendemail.bcc::
1753sendemail.cc::
1754sendemail.cccmd::
1755sendemail.chainreplyto::
1756sendemail.confirm::
1757sendemail.envelopesender::
1758sendemail.from::
1759sendemail.multiedit::
1760sendemail.signedoffbycc::
1761sendemail.smtppass::
1762sendemail.suppresscc::
1763sendemail.suppressfrom::
1764sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:481765sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:291766sendemail.smtpserver::
1767sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:541768sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:291769sendemail.smtpuser::
1770sendemail.thread::
1771sendemail.validate::
1772See linkgit:git-send-email[1] for description.
1773
1774sendemail.signedoffcc::
1775Deprecated alias for 'sendemail.signedoffbycc'.
1776
Junio C Hamano07824ce2006-04-25 07:36:541777showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461778The default set of branches for linkgit:git-show-branch[1].
1779See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541780
Junio C Hamano942b35e2007-12-09 10:19:331781status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461782By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331783current directory. Setting this variable to `false` shows paths
1784relative to the repository root (this was the default for git
1785prior to v1.5.4).
1786
Junio C Hamano4224f992008-06-23 07:14:081787status.showUntrackedFiles::
1788By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1789files which are not currently tracked by Git. Directories which
1790contain only untracked files, are shown with the directory name
1791only. Showing untracked files means that Git needs to lstat() all
1792all the files in the whole repository, which might be slow on some
1793systems. So, this variable controls how the commands displays
1794the untracked files. Possible values are:
1795+
1796--
Junio C Hamano7f9fa862010-10-19 23:51:141797* `no` - Show no untracked files.
1798* `normal` - Show untracked files and directories.
1799* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:081800--
1801+
1802If this variable is not specified, it defaults to 'normal'.
1803This variable can be overridden with the -u|--untracked-files option
1804of linkgit:git-status[1] and linkgit:git-commit[1].
1805
Junio C Hamanob671fb52010-06-01 05:06:141806status.submodulesummary::
1807Defaults to false.
1808If this is set to a non zero number or true (identical to -1 or an
1809unlimited number), the submodule summary will be enabled and a
1810summary of commits for modified submodules will be shown (see
1811--summary-limit option of linkgit:git-submodule[1]).
1812
Junio C Hamano78e3a782010-07-15 22:24:451813submodule.<name>.path::
1814submodule.<name>.url::
1815submodule.<name>.update::
1816The path within this project, URL, and the updating strategy
1817for a submodule. These variables are initially populated
1818by 'git submodule init'; edit them to override the
1819URL and other values found in the `.gitmodules` file. See
1820linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1821
Junio C Hamano0d75e872010-12-17 06:57:261822submodule.<name>.fetchRecurseSubmodules::
1823This option can be used to enable/disable recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:181824submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:261825command line option to "git fetch" and "git pull".
1826This setting will override that from in the linkgit:gitmodules[5]
1827file.
1828
Junio C Hamano619596a2010-08-18 22:15:351829submodule.<name>.ignore::
1830Defines under what circumstances "git status" and the diff family show
1831a submodule as modified. When set to "all", it will never be considered
1832modified, "dirty" will ignore all changes to the submodules work tree and
1833takes only differences between the HEAD of the submodule and the commit
1834recorded in the superproject into account. "untracked" will additionally
1835let submodules with modified tracked files in their work tree show up.
1836Using "none" (the default when this option is not set) also shows
1837submodules that have untracked files in their work tree as changed.
1838This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:181839both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:351840"--ignore-submodules" option.
1841
Junio C Hamano75cc4c92006-07-24 08:25:031842tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091843This variable can be used to restrict the permission bits of
1844tar archive entries. The default is 0002, which turns off the
1845world write bit. The special value "user" indicates that the
1846archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461847linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031848
Junio C Hamano4653c6f2008-11-26 22:50:201849transfer.unpackLimit::
1850When `fetch.unpackLimit` or `receive.unpackLimit` are
1851not set, the value of this variable is used instead.
1852The default value is 100.
1853
Junio C Hamano24bc09a2008-02-28 00:27:441854url.<base>.insteadOf::
1855Any URL that starts with this value will be rewritten to
1856start, instead, with <base>. In cases where some site serves a
1857large number of repositories, and serves them with multiple
1858access methods, and some users need to use different access
1859methods, this feature allows people to specify any of the
1860equivalent URLs and have git automatically rewrite the URL to
1861the best alternative for the particular user, even for a
1862never-before-seen repository on the site. When more than one
1863insteadOf strings match a given URL, the longest match is used.
1864
Junio C Hamano7df6dcf2009-09-13 09:51:171865url.<base>.pushInsteadOf::
1866Any URL that starts with this value will not be pushed to;
1867instead, it will be rewritten to start with <base>, and the
1868resulting URL will be pushed to. In cases where some site serves
1869a large number of repositories, and serves them with multiple
1870access methods, some of which do not allow push, this feature
1871allows people to specify a pull-only URL and have git
1872automatically use an appropriate URL to push, even for a
1873never-before-seen repository on the site. When more than one
1874pushInsteadOf strings match a given URL, the longest match is
1875used. If a remote has an explicit pushurl, git will ignore this
1876setting for that remote.
1877
Junio C Hamano07824ce2006-04-25 07:36:541878user.email::
1879Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341880Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461881'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541882
1883user.name::
1884Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481885Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461886environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541887
Junio C Hamanoa890c4f2007-01-28 10:29:211888user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461889If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211890automatically when creating a signed tag, you can override the
1891default selection with this variable. This option is passed
1892unchanged to gpg's --local-user parameter, so you may specify a key
1893using any method that gpg supports.
1894
Junio C Hamano4e272312008-01-08 09:13:211895web.browser::
1896Specify a web browser that may be used by some commands.
1897Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1898may use it.