blob: 3f01bd929f4cffe71eb8de1366ef6065cbf711fc [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Junio C Hamanobee172f2007-01-23 08:44:1818Syntax
19~~~~~~
20
Junio C Hamano07824ce2006-04-25 07:36:5421The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1822ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4828characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5929must belong to some section, which means that there must be a section
30header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1831
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5934in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1835
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanof4581102009-04-25 08:29:5941Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1844lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
Junio C Hamanof4581102009-04-25 08:29:5948There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
Junio C Hamanobee172f2007-01-23 08:44:1851
Junio C Hamanoaa2cd762009-07-26 08:14:0152All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1854'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4857characters and `-` are allowed. There can be more than one value
Junio C Hamanobee172f2007-01-23 08:44:1858for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano4cfa5362009-04-18 23:01:01650/1, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1866converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4367'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1868
69String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5970You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4874be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1875
Junio C Hamanoea82cff2009-03-18 01:54:4876The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1879char sequences are valid.
80
Junio C Hamanof4581102009-04-25 08:29:5981Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1882customary UNIX fashion.
83
Junio C Hamanof4581102009-04-25 08:29:5984Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5485
86Example
87~~~~~~~
88
89# Core variables
90[core]
91; Don't trust file modes
92filemode = false
93
94# Our diff algorithm
95[diff]
Junio C Hamano85c71572008-07-28 00:03:3196external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:5497renames = true
98
Junio C Hamano52401ef2006-12-19 00:54:3899[branch "devel"]
100remote = origin
101merge = refs/heads/devel
102
Junio C Hamanobee172f2007-01-23 08:44:18103# Proxy settings
104[core]
Junio C Hamanoc71a8732007-08-04 00:27:26105gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18106gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38107
Junio C Hamano07824ce2006-04-25 07:36:54108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54114porcelain configuration variables in the respective porcelain documentation.
115
Junio C Hamano7df6dcf2009-09-13 09:51:17116advice.*::
117When set to 'true', display the given optional help message.
118When set to 'false', do not display. The configuration variables
119are:
120+
121--
122pushNonFastForward::
123Advice shown when linkgit:git-push[1] refuses
124non-fast-forward refs. Default: true.
125statusHints::
126Directions on how to stage/unstage/add shown in the
127output of linkgit:git-status[1] and the template shown
128when writing commit messages. Default: true.
Junio C Hamano5706e0b2009-11-24 10:54:16129commitBeforeMerge::
130Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35131merge to avoid overwriting local changes.
Junio C Hamano5706e0b2009-11-24 10:54:16132Default: true.
Junio C Hamanoa9701f02010-01-21 00:42:16133resolveConflict::
134Advices shown by various commands when conflicts
135prevent the operation from being performed.
136Default: true.
137implicitIdentity::
138Advice on how to set your identity configuration when
139your information is guessed from the system username and
140domain name. Default: true.
Junio C Hamano74a198f2010-02-22 00:13:31141
142detachedHead::
143Advice shown when you used linkgit::git-checkout[1] to
144move to the detach HEAD state, to instruct how to create
145a local branch after the fact. Default: true.
Junio C Hamano7df6dcf2009-09-13 09:51:17146--
147
Junio C Hamano07824ce2006-04-25 07:36:54148core.fileMode::
149If false, the executable bit differences between the index and
150the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27151See linkgit:git-update-index[1].
152+
153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154will probe and set core.fileMode false if appropriate when the
155repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54156
Junio C Hamanoa476efa2008-10-10 15:31:42157core.ignoreCygwinFSTricks::
158This option is only used by Cygwin implementation of Git. If false,
159the Cygwin stat() and lstat() functions are used. This may be useful
160if your repository consists of a few separate directories joined in
161one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162whenever it is possible and falls back to Cygwin functions only to
163handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33164normal Cygwin l/stat() functions. True by default, unless core.filemode
165is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42167
Junio C Hamano9df0c662009-11-23 11:09:27168core.ignorecase::
169If true, this option enables various workarounds to enable
170git to work better on filesystems that are not case sensitive,
171like FAT. For example, if a directory listing finds
172"makefile" when git expects "Makefile", git will assume
173it is really the same file, and continue to remember it as
174"Makefile".
175+
176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177will probe and set core.ignorecase true if appropriate when the repository
178is created.
179
Junio C Hamano90ccff32008-07-29 08:17:24180core.trustctime::
181If false, the ctime differences between the index and the
182working copy are ignored; useful when the inode change time
183is regularly modified by something outside Git (file system
184crawlers and some backup systems).
185See linkgit:git-update-index[1]. True by default.
186
Junio C Hamanod526ba92007-07-02 00:17:42187core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31188The commands that output paths (e.g. 'ls-files',
189'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42190"unusual" characters in the pathname by enclosing the
191pathname in a double-quote pair and with backslashes the
192same way strings in C source code are quoted. If this
193variable is set to false, the bytes higher than 0x80 are
194not quoted but output as verbatim. Note that double
195quote, backslash and control characters are always
196quoted without `-z` regardless of the setting of this
197variable.
198
Junio C Hamanobb88cf42010-06-21 15:23:55199core.eol::
200Sets the line ending type to use in the working directory for
201files that have the `text` property set. Alternatives are
202'lf', 'crlf' and 'native', which uses the platform's native
203line ending. The default value is `native`. See
204linkgit:gitattributes[5] for more information on end-of-line
205conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04206
Junio C Hamano26e590a2008-02-17 03:53:51207core.safecrlf::
Junio C Hamanobb88cf42010-06-21 15:23:55208If true, makes git check if converting `CRLF` is reversible when
209end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51210modifies a file in the work tree either directly or indirectly.
211For example, committing a file followed by checking out the
212same file should yield the original file in the work tree. If
213this is not the case for the current setting of
214`core.autocrlf`, git will reject the file. The variable can
215be set to "warn", in which case git will only warn about an
216irreversible conversion but continue the operation.
217+
218CRLF conversion bears a slight chance of corrupting data.
Junio C Hamanobb88cf42010-06-21 15:23:55219When it is enabled, git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51220CRLF during checkout. A file that contains a mixture of LF and
221CRLF before the commit cannot be recreated by git. For text
222files this is the right thing to do: it corrects line endings
223such that we have only LF line endings in the repository.
224But for binary files that are accidentally classified as text the
225conversion can corrupt data.
226+
227If you recognize such corruption early you can easily fix it by
228setting the conversion type explicitly in .gitattributes. Right
229after committing you still have the original file in your work
230tree and this file is not yet corrupted. You can explicitly tell
231git that this file is binary and git will handle the file
232appropriately.
233+
234Unfortunately, the desired effect of cleaning up text files with
235mixed line endings and the undesired effect of corrupting binary
236files cannot be distinguished. In both cases CRLFs are removed
237in an irreversible way. For text files this is the right thing
238to do because CRLFs are line endings, while for binary files
239converting CRLFs corrupts data.
240+
241Note, this safety check does not mean that a checkout will generate a
242file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55243`core.eol` and `core.autocrlf`, but only for the current one. For
244example, a text file with `LF` would be accepted with `core.eol=lf`
245and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51246resulting file would contain `CRLF`, although the original file
247contained `LF`. However, in both work trees the line endings would be
248consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249file with mixed line endings would be reported by the `core.safecrlf`
250mechanism.
251
Junio C Hamanobb88cf42010-06-21 15:23:55252core.autocrlf::
253Setting this variable to "true" is almost the same as setting
254the `text` attribute to "auto" on all files except that text
255files are not guaranteed to be normalized: files that contain
256`CRLF` in the repository will not be touched. Use this
257setting if you want to have `CRLF` line endings in your
258working directory even though the repository does not have
259normalized line endings. This variable can be set to 'input',
260in which case no output conversion is performed.
261
Junio C Hamanoaa83a7d2007-03-05 02:37:29262core.symlinks::
263If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46264contain the link text. linkgit:git-update-index[1] and
265linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29266file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27267symbolic links.
268+
269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270will probe and set core.symlinks false if appropriate when the repository
271is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29272
Junio C Hamano07824ce2006-04-25 07:36:54273core.gitProxy::
274A "proxy command" to execute (as 'command host port') instead
275of establishing direct connection to the remote server when
276using the git protocol for fetching. If the variable value is
277in the "COMMAND for DOMAIN" format, the command is applied only
278on hostnames ending with the specified domain string. This variable
279may be set multiple times and is matched in the given order;
280the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17281+
282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283(which always applies universally, without the special "for"
284handling).
Junio C Hamanoea82cff2009-03-18 01:54:48285+
286The special string `none` can be used as the proxy command to
287specify that no proxy be used for a given domain pattern.
288This is useful for excluding servers inside a firewall from
289proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54290
291core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34292If true, commands which modify both the working tree and the index
293will mark the updated paths with the "assume unchanged" bit in the
294index. These marked files are then assumed to stay unchanged in the
295working copy, until you mark them otherwise manually - Git will not
296detect the file changes by lstat() calls. This is useful on systems
297where those are very slow, such as Microsoft Windows.
298See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54299False by default.
300
Junio C Hamano88a3a072006-05-04 08:01:43301core.preferSymlinkRefs::
302Instead of the default "symref" format for HEAD
303and other symbolic reference files, use symbolic links.
304This is sometimes needed to work with old scripts that
305expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54306
Junio C Hamano1025e752007-02-23 07:21:26307core.bare::
308If true this repository is assumed to be 'bare' and has no
309working directory associated with it. If this is the case a
310number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46311disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26312+
Junio C Hamano35738e82008-01-07 07:55:46313This setting is automatically guessed by linkgit:git-clone[1] or
314linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26315repository that ends in "/.git" is assumed to be not bare (bare =
316false), while all other repositories are assumed to be bare (bare
317= true).
318
Junio C Hamanod526ba92007-07-02 00:17:42319core.worktree::
Junio C Hamanodab291e2009-12-30 09:45:38320Set the path to the root of the work tree.
Junio C Hamano764a6672007-10-23 01:23:31321This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27322variable and the '--work-tree' command line option. It can be
Junio C Hamanodab291e2009-12-30 09:45:38323an absolute path or a relative path to the .git directory,
324either specified by --git-dir or GIT_DIR, or automatically
325discovered.
326If --git-dir or GIT_DIR are specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27327--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanodab291e2009-12-30 09:45:38328the current working directory is regarded as the root of the
329work tree.
330+
331Note that this variable is honored even when set in a configuration
332file in a ".git" subdirectory of a directory, and its value differs
333from the latter directory (e.g. "/path/to/.git/config" has
334core.worktree set to "/different/path"), which is most likely a
335misconfiguration. Running git commands in "/path/to" directory will
336still use "/different/path" as the root of the work tree and can cause
337great confusion to the users.
Junio C Hamanod526ba92007-07-02 00:17:42338
Junio C Hamano341071d2006-06-04 07:24:48339core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49340Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48341"$GIT_DIR/logs/<ref>", by appending the new and old
342SHA1, the date/time and the reason of the update, but
343only when the file exists. If this configuration
344variable is set to true, missing "$GIT_DIR/logs/<ref>"
345file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35346+
347This information can be used to determine what commit
348was the tip of a branch "2 days ago".
349+
350This value is true by default in a repository that has
351a working directory associated with it, and false by
352default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48353
Junio C Hamano07824ce2006-04-25 07:36:54354core.repositoryFormatVersion::
355Internal variable identifying the repository format and layout
356version.
357
358core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42359When 'group' (or 'true'), the repository is made shareable between
360several users in a group (making sure all the files and objects are
361group-writable). When 'all' (or 'world' or 'everybody'), the
362repository will be readable by all users, additionally to being
363group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37364reported by umask(2). When '0xxx', where '0xxx' is an octal number,
365files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00366user's umask value (whereas the other options will only override
367requested parts of the user's umask value). Examples: '0660' will make
368the repo read/write-able for the owner and group, but inaccessible to
369others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37370repository that is group-readable but not group-writable.
371See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54372
373core.warnAmbiguousRefs::
374If true, git will warn you if the ref name you passed it is ambiguous
375and might match multiple refs in the .git/refs/ tree. True by default.
376
Junio C Hamano2e6ded82010-12-05 06:20:48377core.abbrevguard::
378Even though git makes sure that it uses enough hexdigits to show
379an abbreviated object name unambiguously, as more objects are
380added to the repository over time, a short name that used to be
381unique will stop being unique. Git uses this many extra hexdigits
382that are more than necessary to make the object name currently
383unique, in the hope that its output will stay unique a bit longer.
384Defaults to 0.
385
Junio C Hamano7ec15722006-07-07 02:03:59386core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09387An integer -1..9, indicating a default compression level.
388-1 is the zlib default. 0 means no compression,
389and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42390If set, this provides a default to other compression variables,
391such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26392
Junio C Hamanof2ce2972007-05-20 19:12:09393core.loosecompression::
394An integer -1..9, indicating the compression level for objects that
395are not in a pack file. -1 is the zlib default. 0 means no
396compression, and 1..9 are various speed/size tradeoffs, 9 being
397slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42398not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49399
Junio C Hamanofc4d38c2007-01-08 06:53:32400core.packedGitWindowSize::
401Number of bytes of a pack file to map into memory in a
402single mapping operation. Larger window sizes may allow
403your system to process a smaller number of large pack files
404more quickly. Smaller window sizes will negatively affect
405performance due to increased calls to the operating system's
406memory manager, but may improve performance when accessing
407a large number of large pack files.
408+
409Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
410MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
411be reasonable for all users/operating systems. You probably do
412not need to adjust this value.
413+
414Common unit suffixes of 'k', 'm', or 'g' are supported.
415
416core.packedGitLimit::
417Maximum number of bytes to map simultaneously into memory
418from pack files. If Git needs to access more than this many
419bytes at once to complete an operation it will unmap existing
420regions to reclaim virtual address space within the process.
421+
422Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
423This should be reasonable for all users/operating systems, except on
424the largest projects. You probably do not need to adjust this value.
425+
426Common unit suffixes of 'k', 'm', or 'g' are supported.
427
Junio C Hamanob8c51282007-03-19 10:43:30428core.deltaBaseCacheLimit::
429Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35430that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30431entire decompressed base objects in a cache Git is able
432to avoid unpacking and decompressing frequently used base
433objects multiple times.
434+
435Default is 16 MiB on all platforms. This should be reasonable
436for all users/operating systems, except on the largest projects.
437You probably do not need to adjust this value.
438+
439Common unit suffixes of 'k', 'm', or 'g' are supported.
440
Junio C Hamano5c246f22010-02-03 07:34:53441core.bigFileThreshold::
442Files larger than this size are stored deflated, without
443attempting delta compression. Storing large files without
444delta compression avoids excessive memory usage, at the
445slight expense of increased disk usage.
446+
447Default is 512 MiB on all platforms. This should be reasonable
448for most projects as source code and other text files can still
449be delta compressed, but larger binary media files won't be.
450+
451Common unit suffixes of 'k', 'm', or 'g' are supported.
452+
453Currently only linkgit:git-fast-import[1] honors this setting.
454
Junio C Hamano1d90cb02007-07-03 07:05:31455core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37456In addition to '.gitignore' (per-directory) and
457'.git/info/exclude', git looks into this file for patterns
Junio C Hamanobf984de2009-11-23 06:11:19458of files which are not meant to be tracked. "{tilde}/" is expanded
459to the value of `$HOME` and "{tilde}user/" to the specified user's
460home directory. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37461
Junio C Hamano3fd7b262010-09-08 22:44:20462core.askpass::
463Some commands (e.g. svn and http interfaces) that interactively
464ask for a password can be told to use an external program given
465via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
466environment variable. If not set, fall back to the value of the
467'SSH_ASKPASS' environment variable or, failing that, a simple password
468prompt. The external program shall be given a suitable prompt as
469command line argument and write the password on its STDOUT.
470
Junio C Hamano3b4609d2010-09-30 00:04:34471core.attributesfile::
472In addition to '.gitattributes' (per-directory) and
473'.git/info/attributes', git looks into this file for attributes
474(see linkgit:gitattributes[5]). Path expansions are made the same
475way as for `core.excludesfile`.
476
Junio C Hamanof6002a92007-07-20 10:28:22477core.editor::
478Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27479messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22480variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37481`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22482
Junio C Hamano28d8ede2007-07-05 05:51:38483core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33484The command that git will use to paginate output. Can
485be overridden with the `GIT_PAGER` environment
486variable. Note that git sets the `LESS` environment
487variable to `FRSX` if it is unset when it runs the
488pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42489`LESS` variable to some other value. Alternately,
490these settings can be overridden on a project or
491global basis by setting the `core.pager` option.
492Setting `core.pager` has no affect on the `LESS`
493environment variable behaviour above, so if you want
494to override git's default settings this way, you need
495to be explicit. For example, to disable the S option
496in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48497to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42498shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48499`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38500
Junio C Hamano942b35e2007-12-09 10:19:33501core.whitespace::
502A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43503notice. 'git diff' will use `color.diff.whitespace` to
504highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59505consider them as errors. You can prefix `-` to disable
506any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33507+
Junio C Hamanob71a22d2009-10-17 08:23:47508* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33509 as an error (enabled by default).
510* `space-before-tab` treats a space character that appears immediately
511 before a tab character in the initial indent part of the line as an
512 error (enabled by default).
513* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42514 space characters as an error (not enabled by default).
Junio C Hamanocb39aea2010-05-09 07:24:48515* `tab-in-indent` treats a tab character in the initial indent part of
516 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47517* `blank-at-eof` treats blank lines added at the end of file as an error
518 (enabled by default).
519* `trailing-space` is a short-hand to cover both `blank-at-eol` and
520 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42521* `cr-at-eol` treats a carriage-return at the end of line as
522 part of the line terminator, i.e. with it, `trailing-space`
523 does not trigger if the character before such a carriage-return
524 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58525* `tabwidth=<n>` tells how many character positions a tab occupies; this
526 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
527 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33528
Junio C Hamano9eb57532008-06-26 06:33:46529core.fsyncobjectfiles::
530This boolean will enable 'fsync()' when writing object files.
531+
532This is a total waste of time and effort on a filesystem that orders
533data writes properly, but can be useful for filesystems that do not use
534journalling (traditional UNIX filesystems) or that only journal metadata
535and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
536
Junio C Hamano610d1762008-11-28 06:27:13537core.preloadindex::
538Enable parallel index preload for operations like 'git diff'
539+
540This can speed up operations like 'git diff' and 'git status' especially
541on filesystems like NFS that have weak caching semantics and thus
542relatively high IO latencies. With this set to 'true', git will do the
543index comparison to the filesystem data in parallel, allowing
544overlapping IO's.
545
Junio C Hamanoa9499de2009-04-30 03:38:48546core.createObject::
547You can set this to 'link', in which case a hardlink followed by
548a delete of the source are used to make sure that object creation
549will not overwrite existing objects.
550+
551On some file system/operating system combinations, this is unreliable.
552Set this config setting to 'rename' there; However, This will remove the
553check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41554
Junio C Hamano3b70d3c2009-11-21 17:37:37555core.notesRef::
556When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10557the given ref. The ref must be fully qualified. If the given
558ref does not exist, it is not an error but means that no
559notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37560+
Junio C Hamanoa574a092010-06-13 19:57:10561This setting defaults to "refs/notes/commits", and it can be overridden by
562the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37563
Junio C Hamano3c8d6702010-01-13 23:09:03564core.sparseCheckout::
565Enable "sparse checkout" feature. See section "Sparse checkout" in
566linkgit:git-read-tree[1] for more information.
567
Junio C Hamano3d141512009-06-01 01:22:40568add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26569add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43570Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40571added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano60186642010-12-02 14:18:26572option of linkgit:git-add[1]. Older versions of git accept only
573`add.ignore-errors`, which does not follow the usual naming
574convention for configuration variables. Newer versions of git
575honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40576
Junio C Hamano33db4372006-06-07 19:51:45577alias.*::
Junio C Hamano35738e82008-01-07 07:55:46578Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45579after defining "alias.last = cat-file commit HEAD", the invocation
580"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17581confusion and troubles with script usage, aliases that
582hide existing git commands are ignored. Arguments are split by
583spaces, the usual shell quoting and escaping is supported.
584quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39585+
586If the alias expansion is prefixed with an exclamation point,
587it will be treated as a shell command. For example, defining
588"alias.new = !gitk --all --not ORIG_HEAD", the invocation
589"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19590"gitk --all --not ORIG_HEAD". Note that shell commands will be
591executed from the top-level directory of a repository, which may
592not necessarily be the current directory.
Junio C Hamano9cb74f22007-02-12 04:15:05593
Junio C Hamanocaa712a2010-03-11 01:17:35594am.keepcr::
595If true, git-am will call git-mailsplit for patches in mbox format
596with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35597not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35598by giving '--no-keep-cr' from the command line.
599See linkgit:git-am[1], linkgit:git-mailsplit[1].
600
Junio C Hamanofe24db02009-08-22 05:10:47601apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43602When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47603whitespace, in the same way as the '--ignore-space-change'
604option.
Junio C Hamano1aa40d22010-01-21 17:46:43605When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47606respect all whitespace differences.
607See linkgit:git-apply[1].
608
Junio C Hamano07824ce2006-04-25 07:36:54609apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43610Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46611as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54612
Junio C Hamano7fd84172007-05-24 07:00:32613branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43614Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44615so that linkgit:git-pull[1] will appropriately merge from the
616starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32617this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44618and `--no-track` options. The valid settings are: `false` -- no
619automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07620starting point is a remote-tracking branch; `always` --
621automatic setup is done when the starting point is either a
622local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44623branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32624
Junio C Hamano869bb802008-05-12 00:29:47625branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43626When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano869bb802008-05-12 00:29:47627that tracks another branch, this variable tells git to set
628up pull to rebase instead of merge (see "branch.<name>.rebase").
629When `never`, rebase is never automatically set to true.
630When `local`, rebase is set to true for tracked branches of
631other local branches.
632When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07633remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47634When `always`, rebase will be set to true for all tracking
635branches.
636See "branch.autosetupmerge" for details on how to set up a
637branch to track another branch.
638This option defaults to never.
639
Junio C Hamano47c1e3c2006-09-25 04:45:55640branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43641When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19642remote to fetch from/push to. It defaults to `origin` if no remote is
643configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55644
645branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19646Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamano1aa40d22010-01-21 17:46:43647for the given branch. It tells 'git fetch'/'git pull' which
648branch to merge and can also affect 'git push' (see push.default).
649When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31650refspec to be marked for merging in FETCH_HEAD. The value is
651handled like the remote part of a refspec, and must match a
652ref which is fetched from the remote given by
653"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43654The merge information is used by 'git pull' (which at first calls
655'git fetch') to lookup the default branch for merging. Without
656this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46657Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43658If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07659another branch in the local repository, you can point
660branch.<name>.merge to the desired branch, and use the special setting
661`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55662
Junio C Hamano1b50ce92007-10-03 12:05:53663branch.<name>.mergeoptions::
664Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29665supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53666option values containing whitespace characters are currently not
667supported.
668
Junio C Hamano0c999702007-12-03 09:57:55669branch.<name>.rebase::
670When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08671instead of merging the default branch from the default remote when
672"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55673*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46674it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55675for details).
676
Junio C Hamano8760ea62008-03-14 08:58:45677browser.<tool>.cmd::
678Specify the command to invoke the specified browser. The
679specified command is evaluated in shell with the URLs passed
680as arguments. (See linkgit:git-web--browse[1].)
681
Junio C Hamanoe35a6fc2008-01-29 09:46:27682browser.<tool>.path::
683Override the path for the given tool that may be used to
684browse HTML help (see '-w' option in linkgit:git-help[1]) or a
685working repository in gitweb (see linkgit:git-instaweb[1]).
686
Junio C Hamano47b9acd2007-04-24 07:34:34687clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45688A boolean to make git-clean do nothing unless given -f
689or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34690
Junio C Hamanoeb692952007-01-03 22:02:12691color.branch::
692A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46693linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21694`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12695only when the output is to a terminal. Defaults to false.
696
697color.branch.<slot>::
698Use customized color for branch coloration. `<slot>` is one of
699`current` (the current branch), `local` (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07700`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22701refs).
702+
703The value for these configuration variables is a list of colors (at most
704two) and attributes (at most one), separated by spaces. The colors
705accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
706`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
707`blink` and `reverse`. The first color given is the foreground; the
708second is the background. The position of the attribute, if any,
709doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12710
Junio C Hamano3f403b02006-12-13 10:14:13711color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21712When set to `always`, always use colors in patch.
713When false (or `never`), never. When set to `true` or `auto`, use
714colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34715
Junio C Hamano3f403b02006-12-13 10:14:13716color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22717Use customized color for diff colorization. `<slot>` specifies
718which part of the patch to use the specified color, and is one
719of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59720(hunk header), 'func' (function in hunk header), `old` (removed lines),
721`new` (added lines), `commit` (commit headers), or `whitespace`
722(highlighting whitespace errors). The values of these variables may be
723specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34724
Junio C Hamano7d449522010-07-01 00:08:51725color.decorate.<slot>::
726Use customized color for 'git log --decorate' output. `<slot>` is one
727of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07728branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51729
Junio C Hamanod257cff2009-03-18 05:27:16730color.grep::
731When set to `always`, always highlight matches. When `false` (or
732`never`), never. When set to `true` or `auto`, use color only
733when the output is written to the terminal. Defaults to `false`.
734
Junio C Hamano0299d922010-03-20 20:59:31735color.grep.<slot>::
736Use customized color for grep colorization. `<slot>` specifies which
737part of the line to use the specified color, and is one of
738+
739--
740`context`;;
741non-matching text in context lines (when using `-A`, `-B`, or `-C`)
742`filename`;;
743filename prefix (when not using `-h`)
744`function`;;
745function name lines (when using `-p`)
746`linenumber`;;
747line number prefix (when using `-n`)
748`match`;;
749matching text
750`selected`;;
751non-matching text in selected lines
752`separator`;;
753separators between fields on a line (`:`, `-`, and `=`)
754and between hunks (`--`)
755--
756+
757The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16758
Junio C Hamano00b8b632007-12-07 09:50:49759color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46760When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31761and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49762When false (or `never`), never. When set to `true` or `auto`, use
763colors only when the output is to the terminal. Defaults to false.
764
765color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43766Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10767output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
768four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00769commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49770in color.branch.<slot>.
771
Junio C Hamanoe7935c42006-12-13 21:32:17772color.pager::
773A boolean to enable/disable colored output when the pager is in
774use (default is true).
775
Junio C Hamano52ba2952009-05-18 17:43:02776color.showbranch::
777A boolean to enable/disable color in the output of
778linkgit:git-show-branch[1]. May be set to `always`,
779`false` (or `never`) or `auto` (or `true`), in which case colors are used
780only when the output is to a terminal. Defaults to false.
781
Junio C Hamanoe7935c42006-12-13 21:32:17782color.status::
783A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46784linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21785`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17786only when the output is to a terminal. Defaults to false.
787
788color.status.<slot>::
789Use customized color for status colorization. `<slot>` is
790one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04791`added` or `updated` (files which are added but not committed),
792`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30793`untracked` (files which are not tracked by git), or
794`nobranch` (the color the 'no branch' warning is shown in, defaulting
795to red). The values of these variables may be specified as in
796color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17797
Junio C Hamano83d46a22008-02-21 02:29:42798color.ui::
799When set to `always`, always use colors in all git commands which
800are capable of colored output. When false (or `never`), never. When
801set to `true` or `auto`, use colors only when the output is to the
802terminal. When more specific variables of color.* are set, they always
803take precedence over this setting. Defaults to false.
804
Junio C Hamanod0d892c2010-01-24 20:06:29805commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50806A boolean to enable/disable inclusion of status information in the
807commit message template when using an editor to prepare the commit
808message. Defaults to true.
809
Junio C Hamano4653c6f2008-11-26 22:50:20810commit.template::
811Specify a file to use as the template for new commit messages.
Junio C Hamanobf984de2009-11-23 06:11:19812"{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
813specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20814
Junio C Hamanodbb64592007-09-01 11:17:39815diff.autorefreshindex::
Junio C Hamano1aa40d22010-01-21 17:46:43816When using 'git diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39817files, do not consider stat-only change as changed.
818Instead, silently run `git update-index --refresh` to
819update the cached stat information for paths whose
820contents in the work tree match the contents in the
821index. This option defaults to true. Note that this
Junio C Hamano1aa40d22010-01-21 17:46:43822affects only 'git diff' Porcelain, and not lower level
823'diff' commands such as 'git diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39824
Junio C Hamano1fbbbc12007-12-18 07:01:27825diff.external::
826If this config variable is set, diff generation is not
827performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31828given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
829environment variable. The command is called with parameters
830as described under "git Diffs" in linkgit:git[1]. Note: if
831you want to use an external diff program only on a subset of
832your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27833
Junio C Hamano5e4d8de2008-09-19 06:27:02834diff.mnemonicprefix::
Junio C Hamano1aa40d22010-01-21 17:46:43835If set, 'git diff' uses a prefix pair that is different from the
Junio C Hamano5e4d8de2008-09-19 06:27:02836standard "a/" and "b/" depending on what is being compared. When
837this configuration is in effect, reverse diff output also swaps
838the order of the prefixes:
Junio C Hamano1aa40d22010-01-21 17:46:43839`git diff`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02840compares the (i)ndex and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43841`git diff HEAD`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02842 compares a (c)ommit and the (w)ork tree;
Junio C Hamano1aa40d22010-01-21 17:46:43843`git diff --cached`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02844compares a (c)ommit and the (i)ndex;
Junio C Hamano1aa40d22010-01-21 17:46:43845`git diff HEAD:file1 file2`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02846compares an (o)bject and a (w)ork tree entity;
Junio C Hamano1aa40d22010-01-21 17:46:43847`git diff --no-index a b`;;
Junio C Hamano5e4d8de2008-09-19 06:27:02848compares two non-git things (1) and (2).
849
Junio C Hamano21c2d142010-09-10 18:09:27850diff.noprefix::
851If set, 'git diff' does not show any source or destination prefix.
852
Junio C Hamano07824ce2006-04-25 07:36:54853diff.renameLimit::
854The number of files to consider when performing the copy/rename
Junio C Hamano1aa40d22010-01-21 17:46:43855detection; equivalent to the 'git diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54856
Junio C Hamano9ae1a062006-07-10 08:12:34857diff.renames::
858Tells git to detect renames. If set to any boolean value, it
859will enable basic rename detection. If set to "copies" or
860"copy", it will detect copies, as well.
861
Junio C Hamano619596a2010-08-18 22:15:35862diff.ignoreSubmodules::
863Sets the default value of --ignore-submodules. Note that this
864affects only 'git diff' Porcelain, and not lower level 'diff'
Junio C Hamanof0f41ba2010-09-04 16:23:06865commands such as 'git diff-files'. 'git checkout' also honors
866this setting when reporting uncommitted changes.
Junio C Hamano619596a2010-08-18 22:15:35867
Junio C Hamanobc4852e2009-01-21 10:51:14868diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21869A boolean to inhibit the standard behavior of printing a space
870before each empty output line. Defaults to false.
871
Junio C Hamano3bd66e92009-04-18 06:17:56872diff.tool::
873Controls which diff tool is used. `diff.tool` overrides
874`merge.tool` when used by linkgit:git-difftool[1] and has
875the same valid values as `merge.tool` minus "tortoisemerge"
876and plus "kompare".
877
878difftool.<tool>.path::
879Override the path for the given tool. This is useful in case
880your tool is not in the PATH.
881
882difftool.<tool>.cmd::
883Specify the command to invoke the specified diff tool.
884The specified command is evaluated in shell with the following
885variables available: 'LOCAL' is set to the name of the temporary
886file containing the contents of the diff pre-image and 'REMOTE'
887is set to the name of the temporary file containing the contents
888of the diff post-image.
889
890difftool.prompt::
891Prompt before each invocation of the diff tool.
892
Junio C Hamano20d47e32009-01-26 06:36:02893diff.wordRegex::
894A POSIX Extended Regular Expression used to determine what is a "word"
895when performing word-by-word difference calculations. Character
896sequences that match the regular expression are "words", all other
897characters are *ignorable* whitespace.
898
Junio C Hamano54ea8d32007-01-25 07:59:48899fetch.unpackLimit::
900If the number of objects fetched over the git native
901transfer is below this
902limit, then the objects will be unpacked into loose object
903files. However if the number of received objects equals or
904exceeds this limit then the received pack will be stored as
905a pack, after adding any missing delta bases. Storing the
906pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17907especially on slow filesystems. If not set, the value of
908`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48909
Junio C Hamanof4581102009-04-25 08:29:59910format.attach::
911Enable multipart/mixed attachments as the default for
912'format-patch'. The value can also be a double quoted string
913which will enable attachments as the default and set the
914value as the boundary. See the --attach option in
915linkgit:git-format-patch[1].
916
Junio C Hamano8c5802d2007-11-15 00:13:36917format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33918A boolean which can enable or disable sequence numbers in patch
919subjects. It defaults to "auto" which enables it only if there
920is more than one patch. It can be enabled or disabled for all
921messages by setting it to "true" or "false". See --numbered
922option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36923
Junio C Hamano07824ce2006-04-25 07:36:54924format.headers::
925Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46926by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54927
Junio C Hamano70664a02010-07-13 22:48:05928format.to::
Junio C Hamanof4581102009-04-25 08:29:59929format.cc::
Junio C Hamano70664a02010-07-13 22:48:05930Additional recipients to include in a patch to be submitted
931by mail. See the --to and --cc options in
932linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:59933
934format.subjectprefix::
935The default for format-patch is to output files with the '[PATCH]'
936subject prefix. Use this variable to change that prefix.
937
Junio C Hamano89a57342010-06-22 23:22:55938format.signature::
939The default for format-patch is to output a signature containing
940the git version number. Use this variable to change that default.
941Set this variable to the empty string ("") to suppress
942signature generation.
943
Junio C Hamanod4c8e112007-03-04 10:32:38944format.suffix::
945The default for format-patch is to output files with the suffix
946`.patch`. Use this variable to change that suffix (make sure to
947include the dot if you want it).
948
Junio C Hamano86bcccc2008-03-08 09:33:55949format.pretty::
950The default pretty format for log/show/whatchanged command,
951See linkgit:git-log[1], linkgit:git-show[1],
952linkgit:git-whatchanged[1].
953
Junio C Hamanoea6a7642009-03-11 23:56:19954format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:43955The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:14956a boolean value, or `shallow` or `deep`. `shallow` threading
957makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:19958where the head is chosen from the cover letter, the
959`\--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59960`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19961A true boolean value is the same as `shallow`, and a false
962value disables threading.
963
Junio C Hamano5f9a6f02009-04-06 08:26:56964format.signoff::
965 A boolean value which lets you enable the `-s/--signoff` option of
966 format-patch by default. *Note:* Adding the Signed-off-by: line to a
967 patch should be a conscious act and means that you certify you have
968 the rights to submit this work under the same open source license.
969 Please see the 'SubmittingPatches' document for further discussion.
970
Junio C Hamanof2ce2972007-05-20 19:12:09971gc.aggressiveWindow::
972The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:43973algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:36974to 250.
Junio C Hamanof2ce2972007-05-20 19:12:09975
Junio C Hamano1b50ce92007-10-03 12:05:53976gc.auto::
977When there are approximately more than this many loose
978objects in the repository, `git gc --auto` will pack them.
979Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17980light-weight garbage collection from time to time. The
981default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53982
983gc.autopacklimit::
984When there are more than this many packs that are not
985marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17986--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37987default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53988
Junio C Hamano9d52e572007-02-13 23:48:20989gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:14990Running `git pack-refs` in a repository renders it
991unclonable by Git versions prior to 1.5.1.2 over dumb
992transports such as HTTP. This variable determines whether
Junio C Hamano1aa40d22010-01-21 17:46:43993'git gc' runs `git pack-refs`. This can be set to `nobare`
Junio C Hamanob141a922010-01-10 19:55:14994to enable it within all non-bare repos or it can be set to a
995boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:20996
Junio C Hamano09a926d2008-03-13 07:55:29997gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:43998When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:57999Override the grace period with this config variable. The value
1000"now" may be used to disable this grace period and always prune
1001unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291002
Junio C Hamano74640642006-12-27 10:59:551003gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531004gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431005'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531006this time; defaults to 90 days. With "<pattern>" (e.g.
1007"refs/stash") in the middle the setting applies only to
1008the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551009
1010gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531011gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431012'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551013this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531014defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1015in the middle, the setting applies only to the refs that
1016match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551017
1018gc.rerereresolved::
1019Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431020kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461021The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551022
1023gc.rerereunresolved::
1024Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431025kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461026The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551027
Junio C Hamanoa3148f52009-01-14 08:49:571028gitcvs.commitmsgannotation::
1029Append this string to each commit message. Set to empty string
1030to disable this feature. Defaults to "via git-CVS emulator".
1031
Junio C Hamano07824ce2006-04-25 07:36:541032gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271033Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461034See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541035
1036gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271037Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461038various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541039
Junio C Hamano17bd2272008-09-01 06:11:171040gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551041If true, the server will look up the end-of-line conversion
1042attributes for files to determine the '-k' modes to use. If
1043the attributes force git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351044the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551045treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331046will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551047the client might otherwise do. If the attributes do not allow
1048the file type to be determined, then 'gitcvs.allbinary' is
1049used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141050
Junio C Hamanod9e0e5d2007-04-14 16:22:041051gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141052This is used if 'gitcvs.usecrlfattr' does not resolve
1053the correct '-kb' mode to use. If true, all
1054unresolved files are sent to the client in
1055mode '-kb'. This causes the client to treat them
1056as binary files, which suppresses any newline munging it
1057otherwise might do. Alternatively, if it is set to "guess",
1058then the contents of the file are examined to decide if
1059it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041060
1061gitcvs.dbname::
1062Database used by git-cvsserver to cache revision information
1063derived from the git repository. The exact meaning depends on the
1064used database driver, for SQLite (which is the default driver) this
1065is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461066linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041067Default: '%Ggitcvs.%m.sqlite'
1068
1069gitcvs.dbdriver::
1070Used Perl DBI driver. You can specify any available driver
1071 for this here, but it might not work. git-cvsserver is tested
1072with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1073reported *not* to work with 'DBD::mysql'. Experimental feature.
1074May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461075See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041076
Junio C Hamanoa2ad99e2007-04-18 09:57:041077gitcvs.dbuser, gitcvs.dbpass::
1078Database user and password. Only useful if setting 'gitcvs.dbdriver',
1079since SQLite has no concept of database users and/or passwords.
1080'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461081linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041082
Junio C Hamanoa74efce2008-04-02 08:39:081083gitcvs.dbTableNamePrefix::
1084Database table name prefix. Prepended to the names of any
1085database tables used, allowing a single database to be used
1086for several repositories. Supports variable substitution (see
1087linkgit:git-cvsserver[1] for details). Any non-alphabetic
1088characters will be replaced with underscores.
1089
Junio C Hamanodfccbb02008-05-26 01:16:141090All gitcvs variables except for 'gitcvs.usecrlfattr' and
1091'gitcvs.allbinary' can also be specified as
1092'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271093is one of "ext" and "pserver") to make them apply only for the given
1094access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041095
Junio C Hamano6d76d612008-05-09 05:46:081096gui.commitmsgwidth::
1097Defines how wide the commit message window is in the
1098linkgit:git-gui[1]. "75" is the default.
1099
1100gui.diffcontext::
1101Specifies how many context lines should be used in calls to diff
1102made by the linkgit:git-gui[1]. The default is "5".
1103
Junio C Hamanod3452a02008-11-15 08:07:551104gui.encoding::
1105Specifies the default encoding to use for displaying of
1106file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1107It can be overridden by setting the 'encoding' attribute
1108for relevant files (see linkgit:gitattributes[5]).
1109If this option is not set, the tools default to the
1110locale encoding.
1111
Junio C Hamano6d76d612008-05-09 05:46:081112gui.matchtrackingbranch::
1113Determines if new branches created with linkgit:git-gui[1] should
1114default to tracking remote branches with matching names or
1115not. Default: "false".
1116
1117gui.newbranchtemplate::
1118Is used as suggested name when creating new branches using the
1119linkgit:git-gui[1].
1120
1121gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071122"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081123performing a fetch. The default value is "false".
1124
1125gui.trustmtime::
1126Determines if linkgit:git-gui[1] should trust the file modification
1127timestamp or not. By default the timestamps are not trusted.
1128
1129gui.spellingdictionary::
1130Specifies the dictionary used for spell checking commit messages in
1131the linkgit:git-gui[1]. When set to "none" spell checking is turned
1132off.
1133
Junio C Hamanod3452a02008-11-15 08:07:551134gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431135If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551136location detection. It makes blame significantly faster on huge
1137repositories at the expense of less thorough copy detection.
1138
1139gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131140Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551141detection, measured in alphanumeric characters. See the
1142linkgit:git-blame[1] manual for more information on copy detection.
1143
1144gui.blamehistoryctx::
1145Specifies the radius of history context in days to show in
1146linkgit:gitk[1] for the selected commit, when the `Show History
1147Context` menu item is invoked from 'git gui blame'. If this
1148variable is set to zero, the whole history is shown.
1149
Junio C Hamano92d312a2008-12-15 07:22:201150guitool.<name>.cmd::
1151Specifies the shell command line to execute when the corresponding item
1152of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1153mandatory for every tool. The command is executed from the root of
1154the working directory, and in the environment it receives the name of
1155the tool as 'GIT_GUITOOL', the name of the currently selected file as
1156'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1157the head is detached, 'CUR_BRANCH' is empty).
1158
1159guitool.<name>.needsfile::
1160Run the tool only if a diff is selected in the GUI. It guarantees
1161that 'FILENAME' is not empty.
1162
1163guitool.<name>.noconsole::
1164Run the command silently, without creating a window to display its
1165output.
1166
1167guitool.<name>.norescan::
1168Don't rescan the working directory for changes after the tool
1169finishes execution.
1170
1171guitool.<name>.confirm::
1172Show a confirmation dialog before actually running the tool.
1173
1174guitool.<name>.argprompt::
1175Request a string argument from the user, and pass it to the tool
1176through the 'ARGS' environment variable. Since requesting an
1177argument implies confirmation, the 'confirm' option has no effect
1178if this is enabled. If the option is set to 'true', 'yes', or '1',
1179the dialog uses a built-in generic prompt; otherwise the exact
1180value of the variable is used.
1181
1182guitool.<name>.revprompt::
1183Request a single valid revision from the user, and set the
1184'REVISION' environment variable. In other aspects this option
1185is similar to 'argprompt', and can be used together with it.
1186
1187guitool.<name>.revunmerged::
1188Show only unmerged branches in the 'revprompt' subdialog.
1189This is useful for tools similar to merge or rebase, but not
1190for things like checkout or reset.
1191
1192guitool.<name>.title::
1193Specifies the title to use for the prompt dialog. The default
1194is the tool name.
1195
1196guitool.<name>.prompt::
1197Specifies the general prompt string to display at the top of
1198the dialog, before subsections for 'argprompt' and 'revprompt'.
1199The default value includes the actual command.
1200
Junio C Hamano4e272312008-01-08 09:13:211201help.browser::
1202Specify the browser that will be used to display help in the
1203'web' format. See linkgit:git-help[1].
1204
1205help.format::
1206Override the default help format used by linkgit:git-help[1].
1207Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1208the default. 'web' and 'html' are the same.
1209
Junio C Hamanof24b8062008-09-09 01:34:391210help.autocorrect::
1211Automatically correct and execute mistyped commands after
1212waiting for the given number of deciseconds (0.1 sec). If more
1213than one command can be deduced from the entered text, nothing
1214will be executed. If the value of this option is negative,
1215the corrected command will be executed immediately. If the
1216value is 0 - the command will be just shown but not executed.
1217This is the default.
1218
Junio C Hamano58256872007-12-04 08:31:131219http.proxy::
1220Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:461221environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:131222on a per-remote basis; see remote.<name>.proxy
1223
Junio C Hamano07824ce2006-04-25 07:36:541224http.sslVerify::
1225Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451226over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541227variable.
1228
1229http.sslCert::
1230File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451231over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541232variable.
1233
1234http.sslKey::
1235File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481236over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541237variable.
1238
Junio C Hamano48bc1ce2009-07-09 16:49:191239http.sslCertPasswordProtected::
1240Enable git's password prompt for the SSL certificate. Otherwise
1241OpenSSL will prompt the user, possibly many times, if the
1242certificate or private key is encrypted. Can be overridden by the
1243'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1244
Junio C Hamano07824ce2006-04-25 07:36:541245http.sslCAInfo::
1246File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481247fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541248'GIT_SSL_CAINFO' environment variable.
1249
1250http.sslCAPath::
1251Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451252with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541253by the 'GIT_SSL_CAPATH' environment variable.
1254
1255http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481256How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541257by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1258
Junio C Hamanob141a922010-01-10 19:55:141259http.minSessions::
1260The number of curl sessions (counted across slots) to be kept across
1261requests. They will not be ended with curl_easy_cleanup() until
1262http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1263value will be capped at 1. Defaults to 1.
1264
Junio C Hamano3b70d3c2009-11-21 17:37:371265http.postBuffer::
1266Maximum size in bytes of the buffer used by smart HTTP
1267transports when POSTing data to the remote system.
1268For requests larger than this buffer size, HTTP/1.1 and
1269Transfer-Encoding: chunked is used to avoid creating a
1270massive pack file locally. Default is 1 MiB, which is
1271sufficient for most requests.
1272
Junio C Hamano07824ce2006-04-25 07:36:541273http.lowSpeedLimit, http.lowSpeedTime::
1274If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1275for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481276Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541277'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1278
Junio C Hamanof1dcdfe2006-09-29 08:10:511279http.noEPSV::
1280A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041281This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511282support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1283environment variable. Default is false (curl will use EPSV).
1284
Junio C Hamano53ba6d02010-08-22 07:25:121285http.useragent::
1286The HTTP USER_AGENT string presented to an HTTP server. The default
1287value represents the version of the client git such as git/1.7.1.
1288This option allows you to override this value to a more common value
1289such as Mozilla/4.0. This may be necessary, for instance, if
1290connecting through a firewall that restricts HTTP connections to a set
1291of common USER_AGENT strings (but not including those like git/1.7.1).
1292Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1293
Junio C Hamano07824ce2006-04-25 07:36:541294i18n.commitEncoding::
1295Character encoding the commit messages are stored in; git itself
1296does not care per se, but this information is necessary e.g. when
1297importing commits from emails or in the gitk graphical history
1298browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461299porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541300
Junio C Hamano51f92e22006-12-29 05:18:281301i18n.logOutputEncoding::
1302Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431303running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281304
Junio C Hamano4653c6f2008-11-26 22:50:201305imap::
1306The configuration variables in the 'imap' section are described
1307in linkgit:git-imap-send[1].
1308
Junio C Hamanocaa712a2010-03-11 01:17:351309init.templatedir::
1310Specify the directory from which templates will be copied.
1311(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1312
Junio C Hamano4e272312008-01-08 09:13:211313instaweb.browser::
1314Specify the program that will be used to browse your working
1315repository in gitweb. See linkgit:git-instaweb[1].
1316
1317instaweb.httpd::
1318The HTTP daemon command-line to start gitweb on your working
1319repository. See linkgit:git-instaweb[1].
1320
1321instaweb.local::
1322If true the web server started by linkgit:git-instaweb[1] will
1323be bound to the local IP (127.0.0.1).
1324
1325instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351326The default module path for linkgit:git-instaweb[1] to use
1327instead of /usr/lib/apache2/modules. Only used if httpd
1328is Apache.
Junio C Hamano4e272312008-01-08 09:13:211329
1330instaweb.port::
1331The port number to bind the gitweb httpd to. See
1332linkgit:git-instaweb[1].
1333
Junio C Hamanoe5bf6c12009-02-07 21:43:101334interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001335In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101336input with a single key (i.e., without hitting enter).
1337Currently this is used only by the `\--patch` mode of
1338linkgit:git-add[1]. Note that this setting is silently
1339ignored if portable keystroke input is not available.
1340
Junio C Hamanob713ff12008-05-24 01:12:301341log.date::
Junio C Hamano2db3e752010-09-03 21:33:061342Set the default date-time mode for the 'log' command.
1343Setting a value for log.date is similar to using 'git log''s
1344`\--date` option. Possible values are `relative`, `local`,
1345`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1346for details.
Junio C Hamanob713ff12008-05-24 01:12:301347
Junio C Hamanocb39aea2010-05-09 07:24:481348log.decorate::
1349Print out the ref names of any commits that are shown by the log
1350command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1351'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1352specified, the full ref name (including prefix) will be printed.
1353This is the same as the log commands '--decorate' option.
1354
Junio C Hamanofe9acab2006-11-24 12:10:551355log.showroot::
1356If true, the initial commit will be shown as a big creation event.
1357This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461358Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551359normally hide the root commit will now show it. True by default.
1360
Junio C Hamano8bc410e2009-02-15 10:38:191361mailmap.file::
1362The location of an augmenting mailmap file. The default
1363mailmap, located in the root of the repository, is loaded
1364first, then the mailmap file pointed to by this variable.
1365The location of the mailmap file may be in a repository
1366subdirectory, or somewhere outside of the repository itself.
1367See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1368
Junio C Hamano8b588d52008-03-15 09:48:371369man.viewer::
1370Specify the programs that may be used to display help in the
1371'man' format. See linkgit:git-help[1].
1372
Junio C Hamano6d76d612008-05-09 05:46:081373man.<tool>.cmd::
1374Specify the command to invoke the specified man viewer. The
1375specified command is evaluated in shell with the man page
1376passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261377
Junio C Hamano6d76d612008-05-09 05:46:081378man.<tool>.path::
1379Override the path for the given tool that may be used to
1380display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131381
Junio C Hamano4653c6f2008-11-26 22:50:201382include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421383
Junio C Hamano1fbbbc12007-12-18 07:01:271384mergetool.<tool>.path::
1385Override the path for the given tool. This is useful in case
1386your tool is not in the PATH.
1387
Junio C Hamano86bcccc2008-03-08 09:33:551388mergetool.<tool>.cmd::
1389Specify the command to invoke the specified merge tool. The
1390specified command is evaluated in shell with the following
1391variables available: 'BASE' is the name of a temporary file
1392containing the common base of the files to be merged, if available;
1393'LOCAL' is the name of a temporary file containing the contents of
1394the file on the current branch; 'REMOTE' is the name of a temporary
1395file containing the contents of the file from the branch being
1396merged; 'MERGED' contains the name of the file to which the merge
1397tool should write the results of a successful merge.
1398
1399mergetool.<tool>.trustExitCode::
1400For a custom merge command, specify whether the exit code of
1401the merge command can be used to determine whether the merge was
1402successful. If this is not set to true then the merge target file
1403timestamp is checked and the merge assumed to have been successful
1404if the file has been updated, otherwise the user is prompted to
1405indicate the success of the merge.
1406
1407mergetool.keepBackup::
1408After performing a merge, the original file with conflict markers
1409can be saved as a file with a `.orig` extension. If this variable
1410is set to `false` then this file is not preserved. Defaults to
1411`true` (i.e. keep the backup files).
1412
Junio C Hamano10b7a342009-01-01 22:05:171413mergetool.keepTemporaries::
1414When invoking a custom merge tool, git uses a set of temporary
1415files to pass to the tool. If the tool returns an error and this
1416variable is set to `true`, then these temporary files will be
1417preserved, otherwise they will be removed after the tool has
1418exited. Defaults to `false`.
1419
1420mergetool.prompt::
1421Prompt before each invocation of the merge resolution program.
1422
Junio C Hamano31667362010-03-25 00:38:531423notes.displayRef::
1424The (fully qualified) refname from which to show notes when
1425showing commit messages. The value of this variable can be set
1426to a glob, in which case notes from all matching refs will be
1427shown. You may also specify this configuration variable
1428several times. A warning will be issued for refs that do not
1429exist, but a glob that does not match any refs is silently
1430ignored.
1431+
1432This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1433environment variable, which must be a colon separated list of refs or
1434globs.
1435+
1436The effective value of "core.notesRef" (possibly overridden by
1437GIT_NOTES_REF) is also implicitly added to the list of refs to be
1438displayed.
1439
1440notes.rewrite.<command>::
1441When rewriting commits with <command> (currently `amend` or
1442`rebase`) and this variable is set to `true`, git
1443automatically copies your notes from the original to the
1444rewritten commit. Defaults to `true`, but see
1445"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531446
1447notes.rewriteMode::
1448When copying notes during a rewrite (see the
1449"notes.rewrite.<command>" option), determines what to do if
1450the target commit already has a note. Must be one of
1451`overwrite`, `concatenate`, or `ignore`. Defaults to
1452`concatenate`.
1453+
1454This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1455environment variable.
1456
1457notes.rewriteRef::
1458When copying notes during a rewrite, specifies the (fully
1459qualified) ref whose notes should be copied. The ref may be a
1460glob, in which case notes in all matching refs will be copied.
1461You may also specify this configuration several times.
1462+
1463Does not have a default value; you must configure this variable to
1464enable note rewriting.
Junio C Hamano2b3ee5d2010-05-08 05:41:181465+
1466This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1467environment variable, which must be a colon separated list of refs or
1468globs.
Junio C Hamano31667362010-03-25 00:38:531469
Junio C Hamano75cc4c92006-07-24 08:25:031470pack.window::
Junio C Hamano35738e82008-01-07 07:55:461471The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031472window size is given on the command line. Defaults to 10.
1473
Junio C Hamano91d44c52007-05-09 07:16:071474pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461475The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071476maximum depth is given on the command line. Defaults to 50.
1477
Junio C Hamano235d53f2007-07-13 00:25:151478pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461479The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151480when no limit is given on the command line. The value can be
1481suffixed with "k", "m", or "g". Defaults to 0, meaning no
1482limit.
1483
Junio C Hamanof2ce2972007-05-20 19:12:091484pack.compression::
1485An integer -1..9, indicating the compression level for objects
1486in a pack file. -1 is the zlib default. 0 means no
1487compression, and 1..9 are various speed/size tradeoffs, 9 being
1488slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421489not set, defaults to -1, the zlib default, which is "a default
1490compromise between speed and compression (currently equivalent
1491to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241492+
1493Note that changing the compression level will not automatically recompress
1494all existing objects. You can force recompression by passing the -F option
1495to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091496
Junio C Hamano679d22d2007-06-02 21:13:441497pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271498The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521499linkgit:git-pack-objects[1] before writing them out to a pack.
1500This cache is used to speed up the writing object phase by not
1501having to recompute the final delta result once the best match
1502for all objects is found. Repacking large repositories on machines
1503which are tight with memory might be badly impacted by this though,
1504especially if this cache pushes the system into swapping.
1505A value of 0 means no limit. The smallest size of 1 byte may be
1506used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441507
1508pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141509The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521510linkgit:git-pack-objects[1]. This cache is used to speed up the
1511writing object phase by not having to recompute the final delta
1512result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441513
Junio C Hamano58155b42007-09-15 07:46:141514pack.threads::
1515Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461516delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141517be compiled with pthreads otherwise this option is ignored with a
1518warning. This is meant to reduce packing time on multiprocessor
1519machines. The required amount of memory for the delta search window
1520is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441521Specifying 0 will cause git to auto-detect the number of CPU's
1522and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141523
Junio C Hamanod814b6d2007-11-04 11:13:491524pack.indexVersion::
1525Specify the default pack index version. Valid values are 1 for
1526legacy pack index used by Git versions prior to 1.5.2, and 2 for
1527the new pack index with capabilities for packs larger than 4 GB
1528as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381529packs. Version 2 is the default. Note that version 2 is enforced
1530and this config option ignored whenever the corresponding pack is
1531larger than 2 GB.
1532+
1533If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1534cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1535that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1536other side may give you a repository that cannot be accessed with your
1537older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1538you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1539the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491540
Junio C Hamano09a926d2008-03-13 07:55:291541pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291542The maximum size of a pack. This setting only affects
1543packing to a file when repacking, i.e. the git:// protocol
1544is unaffected. It can be overridden by the `\--max-pack-size`
1545option of linkgit:git-repack[1]. The minimum size allowed is
1546limited to 1 MiB. The default is unlimited.
1547Common unit suffixes of 'k', 'm', or 'g' are
1548supported.
Junio C Hamano49dccaf2008-02-10 10:48:011549
Junio C Hamano9e96a1a2008-08-16 10:23:181550pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431551If the value is boolean, turns on or off pagination of the
1552output of a particular git subcommand when writing to a tty.
1553Otherwise, turns on pagination for the subcommand using the
1554pager specified by the value of `pager.<cmd>`. If `\--paginate`
1555or `\--no-pager` is specified on the command line, it takes
1556precedence over this option. To disable pagination for all
1557commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181558
Junio C Hamanoa574a092010-06-13 19:57:101559pretty.<name>::
1560Alias for a --pretty= format string, as specified in
1561linkgit:git-log[1]. Any aliases defined here can be used just
1562as the built-in pretty formats could. For example,
1563running `git config pretty.changelog "format:{asterisk} %H %s"`
1564would cause the invocation `git log --pretty=changelog`
1565to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1566Note that an alias with the same name as a built-in format
1567will be silently ignored.
1568
Junio C Hamano07824ce2006-04-25 07:36:541569pull.octopus::
1570The default merge strategy to use when pulling multiple branches
1571at once.
1572
1573pull.twohead::
1574The default merge strategy to use when pulling a single branch.
1575
Junio C Hamano1de75722009-03-26 08:39:381576push.default::
1577Defines the action git push should take if no refspec is given
1578on the command line, no refspec is configured in the remote, and
1579no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191580line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381581+
Junio C Hamano7f9fa862010-10-19 23:51:141582* `nothing` - do not push anything.
1583* `matching` - push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381584 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191585 matching. This is the default.
Junio C Hamano7f9fa862010-10-19 23:51:141586* `tracking` - push the current branch to its upstream branch.
1587* `current` - push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381588
Junio C Hamanoea6a7642009-03-11 23:56:191589rebase.stat::
1590Whether to show a diffstat of what changed upstream since the last
1591rebase. False by default.
1592
Junio C Hamano075ae872010-09-01 18:43:071593rebase.autosquash::
1594If set to true enable '--autosquash' option by default.
1595
Junio C Hamano621e1232009-10-26 05:16:471596receive.autogc::
1597By default, git-receive-pack will run "git-gc --auto" after
1598receiving data from git-push and updating refs. You can stop
1599it by setting this variable to false.
1600
Junio C Hamano4653c6f2008-11-26 22:50:201601receive.fsckObjects::
1602If it is set to true, git-receive-pack will check all received
1603objects. It will abort in the case of a malformed object or a
1604broken link. The result of an abort are only dangling objects.
1605Defaults to false.
1606
1607receive.unpackLimit::
1608If the number of objects received in a push is below this
1609limit then the objects will be unpacked into loose object
1610files. However if the number of received objects equals or
1611exceeds this limit then the received pack will be stored as
1612a pack, after adding any missing delta bases. Storing the
1613pack from a push can make the push operation complete faster,
1614especially on slow filesystems. If not set, the value of
1615`transfer.unpackLimit` is used instead.
1616
1617receive.denyDeletes::
1618If set to true, git-receive-pack will deny a ref update that deletes
1619the ref. Use this to prevent such a ref deletion via a push.
1620
Junio C Hamanob4448a82010-07-26 09:02:321621receive.denyDeleteCurrent::
1622If set to true, git-receive-pack will deny a ref update that
1623deletes the currently checked out branch of a non-bare repository.
1624
Junio C Hamano4653c6f2008-11-26 22:50:201625receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:581626If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:201627to the currently checked out branch of a non-bare repository.
1628Such a push is potentially dangerous because it brings the HEAD
1629out of sync with the index and working tree. If set to "warn",
1630print a warning of such a push to stderr, but allow the push to
1631proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:151632message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:201633
1634receive.denyNonFastForwards::
1635If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541636not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201637even if that push is forced. This configuration variable is
1638set when initializing a shared repository.
1639
Junio C Hamano621e1232009-10-26 05:16:471640receive.updateserverinfo::
1641If set to true, git-receive-pack will run git-update-server-info
1642after receiving data from git-push and updating refs.
1643
Junio C Hamano249572f2006-10-24 05:44:081644remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461645The URL of a remote repository. See linkgit:git-fetch[1] or
1646linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081647
Junio C Hamano0e88f3e2009-06-21 08:03:251648remote.<name>.pushurl::
1649The push URL of a remote repository. See linkgit:git-push[1].
1650
Junio C Hamano58256872007-12-04 08:31:131651remote.<name>.proxy::
1652For remotes that require curl (http, https and ftp), the URL to
1653the proxy to use for that remote. Set to the empty string to
1654disable proxying for that remote.
1655
Junio C Hamano249572f2006-10-24 05:44:081656remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461657The default set of "refspec" for linkgit:git-fetch[1]. See
1658linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081659
1660remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461661The default set of "refspec" for linkgit:git-push[1]. See
1662linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081663
Junio C Hamano47d68a52008-05-06 06:35:401664remote.<name>.mirror::
1665If true, pushing to this remote will automatically behave
1666as if the `\--mirror` option was given on the command line.
1667
Junio C Hamano118d2772007-02-21 20:24:101668remote.<name>.skipDefaultUpdate::
1669If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271670using linkgit:git-fetch[1] or the `update` subcommand of
1671linkgit:git-remote[1].
1672
1673remote.<name>.skipFetchAll::
1674If true, this remote will be skipped by default when updating
1675using linkgit:git-fetch[1] or the `update` subcommand of
1676linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101677
Junio C Hamano4ad294b2007-01-20 02:22:501678remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481679The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551680option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501681
Junio C Hamano54ea8d32007-01-25 07:59:481682remote.<name>.uploadpack::
1683The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551684option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481685
Junio C Hamano17dde0e2007-02-26 09:50:211686remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551687Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:531688fetching from remote <name>. Setting it to \--tags will fetch every
1689tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:071690branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1691override this setting. See options \--tags and \--no-tags of
1692linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:211693
Junio C Hamano096dde22009-12-26 23:14:111694remote.<name>.vcs::
1695Setting this to a value <vcs> will cause git to interact with
1696the remote with the git-remote-<vcs> helper.
1697
Junio C Hamano118d2772007-02-21 20:24:101698remotes.<group>::
1699The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461700<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101701
Junio C Hamano77b7e902006-10-23 07:18:501702repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381703By default, linkgit:git-repack[1] creates packs that use
1704delta-base offset. If you need to share your repository with
1705git older than version 1.4.4, either directly or via a dumb
1706protocol such as http, then you need to set this option to
1707"false" and repack. Access from old git versions over the
1708native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501709
Junio C Hamano4653c6f2008-11-26 22:50:201710rerere.autoupdate::
1711When set to true, `git-rerere` updates the index with the
1712resulting contents after it cleanly resolves conflicts using
1713previously recorded resolution. Defaults to false.
1714
1715rerere.enabled::
1716Activate recording of resolved conflicts, so that identical
1717conflict hunks can be resolved automatically, should they
1718be encountered again. linkgit:git-rerere[1] command is by
1719default enabled if you create `rr-cache` directory under
1720`$GIT_DIR`, but can be disabled by setting this option to false.
1721
Junio C Hamano1bbd0f42009-07-23 06:20:291722sendemail.identity::
1723A configuration identity. When given, causes values in the
1724'sendemail.<identity>' subsection to take precedence over
1725values in the 'sendemail' section. The default identity is
1726the value of 'sendemail.identity'.
1727
1728sendemail.smtpencryption::
1729See linkgit:git-send-email[1] for description. Note that this
1730setting is not subject to the 'identity' mechanism.
1731
1732sendemail.smtpssl::
1733Deprecated alias for 'sendemail.smtpencryption = ssl'.
1734
1735sendemail.<identity>.*::
1736Identity-specific versions of the 'sendemail.*' parameters
1737found below, taking precedence over those when the this
1738identity is selected, through command-line or
1739'sendemail.identity'.
1740
1741sendemail.aliasesfile::
1742sendemail.aliasfiletype::
1743sendemail.bcc::
1744sendemail.cc::
1745sendemail.cccmd::
1746sendemail.chainreplyto::
1747sendemail.confirm::
1748sendemail.envelopesender::
1749sendemail.from::
1750sendemail.multiedit::
1751sendemail.signedoffbycc::
1752sendemail.smtppass::
1753sendemail.suppresscc::
1754sendemail.suppressfrom::
1755sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:481756sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:291757sendemail.smtpserver::
1758sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:541759sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:291760sendemail.smtpuser::
1761sendemail.thread::
1762sendemail.validate::
1763See linkgit:git-send-email[1] for description.
1764
1765sendemail.signedoffcc::
1766Deprecated alias for 'sendemail.signedoffbycc'.
1767
Junio C Hamano07824ce2006-04-25 07:36:541768showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461769The default set of branches for linkgit:git-show-branch[1].
1770See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541771
Junio C Hamano942b35e2007-12-09 10:19:331772status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461773By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331774current directory. Setting this variable to `false` shows paths
1775relative to the repository root (this was the default for git
1776prior to v1.5.4).
1777
Junio C Hamano4224f992008-06-23 07:14:081778status.showUntrackedFiles::
1779By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1780files which are not currently tracked by Git. Directories which
1781contain only untracked files, are shown with the directory name
1782only. Showing untracked files means that Git needs to lstat() all
1783all the files in the whole repository, which might be slow on some
1784systems. So, this variable controls how the commands displays
1785the untracked files. Possible values are:
1786+
1787--
Junio C Hamano7f9fa862010-10-19 23:51:141788* `no` - Show no untracked files.
1789* `normal` - Show untracked files and directories.
1790* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:081791--
1792+
1793If this variable is not specified, it defaults to 'normal'.
1794This variable can be overridden with the -u|--untracked-files option
1795of linkgit:git-status[1] and linkgit:git-commit[1].
1796
Junio C Hamanob671fb52010-06-01 05:06:141797status.submodulesummary::
1798Defaults to false.
1799If this is set to a non zero number or true (identical to -1 or an
1800unlimited number), the submodule summary will be enabled and a
1801summary of commits for modified submodules will be shown (see
1802--summary-limit option of linkgit:git-submodule[1]).
1803
Junio C Hamano78e3a782010-07-15 22:24:451804submodule.<name>.path::
1805submodule.<name>.url::
1806submodule.<name>.update::
1807The path within this project, URL, and the updating strategy
1808for a submodule. These variables are initially populated
1809by 'git submodule init'; edit them to override the
1810URL and other values found in the `.gitmodules` file. See
1811linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1812
Junio C Hamano619596a2010-08-18 22:15:351813submodule.<name>.ignore::
1814Defines under what circumstances "git status" and the diff family show
1815a submodule as modified. When set to "all", it will never be considered
1816modified, "dirty" will ignore all changes to the submodules work tree and
1817takes only differences between the HEAD of the submodule and the commit
1818recorded in the superproject into account. "untracked" will additionally
1819let submodules with modified tracked files in their work tree show up.
1820Using "none" (the default when this option is not set) also shows
1821submodules that have untracked files in their work tree as changed.
1822This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:181823both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:351824"--ignore-submodules" option.
1825
Junio C Hamano75cc4c92006-07-24 08:25:031826tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091827This variable can be used to restrict the permission bits of
1828tar archive entries. The default is 0002, which turns off the
1829world write bit. The special value "user" indicates that the
1830archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461831linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031832
Junio C Hamano4653c6f2008-11-26 22:50:201833transfer.unpackLimit::
1834When `fetch.unpackLimit` or `receive.unpackLimit` are
1835not set, the value of this variable is used instead.
1836The default value is 100.
1837
Junio C Hamano24bc09a2008-02-28 00:27:441838url.<base>.insteadOf::
1839Any URL that starts with this value will be rewritten to
1840start, instead, with <base>. In cases where some site serves a
1841large number of repositories, and serves them with multiple
1842access methods, and some users need to use different access
1843methods, this feature allows people to specify any of the
1844equivalent URLs and have git automatically rewrite the URL to
1845the best alternative for the particular user, even for a
1846never-before-seen repository on the site. When more than one
1847insteadOf strings match a given URL, the longest match is used.
1848
Junio C Hamano7df6dcf2009-09-13 09:51:171849url.<base>.pushInsteadOf::
1850Any URL that starts with this value will not be pushed to;
1851instead, it will be rewritten to start with <base>, and the
1852resulting URL will be pushed to. In cases where some site serves
1853a large number of repositories, and serves them with multiple
1854access methods, some of which do not allow push, this feature
1855allows people to specify a pull-only URL and have git
1856automatically use an appropriate URL to push, even for a
1857never-before-seen repository on the site. When more than one
1858pushInsteadOf strings match a given URL, the longest match is
1859used. If a remote has an explicit pushurl, git will ignore this
1860setting for that remote.
1861
Junio C Hamano07824ce2006-04-25 07:36:541862user.email::
1863Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341864Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461865'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541866
1867user.name::
1868Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481869Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461870environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541871
Junio C Hamanoa890c4f2007-01-28 10:29:211872user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461873If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211874automatically when creating a signed tag, you can override the
1875default selection with this variable. This option is passed
1876unchanged to gpg's --local-user parameter, so you may specify a key
1877using any method that gpg supports.
1878
Junio C Hamano4e272312008-01-08 09:13:211879web.browser::
1880Specify a web browser that may be used by some commands.
1881Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1882may use it.