blob: 50840aab5e9b8c525271d171f719ff6bda3580b0 [file] [log] [blame]
Petr Baudis1ab661d2006-04-25 00:59:33 +02001CONFIGURATION FILE
2------------------
3
Thomas Ackermann2de9b712013-01-21 20:17:53 +01004The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
Stephen Boyd66e35fc2009-04-23 02:38:02 -07006is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
Stephen Boyd773002a2009-04-23 02:38:00 -07008fallback values for the `.git/config` file. The file `/etc/gitconfig`
Stephen Boyd66e35fc2009-04-23 02:38:02 -07009can be used to store a system-wide default configuration.
Junio C Hamano5ea56212007-01-16 22:45:35 -080010
Thomas Ackermann2de9b712013-01-21 20:17:53 +010011The configuration variables are used by both the Git plumbing
Stephen Boydb7ee2262009-04-23 02:38:01 -070012and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Petr Baudis1ab661d2006-04-25 00:59:33 +020014dot-separated segment and the section name is everything before the last
Libor Pechaceke0a4aae2012-03-01 11:59:45 +010015dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
Petr Baudis1ab661d2006-04-25 00:59:33 +020018
Jakub Narebskie136f332007-01-22 16:25:47 +010019Syntax
20~~~~~~
21
Petr Baudis1ab661d2006-04-25 00:59:33 +020022The syntax is fairly flexible and permissive; whitespaces are mostly
Jakub Narebskie136f332007-01-22 16:25:47 +010023ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
Chris Johnsendcb11262009-03-15 06:30:52 -050029characters, `-` and `.` are allowed in section names. Each variable
Stephen Boyd773002a2009-04-23 02:38:00 -070030must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Jakub Narebskie136f332007-01-22 16:25:47 +010032
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Stephen Boyd773002a2009-04-23 02:38:00 -070035in the section header, like in the example below:
Jakub Narebskie136f332007-01-22 16:25:47 +010036
37--------
38 [section "subsection"]
39
40--------
41
Stephen Boydb7ee2262009-04-23 02:38:01 -070042Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
Jakub Narebskie136f332007-01-22 16:25:47 +010045lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
Carlos Martín Nietof7376322011-10-12 17:52:06 +020049There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
Jakub Narebskie136f332007-01-22 16:25:47 +010053
Nanako Shiraishi2ceb6392009-07-25 09:28:50 +090054All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Jakub Narebskie136f332007-01-22 16:25:47 +010056'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
Libor Pechaceke0a4aae2012-03-01 11:59:45 +010058The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
Jakub Narebskie136f332007-01-22 16:25:47 +010062
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
Carlos Martín Nieto18b19e42011-03-30 12:22:32 +0200681/0, true/false or on/off. Case is not significant in boolean values, when
Jakub Narebskie136f332007-01-22 16:25:47 +010069converting value to the canonical form using '--bool' type specifier;
Thomas Rast0b444cd2010-01-10 00:33:00 +010070'git config' will ensure that the output is "true" or "false".
Jakub Narebskie136f332007-01-22 16:25:47 +010071
72String values may be entirely or partially enclosed in double quotes.
Stephen Boyd773002a2009-04-23 02:38:00 -070073You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
Chris Johnsendcb11262009-03-15 06:30:52 -050077be escaped: use `\"` for `"` and `\\` for `\`.
Jakub Narebskie136f332007-01-22 16:25:47 +010078
Chris Johnsendcb11262009-03-15 06:30:52 -050079The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81and `\b` for backspace (BS). No other char escape sequence, nor octal
Jakub Narebskie136f332007-01-22 16:25:47 +010082char sequences are valid.
83
Stephen Boyd773002a2009-04-23 02:38:00 -070084Variable values ending in a `\` are continued on the next line in the
Jakub Narebskie136f332007-01-22 16:25:47 +010085customary UNIX fashion.
86
Stephen Boyd773002a2009-04-23 02:38:00 -070087Some variables may require a special value format.
Petr Baudis1ab661d2006-04-25 00:59:33 +020088
Jeff King9b25a0b2012-02-06 04:54:04 -050089Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
Jeff King9a7b0bc2012-05-02 19:43:52 -040098found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Jeff King4c0a89f2012-04-25 08:00:36 -0400100user's home directory. See below for examples.
Jeff King9b25a0b2012-02-06 04:54:04 -0500101
Petr Baudis1ab661d2006-04-25 00:59:33 +0200102Example
103~~~~~~~
104
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
109
110 # Our diff algorithm
111 [diff]
Anders Melchiorsen6bb9e512008-07-27 13:12:15 +0200112 external = /usr/local/bin/diff-wrapper
Petr Baudis1ab661d2006-04-25 00:59:33 +0200113 renames = true
114
Aneesh Kumar K.V910c00c2006-12-07 12:06:55 +0530115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
118
Jakub Narebskie136f332007-01-22 16:25:47 +0100119 # Proxy settings
120 [core]
David Symonds29093c22007-08-03 08:45:56 +1000121 gitProxy="ssh" for "kernel.org"
Jakub Narebskie136f332007-01-22 16:25:47 +0100122 gitProxy=default-proxy ; for the rest
Aneesh Kumar K.V910c00c2006-12-07 12:06:55 +0530123
Jeff King9b25a0b2012-02-06 04:54:04 -0500124 [include]
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
Jeff King4c0a89f2012-04-25 08:00:36 -0400127 path = ~/foo ; expand "foo" in your $HOME directory
Jeff King9b25a0b2012-02-06 04:54:04 -0500128
Petr Baudis1ab661d2006-04-25 00:59:33 +0200129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100133For command-specific variables, you will find a more detailed description
134in the appropriate manual page. You will find a description of non-core
Petr Baudis1ab661d2006-04-25 00:59:33 +0200135porcelain configuration variables in the respective porcelain documentation.
136
Jeff King75194432009-09-09 07:38:58 -0400137advice.*::
Junio C Hamano26e94af2011-12-18 21:35:01 -0800138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
Jeff King75194432009-09-09 07:38:58 -0400141+
142--
Chris Rorvick11845642012-12-02 21:27:50 -0600143 pushUpdateRejected::
Christopher Tiwaldf25950f2012-03-20 00:31:33 -0400144 Set this variable to 'false' if you want to disable
Chris Rorvickb4505682012-12-02 21:27:51 -0600145 'pushNonFFCurrent', 'pushNonFFDefault',
Junio C Hamano75e5c0d2013-01-23 13:55:30 -0800146 'pushNonFFMatching', 'pushAlreadyExists',
147 'pushFetchFirst', and 'pushNeedsForce'
Chris Rorvickb4505682012-12-02 21:27:51 -0600148 simultaneously.
Christopher Tiwaldf25950f2012-03-20 00:31:33 -0400149 pushNonFFCurrent::
150 Advice shown when linkgit:git-push[1] fails due to a
151 non-fast-forward update to the current branch.
152 pushNonFFDefault::
153 Advice to set 'push.default' to 'upstream' or 'current'
154 when you ran linkgit:git-push[1] and pushed 'matching
155 refs' by default (i.e. you did not provide an explicit
156 refspec, and no 'push.default' configuration was set)
157 and it resulted in a non-fast-forward error.
158 pushNonFFMatching::
159 Advice shown when you ran linkgit:git-push[1] and pushed
160 'matching refs' explicitly (i.e. you used ':', or
161 specified a refspec that isn't your current branch) and
162 it resulted in a non-fast-forward error.
Chris Rorvickb4505682012-12-02 21:27:51 -0600163 pushAlreadyExists::
164 Shown when linkgit:git-push[1] rejects an update that
165 does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano75e5c0d2013-01-23 13:55:30 -0800166 pushFetchFirst::
167 Shown when linkgit:git-push[1] rejects an update that
168 tries to overwrite a remote ref that points at an
169 object we do not have.
170 pushNeedsForce::
171 Shown when linkgit:git-push[1] rejects an update that
172 tries to overwrite a remote ref that points at an
173 object that is not a committish, or make the remote
174 ref point at an object that is not a committish.
Jeff Kingedf563f2009-09-09 07:43:03 -0400175 statusHints::
Lucien Kong83c750a2012-06-05 22:21:24 +0200176 Show directions on how to proceed from the current
Matthieu Moy552755a2012-12-04 10:15:03 +0100177 state in the output of linkgit:git-status[1], in
Lucien Kong83c750a2012-06-05 22:21:24 +0200178 the template shown when writing commit messages in
Matthieu Moy552755a2012-12-04 10:15:03 +0100179 linkgit:git-commit[1], and in the help message shown
180 by linkgit:git-checkout[1] when switching branch.
Nguyễn Thái Ngọc Duy6a38ef22013-03-13 19:59:16 +0700181 statusUoption::
182 Advise to consider using the `-u` option to linkgit:git-status[1]
183 when the command takes more than 2 seconds to enumerate untracked
184 files.
Matthieu Moy4c371f92009-11-22 23:26:17 +0100185 commitBeforeMerge::
186 Advice shown when linkgit:git-merge[1] refuses to
Ville Skyttä6b677a22010-07-20 00:17:17 +0300187 merge to avoid overwriting local changes.
Matthieu Moyd38a30d2010-01-12 10:54:44 +0100188 resolveConflict::
Greg Price4f021b32013-02-25 00:27:20 -0500189 Advice shown by various commands when conflicts
Matthieu Moyd38a30d2010-01-12 10:54:44 +0100190 prevent the operation from being performed.
Jeff Kingb706fcf2010-01-13 15:17:08 -0500191 implicitIdentity::
192 Advice on how to set your identity configuration when
193 your information is guessed from the system username and
Junio C Hamano26e94af2011-12-18 21:35:01 -0800194 domain name.
Junio C Hamano13be3e32010-01-29 22:03:24 -0800195 detachedHead::
Junio C Hamano26e94af2011-12-18 21:35:01 -0800196 Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano13be3e32010-01-29 22:03:24 -0800197 move to the detach HEAD state, to instruct how to create
Junio C Hamano26e94af2011-12-18 21:35:01 -0800198 a local branch after the fact.
Paul Gortmaker14bf2d52012-07-13 11:51:30 -0400199 amWorkDir::
200 Advice that shows the location of the patch file when
201 linkgit:git-am[1] fails to apply it.
Jeff King75194432009-09-09 07:38:58 -0400202--
203
Petr Baudis1ab661d2006-04-25 00:59:33 +0200204core.fileMode::
205 If false, the executable bit differences between the index and
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200206 the working tree are ignored; useful on broken filesystems like FAT.
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700207 See linkgit:git-update-index[1].
208+
209The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
210will probe and set core.fileMode false if appropriate when the
211repository is created.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200212
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400213core.ignoreCygwinFSTricks::
214 This option is only used by Cygwin implementation of Git. If false,
215 the Cygwin stat() and lstat() functions are used. This may be useful
216 if your repository consists of a few separate directories joined in
217 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
218 whenever it is possible and falls back to Cygwin functions only to
219 handle symbol links. The native mode is more than twice faster than
Mark Levedahl7faee6b2008-10-13 00:33:31 -0400220 normal Cygwin l/stat() functions. True by default, unless core.filemode
221 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
222 POSIX emulation is required to support core.filemode.
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400223
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700224core.ignorecase::
225 If true, this option enables various workarounds to enable
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100226 Git to work better on filesystems that are not case sensitive,
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700227 like FAT. For example, if a directory listing finds
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100228 "makefile" when Git expects "Makefile", Git will assume
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700229 it is really the same file, and continue to remember it as
230 "Makefile".
231+
232The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
233will probe and set core.ignorecase true if appropriate when the repository
234is created.
235
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200236core.precomposeunicode::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100237 This option is only used by Mac OS implementation of Git.
238 When core.precomposeunicode=true, Git reverts the unicode decomposition
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200239 of filenames done by Mac OS. This is useful when sharing a repository
240 between Mac OS and Linux or Windows.
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100241 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
242 When false, file names are handled fully transparent by Git,
243 which is backward compatible with older versions of Git.
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200244
Alex Riesen1ce47902008-07-28 08:31:28 +0200245core.trustctime::
246 If false, the ctime differences between the index and the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200247 working tree are ignored; useful when the inode change time
Alex Riesen1ce47902008-07-28 08:31:28 +0200248 is regularly modified by something outside Git (file system
249 crawlers and some backup systems).
250 See linkgit:git-update-index[1]. True by default.
251
Robin Rosenbergc08e4d52013-01-22 08:49:22 +0100252core.checkstat::
253 Determines which stat fields to match between the index
254 and work tree. The user can set this to 'default' or
255 'minimal'. Default (or explicitly 'default'), is to check
256 all fields, including the sub-second part of mtime and ctime.
257
Junio C Hamano9378c162007-06-24 15:11:24 -0700258core.quotepath::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500259 The commands that output paths (e.g. 'ls-files',
260 'diff'), when not given the `-z` option, will quote
Junio C Hamano9378c162007-06-24 15:11:24 -0700261 "unusual" characters in the pathname by enclosing the
262 pathname in a double-quote pair and with backslashes the
263 same way strings in C source code are quoted. If this
264 variable is set to false, the bytes higher than 0x80 are
265 not quoted but output as verbatim. Note that double
266 quote, backslash and control characters are always
267 quoted without `-z` regardless of the setting of this
268 variable.
269
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200270core.eol::
271 Sets the line ending type to use in the working directory for
272 files that have the `text` property set. Alternatives are
273 'lf', 'crlf' and 'native', which uses the platform's native
274 line ending. The default value is `native`. See
275 linkgit:gitattributes[5] for more information on end-of-line
276 conversion.
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200277
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100278core.safecrlf::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100279 If true, makes Git check if converting `CRLF` is reversible when
Eyvind Bernhardsenfd6cce92010-05-19 22:43:10 +0200280 end-of-line conversion is active. Git will verify if a command
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100281 modifies a file in the work tree either directly or indirectly.
282 For example, committing a file followed by checking out the
283 same file should yield the original file in the work tree. If
284 this is not the case for the current setting of
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100285 `core.autocrlf`, Git will reject the file. The variable can
286 be set to "warn", in which case Git will only warn about an
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100287 irreversible conversion but continue the operation.
288+
289CRLF conversion bears a slight chance of corrupting data.
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100290When it is enabled, Git will convert CRLF to LF during commit and LF to
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100291CRLF during checkout. A file that contains a mixture of LF and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100292CRLF before the commit cannot be recreated by Git. For text
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100293files this is the right thing to do: it corrects line endings
294such that we have only LF line endings in the repository.
295But for binary files that are accidentally classified as text the
296conversion can corrupt data.
297+
298If you recognize such corruption early you can easily fix it by
299setting the conversion type explicitly in .gitattributes. Right
300after committing you still have the original file in your work
301tree and this file is not yet corrupted. You can explicitly tell
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100302Git that this file is binary and Git will handle the file
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100303appropriately.
304+
305Unfortunately, the desired effect of cleaning up text files with
306mixed line endings and the undesired effect of corrupting binary
307files cannot be distinguished. In both cases CRLFs are removed
308in an irreversible way. For text files this is the right thing
309to do because CRLFs are line endings, while for binary files
310converting CRLFs corrupts data.
311+
312Note, this safety check does not mean that a checkout will generate a
313file identical to the original file for a different setting of
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200314`core.eol` and `core.autocrlf`, but only for the current one. For
315example, a text file with `LF` would be accepted with `core.eol=lf`
316and could later be checked out with `core.eol=crlf`, in which case the
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100317resulting file would contain `CRLF`, although the original file
318contained `LF`. However, in both work trees the line endings would be
319consistent, that is either all `LF` or all `CRLF`, but never mixed. A
320file with mixed line endings would be reported by the `core.safecrlf`
321mechanism.
322
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200323core.autocrlf::
324 Setting this variable to "true" is almost the same as setting
325 the `text` attribute to "auto" on all files except that text
326 files are not guaranteed to be normalized: files that contain
327 `CRLF` in the repository will not be touched. Use this
328 setting if you want to have `CRLF` line endings in your
329 working directory even though the repository does not have
330 normalized line endings. This variable can be set to 'input',
331 in which case no output conversion is performed.
332
Johannes Sixt78a8d642007-03-02 22:11:30 +0100333core.symlinks::
334 If false, symbolic links are checked out as small plain files that
Dan McGee5162e692007-12-29 00:20:38 -0600335 contain the link text. linkgit:git-update-index[1] and
336 linkgit:git-add[1] will not change the recorded type to regular
Johannes Sixt78a8d642007-03-02 22:11:30 +0100337 file. Useful on filesystems like FAT that do not support
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700338 symbolic links.
339+
340The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
341will probe and set core.symlinks false if appropriate when the repository
342is created.
Johannes Sixt78a8d642007-03-02 22:11:30 +0100343
Petr Baudis1ab661d2006-04-25 00:59:33 +0200344core.gitProxy::
345 A "proxy command" to execute (as 'command host port') instead
346 of establishing direct connection to the remote server when
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100347 using the Git protocol for fetching. If the variable value is
Petr Baudis1ab661d2006-04-25 00:59:33 +0200348 in the "COMMAND for DOMAIN" format, the command is applied only
349 on hostnames ending with the specified domain string. This variable
350 may be set multiple times and is matched in the given order;
351 the first match wins.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100352+
353Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
354(which always applies universally, without the special "for"
355handling).
Emil Sit642d0842009-03-17 13:31:42 -0400356+
357The special string `none` can be used as the proxy command to
358specify that no proxy be used for a given domain pattern.
359This is useful for excluding servers inside a firewall from
360proxy use, while defaulting to a common proxy for external domains.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200361
362core.ignoreStat::
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200363 If true, commands which modify both the working tree and the index
364 will mark the updated paths with the "assume unchanged" bit in the
365 index. These marked files are then assumed to stay unchanged in the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200366 working tree, until you mark them otherwise manually - Git will not
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200367 detect the file changes by lstat() calls. This is useful on systems
368 where those are very slow, such as Microsoft Windows.
369 See linkgit:git-update-index[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200370 False by default.
371
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700372core.preferSymlinkRefs::
373 Instead of the default "symref" format for HEAD
374 and other symbolic reference files, use symbolic links.
375 This is sometimes needed to work with old scripts that
376 expect HEAD to be a symbolic link.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200377
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500378core.bare::
379 If true this repository is assumed to be 'bare' and has no
380 working directory associated with it. If this is the case a
381 number of commands that require a working directory will be
Dan McGee5162e692007-12-29 00:20:38 -0600382 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500383+
Dan McGee5162e692007-12-29 00:20:38 -0600384This setting is automatically guessed by linkgit:git-clone[1] or
385linkgit:git-init[1] when the repository was created. By default a
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500386repository that ends in "/.git" is assumed to be not bare (bare =
387false), while all other repositories are assumed to be bare (bare
388= true).
389
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200390core.worktree::
Junio C Hamanoea472c12011-01-23 15:49:41 -0800391 Set the path to the root of the working tree.
Ralf Wildenhues06ada152007-10-09 23:00:03 +0200392 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoea472c12011-01-23 15:49:41 -0800393 variable and the '--work-tree' command line option.
SZEDER Gábord424a472011-04-04 16:59:25 +0200394 The value can be an absolute path or relative to the path to
Junio C Hamanoea472c12011-01-23 15:49:41 -0800395 the .git directory, which is either specified by --git-dir
396 or GIT_DIR, or automatically discovered.
397 If --git-dir or GIT_DIR is specified but none of
Liu Yubao302cc112008-04-29 04:09:20 +0800398 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanoea472c12011-01-23 15:49:41 -0800399 the current working directory is regarded as the top level
Nguyễn Thái Ngọc Duy98acf752010-11-26 22:32:42 +0700400 of your working tree.
Junio C Hamanoea472c12011-01-23 15:49:41 -0800401+
402Note that this variable is honored even when set in a configuration
403file in a ".git" subdirectory of a directory and its value differs
404from the latter directory (e.g. "/path/to/.git/config" has
405core.worktree set to "/different/path"), which is most likely a
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100406misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamanoea472c12011-01-23 15:49:41 -0800407still use "/different/path" as the root of the work tree and can cause
408confusion unless you know what you are doing (e.g. you are creating a
409read-only snapshot of the same index to a location different from the
410repository's usual working tree).
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200411
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400412core.logAllRefUpdates::
Lukas Sandström14cd5602007-08-19 23:38:57 +0200413 Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano4057deb2006-10-08 01:35:18 -0700414 "$GIT_DIR/logs/<ref>", by appending the new and old
415 SHA1, the date/time and the reason of the update, but
416 only when the file exists. If this configuration
417 variable is set to true, missing "$GIT_DIR/logs/<ref>"
Bert Wesargcd8e3712011-07-11 11:14:18 +0200418 file is automatically created for branch heads (i.e. under
419 refs/heads/), remote refs (i.e. under refs/remotes/),
420 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamanoa862f972006-12-30 22:39:24 -0800421+
422This information can be used to determine what commit
423was the tip of a branch "2 days ago".
424+
425This value is true by default in a repository that has
426a working directory associated with it, and false by
427default in a bare repository.
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400428
Petr Baudis1ab661d2006-04-25 00:59:33 +0200429core.repositoryFormatVersion::
430 Internal variable identifying the repository format and layout
431 version.
432
433core.sharedRepository::
Jonas Fonsecad5dc6a72006-08-09 02:26:23 +0200434 When 'group' (or 'true'), the repository is made shareable between
435 several users in a group (making sure all the files and objects are
436 group-writable). When 'all' (or 'world' or 'everybody'), the
437 repository will be readable by all users, additionally to being
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100438 group-shareable. When 'umask' (or 'false'), Git will use permissions
Heikki Orsila06cbe852008-04-16 11:34:24 +0300439 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
440 files in the repository will have this mode value. '0xxx' will override
Johan Herland098082f2009-04-14 15:15:42 +0200441 user's umask value (whereas the other options will only override
442 requested parts of the user's umask value). Examples: '0660' will make
443 the repo read/write-able for the owner and group, but inaccessible to
444 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Heikki Orsila06cbe852008-04-16 11:34:24 +0300445 repository that is group-readable but not group-writable.
446 See linkgit:git-init[1]. False by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200447
448core.warnAmbiguousRefs::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100449 If true, Git will warn you if the ref name you passed it is ambiguous
Greg Price48dfe962013-02-25 00:34:14 -0500450 and might match multiple refs in the repository. True by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200451
Joachim Berdal Haga3d3e95a2006-07-06 22:35:54 +0200452core.compression::
Dana How960ccca2007-05-09 13:56:50 -0700453 An integer -1..9, indicating a default compression level.
454 -1 is the zlib default. 0 means no compression,
455 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Brian Downingdec92302007-11-19 10:58:51 -0600456 If set, this provides a default to other compression variables,
457 such as 'core.loosecompression' and 'pack.compression'.
Dana How960ccca2007-05-09 13:56:50 -0700458
459core.loosecompression::
Joachim B Haga12f6c302006-07-03 22:11:47 +0200460 An integer -1..9, indicating the compression level for objects that
Dana How960ccca2007-05-09 13:56:50 -0700461 are not in a pack file. -1 is the zlib default. 0 means no
Joachim B Haga12f6c302006-07-03 22:11:47 +0200462 compression, and 1..9 are various speed/size tradeoffs, 9 being
Dana How960ccca2007-05-09 13:56:50 -0700463 slowest. If not set, defaults to core.compression. If that is
Brian Downingde1b2462007-11-19 10:58:50 -0600464 not set, defaults to 1 (best speed).
Joachim B Haga12f6c302006-07-03 22:11:47 +0200465
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500466core.packedGitWindowSize::
467 Number of bytes of a pack file to map into memory in a
468 single mapping operation. Larger window sizes may allow
469 your system to process a smaller number of large pack files
470 more quickly. Smaller window sizes will negatively affect
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500471 performance due to increased calls to the operating system's
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500472 memory manager, but may improve performance when accessing
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500473 a large number of large pack files.
474+
475Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
476MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
477be reasonable for all users/operating systems. You probably do
478not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500479+
480Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500481
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500482core.packedGitLimit::
483 Maximum number of bytes to map simultaneously into memory
484 from pack files. If Git needs to access more than this many
485 bytes at once to complete an operation it will unmap existing
486 regions to reclaim virtual address space within the process.
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500487+
488Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
489This should be reasonable for all users/operating systems, except on
490the largest projects. You probably do not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500491+
492Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500493
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400494core.deltaBaseCacheLimit::
495 Maximum number of bytes to reserve for caching base objects
Ville Skyttä6b677a22010-07-20 00:17:17 +0300496 that may be referenced by multiple deltified objects. By storing the
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400497 entire decompressed base objects in a cache Git is able
498 to avoid unpacking and decompressing frequently used base
499 objects multiple times.
500+
501Default is 16 MiB on all platforms. This should be reasonable
502for all users/operating systems, except on the largest projects.
503You probably do not need to adjust this value.
504+
505Common unit suffixes of 'k', 'm', or 'g' are supported.
506
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800507core.bigFileThreshold::
508 Files larger than this size are stored deflated, without
509 attempting delta compression. Storing large files without
510 delta compression avoids excessive memory usage, at the
511 slight expense of increased disk usage.
512+
513Default is 512 MiB on all platforms. This should be reasonable
514for most projects as source code and other text files can still
515be delta compressed, but larger binary media files won't be.
516+
517Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800518
Michael Hendrickse8964a52007-07-02 10:48:34 -0600519core.excludesfile::
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100520 In addition to '.gitignore' (per-directory) and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100521 '.git/info/exclude', Git looks into this file for patterns
Jeff King6cf378f2012-04-26 04:51:57 -0400522 of files which are not meant to be tracked. "`~/`" is expanded
523 to the value of `$HOME` and "`~user/`" to the specified user's
Huynh Khoi Nguyen Nguyendc796872012-06-22 11:03:24 +0200524 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
525 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
526 is used instead. See linkgit:gitignore[5].
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100527
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200528core.askpass::
529 Some commands (e.g. svn and http interfaces) that interactively
530 ask for a password can be told to use an external program given
Knut Franke453842c2010-08-30 15:40:29 +0200531 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
532 environment variable. If not set, fall back to the value of the
533 'SSH_ASKPASS' environment variable or, failing that, a simple password
534 prompt. The external program shall be given a suitable prompt as
535 command line argument and write the password on its STDOUT.
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200536
Petr Onderka6df42ab2010-09-01 00:42:43 +0200537core.attributesfile::
538 In addition to '.gitattributes' (per-directory) and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100539 '.git/info/attributes', Git looks into this file for attributes
Petr Onderka6df42ab2010-09-01 00:42:43 +0200540 (see linkgit:gitattributes[5]). Path expansions are made the same
Huynh Khoi Nguyen Nguyen684e40f2012-06-22 11:03:25 +0200541 way as for `core.excludesfile`. Its default value is
542 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
543 set or empty, $HOME/.config/git/attributes is used instead.
Petr Onderka6df42ab2010-09-01 00:42:43 +0200544
Adam Robenef0c2ab2007-07-19 22:09:35 -0700545core.editor::
546 Commands such as `commit` and `tag` that lets you edit
Brian Hetro02783072007-08-23 20:44:13 -0400547 messages by launching an editor uses the value of this
Adam Robenef0c2ab2007-07-19 22:09:35 -0700548 variable when it is set, and the environment variable
Jonathan Niederb4479f02009-10-30 20:42:34 -0500549 `GIT_EDITOR` is not set. See linkgit:git-var[1].
Adam Robenef0c2ab2007-07-19 22:09:35 -0700550
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100551core.commentchar::
552 Commands such as `commit` and `tag` that lets you edit
553 messages consider a line that begins with this character
554 commented, and removes them after the editor returns
555 (default '#').
556
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200557sequence.editor::
Matthias Krüger3322ad42013-03-27 23:53:50 +0100558 Text editor used by `git rebase -i` for editing the rebase instruction file.
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200559 The value is meant to be interpreted by the shell when it is used.
560 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
561 When not configured the default commit message editor is used instead.
562
Brian Gernhardt54adf372007-07-03 14:18:11 -0400563core.pager::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100564 The command that Git will use to paginate output. Can
Jonathan Niederab54cd62008-08-24 00:28:32 -0500565 be overridden with the `GIT_PAGER` environment
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100566 variable. Note that Git sets the `LESS` environment
Jonathan Niederab54cd62008-08-24 00:28:32 -0500567 variable to `FRSX` if it is unset when it runs the
568 pager. One can change these settings by setting the
Chris Freyfee75452008-09-24 19:21:28 -0400569 `LESS` variable to some other value. Alternately,
570 these settings can be overridden on a project or
571 global basis by setting the `core.pager` option.
Patrick Palka3a599b82012-10-28 16:12:46 -0400572 Setting `core.pager` has no effect on the `LESS`
Chris Freyfee75452008-09-24 19:21:28 -0400573 environment variable behaviour above, so if you want
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100574 to override Git's default settings this way, you need
Chris Freyfee75452008-09-24 19:21:28 -0400575 to be explicit. For example, to disable the S option
576 in a backward compatible manner, set `core.pager`
Patrick Palka3a599b82012-10-28 16:12:46 -0400577 to `less -+S`. This will be passed to the shell by
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100578 Git, which will translate the final command to
Patrick Palka3a599b82012-10-28 16:12:46 -0400579 `LESS=FRSX less -+S`.
Brian Gernhardt54adf372007-07-03 14:18:11 -0400580
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800581core.whitespace::
582 A comma separated list of common whitespace problems to
Thomas Rast0b444cd2010-01-10 00:33:00 +0100583 notice. 'git diff' will use `color.diff.whitespace` to
584 highlight them, and 'git apply --whitespace=error' will
Junio C Hamanoc921cc92008-07-25 00:34:47 -0700585 consider them as errors. You can prefix `-` to disable
586 any of them (e.g. `-trailing-space`):
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800587+
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700588* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800589 as an error (enabled by default).
590* `space-before-tab` treats a space character that appears immediately
591 before a tab character in the initial indent part of the line as an
592 error (enabled by default).
Wesley J. Landaker2ce4fee2012-09-17 08:22:15 -0600593* `indent-with-non-tab` treats a line that is indented with space
594 characters instead of the equivalent tabs as an error (not enabled by
595 default).
Chris Webb3e3ec2a2010-04-03 00:37:08 +0100596* `tab-in-indent` treats a tab character in the initial indent part of
597 the line as an error (not enabled by default).
Junio C Hamano77b15bb2009-09-03 16:02:32 -0700598* `blank-at-eof` treats blank lines added at the end of file as an error
599 (enabled by default).
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700600* `trailing-space` is a short-hand to cover both `blank-at-eol` and
601 `blank-at-eof`.
Junio C Hamanob2979ff2008-01-15 00:59:05 -0800602* `cr-at-eol` treats a carriage-return at the end of line as
603 part of the line terminator, i.e. with it, `trailing-space`
604 does not trigger if the character before such a carriage-return
605 is not a whitespace (not enabled by default).
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100606* `tabwidth=<n>` tells how many character positions a tab occupies; this
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100607 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100608 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800609
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700610core.fsyncobjectfiles::
611 This boolean will enable 'fsync()' when writing object files.
612+
613This is a total waste of time and effort on a filesystem that orders
614data writes properly, but can be useful for filesystems that do not use
615journalling (traditional UNIX filesystems) or that only journal metadata
616and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
617
Linus Torvalds671c9b72008-11-13 16:36:30 -0800618core.preloadindex::
619 Enable parallel index preload for operations like 'git diff'
620+
621This can speed up operations like 'git diff' and 'git status' especially
622on filesystems like NFS that have weak caching semantics and thus
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100623relatively high IO latencies. With this set to 'true', Git will do the
Linus Torvalds671c9b72008-11-13 16:36:30 -0800624index comparison to the filesystem data in parallel, allowing
625overlapping IO's.
626
Johannes Schindelin348df162009-04-28 00:32:25 +0200627core.createObject::
628 You can set this to 'link', in which case a hardlink followed by
629 a delete of the source are used to make sure that object creation
630 will not overwrite existing objects.
631+
632On some file system/operating system combinations, this is unreliable.
633Set this config setting to 'rename' there; However, This will remove the
634check that makes sure that existing object files will not get overwritten.
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200635
Johannes Schindelina97a7462009-10-09 12:21:57 +0200636core.notesRef::
637 When showing commit messages, also show notes which are stored in
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500638 the given ref. The ref must be fully qualified. If the given
639 ref does not exist, it is not an error but means that no
640 notes should be printed.
Johannes Schindelina97a7462009-10-09 12:21:57 +0200641+
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500642This setting defaults to "refs/notes/commits", and it can be overridden by
643the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Johannes Schindelina97a7462009-10-09 12:21:57 +0200644
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +0700645core.sparseCheckout::
646 Enable "sparse checkout" feature. See section "Sparse checkout" in
647 linkgit:git-read-tree[1] for more information.
648
Junio C Hamanoa71f09f2011-03-20 22:26:24 -0700649core.abbrev::
Linus Torvaldsdce96482010-10-28 11:28:04 -0700650 Set the length object names are abbreviated to. If unspecified,
651 many commands abbreviate to 7 hexdigits, which may not be enough
652 for abbreviated object names to stay unique for sufficiently long
653 time.
654
Stephen Boyd13bd2132009-05-30 22:08:02 -0700655add.ignore-errors::
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600656add.ignoreErrors::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100657 Tells 'git add' to continue adding files when some files cannot be
Stephen Boyd13bd2132009-05-30 22:08:02 -0700658 added due to indexing errors. Equivalent to the '--ignore-errors'
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100659 option of linkgit:git-add[1]. Older versions of Git accept only
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600660 `add.ignore-errors`, which does not follow the usual naming
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100661 convention for configuration variables. Newer versions of Git
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600662 honor `add.ignoreErrors` as well.
Stephen Boyd13bd2132009-05-30 22:08:02 -0700663
Petr Baudis4514ad42006-06-07 20:43:50 +0200664alias.*::
Dan McGee5162e692007-12-29 00:20:38 -0600665 Command aliases for the linkgit:git[1] command wrapper - e.g.
Petr Baudis4514ad42006-06-07 20:43:50 +0200666 after defining "alias.last = cat-file commit HEAD", the invocation
667 "git last" is equivalent to "git cat-file commit HEAD". To avoid
Petr Baudis99b41c82006-06-07 17:25:21 -0700668 confusion and troubles with script usage, aliases that
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100669 hide existing Git commands are ignored. Arguments are split by
Petr Baudis99b41c82006-06-07 17:25:21 -0700670 spaces, the usual shell quoting and escaping is supported.
671 quote pair and a backslash can be used to quote them.
Junio C Hamanof368f5a2007-09-01 04:01:54 -0700672+
673If the alias expansion is prefixed with an exclamation point,
674it will be treated as a shell command. For example, defining
675"alias.new = !gitk --all --not ORIG_HEAD", the invocation
676"git new" is equivalent to running the shell command
Sitaram Chamarty595b8db2009-07-01 21:30:31 +0530677"gitk --all --not ORIG_HEAD". Note that shell commands will be
678executed from the top-level directory of a repository, which may
679not necessarily be the current directory.
Michael J Gruber7cf16a12011-04-27 10:36:27 +0200680'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
681from the original current directory. See linkgit:git-rev-parse[1].
Theodore Ts'odfd42a32007-02-10 19:33:58 -0500682
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100683am.keepcr::
684 If true, git-am will call git-mailsplit for patches in mbox format
685 with parameter '--keep-cr'. In this case git-mailsplit will
Ville Skyttä6b677a22010-07-20 00:17:17 +0300686 not remove `\r` from lines ending with `\r\n`. Can be overridden
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100687 by giving '--no-keep-cr' from the command line.
688 See linkgit:git-am[1], linkgit:git-mailsplit[1].
689
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200690apply.ignorewhitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100691 When set to 'change', tells 'git apply' to ignore changes in
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200692 whitespace, in the same way as the '--ignore-space-change'
693 option.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100694 When set to one of: no, none, never, false tells 'git apply' to
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200695 respect all whitespace differences.
696 See linkgit:git-apply[1].
697
Petr Baudis1ab661d2006-04-25 00:59:33 +0200698apply.whitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100699 Tells 'git apply' how to handle whitespaces, in the same way
Dan McGee5162e692007-12-29 00:20:38 -0600700 as the '--whitespace' option. See linkgit:git-apply[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200701
Paolo Bonzini99023872007-05-23 07:07:54 +0200702branch.autosetupmerge::
Junio C Hamanoadd09512010-01-20 20:28:49 -0800703 Tells 'git branch' and 'git checkout' to set up new branches
Jay Soffian572fc812008-02-19 11:24:38 -0500704 so that linkgit:git-pull[1] will appropriately merge from the
705 starting point branch. Note that even if this option is not set,
Paolo Bonzini99023872007-05-23 07:07:54 +0200706 this behavior can be chosen per-branch using the `--track`
Jay Soffian572fc812008-02-19 11:24:38 -0500707 and `--no-track` options. The valid settings are: `false` -- no
708 automatic setup is done; `true` -- automatic setup is done when the
Matthieu Moy29b9a662010-11-02 16:31:24 +0100709 starting point is a remote-tracking branch; `always` --
710 automatic setup is done when the starting point is either a
711 local branch or remote-tracking
Jay Soffian572fc812008-02-19 11:24:38 -0500712 branch. This option defaults to true.
Paolo Bonzini99023872007-05-23 07:07:54 +0200713
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700714branch.autosetuprebase::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100715 When a new branch is created with 'git branch' or 'git checkout'
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100716 that tracks another branch, this variable tells Git to set
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700717 up pull to rebase instead of merge (see "branch.<name>.rebase").
718 When `never`, rebase is never automatically set to true.
719 When `local`, rebase is set to true for tracked branches of
720 other local branches.
721 When `remote`, rebase is set to true for tracked branches of
Matthieu Moy29b9a662010-11-02 16:31:24 +0100722 remote-tracking branches.
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700723 When `always`, rebase will be set to true for all tracking
724 branches.
725 See "branch.autosetupmerge" for details on how to set up a
726 branch to track another branch.
727 This option defaults to never.
728
Santi Béjar648ad182006-09-23 12:05:43 +0200729branch.<name>.remote::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100730 When in branch <name>, it tells 'git fetch' and 'git push' which
Santi Béjar76d3cc52009-03-30 12:11:40 +0200731 remote to fetch from/push to. It defaults to `origin` if no remote is
732 configured. `origin` is also used if you are not on any branch.
Santi Béjar648ad182006-09-23 12:05:43 +0200733
Santi Béjar53728062006-09-23 22:53:04 +0200734branch.<name>.merge::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200735 Defines, together with branch.<name>.remote, the upstream branch
Martin von Zweigbergk15a147e2011-02-09 20:54:02 -0500736 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Thomas Rast0b444cd2010-01-10 00:33:00 +0100737 branch to merge and can also affect 'git push' (see push.default).
738 When in branch <name>, it tells 'git fetch' the default
Daniel Barkalowb888d612007-09-10 23:03:25 -0400739 refspec to be marked for merging in FETCH_HEAD. The value is
740 handled like the remote part of a refspec, and must match a
741 ref which is fetched from the remote given by
742 "branch.<name>.remote".
Thomas Rast0b444cd2010-01-10 00:33:00 +0100743 The merge information is used by 'git pull' (which at first calls
744 'git fetch') to lookup the default branch for merging. Without
745 this option, 'git pull' defaults to merge the first refspec fetched.
Josef Weidendorfer62b339a2006-12-09 02:28:26 +0100746 Specify multiple values to get an octopus merge.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100747 If you wish to setup 'git pull' so that it merges into <name> from
Paolo Bonzini9debc322007-03-15 09:23:20 +0100748 another branch in the local repository, you can point
749 branch.<name>.merge to the desired branch, and use the special setting
750 `.` (a period) for branch.<name>.remote.
Santi Béjar53728062006-09-23 22:53:04 +0200751
Lars Hjemliaec7b362007-09-24 00:51:43 +0200752branch.<name>.mergeoptions::
753 Sets default options for merging into branch <name>. The syntax and
Jonathan Nieder25dcc0d2009-10-09 13:51:14 -0500754 supported options are the same as those of linkgit:git-merge[1], but
Lars Hjemliaec7b362007-09-24 00:51:43 +0200755 option values containing whitespace characters are currently not
756 supported.
757
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000758branch.<name>.rebase::
759 When true, rebase the branch <name> on top of the fetched branch,
Dustin Sallings15ddb6f2008-05-08 11:28:07 -0700760 instead of merging the default branch from the default remote when
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100761 "git pull" is run. See "pull.rebase" for doing this in a non
762 branch-specific manner.
763+
764*NOTE*: this is a possibly dangerous operation; do *not* use
765it unless you understand the implications (see linkgit:git-rebase[1]
766for details).
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000767
Nguyễn Thái Ngọc Duya5ba2cb2013-01-01 16:30:53 +0700768branch.<name>.description::
769 Branch description, can be edited with
770 `git branch --edit-description`. Branch description is
771 automatically added in the format-patch cover letter or
772 request-pull summary.
773
Christian Couder1658c612008-03-14 05:56:53 +0100774browser.<tool>.cmd::
775 Specify the command to invoke the specified browser. The
776 specified command is evaluated in shell with the URLs passed
Jonathan Nieder565e1352011-06-29 00:35:10 -0500777 as arguments. (See linkgit:git-web{litdd}browse[1].)
Christian Couder1658c612008-03-14 05:56:53 +0100778
Christian Couder584627b2008-01-29 07:08:22 +0100779browser.<tool>.path::
780 Override the path for the given tool that may be used to
Christian Couderab989ad2008-01-29 07:08:44 +0100781 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
782 working repository in gitweb (see linkgit:git-instaweb[1]).
Christian Couder584627b2008-01-29 07:08:22 +0100783
Josh Triplett21225912007-04-23 17:18:16 -0700784clean.requireForce::
Junio C Hamano562ca192007-11-01 17:32:04 -0700785 A boolean to make git-clean do nothing unless given -f
786 or -n. Defaults to true.
Josh Triplett21225912007-04-23 17:18:16 -0700787
Brian Gernhardtf3673982007-01-03 10:36:29 -0500788color.branch::
789 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600790 linkgit:git-branch[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800791 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Brian Gernhardtf3673982007-01-03 10:36:29 -0500792 only when the output is to a terminal. Defaults to false.
793
794color.branch.<slot>::
795 Use customized color for branch coloration. `<slot>` is one of
796 `current` (the current branch), `local` (a local branch),
Matthieu Moy8b3f3f82010-11-02 16:31:23 +0100797 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Mark Wooding4f193f22007-01-28 15:17:36 +0000798 refs).
799+
800The value for these configuration variables is a list of colors (at most
801two) and attributes (at most one), separated by spaces. The colors
802accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
803`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
804`blink` and `reverse`. The first color given is the foreground; the
805second is the background. The position of the attribute, if any,
806doesn't matter.
Brian Gernhardtf3673982007-01-03 10:36:29 -0500807
Andy Parkinsa159ca02006-12-13 09:13:28 +0000808color.diff::
Michael J Gruber6999c542011-04-27 09:38:27 +0200809 Whether to use ANSI escape sequences to add color to patches.
810 If this is set to `always`, linkgit:git-diff[1],
811 linkgit:git-log[1], and linkgit:git-show[1] will use color
812 for all patches. If it is set to `true` or `auto`, those
813 commands will only use color when output is to the terminal.
814 Defaults to false.
815+
816This does not affect linkgit:git-format-patch[1] nor the
817'git-diff-{asterisk}' plumbing commands. Can be overridden on the
818command line with the `--color[=<when>]` option.
Junio C Hamanob5376642006-07-07 05:28:05 -0700819
Andy Parkinsa159ca02006-12-13 09:13:28 +0000820color.diff.<slot>::
Mark Wooding4f193f22007-01-28 15:17:36 +0000821 Use customized color for diff colorization. `<slot>` specifies
822 which part of the patch to use the specified color, and is one
823 of `plain` (context text), `meta` (metainformation), `frag`
Bert Wesarg89cb73a2009-11-27 07:55:18 +0100824 (hunk header), 'func' (function in hunk header), `old` (removed lines),
825 `new` (added lines), `commit` (commit headers), or `whitespace`
826 (highlighting whitespace errors). The values of these variables may be
827 specified as in color.branch.<slot>.
Junio C Hamanob5376642006-07-07 05:28:05 -0700828
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800829color.decorate.<slot>::
830 Use customized color for 'git log --decorate' output. `<slot>` is one
831 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Matthieu Moy0e615b22010-11-02 16:31:20 +0100832 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800833
René Scharfe7e8f59d2009-03-07 13:32:32 +0100834color.grep::
835 When set to `always`, always highlight matches. When `false` (or
836 `never`), never. When set to `true` or `auto`, use color only
837 when the output is written to the terminal. Defaults to `false`.
838
Mark Lodato55f638b2010-03-07 11:52:46 -0500839color.grep.<slot>::
840 Use customized color for grep colorization. `<slot>` specifies which
841 part of the line to use the specified color, and is one of
842+
843--
Mark Lodato00588bb2010-03-07 11:52:47 -0500844`context`;;
845 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500846`filename`;;
847 filename prefix (when not using `-h`)
Mark Lodato00588bb2010-03-07 11:52:47 -0500848`function`;;
849 function name lines (when using `-p`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500850`linenumber`;;
851 line number prefix (when using `-n`)
852`match`;;
853 matching text
Mark Lodato00588bb2010-03-07 11:52:47 -0500854`selected`;;
855 non-matching text in selected lines
Mark Lodato55f638b2010-03-07 11:52:46 -0500856`separator`;;
857 separators between fields on a line (`:`, `-`, and `=`)
858 and between hunks (`--`)
859--
860+
861The values of these variables may be specified as in color.branch.<slot>.
René Scharfe7e8f59d2009-03-07 13:32:32 +0100862
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800863color.interactive::
Jeff King47ee06f2008-01-05 04:57:44 -0500864 When set to `always`, always use colors for interactive prompts
Jonathan Nieder467c0192008-07-03 00:28:15 -0500865 and displays (such as those used by "git-add --interactive").
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800866 When false (or `never`), never. When set to `true` or `auto`, use
867 colors only when the output is to the terminal. Defaults to false.
868
869color.interactive.<slot>::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100870 Use customized color for 'git add --interactive'
Thomas Rasta3019732009-02-05 09:28:27 +0100871 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
872 four distinct types of normal output from interactive
Ori Avtalion57f6ec02009-08-07 17:24:21 +0300873 commands. The values of these variables may be specified as
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800874 in color.branch.<slot>.
875
Junio C Hamano1d770432006-12-13 12:11:03 -0800876color.pager::
877 A boolean to enable/disable colored output when the pager is in
878 use (default is true).
879
Markus Heidelbergab07ba22009-04-22 23:41:25 +0200880color.showbranch::
881 A boolean to enable/disable color in the output of
882 linkgit:git-show-branch[1]. May be set to `always`,
883 `false` (or `never`) or `auto` (or `true`), in which case colors are used
884 only when the output is to a terminal. Defaults to false.
885
Junio C Hamano1d770432006-12-13 12:11:03 -0800886color.status::
887 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600888 linkgit:git-status[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800889 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamano1d770432006-12-13 12:11:03 -0800890 only when the output is to a terminal. Defaults to false.
891
892color.status.<slot>::
893 Use customized color for status colorization. `<slot>` is
894 one of `header` (the header text of the status message),
Shawn O. Pearce82dca842006-12-15 21:53:13 -0500895 `added` or `updated` (files which are added but not committed),
896 `changed` (files which are changed but not added in the index),
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100897 `untracked` (files which are not tracked by Git),
Aleksi Aalto1d282322010-11-18 01:40:05 +0200898 `branch` (the current branch), or
Chris Parsons950ce2e2008-05-22 08:50:02 -0400899 `nobranch` (the color the 'no branch' warning is shown in, defaulting
900 to red). The values of these variables may be specified as in
901 color.branch.<slot>.
Junio C Hamano1d770432006-12-13 12:11:03 -0800902
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100903color.ui::
Michael J Gruber6999c542011-04-27 09:38:27 +0200904 This variable determines the default value for variables such
905 as `color.diff` and `color.grep` that control the use of color
906 per command family. Its scope will expand as more commands learn
907 configuration to set a default for the `--color` option. Set it
908 to `always` if you want all output not intended for machine
909 consumption to use color, to `true` or `auto` if you want such
910 output to use color when written to the terminal, or to `false` or
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100911 `never` if you prefer Git commands not to use color unless enabled
Michael J Gruber6999c542011-04-27 09:38:27 +0200912 explicitly with some other configuration or the `--color` option.
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100913
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700914column.ui::
915 Specify whether supported commands should output in columns.
916 This variable consists of a list of tokens separated by spaces
917 or commas:
918+
919--
920`always`;;
921 always show in columns
922`never`;;
923 never show in columns
924`auto`;;
925 show in columns if the output is to the terminal
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700926`column`;;
927 fill columns before rows (default)
928`row`;;
929 fill rows before columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700930`plain`;;
931 show in one column
Nguyễn Thái Ngọc Duy3f8eccb2012-04-13 17:54:36 +0700932`dense`;;
933 make unequal size columns to utilize more space
934`nodense`;;
935 make equal size columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700936--
937+
Andreas Schwabb1290512012-06-23 15:18:00 +0200938This option defaults to 'never'.
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700939
Nguyễn Thái Ngọc Duyebe31ef2012-04-13 17:54:38 +0700940column.branch::
941 Specify whether to output branch listing in `git branch` in columns.
942 See `column.ui` for details.
943
Nguyễn Thái Ngọc Duy323d0532012-04-13 17:54:39 +0700944column.status::
945 Specify whether to output untracked files in `git status` in columns.
946 See `column.ui` for details.
947
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700948column.tag::
949 Specify whether to output tag listing in `git tag` in columns.
950 See `column.ui` for details.
951
Ralf Thielow51fb3a32013-01-10 18:45:59 +0100952commit.cleanup::
953 This setting overrides the default of the `--cleanup` option in
954 `git commit`. See linkgit:git-commit[1] for details. Changing the
955 default can be useful when you always want to keep lines that begin
956 with comment character `#` in your log message, in which case you
957 would do `git config commit.cleanup whitespace` (note that you will
958 have to remove the help lines that begin with `#` in the commit log
959 template yourself, if you do this).
960
Thomas Rast88955ed2010-01-23 23:13:17 +0100961commit.status::
James P. Howard, IIbed575e2009-12-07 17:45:27 -0500962 A boolean to enable/disable inclusion of status information in the
963 commit message template when using an editor to prepare the commit
964 message. Defaults to true.
965
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500966commit.template::
967 Specify a file to use as the template for new commit messages.
Jeff King6cf378f2012-04-26 04:51:57 -0400968 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Matthieu Moydf2a79f2009-11-19 16:21:15 +0100969 specified user's home directory.
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500970
Jeff Kinga6fc9fd2011-12-10 05:31:38 -0500971credential.helper::
972 Specify an external helper to be called when a username or
973 password credential is needed; the helper may consult external
974 storage to avoid prompting the user for the credentials. See
975 linkgit:gitcredentials[7] for details.
976
977credential.useHttpPath::
978 When acquiring credentials, consider the "path" component of an http
979 or https URL to be important. Defaults to false. See
980 linkgit:gitcredentials[7] for more information.
981
982credential.username::
983 If no username is set for a network authentication, use this username
984 by default. See credential.<context>.* below, and
985 linkgit:gitcredentials[7].
986
987credential.<url>.*::
988 Any of the credential.* options above can be applied selectively to
989 some credentials. For example "credential.https://example.com.username"
990 would set the default username only for https connections to
991 example.com. See linkgit:gitcredentials[7] for details on how URLs are
992 matched.
993
Ramkumar Ramachandra19299a82011-04-07 00:16:49 +0530994include::diff-config.txt[]
David Aguilarafcbc8e2009-04-07 01:21:20 -0700995
996difftool.<tool>.path::
997 Override the path for the given tool. This is useful in case
998 your tool is not in the PATH.
999
1000difftool.<tool>.cmd::
1001 Specify the command to invoke the specified diff tool.
1002 The specified command is evaluated in shell with the following
1003 variables available: 'LOCAL' is set to the name of the temporary
1004 file containing the contents of the diff pre-image and 'REMOTE'
1005 is set to the name of the temporary file containing the contents
1006 of the diff post-image.
1007
David Aguilara9043922009-04-07 01:21:22 -07001008difftool.prompt::
1009 Prompt before each invocation of the diff tool.
1010
Jens Lehmannbe254a02010-11-11 00:55:02 +01001011fetch.recurseSubmodules::
Jens Lehmann1fb25502011-03-06 23:11:48 +01001012 This option can be either set to a boolean value or to 'on-demand'.
1013 Setting it to a boolean changes the behavior of fetch and pull to
1014 unconditionally recurse into submodules when set to true or to not
1015 recurse at all when set to false. When set to 'on-demand' (the default
1016 value), fetch and pull will only recurse into a populated submodule
1017 when its superproject retrieves a commit that updates the submodule's
1018 reference.
Jens Lehmannbe254a02010-11-11 00:55:02 +01001019
Junio C Hamano5e838ea2011-09-04 12:26:14 -07001020fetch.fsckObjects::
1021 If it is set to true, git-fetch-pack will check all fetched
1022 objects. It will abort in the case of a malformed object or a
1023 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001024 Defaults to false. If not set, the value of `transfer.fsckObjects`
1025 is used instead.
Junio C Hamano5e838ea2011-09-04 12:26:14 -07001026
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001027fetch.unpackLimit::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001028 If the number of objects fetched over the Git native
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001029 transfer is below this
1030 limit, then the objects will be unpacked into loose object
1031 files. However if the number of received objects equals or
1032 exceeds this limit then the received pack will be stored as
1033 a pack, after adding any missing delta bases. Storing the
1034 pack from a push can make the push operation complete faster,
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001035 especially on slow filesystems. If not set, the value of
1036 `transfer.unpackLimit` is used instead.
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001037
Stephen Boyd48d34482009-04-23 02:37:56 -07001038format.attach::
1039 Enable multipart/mixed attachments as the default for
1040 'format-patch'. The value can also be a double quoted string
1041 which will enable attachments as the default and set the
1042 value as the boundary. See the --attach option in
1043 linkgit:git-format-patch[1].
1044
Brian Gernhardt49604a42007-11-03 23:38:24 -04001045format.numbered::
Brian Gernhardta567fdc2008-10-02 16:55:39 -04001046 A boolean which can enable or disable sequence numbers in patch
1047 subjects. It defaults to "auto" which enables it only if there
1048 is more than one patch. It can be enabled or disabled for all
1049 messages by setting it to "true" or "false". See --numbered
1050 option in linkgit:git-format-patch[1].
Brian Gernhardt49604a42007-11-03 23:38:24 -04001051
Petr Baudis1ab661d2006-04-25 00:59:33 +02001052format.headers::
1053 Additional email headers to include in a patch to be submitted
Dan McGee5162e692007-12-29 00:20:38 -06001054 by mail. See linkgit:git-format-patch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001055
Miklos Vajna312a30e2010-07-12 20:58:38 +02001056format.to::
Stephen Boyd48d34482009-04-23 02:37:56 -07001057format.cc::
Miklos Vajna312a30e2010-07-12 20:58:38 +02001058 Additional recipients to include in a patch to be submitted
1059 by mail. See the --to and --cc options in
1060 linkgit:git-format-patch[1].
Stephen Boyd48d34482009-04-23 02:37:56 -07001061
1062format.subjectprefix::
1063 The default for format-patch is to output files with the '[PATCH]'
1064 subject prefix. Use this variable to change that prefix.
1065
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001066format.signature::
1067 The default for format-patch is to output a signature containing
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001068 the Git version number. Use this variable to change that default.
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001069 Set this variable to the empty string ("") to suppress
1070 signature generation.
1071
Johannes Schindelin78cb59c2007-03-04 00:17:23 +01001072format.suffix::
1073 The default for format-patch is to output files with the suffix
1074 `.patch`. Use this variable to change that suffix (make sure to
1075 include the dot if you want it).
1076
Denis Cheng94c22a52008-03-02 17:05:53 +08001077format.pretty::
1078 The default pretty format for log/show/whatchanged command,
1079 See linkgit:git-log[1], linkgit:git-show[1],
1080 linkgit:git-whatchanged[1].
1081
Thomas Rast30984ed2009-02-19 22:26:33 +01001082format.thread::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001083 The default threading style for 'git format-patch'. Can be
Jonathan Nieder578b62b2010-01-09 21:01:21 -06001084 a boolean value, or `shallow` or `deep`. `shallow` threading
1085 makes every mail a reply to the head of the series,
Thomas Rast30984ed2009-02-19 22:26:33 +01001086 where the head is chosen from the cover letter, the
Jeff King6cf378f2012-04-26 04:51:57 -04001087 `--in-reply-to`, and the first patch mail, in this order.
Stephen Boydfd1ff302009-04-23 02:37:57 -07001088 `deep` threading makes every mail a reply to the previous one.
Thomas Rast30984ed2009-02-19 22:26:33 +01001089 A true boolean value is the same as `shallow`, and a false
1090 value disables threading.
1091
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001092format.signoff::
1093 A boolean value which lets you enable the `-s/--signoff` option of
1094 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1095 patch should be a conscious act and means that you certify you have
1096 the rights to submit this work under the same open source license.
1097 Please see the 'SubmittingPatches' document for further discussion.
1098
Ramkumar Ramachandra26488f52011-04-07 00:16:48 +05301099filter.<driver>.clean::
1100 The command which is used to convert the content of a worktree
1101 file to a blob upon checkin. See linkgit:gitattributes[5] for
1102 details.
1103
1104filter.<driver>.smudge::
1105 The command which is used to convert the content of a blob
1106 object to a worktree file upon checkout. See
1107 linkgit:gitattributes[5] for details.
1108
Theodore Tso0d7566a2007-05-09 15:48:39 -04001109gc.aggressiveWindow::
1110 The window size parameter used in the delta compression
Thomas Rast0b444cd2010-01-10 00:33:00 +01001111 algorithm used by 'git gc --aggressive'. This defaults
Jay Soffianf78683f2010-04-13 12:52:55 -04001112 to 250.
Theodore Tso0d7566a2007-05-09 15:48:39 -04001113
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001114gc.auto::
1115 When there are approximately more than this many loose
1116 objects in the repository, `git gc --auto` will pack them.
1117 Some Porcelain commands use this command to perform a
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001118 light-weight garbage collection from time to time. The
1119 default value is 6700. Setting this to 0 disables it.
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001120
Junio C Hamano17815502007-09-17 00:55:13 -07001121gc.autopacklimit::
1122 When there are more than this many packs that are not
1123 marked with `*.keep` file in the repository, `git gc
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001124 --auto` consolidates them into one larger pack. The
Junio C Hamano97063972008-03-23 00:04:48 -07001125 default value is 50. Setting this to 0 disables it.
Junio C Hamano17815502007-09-17 00:55:13 -07001126
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001127gc.packrefs::
Jonathan Niederefc266e2010-01-09 20:59:41 -06001128 Running `git pack-refs` in a repository renders it
1129 unclonable by Git versions prior to 1.5.1.2 over dumb
1130 transports such as HTTP. This variable determines whether
Jiang Xin4be0c352010-12-16 15:16:49 +08001131 'git gc' runs `git pack-refs`. This can be set to `notbare`
Jonathan Niederefc266e2010-01-09 20:59:41 -06001132 to enable it within all non-bare repos or it can be set to a
1133 boolean value. The default is `true`.
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001134
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001135gc.pruneexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001136 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Nicolas Pitre8e8daf32008-12-30 14:45:11 -05001137 Override the grace period with this config variable. The value
1138 "now" may be used to disable this grace period and always prune
1139 unreachable objects immediately.
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001140
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001141gc.reflogexpire::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001142gc.<pattern>.reflogexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001143 'git reflog expire' removes reflog entries older than
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001144 this time; defaults to 90 days. With "<pattern>" (e.g.
1145 "refs/stash") in the middle the setting applies only to
1146 the refs that match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001147
1148gc.reflogexpireunreachable::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001149gc.<ref>.reflogexpireunreachable::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001150 'git reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001151 this time and are not reachable from the current tip;
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001152 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1153 in the middle, the setting applies only to the refs that
1154 match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001155
Junio C Hamano48c32422006-12-27 01:24:05 -08001156gc.rerereresolved::
1157 Records of conflicted merge you resolved earlier are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001158 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001159 The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001160
1161gc.rerereunresolved::
1162 Records of conflicted merge you have not resolved are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001163 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001164 The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001165
Fabian Emmes280514e2009-01-02 16:40:13 +01001166gitcvs.commitmsgannotation::
1167 Append this string to each commit message. Set to empty string
1168 to disable this feature. Defaults to "via git-CVS emulator".
1169
Petr Baudis1ab661d2006-04-25 00:59:33 +02001170gitcvs.enabled::
Brian Hetrodb218722007-08-23 20:40:08 -04001171 Whether the CVS server interface is enabled for this repository.
Dan McGee5162e692007-12-29 00:20:38 -06001172 See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001173
1174gitcvs.logfile::
Brian Hetrodb218722007-08-23 20:40:08 -04001175 Path to a log file where the CVS server interface well... logs
Dan McGee5162e692007-12-29 00:20:38 -06001176 various stuff. See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001177
Teemu Likonen1707adb2008-08-29 10:29:42 +03001178gitcvs.usecrlfattr::
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001179 If true, the server will look up the end-of-line conversion
1180 attributes for files to determine the '-k' modes to use. If
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001181 the attributes force Git to treat a file as text,
Ville Skyttä6b677a22010-07-20 00:17:17 +03001182 the '-k' mode will be left blank so CVS clients will
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001183 treat it as text. If they suppress text conversion, the file
Mike Ralphson1168d402008-08-05 17:12:05 +01001184 will be set with '-kb' mode, which suppresses any newline munging
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001185 the client might otherwise do. If the attributes do not allow
1186 the file type to be determined, then 'gitcvs.allbinary' is
1187 used. See linkgit:gitattributes[5].
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001188
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001189gitcvs.allbinary::
Matthew Ogilvie90948a42008-05-14 22:35:48 -06001190 This is used if 'gitcvs.usecrlfattr' does not resolve
1191 the correct '-kb' mode to use. If true, all
1192 unresolved files are sent to the client in
1193 mode '-kb'. This causes the client to treat them
1194 as binary files, which suppresses any newline munging it
1195 otherwise might do. Alternatively, if it is set to "guess",
1196 then the contents of the file are examined to decide if
1197 it is binary, similar to 'core.autocrlf'.
Junio C Hamanoabbf5942007-04-17 22:17:46 -07001198
Frank Lichtenheld04752862007-04-13 18:13:42 +02001199gitcvs.dbname::
1200 Database used by git-cvsserver to cache revision information
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001201 derived from the Git repository. The exact meaning depends on the
Frank Lichtenheld04752862007-04-13 18:13:42 +02001202 used database driver, for SQLite (which is the default driver) this
1203 is a filename. Supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001204 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001205 Default: '%Ggitcvs.%m.sqlite'
1206
1207gitcvs.dbdriver::
1208 Used Perl DBI driver. You can specify any available driver
1209 for this here, but it might not work. git-cvsserver is tested
1210 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1211 reported *not* to work with 'DBD::mysql'. Experimental feature.
1212 May not contain double colons (`:`). Default: 'SQLite'.
Dan McGee5162e692007-12-29 00:20:38 -06001213 See linkgit:git-cvsserver[1].
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001214
Frank Lichtenheld04752862007-04-13 18:13:42 +02001215gitcvs.dbuser, gitcvs.dbpass::
1216 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1217 since SQLite has no concept of database users and/or passwords.
1218 'gitcvs.dbuser' supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001219 linkgit:git-cvsserver[1] for details).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001220
Josh Elsasser6aeeffd2008-03-27 14:02:14 -07001221gitcvs.dbTableNamePrefix::
1222 Database table name prefix. Prepended to the names of any
1223 database tables used, allowing a single database to be used
1224 for several repositories. Supports variable substitution (see
1225 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1226 characters will be replaced with underscores.
1227
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001228All gitcvs variables except for 'gitcvs.usecrlfattr' and
1229'gitcvs.allbinary' can also be specified as
1230'gitcvs.<access_method>.<varname>' (where 'access_method'
Brian Hetro02783072007-08-23 20:44:13 -04001231is one of "ext" and "pserver") to make them apply only for the given
1232access method.
Frank Lichtenheld04752862007-04-13 18:13:42 +02001233
Jakub Narebskicd823232011-10-16 13:07:34 +02001234gitweb.category::
1235gitweb.description::
1236gitweb.owner::
1237gitweb.url::
1238 See linkgit:gitweb[1] for description.
1239
1240gitweb.avatar::
1241gitweb.blame::
1242gitweb.grep::
1243gitweb.highlight::
1244gitweb.patches::
1245gitweb.pickaxe::
1246gitweb.remote_heads::
1247gitweb.showsizes::
1248gitweb.snapshot::
1249 See linkgit:gitweb.conf[5] for description.
1250
Joe Rattermanb22520a2011-03-30 14:31:05 -05001251grep.lineNumber::
1252 If set to true, enable '-n' option by default.
1253
J Smith84befcd2012-08-03 10:53:50 -04001254grep.patternType::
1255 Set the default matching behavior. Using a value of 'basic', 'extended',
1256 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1257 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1258 value 'default' will return to the default matching behavior.
1259
Joe Rattermanb22520a2011-03-30 14:31:05 -05001260grep.extendedRegexp::
J Smith84befcd2012-08-03 10:53:50 -04001261 If set to true, enable '--extended-regexp' option by default. This
1262 option is ignored when the 'grep.patternType' option is set to a value
1263 other than 'default'.
Joe Rattermanb22520a2011-03-30 14:31:05 -05001264
Junio C Hamano0c5e70f2011-11-29 12:29:48 -08001265gpg.program::
1266 Use this custom program instead of "gpg" found on $PATH when
1267 making or verifying a PGP signature. The program must support the
1268 same command line interface as GPG, namely, to verify a detached
1269 signature, "gpg --verify $file - <$signature" is run, and the
1270 program is expected to signal a good signature by exiting with
1271 code 0, and to generate an ascii-armored detached signature, the
1272 standard input of "gpg -bsau $key" is fed with the contents to be
1273 signed, and the program is expected to send the result to its
1274 standard output.
1275
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001276gui.commitmsgwidth::
1277 Defines how wide the commit message window is in the
1278 linkgit:git-gui[1]. "75" is the default.
1279
1280gui.diffcontext::
1281 Specifies how many context lines should be used in calls to diff
1282 made by the linkgit:git-gui[1]. The default is "5".
1283
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001284gui.encoding::
1285 Specifies the default encoding to use for displaying of
1286 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1287 It can be overridden by setting the 'encoding' attribute
1288 for relevant files (see linkgit:gitattributes[5]).
1289 If this option is not set, the tools default to the
1290 locale encoding.
1291
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001292gui.matchtrackingbranch::
1293 Determines if new branches created with linkgit:git-gui[1] should
1294 default to tracking remote branches with matching names or
1295 not. Default: "false".
1296
1297gui.newbranchtemplate::
1298 Is used as suggested name when creating new branches using the
1299 linkgit:git-gui[1].
1300
1301gui.pruneduringfetch::
Matthieu Moy8b3f3f82010-11-02 16:31:23 +01001302 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001303 performing a fetch. The default value is "false".
1304
1305gui.trustmtime::
1306 Determines if linkgit:git-gui[1] should trust the file modification
1307 timestamp or not. By default the timestamps are not trusted.
1308
1309gui.spellingdictionary::
1310 Specifies the dictionary used for spell checking commit messages in
1311 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1312 off.
1313
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001314gui.fastcopyblame::
Thomas Rastca768282010-01-07 17:49:12 +01001315 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001316 location detection. It makes blame significantly faster on huge
1317 repositories at the expense of less thorough copy detection.
1318
1319gui.copyblamethreshold::
Ralf Wildenhues76bac892008-11-27 08:32:01 +01001320 Specifies the threshold to use in 'git gui blame' original location
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001321 detection, measured in alphanumeric characters. See the
1322 linkgit:git-blame[1] manual for more information on copy detection.
1323
1324gui.blamehistoryctx::
1325 Specifies the radius of history context in days to show in
1326 linkgit:gitk[1] for the selected commit, when the `Show History
1327 Context` menu item is invoked from 'git gui blame'. If this
1328 variable is set to zero, the whole history is shown.
1329
Alexander Gavrilov390c3482008-12-14 22:44:32 +03001330guitool.<name>.cmd::
1331 Specifies the shell command line to execute when the corresponding item
1332 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1333 mandatory for every tool. The command is executed from the root of
1334 the working directory, and in the environment it receives the name of
1335 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1336 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1337 the head is detached, 'CUR_BRANCH' is empty).
1338
1339guitool.<name>.needsfile::
1340 Run the tool only if a diff is selected in the GUI. It guarantees
1341 that 'FILENAME' is not empty.
1342
1343guitool.<name>.noconsole::
1344 Run the command silently, without creating a window to display its
1345 output.
1346
1347guitool.<name>.norescan::
1348 Don't rescan the working directory for changes after the tool
1349 finishes execution.
1350
1351guitool.<name>.confirm::
1352 Show a confirmation dialog before actually running the tool.
1353
1354guitool.<name>.argprompt::
1355 Request a string argument from the user, and pass it to the tool
1356 through the 'ARGS' environment variable. Since requesting an
1357 argument implies confirmation, the 'confirm' option has no effect
1358 if this is enabled. If the option is set to 'true', 'yes', or '1',
1359 the dialog uses a built-in generic prompt; otherwise the exact
1360 value of the variable is used.
1361
1362guitool.<name>.revprompt::
1363 Request a single valid revision from the user, and set the
1364 'REVISION' environment variable. In other aspects this option
1365 is similar to 'argprompt', and can be used together with it.
1366
1367guitool.<name>.revunmerged::
1368 Show only unmerged branches in the 'revprompt' subdialog.
1369 This is useful for tools similar to merge or rebase, but not
1370 for things like checkout or reset.
1371
1372guitool.<name>.title::
1373 Specifies the title to use for the prompt dialog. The default
1374 is the tool name.
1375
1376guitool.<name>.prompt::
1377 Specifies the general prompt string to display at the top of
1378 the dialog, before subsections for 'argprompt' and 'revprompt'.
1379 The default value includes the actual command.
1380
Christian Couder983a9ee2008-01-08 04:55:14 +01001381help.browser::
1382 Specify the browser that will be used to display help in the
1383 'web' format. See linkgit:git-help[1].
1384
1385help.format::
1386 Override the default help format used by linkgit:git-help[1].
1387 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1388 the default. 'web' and 'html' are the same.
1389
Alex Riesenf0e90712008-08-31 15:54:58 +02001390help.autocorrect::
1391 Automatically correct and execute mistyped commands after
1392 waiting for the given number of deciseconds (0.1 sec). If more
1393 than one command can be deduced from the entered text, nothing
1394 will be executed. If the value of this option is negative,
1395 the corrected command will be executed immediately. If the
1396 value is 0 - the command will be just shown but not executed.
1397 This is the default.
1398
Sebastian Staudtb1f809d2013-01-15 21:56:21 +01001399help.htmlpath::
1400 Specify the path where the HTML documentation resides. File system paths
1401 and URLs are supported. HTML pages will be prefixed with this path when
1402 help is displayed in the 'web' format. This defaults to the documentation
1403 path of your Git installation.
1404
Sam Vilain9c5665a2007-11-23 13:07:00 +13001405http.proxy::
Clemens Buchacherb2c8c6d2012-03-04 17:50:43 +01001406 Override the HTTP proxy, normally configured using the 'http_proxy',
1407 'https_proxy', and 'all_proxy' environment variables (see
1408 `curl(1)`). This can be overridden on a per-remote basis; see
1409 remote.<name>.proxy
Sam Vilain9c5665a2007-11-23 13:07:00 +13001410
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001411http.cookiefile::
1412 File containing previously stored cookie lines which should be used
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001413 in the Git http session, if they match the server. The file format
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001414 of the file to read cookies from should be plain HTTP headers or
1415 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1416 NOTE that the file specified with http.cookiefile is only used as
1417 input. No cookies will be stored in the file.
1418
Petr Baudis1ab661d2006-04-25 00:59:33 +02001419http.sslVerify::
1420 Whether to verify the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001421 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001422 variable.
1423
1424http.sslCert::
1425 File containing the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001426 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001427 variable.
1428
1429http.sslKey::
1430 File containing the SSL private key when fetching or pushing
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001431 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001432 variable.
1433
Mark Lodato754ae192009-05-27 23:16:03 -04001434http.sslCertPasswordProtected::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001435 Enable Git's password prompt for the SSL certificate. Otherwise
Mark Lodato754ae192009-05-27 23:16:03 -04001436 OpenSSL will prompt the user, possibly many times, if the
1437 certificate or private key is encrypted. Can be overridden by the
1438 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1439
Petr Baudis1ab661d2006-04-25 00:59:33 +02001440http.sslCAInfo::
1441 File containing the certificates to verify the peer with when
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001442 fetching or pushing over HTTPS. Can be overridden by the
Petr Baudis1ab661d2006-04-25 00:59:33 +02001443 'GIT_SSL_CAINFO' environment variable.
1444
1445http.sslCAPath::
1446 Path containing files with the CA certificates to verify the peer
Francis Daly37425062006-06-07 13:56:45 +01001447 with when fetching or pushing over HTTPS. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001448 by the 'GIT_SSL_CAPATH' environment variable.
1449
1450http.maxRequests::
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001451 How many HTTP requests to launch in parallel. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001452 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1453
Tay Ray Chuanad75ebe2009-11-27 23:42:26 +08001454http.minSessions::
1455 The number of curl sessions (counted across slots) to be kept across
1456 requests. They will not be ended with curl_easy_cleanup() until
1457 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1458 value will be capped at 1. Defaults to 1.
1459
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -07001460http.postBuffer::
1461 Maximum size in bytes of the buffer used by smart HTTP
1462 transports when POSTing data to the remote system.
1463 For requests larger than this buffer size, HTTP/1.1 and
1464 Transfer-Encoding: chunked is used to avoid creating a
1465 massive pack file locally. Default is 1 MiB, which is
1466 sufficient for most requests.
1467
Petr Baudis1ab661d2006-04-25 00:59:33 +02001468http.lowSpeedLimit, http.lowSpeedTime::
1469 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1470 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001471 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Petr Baudis1ab661d2006-04-25 00:59:33 +02001472 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1473
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001474http.noEPSV::
1475 A boolean which disables using of EPSV ftp command by curl.
Frank Lichtenheldbefc9c42007-04-13 18:02:33 +02001476 This can helpful with some "poor" ftp servers which don't
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001477 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1478 environment variable. Default is false (curl will use EPSV).
1479
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001480http.useragent::
1481 The HTTP USER_AGENT string presented to an HTTP server. The default
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001482 value represents the version of the client Git such as git/1.7.1.
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001483 This option allows you to override this value to a more common value
1484 such as Mozilla/4.0. This may be necessary, for instance, if
1485 connecting through a firewall that restricts HTTP connections to a set
1486 of common USER_AGENT strings (but not including those like git/1.7.1).
1487 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1488
Petr Baudis1ab661d2006-04-25 00:59:33 +02001489i18n.commitEncoding::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001490 Character encoding the commit messages are stored in; Git itself
Petr Baudis1ab661d2006-04-25 00:59:33 +02001491 does not care per se, but this information is necessary e.g. when
1492 importing commits from emails or in the gitk graphical history
1493 browser (and possibly at other places in the future or in other
Dan McGee5162e692007-12-29 00:20:38 -06001494 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Petr Baudis1ab661d2006-04-25 00:59:33 +02001495
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001496i18n.logOutputEncoding::
1497 Character encoding the commit messages are converted to when
Thomas Rast0b444cd2010-01-10 00:33:00 +01001498 running 'git log' and friends.
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001499
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001500imap::
1501 The configuration variables in the 'imap' section are described
1502 in linkgit:git-imap-send[1].
1503
Steven Draked8a84882010-02-17 12:44:46 +13001504init.templatedir::
1505 Specify the directory from which templates will be copied.
1506 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1507
Christian Couder983a9ee2008-01-08 04:55:14 +01001508instaweb.browser::
1509 Specify the program that will be used to browse your working
1510 repository in gitweb. See linkgit:git-instaweb[1].
1511
1512instaweb.httpd::
1513 The HTTP daemon command-line to start gitweb on your working
1514 repository. See linkgit:git-instaweb[1].
1515
1516instaweb.local::
1517 If true the web server started by linkgit:git-instaweb[1] will
1518 be bound to the local IP (127.0.0.1).
1519
1520instaweb.modulepath::
Ville Skyttä6b677a22010-07-20 00:17:17 +03001521 The default module path for linkgit:git-instaweb[1] to use
1522 instead of /usr/lib/apache2/modules. Only used if httpd
1523 is Apache.
Christian Couder983a9ee2008-01-08 04:55:14 +01001524
1525instaweb.port::
1526 The port number to bind the gitweb httpd to. See
1527 linkgit:git-instaweb[1].
1528
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001529interactive.singlekey::
Ori Avtalion57f6ec02009-08-07 17:24:21 +03001530 In interactive commands, allow the user to provide one-letter
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001531 input with a single key (i.e., without hitting enter).
Jeff King6cf378f2012-04-26 04:51:57 -04001532 Currently this is used by the `--patch` mode of
Conrad Irwine6b57a82011-05-07 10:59:04 -07001533 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1534 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1535 setting is silently ignored if portable keystroke input
1536 is not available.
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001537
Jay Soffian0c476952011-05-18 13:56:04 -04001538log.abbrevCommit::
1539 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Jeff King6cf378f2012-04-26 04:51:57 -04001540 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1541 override this option with `--no-abbrev-commit`.
Jay Soffian0c476952011-05-18 13:56:04 -04001542
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001543log.date::
Jonathan Niedere8607952010-08-20 05:20:36 -05001544 Set the default date-time mode for the 'log' command.
1545 Setting a value for log.date is similar to using 'git log''s
Jeff King6cf378f2012-04-26 04:51:57 -04001546 `--date` option. Possible values are `relative`, `local`,
Jonathan Niedere8607952010-08-20 05:20:36 -05001547 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1548 for details.
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001549
Steven Drakeeb734452010-02-17 12:39:52 +13001550log.decorate::
1551 Print out the ref names of any commits that are shown by the log
1552 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1553 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1554 specified, the full ref name (including prefix) will be printed.
1555 This is the same as the log commands '--decorate' option.
1556
Peter Baumann0f03ca92006-11-23 10:36:33 +01001557log.showroot::
1558 If true, the initial commit will be shown as a big creation event.
1559 This is equivalent to a diff against an empty tree.
Dan McGee5162e692007-12-29 00:20:38 -06001560 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Peter Baumann0f03ca92006-11-23 10:36:33 +01001561 normally hide the root commit will now show it. True by default.
1562
Antoine Pelissee6bb5f72013-01-05 22:26:46 +01001563log.mailmap::
1564 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1565 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1566
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001567mailmap.file::
1568 The location of an augmenting mailmap file. The default
1569 mailmap, located in the root of the repository, is loaded
1570 first, then the mailmap file pointed to by this variable.
1571 The location of the mailmap file may be in a repository
1572 subdirectory, or somewhere outside of the repository itself.
1573 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1574
Jeff King08610902012-12-12 06:04:04 -05001575mailmap.blob::
1576 Like `mailmap.file`, but consider the value as a reference to a
Jeff King8c473ce2012-12-13 08:04:47 -05001577 blob in the repository. If both `mailmap.file` and
1578 `mailmap.blob` are given, both are parsed, with entries from
1579 `mailmap.file` taking precedence. In a bare repository, this
1580 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1581 defaults to empty.
Jeff King08610902012-12-12 06:04:04 -05001582
Christian Couderb5578f32008-03-07 08:46:55 +01001583man.viewer::
Christian Couderb8322ea2008-03-13 06:48:46 +01001584 Specify the programs that may be used to display help in the
Christian Couderb5578f32008-03-07 08:46:55 +01001585 'man' format. See linkgit:git-help[1].
1586
Christian Couder0bb64002008-04-25 08:25:35 +02001587man.<tool>.cmd::
1588 Specify the command to invoke the specified man viewer. The
1589 specified command is evaluated in shell with the man page
1590 passed as argument. (See linkgit:git-help[1].)
1591
Christian Couder7e8114c2008-04-25 08:24:41 +02001592man.<tool>.path::
1593 Override the path for the given tool that may be used to
1594 display help in the 'man' format. See linkgit:git-help[1].
1595
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001596include::merge-config.txt[]
Junio C Hamanob5412482008-08-29 10:49:56 -07001597
Johannes Schindelin77680ca2007-12-17 12:21:22 +00001598mergetool.<tool>.path::
1599 Override the path for the given tool. This is useful in case
1600 your tool is not in the PATH.
1601
Charles Bailey964473a2008-02-21 23:31:12 +00001602mergetool.<tool>.cmd::
1603 Specify the command to invoke the specified merge tool. The
1604 specified command is evaluated in shell with the following
1605 variables available: 'BASE' is the name of a temporary file
1606 containing the common base of the files to be merged, if available;
1607 'LOCAL' is the name of a temporary file containing the contents of
1608 the file on the current branch; 'REMOTE' is the name of a temporary
1609 file containing the contents of the file from the branch being
1610 merged; 'MERGED' contains the name of the file to which the merge
1611 tool should write the results of a successful merge.
1612
1613mergetool.<tool>.trustExitCode::
1614 For a custom merge command, specify whether the exit code of
1615 the merge command can be used to determine whether the merge was
1616 successful. If this is not set to true then the merge target file
1617 timestamp is checked and the merge assumed to have been successful
1618 if the file has been updated, otherwise the user is prompted to
1619 indicate the success of the merge.
1620
Charles Bailey44c36d12008-02-21 23:30:02 +00001621mergetool.keepBackup::
1622 After performing a merge, the original file with conflict markers
1623 can be saved as a file with a `.orig` extension. If this variable
1624 is set to `false` then this file is not preserved. Defaults to
1625 `true` (i.e. keep the backup files).
1626
Charles Bailey162eba82008-12-12 21:48:41 +00001627mergetool.keepTemporaries::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001628 When invoking a custom merge tool, Git uses a set of temporary
Charles Bailey162eba82008-12-12 21:48:41 +00001629 files to pass to the tool. If the tool returns an error and this
1630 variable is set to `true`, then these temporary files will be
1631 preserved, otherwise they will be removed after the tool has
1632 exited. Defaults to `false`.
1633
Charles Bailey682b4512008-11-13 12:41:14 +00001634mergetool.prompt::
1635 Prompt before each invocation of the merge resolution program.
1636
Thomas Rast894a9d32010-03-12 18:04:26 +01001637notes.displayRef::
1638 The (fully qualified) refname from which to show notes when
1639 showing commit messages. The value of this variable can be set
1640 to a glob, in which case notes from all matching refs will be
1641 shown. You may also specify this configuration variable
1642 several times. A warning will be issued for refs that do not
1643 exist, but a glob that does not match any refs is silently
1644 ignored.
1645+
1646This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1647environment variable, which must be a colon separated list of refs or
1648globs.
1649+
1650The effective value of "core.notesRef" (possibly overridden by
1651GIT_NOTES_REF) is also implicitly added to the list of refs to be
1652displayed.
1653
Thomas Rast6956f852010-03-12 18:04:32 +01001654notes.rewrite.<command>::
1655 When rewriting commits with <command> (currently `amend` or
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001656 `rebase`) and this variable is set to `true`, Git
Thomas Rast6956f852010-03-12 18:04:32 +01001657 automatically copies your notes from the original to the
1658 rewritten commit. Defaults to `true`, but see
1659 "notes.rewriteRef" below.
Thomas Rast6956f852010-03-12 18:04:32 +01001660
1661notes.rewriteMode::
1662 When copying notes during a rewrite (see the
1663 "notes.rewrite.<command>" option), determines what to do if
1664 the target commit already has a note. Must be one of
1665 `overwrite`, `concatenate`, or `ignore`. Defaults to
1666 `concatenate`.
1667+
1668This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1669environment variable.
1670
1671notes.rewriteRef::
1672 When copying notes during a rewrite, specifies the (fully
1673 qualified) ref whose notes should be copied. The ref may be a
1674 glob, in which case notes in all matching refs will be copied.
1675 You may also specify this configuration several times.
1676+
1677Does not have a default value; you must configure this variable to
Thomas Rast2b4aa892011-09-13 09:32:42 +02001678enable note rewriting. Set it to `refs/notes/commits` to enable
1679rewriting for the default commit notes.
Leif Arne Storsetcfb88e92010-05-05 16:16:25 +02001680+
1681This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1682environment variable, which must be a colon separated list of refs or
1683globs.
Thomas Rast6956f852010-03-12 18:04:32 +01001684
Jeff King4812a932006-07-23 01:50:30 -04001685pack.window::
Dan McGee5162e692007-12-29 00:20:38 -06001686 The size of the window used by linkgit:git-pack-objects[1] when no
Jeff King4812a932006-07-23 01:50:30 -04001687 window size is given on the command line. Defaults to 10.
1688
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001689pack.depth::
Dan McGee5162e692007-12-29 00:20:38 -06001690 The maximum delta depth used by linkgit:git-pack-objects[1] when no
Theodore Ts'o618e6132007-05-08 09:28:26 -04001691 maximum depth is given on the command line. Defaults to 50.
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001692
Brian Downinge93b15c2007-07-12 07:55:52 -05001693pack.windowMemory::
Dan McGee5162e692007-12-29 00:20:38 -06001694 The window memory size limit used by linkgit:git-pack-objects[1]
Brian Downinge93b15c2007-07-12 07:55:52 -05001695 when no limit is given on the command line. The value can be
1696 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1697 limit.
1698
Dana How960ccca2007-05-09 13:56:50 -07001699pack.compression::
1700 An integer -1..9, indicating the compression level for objects
1701 in a pack file. -1 is the zlib default. 0 means no
1702 compression, and 1..9 are various speed/size tradeoffs, 9 being
1703 slowest. If not set, defaults to core.compression. If that is
Brian Downingdec92302007-11-19 10:58:51 -06001704 not set, defaults to -1, the zlib default, which is "a default
1705 compromise between speed and compression (currently equivalent
1706 to level 6)."
Jan Krüger89d71f72010-09-27 14:21:58 +02001707+
1708Note that changing the compression level will not automatically recompress
1709all existing objects. You can force recompression by passing the -F option
1710to linkgit:git-repack[1].
Dana How960ccca2007-05-09 13:56:50 -07001711
Martin Koegler074b2ee2007-05-28 23:20:58 +02001712pack.deltaCacheSize::
Brian Hetro02783072007-08-23 20:44:13 -04001713 The maximum memory in bytes used for caching deltas in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001714 linkgit:git-pack-objects[1] before writing them out to a pack.
1715 This cache is used to speed up the writing object phase by not
1716 having to recompute the final delta result once the best match
1717 for all objects is found. Repacking large repositories on machines
1718 which are tight with memory might be badly impacted by this though,
1719 especially if this cache pushes the system into swapping.
1720 A value of 0 means no limit. The smallest size of 1 byte may be
1721 used to virtually disable this cache. Defaults to 256 MiB.
Martin Koegler074b2ee2007-05-28 23:20:58 +02001722
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001723pack.deltaCacheLimit::
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001724 The maximum size of a delta, that is cached in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001725 linkgit:git-pack-objects[1]. This cache is used to speed up the
1726 writing object phase by not having to recompute the final delta
1727 result once the best match for all objects is found. Defaults to 1000.
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001728
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001729pack.threads::
1730 Specifies the number of threads to spawn when searching for best
Dan McGee5162e692007-12-29 00:20:38 -06001731 delta matches. This requires that linkgit:git-pack-objects[1]
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001732 be compiled with pthreads otherwise this option is ignored with a
1733 warning. This is meant to reduce packing time on multiprocessor
1734 machines. The required amount of memory for the delta search window
1735 is however multiplied by the number of threads.
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001736 Specifying 0 will cause Git to auto-detect the number of CPU's
Andreas Ericsson833e3df2008-02-22 20:11:56 -06001737 and set the number of threads accordingly.
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001738
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001739pack.indexVersion::
1740 Specify the default pack index version. Valid values are 1 for
1741 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1742 the new pack index with capabilities for packs larger than 4 GB
1743 as well as proper protection against the repacking of corrupted
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001744 packs. Version 2 is the default. Note that version 2 is enforced
1745 and this config option ignored whenever the corresponding pack is
1746 larger than 2 GB.
1747+
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001748If you have an old Git that does not understand the version 2 `*.idx` file,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001749cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Jeff King6cf378f2012-04-26 04:51:57 -04001750that will copy both `*.pack` file and corresponding `*.idx` file from the
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001751other side may give you a repository that cannot be accessed with your
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001752older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001753you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Jeff King6cf378f2012-04-26 04:51:57 -04001754the `*.idx` file.
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001755
Junio C Hamanodbdbfec2008-03-12 23:11:15 -07001756pack.packSizeLimit::
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001757 The maximum size of a pack. This setting only affects
1758 packing to a file when repacking, i.e. the git:// protocol
Jeff King6cf378f2012-04-26 04:51:57 -04001759 is unaffected. It can be overridden by the `--max-pack-size`
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001760 option of linkgit:git-repack[1]. The minimum size allowed is
1761 limited to 1 MiB. The default is unlimited.
1762 Common unit suffixes of 'k', 'm', or 'g' are
1763 supported.
Johannes Schindelin2b84b5a2008-02-05 14:25:04 +00001764
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001765pager.<cmd>::
Jeff King9bad7232010-11-17 12:04:12 -05001766 If the value is boolean, turns on or off pagination of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001767 output of a particular Git subcommand when writing to a tty.
Jeff King9bad7232010-11-17 12:04:12 -05001768 Otherwise, turns on pagination for the subcommand using the
Jeff King6cf378f2012-04-26 04:51:57 -04001769 pager specified by the value of `pager.<cmd>`. If `--paginate`
1770 or `--no-pager` is specified on the command line, it takes
Jeff King9bad7232010-11-17 12:04:12 -05001771 precedence over this option. To disable pagination for all
1772 commands, set `core.pager` or `GIT_PAGER` to `cat`.
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001773
Will Palmer80281842010-05-02 12:00:44 +01001774pretty.<name>::
1775 Alias for a --pretty= format string, as specified in
1776 linkgit:git-log[1]. Any aliases defined here can be used just
1777 as the built-in pretty formats could. For example,
Jeff King6cf378f2012-04-26 04:51:57 -04001778 running `git config pretty.changelog "format:* %H %s"`
Will Palmer80281842010-05-02 12:00:44 +01001779 would cause the invocation `git log --pretty=changelog`
Jeff King6cf378f2012-04-26 04:51:57 -04001780 to be equivalent to running `git log "--pretty=format:* %H %s"`.
Will Palmer80281842010-05-02 12:00:44 +01001781 Note that an alias with the same name as a built-in format
1782 will be silently ignored.
1783
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001784pull.rebase::
1785 When true, rebase branches on top of the fetched branch, instead
1786 of merging the default branch from the default remote when "git
1787 pull" is run. See "branch.<name>.rebase" for setting this on a
1788 per-branch basis.
1789+
1790*NOTE*: this is a possibly dangerous operation; do *not* use
1791it unless you understand the implications (see linkgit:git-rebase[1]
1792for details).
1793
Petr Baudis1ab661d2006-04-25 00:59:33 +02001794pull.octopus::
1795 The default merge strategy to use when pulling multiple branches
1796 at once.
1797
1798pull.twohead::
1799 The default merge strategy to use when pulling a single branch.
1800
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001801push.default::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001802 Defines the action `git push` should take if no refspec is given
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001803 on the command line, no refspec is configured in the remote, and
1804 no refspec is implied by any of the options given on the command
Santi Béjar01eadaf2009-03-30 12:11:41 +02001805 line. Possible values are:
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001806+
Andreas Schwabb1290512012-06-23 15:18:00 +02001807--
Cliff Frey9373bdc2010-10-17 20:10:45 -07001808* `nothing` - do not push anything.
Matthieu Moy185c0872012-04-24 09:50:00 +02001809* `matching` - push all branches having the same name in both ends.
1810 This is for those who prepare all the branches into a publishable
1811 shape and then push them out with a single command. It is not
1812 appropriate for pushing into a repository shared by multiple users,
1813 since locally stalled branches will attempt a non-fast forward push
Matthieu Moy67804c22012-04-24 09:50:05 +02001814 if other users updated the branch.
1815 +
1816 This is currently the default, but Git 2.0 will change the default
1817 to `simple`.
Junio C Hamanofa233482013-01-31 12:50:38 -08001818* `upstream` - push the current branch to its upstream branch
1819 (`tracking` is a deprecated synonym for this).
Matthieu Moy185c0872012-04-24 09:50:00 +02001820 With this, `git push` will update the same remote ref as the one which
1821 is merged by `git pull`, making `push` and `pull` symmetrical.
1822 See "branch.<name>.merge" for how to configure the upstream branch.
Junio C Hamanof4d80d22012-04-24 12:21:12 -07001823* `simple` - like `upstream`, but refuses to push if the upstream
1824 branch's name is different from the local one. This is the safest
1825 option and is well-suited for beginners. It will become the default
1826 in Git 2.0.
Cliff Frey9373bdc2010-10-17 20:10:45 -07001827* `current` - push the current branch to a branch of the same name.
Andreas Schwabb1290512012-06-23 15:18:00 +02001828--
1829+
1830The `simple`, `current` and `upstream` modes are for those who want to
1831push out a single branch after finishing work, even when the other
1832branches are not yet ready to be pushed out. If you are working with
1833other people to push into the same shared repository, you would want
1834to use one of these.
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001835
Tor Arne Vestbøa9c38212009-03-01 23:11:38 +01001836rebase.stat::
1837 Whether to show a diffstat of what changed upstream since the last
1838 rebase. False by default.
1839
Heiko Voigtdd1e5b32010-07-14 13:59:57 +02001840rebase.autosquash::
1841 If set to true enable '--autosquash' option by default.
1842
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001843receive.autogc::
1844 By default, git-receive-pack will run "git-gc --auto" after
1845 receiving data from git-push and updating refs. You can stop
1846 it by setting this variable to false.
1847
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001848receive.fsckObjects::
1849 If it is set to true, git-receive-pack will check all received
1850 objects. It will abort in the case of a malformed object or a
1851 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001852 Defaults to false. If not set, the value of `transfer.fsckObjects`
1853 is used instead.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001854
1855receive.unpackLimit::
1856 If the number of objects received in a push is below this
1857 limit then the objects will be unpacked into loose object
1858 files. However if the number of received objects equals or
1859 exceeds this limit then the received pack will be stored as
1860 a pack, after adding any missing delta bases. Storing the
1861 pack from a push can make the push operation complete faster,
1862 especially on slow filesystems. If not set, the value of
1863 `transfer.unpackLimit` is used instead.
1864
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001865receive.denyDeletes::
1866 If set to true, git-receive-pack will deny a ref update that deletes
1867 the ref. Use this to prevent such a ref deletion via a push.
1868
Thomas Rast662c83f2010-07-24 18:07:53 +02001869receive.denyDeleteCurrent::
1870 If set to true, git-receive-pack will deny a ref update that
1871 deletes the currently checked out branch of a non-bare repository.
1872
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001873receive.denyCurrentBranch::
Michael J Gruberf3838ce2010-05-13 14:51:38 +02001874 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001875 to the currently checked out branch of a non-bare repository.
1876 Such a push is potentially dangerous because it brings the HEAD
1877 out of sync with the index and working tree. If set to "warn",
1878 print a warning of such a push to stderr, but allow the push to
1879 proceed. If set to false or "ignore", allow such pushes with no
Thomas Rast7d182f52010-03-17 12:14:57 +01001880 message. Defaults to "refuse".
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001881
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001882receive.denyNonFastForwards::
1883 If set to true, git-receive-pack will deny a ref update which is
Felipe Contrerasa75d7b52009-10-24 11:31:32 +03001884 not a fast-forward. Use this to prevent such an update via a push,
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001885 even if that push is forced. This configuration variable is
1886 set when initializing a shared repository.
1887
Junio C Hamanodaebaa72013-01-18 16:08:30 -08001888receive.hiderefs::
1889 String(s) `receive-pack` uses to decide which refs to omit
1890 from its initial advertisement. Use more than one
1891 definitions to specify multiple prefix strings. A ref that
1892 are under the hierarchies listed on the value of this
1893 variable is excluded, and is hidden when responding to `git
1894 push`, and an attempt to update or delete a hidden ref by
1895 `git push` is rejected.
1896
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001897receive.updateserverinfo::
1898 If set to true, git-receive-pack will run git-update-server-info
1899 after receiving data from git-push and updating refs.
1900
Santi Béjar0cc6d342006-10-23 18:42:14 +02001901remote.<name>.url::
Dan McGee5162e692007-12-29 00:20:38 -06001902 The URL of a remote repository. See linkgit:git-fetch[1] or
1903 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001904
Michael J Gruber20346232009-06-09 18:01:34 +02001905remote.<name>.pushurl::
1906 The push URL of a remote repository. See linkgit:git-push[1].
1907
Sam Vilain14c98212007-12-04 10:48:54 +13001908remote.<name>.proxy::
1909 For remotes that require curl (http, https and ftp), the URL to
1910 the proxy to use for that remote. Set to the empty string to
1911 disable proxying for that remote.
1912
Santi Béjar0cc6d342006-10-23 18:42:14 +02001913remote.<name>.fetch::
Dan McGee5162e692007-12-29 00:20:38 -06001914 The default set of "refspec" for linkgit:git-fetch[1]. See
1915 linkgit:git-fetch[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001916
1917remote.<name>.push::
Dan McGee5162e692007-12-29 00:20:38 -06001918 The default set of "refspec" for linkgit:git-push[1]. See
1919 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001920
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001921remote.<name>.mirror::
1922 If true, pushing to this remote will automatically behave
Jeff King6cf378f2012-04-26 04:51:57 -04001923 as if the `--mirror` option was given on the command line.
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001924
Theodore Ts'o19182782007-02-20 15:13:43 -05001925remote.<name>.skipDefaultUpdate::
1926 If true, this remote will be skipped by default when updating
Björn Gustavsson7cc91a22009-11-09 21:11:06 +01001927 using linkgit:git-fetch[1] or the `update` subcommand of
1928 linkgit:git-remote[1].
1929
1930remote.<name>.skipFetchAll::
1931 If true, this remote will be skipped by default when updating
1932 using linkgit:git-fetch[1] or the `update` subcommand of
1933 linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001934
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001935remote.<name>.receivepack::
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001936 The default program to execute on the remote side when pushing. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001937 option \--receive-pack of linkgit:git-push[1].
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001938
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001939remote.<name>.uploadpack::
1940 The default program to execute on the remote side when fetching. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001941 option \--upload-pack of linkgit:git-fetch-pack[1].
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001942
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301943remote.<name>.tagopt::
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001944 Setting this value to \--no-tags disables automatic tag following when
Samuel Tardieu944163a2010-04-20 01:31:25 +02001945 fetching from remote <name>. Setting it to \--tags will fetch every
1946 tag from remote <name>, even if they are not reachable from remote
Daniel Johnsoned368542010-08-11 18:57:20 -04001947 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1948 override this setting. See options \--tags and \--no-tags of
1949 linkgit:git-fetch[1].
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301950
Daniel Barkalowc578f512009-11-18 02:42:25 +01001951remote.<name>.vcs::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001952 Setting this to a value <vcs> will cause Git to interact with
Daniel Barkalowc578f512009-11-18 02:42:25 +01001953 the remote with the git-remote-<vcs> helper.
1954
Theodore Ts'o19182782007-02-20 15:13:43 -05001955remotes.<group>::
1956 The list of remotes which are fetched by "git remote update
Dan McGee5162e692007-12-29 00:20:38 -06001957 <group>". See linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001958
Junio C Hamanob6945f52006-10-13 21:28:58 -07001959repack.usedeltabaseoffset::
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04001960 By default, linkgit:git-repack[1] creates packs that use
1961 delta-base offset. If you need to share your repository with
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001962 Git older than version 1.4.4, either directly or via a dumb
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04001963 protocol such as http, then you need to set this option to
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001964 "false" and repack. Access from old Git versions over the
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04001965 native protocol are unaffected by this option.
Junio C Hamanob6945f52006-10-13 21:28:58 -07001966
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001967rerere.autoupdate::
1968 When set to true, `git-rerere` updates the index with the
1969 resulting contents after it cleanly resolves conflicts using
1970 previously recorded resolution. Defaults to false.
1971
1972rerere.enabled::
1973 Activate recording of resolved conflicts, so that identical
Thomas Rast07b88a02012-01-06 14:08:02 +01001974 conflict hunks can be resolved automatically, should they be
1975 encountered again. By default, linkgit:git-rerere[1] is
1976 enabled if there is an `rr-cache` directory under the
Junio C Hamanob6fb7fe2012-01-10 15:57:27 +01001977 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1978 repository.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001979
Yann Dirson65180c62009-07-22 23:39:30 +02001980sendemail.identity::
1981 A configuration identity. When given, causes values in the
1982 'sendemail.<identity>' subsection to take precedence over
1983 values in the 'sendemail' section. The default identity is
1984 the value of 'sendemail.identity'.
1985
1986sendemail.smtpencryption::
1987 See linkgit:git-send-email[1] for description. Note that this
1988 setting is not subject to the 'identity' mechanism.
1989
1990sendemail.smtpssl::
1991 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1992
1993sendemail.<identity>.*::
1994 Identity-specific versions of the 'sendemail.*' parameters
1995 found below, taking precedence over those when the this
1996 identity is selected, through command-line or
1997 'sendemail.identity'.
1998
1999sendemail.aliasesfile::
2000sendemail.aliasfiletype::
Felipe Contreras402596a2013-04-07 01:10:27 -06002001sendemail.annotate::
Yann Dirson65180c62009-07-22 23:39:30 +02002002sendemail.bcc::
2003sendemail.cc::
2004sendemail.cccmd::
2005sendemail.chainreplyto::
2006sendemail.confirm::
2007sendemail.envelopesender::
2008sendemail.from::
2009sendemail.multiedit::
2010sendemail.signedoffbycc::
2011sendemail.smtppass::
2012sendemail.suppresscc::
2013sendemail.suppressfrom::
2014sendemail.to::
Brian Gernhardt69cf7bf2010-04-10 10:53:56 -04002015sendemail.smtpdomain::
Yann Dirson65180c62009-07-22 23:39:30 +02002016sendemail.smtpserver::
2017sendemail.smtpserverport::
Pascal Obry052fbea2010-09-06 20:12:11 +02002018sendemail.smtpserveroption::
Yann Dirson65180c62009-07-22 23:39:30 +02002019sendemail.smtpuser::
2020sendemail.thread::
2021sendemail.validate::
2022 See linkgit:git-send-email[1] for description.
2023
2024sendemail.signedoffcc::
2025 Deprecated alias for 'sendemail.signedoffbycc'.
2026
Petr Baudis1ab661d2006-04-25 00:59:33 +02002027showbranch.default::
Dan McGee5162e692007-12-29 00:20:38 -06002028 The default set of branches for linkgit:git-show-branch[1].
2029 See linkgit:git-show-branch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002030
Jeff King46f721c2007-12-07 16:26:07 -05002031status.relativePaths::
Dan McGee5162e692007-12-29 00:20:38 -06002032 By default, linkgit:git-status[1] shows paths relative to the
Jeff King46f721c2007-12-07 16:26:07 -05002033 current directory. Setting this variable to `false` shows paths
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002034 relative to the repository root (this was the default for Git
Jeff King46f721c2007-12-07 16:26:07 -05002035 prior to v1.5.4).
2036
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02002037status.showUntrackedFiles::
2038 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2039 files which are not currently tracked by Git. Directories which
2040 contain only untracked files, are shown with the directory name
2041 only. Showing untracked files means that Git needs to lstat() all
2042 all the files in the whole repository, which might be slow on some
2043 systems. So, this variable controls how the commands displays
2044 the untracked files. Possible values are:
2045+
2046--
Cliff Frey9373bdc2010-10-17 20:10:45 -07002047* `no` - Show no untracked files.
2048* `normal` - Show untracked files and directories.
2049* `all` - Show also individual files in untracked directories.
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02002050--
2051+
2052If this variable is not specified, it defaults to 'normal'.
2053This variable can be overridden with the -u|--untracked-files option
2054of linkgit:git-status[1] and linkgit:git-commit[1].
2055
Michael J Gruber4b2343f2010-05-20 17:55:42 +02002056status.submodulesummary::
2057 Defaults to false.
2058 If this is set to a non zero number or true (identical to -1 or an
2059 unlimited number), the submodule summary will be enabled and a
2060 summary of commits for modified submodules will be shown (see
2061 --summary-limit option of linkgit:git-submodule[1]).
2062
Jonathan Nieder0ad0a612010-07-15 02:51:19 -05002063submodule.<name>.path::
2064submodule.<name>.url::
2065submodule.<name>.update::
2066 The path within this project, URL, and the updating strategy
2067 for a submodule. These variables are initially populated
2068 by 'git submodule init'; edit them to override the
2069 URL and other values found in the `.gitmodules` file. See
2070 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2071
W. Trevor King06b1abb2012-12-19 11:03:32 -05002072submodule.<name>.branch::
2073 The remote branch name for a submodule, used by `git submodule
2074 update --remote`. Set this option to override the value found in
2075 the `.gitmodules` file. See linkgit:git-submodule[1] and
2076 linkgit:gitmodules[5] for details.
2077
Jens Lehmannc1a3c362010-11-11 00:55:41 +01002078submodule.<name>.fetchRecurseSubmodules::
Jens Lehmannbf42b382011-03-06 23:12:19 +01002079 This option can be used to control recursive fetching of this
Ralf Wildenhues469bfc92011-01-03 20:03:34 +01002080 submodule. It can be overridden by using the --[no-]recurse-submodules
Jens Lehmannc1a3c362010-11-11 00:55:41 +01002081 command line option to "git fetch" and "git pull".
2082 This setting will override that from in the linkgit:gitmodules[5]
2083 file.
2084
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002085submodule.<name>.ignore::
2086 Defines under what circumstances "git status" and the diff family show
2087 a submodule as modified. When set to "all", it will never be considered
2088 modified, "dirty" will ignore all changes to the submodules work tree and
2089 takes only differences between the HEAD of the submodule and the commit
2090 recorded in the superproject into account. "untracked" will additionally
2091 let submodules with modified tracked files in their work tree show up.
2092 Using "none" (the default when this option is not set) also shows
2093 submodules that have untracked files in their work tree as changed.
Jens Lehmann302ad7a2010-08-06 00:40:48 +02002094 This setting overrides any setting made in .gitmodules for this submodule,
Ralf Wildenhues3776ea92010-08-22 13:12:12 +02002095 both settings can be overridden on the command line by using the
Johannes Schindelinbe4f2b42010-08-05 10:49:55 +02002096 "--ignore-submodules" option.
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002097
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002098tar.umask::
René Scharfe687157c2007-08-21 20:01:16 +02002099 This variable can be used to restrict the permission bits of
2100 tar archive entries. The default is 0002, which turns off the
2101 world write bit. The special value "user" indicates that the
2102 archiving user's umask will be used instead. See umask(2) and
Dan McGee5162e692007-12-29 00:20:38 -06002103 linkgit:git-archive[1].
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002104
Junio C Hamanodab76d32011-09-04 12:37:45 -07002105transfer.fsckObjects::
2106 When `fetch.fsckObjects` or `receive.fsckObjects` are
2107 not set, the value of this variable is used instead.
2108 Defaults to false.
2109
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002110transfer.hiderefs::
2111 This variable can be used to set both `receive.hiderefs`
2112 and `uploadpack.hiderefs` at the same time to the same
2113 values. See entries for these other variables.
2114
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002115transfer.unpackLimit::
2116 When `fetch.unpackLimit` or `receive.unpackLimit` are
2117 not set, the value of this variable is used instead.
2118 The default value is 100.
2119
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002120uploadpack.hiderefs::
2121 String(s) `upload-pack` uses to decide which refs to omit
2122 from its initial advertisement. Use more than one
2123 definitions to specify multiple prefix strings. A ref that
2124 are under the hierarchies listed on the value of this
2125 variable is excluded, and is hidden from `git ls-remote`,
2126 `git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano390eb362013-01-28 21:49:57 -08002127 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2128
2129uploadpack.allowtipsha1inwant::
2130 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2131 to accept a fetch request that asks for an object at the tip
2132 of a hidden ref (by default, such a request is rejected).
2133 see also `uploadpack.hiderefs`.
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002134
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002135url.<base>.insteadOf::
2136 Any URL that starts with this value will be rewritten to
2137 start, instead, with <base>. In cases where some site serves a
2138 large number of repositories, and serves them with multiple
2139 access methods, and some users need to use different access
2140 methods, this feature allows people to specify any of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002141 equivalent URLs and have Git automatically rewrite the URL to
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002142 the best alternative for the particular user, even for a
Junio C Hamano844112c2008-02-24 22:25:04 -08002143 never-before-seen repository on the site. When more than one
2144 insteadOf strings match a given URL, the longest match is used.
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002145
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002146url.<base>.pushInsteadOf::
2147 Any URL that starts with this value will not be pushed to;
2148 instead, it will be rewritten to start with <base>, and the
2149 resulting URL will be pushed to. In cases where some site serves
2150 a large number of repositories, and serves them with multiple
2151 access methods, some of which do not allow push, this feature
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002152 allows people to specify a pull-only URL and have Git
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002153 automatically use an appropriate URL to push, even for a
2154 never-before-seen repository on the site. When more than one
2155 pushInsteadOf strings match a given URL, the longest match is
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002156 used. If a remote has an explicit pushurl, Git will ignore this
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002157 setting for that remote.
2158
Petr Baudis1ab661d2006-04-25 00:59:33 +02002159user.email::
2160 Your email address to be recorded in any newly created commits.
Josh Triplett28a94f82007-04-28 18:40:28 -07002161 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Dan McGee5162e692007-12-29 00:20:38 -06002162 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002163
2164user.name::
2165 Your full name to be recorded in any newly created commits.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04002166 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Dan McGee5162e692007-12-29 00:20:38 -06002167 environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002168
Andy Parkinsd67778e2007-01-26 14:13:46 +00002169user.signingkey::
Dan McGee5162e692007-12-29 00:20:38 -06002170 If linkgit:git-tag[1] is not selecting the key you want it to
Andy Parkinsd67778e2007-01-26 14:13:46 +00002171 automatically when creating a signed tag, you can override the
2172 default selection with this variable. This option is passed
2173 unchanged to gpg's --local-user parameter, so you may specify a key
2174 using any method that gpg supports.
2175
Christian Couder983a9ee2008-01-08 04:55:14 +01002176web.browser::
2177 Specify a web browser that may be used by some commands.
2178 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2179 may use it.