blob: 4781773e6a80fbbd62a5eb562b959e1a7d296cb2 [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
Richard Hansena8a54062013-09-04 15:04:31 -0400173 object that is not a commit-ish, or make the remote
174 ref point at an object that is not a commit-ish.
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.
Mathieu Lienard--Mayor7e309442013-06-12 10:06:44 +0200202 rmHints::
203 In case of failure in the output of linkgit:git-rm[1],
204 show directions on how to proceed from the current state.
Jeff King75194432009-09-09 07:38:58 -0400205--
206
Petr Baudis1ab661d2006-04-25 00:59:33 +0200207core.fileMode::
208 If false, the executable bit differences between the index and
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200209 the working tree are ignored; useful on broken filesystems like FAT.
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700210 See linkgit:git-update-index[1].
211+
212The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213will probe and set core.fileMode false if appropriate when the
214repository is created.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200215
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700216core.ignorecase::
217 If true, this option enables various workarounds to enable
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100218 Git to work better on filesystems that are not case sensitive,
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700219 like FAT. For example, if a directory listing finds
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100220 "makefile" when Git expects "Makefile", Git will assume
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700221 it is really the same file, and continue to remember it as
222 "Makefile".
223+
224The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
225will probe and set core.ignorecase true if appropriate when the repository
226is created.
227
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200228core.precomposeunicode::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100229 This option is only used by Mac OS implementation of Git.
230 When core.precomposeunicode=true, Git reverts the unicode decomposition
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200231 of filenames done by Mac OS. This is useful when sharing a repository
232 between Mac OS and Linux or Windows.
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100233 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
234 When false, file names are handled fully transparent by Git,
235 which is backward compatible with older versions of Git.
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200236
Alex Riesen1ce47902008-07-28 08:31:28 +0200237core.trustctime::
238 If false, the ctime differences between the index and the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200239 working tree are ignored; useful when the inode change time
Alex Riesen1ce47902008-07-28 08:31:28 +0200240 is regularly modified by something outside Git (file system
241 crawlers and some backup systems).
242 See linkgit:git-update-index[1]. True by default.
243
Robin Rosenbergc08e4d52013-01-22 08:49:22 +0100244core.checkstat::
245 Determines which stat fields to match between the index
246 and work tree. The user can set this to 'default' or
247 'minimal'. Default (or explicitly 'default'), is to check
248 all fields, including the sub-second part of mtime and ctime.
249
Junio C Hamano9378c162007-06-24 15:11:24 -0700250core.quotepath::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500251 The commands that output paths (e.g. 'ls-files',
252 'diff'), when not given the `-z` option, will quote
Junio C Hamano9378c162007-06-24 15:11:24 -0700253 "unusual" characters in the pathname by enclosing the
254 pathname in a double-quote pair and with backslashes the
255 same way strings in C source code are quoted. If this
256 variable is set to false, the bytes higher than 0x80 are
257 not quoted but output as verbatim. Note that double
258 quote, backslash and control characters are always
259 quoted without `-z` regardless of the setting of this
260 variable.
261
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200262core.eol::
263 Sets the line ending type to use in the working directory for
264 files that have the `text` property set. Alternatives are
265 'lf', 'crlf' and 'native', which uses the platform's native
266 line ending. The default value is `native`. See
267 linkgit:gitattributes[5] for more information on end-of-line
268 conversion.
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200269
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100270core.safecrlf::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100271 If true, makes Git check if converting `CRLF` is reversible when
Eyvind Bernhardsenfd6cce92010-05-19 22:43:10 +0200272 end-of-line conversion is active. Git will verify if a command
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100273 modifies a file in the work tree either directly or indirectly.
274 For example, committing a file followed by checking out the
275 same file should yield the original file in the work tree. If
276 this is not the case for the current setting of
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100277 `core.autocrlf`, Git will reject the file. The variable can
278 be set to "warn", in which case Git will only warn about an
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100279 irreversible conversion but continue the operation.
280+
281CRLF conversion bears a slight chance of corrupting data.
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100282When it is enabled, Git will convert CRLF to LF during commit and LF to
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100283CRLF during checkout. A file that contains a mixture of LF and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100284CRLF before the commit cannot be recreated by Git. For text
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100285files this is the right thing to do: it corrects line endings
286such that we have only LF line endings in the repository.
287But for binary files that are accidentally classified as text the
288conversion can corrupt data.
289+
290If you recognize such corruption early you can easily fix it by
291setting the conversion type explicitly in .gitattributes. Right
292after committing you still have the original file in your work
293tree and this file is not yet corrupted. You can explicitly tell
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100294Git that this file is binary and Git will handle the file
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100295appropriately.
296+
297Unfortunately, the desired effect of cleaning up text files with
298mixed line endings and the undesired effect of corrupting binary
299files cannot be distinguished. In both cases CRLFs are removed
300in an irreversible way. For text files this is the right thing
301to do because CRLFs are line endings, while for binary files
302converting CRLFs corrupts data.
303+
304Note, this safety check does not mean that a checkout will generate a
305file identical to the original file for a different setting of
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200306`core.eol` and `core.autocrlf`, but only for the current one. For
307example, a text file with `LF` would be accepted with `core.eol=lf`
308and could later be checked out with `core.eol=crlf`, in which case the
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100309resulting file would contain `CRLF`, although the original file
310contained `LF`. However, in both work trees the line endings would be
311consistent, that is either all `LF` or all `CRLF`, but never mixed. A
312file with mixed line endings would be reported by the `core.safecrlf`
313mechanism.
314
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200315core.autocrlf::
316 Setting this variable to "true" is almost the same as setting
317 the `text` attribute to "auto" on all files except that text
318 files are not guaranteed to be normalized: files that contain
319 `CRLF` in the repository will not be touched. Use this
320 setting if you want to have `CRLF` line endings in your
321 working directory even though the repository does not have
322 normalized line endings. This variable can be set to 'input',
323 in which case no output conversion is performed.
324
Johannes Sixt78a8d642007-03-02 22:11:30 +0100325core.symlinks::
326 If false, symbolic links are checked out as small plain files that
Dan McGee5162e692007-12-29 00:20:38 -0600327 contain the link text. linkgit:git-update-index[1] and
328 linkgit:git-add[1] will not change the recorded type to regular
Johannes Sixt78a8d642007-03-02 22:11:30 +0100329 file. Useful on filesystems like FAT that do not support
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700330 symbolic links.
331+
332The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
333will probe and set core.symlinks false if appropriate when the repository
334is created.
Johannes Sixt78a8d642007-03-02 22:11:30 +0100335
Petr Baudis1ab661d2006-04-25 00:59:33 +0200336core.gitProxy::
337 A "proxy command" to execute (as 'command host port') instead
338 of establishing direct connection to the remote server when
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100339 using the Git protocol for fetching. If the variable value is
Petr Baudis1ab661d2006-04-25 00:59:33 +0200340 in the "COMMAND for DOMAIN" format, the command is applied only
341 on hostnames ending with the specified domain string. This variable
342 may be set multiple times and is matched in the given order;
343 the first match wins.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100344+
345Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
346(which always applies universally, without the special "for"
347handling).
Emil Sit642d0842009-03-17 13:31:42 -0400348+
349The special string `none` can be used as the proxy command to
350specify that no proxy be used for a given domain pattern.
351This is useful for excluding servers inside a firewall from
352proxy use, while defaulting to a common proxy for external domains.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200353
354core.ignoreStat::
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200355 If true, commands which modify both the working tree and the index
356 will mark the updated paths with the "assume unchanged" bit in the
357 index. These marked files are then assumed to stay unchanged in the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200358 working tree, until you mark them otherwise manually - Git will not
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200359 detect the file changes by lstat() calls. This is useful on systems
360 where those are very slow, such as Microsoft Windows.
361 See linkgit:git-update-index[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200362 False by default.
363
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700364core.preferSymlinkRefs::
365 Instead of the default "symref" format for HEAD
366 and other symbolic reference files, use symbolic links.
367 This is sometimes needed to work with old scripts that
368 expect HEAD to be a symbolic link.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200369
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500370core.bare::
371 If true this repository is assumed to be 'bare' and has no
372 working directory associated with it. If this is the case a
373 number of commands that require a working directory will be
Dan McGee5162e692007-12-29 00:20:38 -0600374 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500375+
Dan McGee5162e692007-12-29 00:20:38 -0600376This setting is automatically guessed by linkgit:git-clone[1] or
377linkgit:git-init[1] when the repository was created. By default a
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500378repository that ends in "/.git" is assumed to be not bare (bare =
379false), while all other repositories are assumed to be bare (bare
380= true).
381
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200382core.worktree::
Junio C Hamanoea472c12011-01-23 15:49:41 -0800383 Set the path to the root of the working tree.
Ralf Wildenhues06ada152007-10-09 23:00:03 +0200384 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoea472c12011-01-23 15:49:41 -0800385 variable and the '--work-tree' command line option.
SZEDER Gábord424a472011-04-04 16:59:25 +0200386 The value can be an absolute path or relative to the path to
Junio C Hamanoea472c12011-01-23 15:49:41 -0800387 the .git directory, which is either specified by --git-dir
388 or GIT_DIR, or automatically discovered.
389 If --git-dir or GIT_DIR is specified but none of
Liu Yubao302cc112008-04-29 04:09:20 +0800390 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanoea472c12011-01-23 15:49:41 -0800391 the current working directory is regarded as the top level
Nguyễn Thái Ngọc Duy98acf752010-11-26 22:32:42 +0700392 of your working tree.
Junio C Hamanoea472c12011-01-23 15:49:41 -0800393+
394Note that this variable is honored even when set in a configuration
395file in a ".git" subdirectory of a directory and its value differs
396from the latter directory (e.g. "/path/to/.git/config" has
397core.worktree set to "/different/path"), which is most likely a
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100398misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamanoea472c12011-01-23 15:49:41 -0800399still use "/different/path" as the root of the work tree and can cause
400confusion unless you know what you are doing (e.g. you are creating a
401read-only snapshot of the same index to a location different from the
402repository's usual working tree).
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200403
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400404core.logAllRefUpdates::
Lukas Sandström14cd5602007-08-19 23:38:57 +0200405 Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano4057deb2006-10-08 01:35:18 -0700406 "$GIT_DIR/logs/<ref>", by appending the new and old
Thomas Ackermannd5fa1f12013-04-15 19:49:04 +0200407 SHA-1, the date/time and the reason of the update, but
Junio C Hamano4057deb2006-10-08 01:35:18 -0700408 only when the file exists. If this configuration
409 variable is set to true, missing "$GIT_DIR/logs/<ref>"
Bert Wesargcd8e3712011-07-11 11:14:18 +0200410 file is automatically created for branch heads (i.e. under
411 refs/heads/), remote refs (i.e. under refs/remotes/),
412 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamanoa862f972006-12-30 22:39:24 -0800413+
414This information can be used to determine what commit
415was the tip of a branch "2 days ago".
416+
417This value is true by default in a repository that has
418a working directory associated with it, and false by
419default in a bare repository.
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400420
Petr Baudis1ab661d2006-04-25 00:59:33 +0200421core.repositoryFormatVersion::
422 Internal variable identifying the repository format and layout
423 version.
424
425core.sharedRepository::
Jonas Fonsecad5dc6a72006-08-09 02:26:23 +0200426 When 'group' (or 'true'), the repository is made shareable between
427 several users in a group (making sure all the files and objects are
428 group-writable). When 'all' (or 'world' or 'everybody'), the
429 repository will be readable by all users, additionally to being
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100430 group-shareable. When 'umask' (or 'false'), Git will use permissions
Heikki Orsila06cbe852008-04-16 11:34:24 +0300431 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
432 files in the repository will have this mode value. '0xxx' will override
Johan Herland098082f2009-04-14 15:15:42 +0200433 user's umask value (whereas the other options will only override
434 requested parts of the user's umask value). Examples: '0660' will make
435 the repo read/write-able for the owner and group, but inaccessible to
436 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Heikki Orsila06cbe852008-04-16 11:34:24 +0300437 repository that is group-readable but not group-writable.
438 See linkgit:git-init[1]. False by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200439
440core.warnAmbiguousRefs::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100441 If true, Git will warn you if the ref name you passed it is ambiguous
Greg Price48dfe962013-02-25 00:34:14 -0500442 and might match multiple refs in the repository. True by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200443
Joachim Berdal Haga3d3e95a2006-07-06 22:35:54 +0200444core.compression::
Dana How960ccca2007-05-09 13:56:50 -0700445 An integer -1..9, indicating a default compression level.
446 -1 is the zlib default. 0 means no compression,
447 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Brian Downingdec92302007-11-19 10:58:51 -0600448 If set, this provides a default to other compression variables,
449 such as 'core.loosecompression' and 'pack.compression'.
Dana How960ccca2007-05-09 13:56:50 -0700450
451core.loosecompression::
Joachim B Haga12f6c302006-07-03 22:11:47 +0200452 An integer -1..9, indicating the compression level for objects that
Dana How960ccca2007-05-09 13:56:50 -0700453 are not in a pack file. -1 is the zlib default. 0 means no
Joachim B Haga12f6c302006-07-03 22:11:47 +0200454 compression, and 1..9 are various speed/size tradeoffs, 9 being
Dana How960ccca2007-05-09 13:56:50 -0700455 slowest. If not set, defaults to core.compression. If that is
Brian Downingde1b2462007-11-19 10:58:50 -0600456 not set, defaults to 1 (best speed).
Joachim B Haga12f6c302006-07-03 22:11:47 +0200457
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500458core.packedGitWindowSize::
459 Number of bytes of a pack file to map into memory in a
460 single mapping operation. Larger window sizes may allow
461 your system to process a smaller number of large pack files
462 more quickly. Smaller window sizes will negatively affect
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500463 performance due to increased calls to the operating system's
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500464 memory manager, but may improve performance when accessing
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500465 a large number of large pack files.
466+
467Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
468MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
469be reasonable for all users/operating systems. You probably do
470not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500471+
472Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500473
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500474core.packedGitLimit::
475 Maximum number of bytes to map simultaneously into memory
476 from pack files. If Git needs to access more than this many
477 bytes at once to complete an operation it will unmap existing
478 regions to reclaim virtual address space within the process.
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500479+
480Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
481This should be reasonable for all users/operating systems, except on
482the largest projects. You probably do not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500483+
484Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500485
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400486core.deltaBaseCacheLimit::
487 Maximum number of bytes to reserve for caching base objects
Ville Skyttä6b677a22010-07-20 00:17:17 +0300488 that may be referenced by multiple deltified objects. By storing the
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400489 entire decompressed base objects in a cache Git is able
490 to avoid unpacking and decompressing frequently used base
491 objects multiple times.
492+
493Default is 16 MiB on all platforms. This should be reasonable
494for all users/operating systems, except on the largest projects.
495You probably do not need to adjust this value.
496+
497Common unit suffixes of 'k', 'm', or 'g' are supported.
498
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800499core.bigFileThreshold::
500 Files larger than this size are stored deflated, without
501 attempting delta compression. Storing large files without
502 delta compression avoids excessive memory usage, at the
503 slight expense of increased disk usage.
504+
505Default is 512 MiB on all platforms. This should be reasonable
506for most projects as source code and other text files can still
507be delta compressed, but larger binary media files won't be.
508+
509Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800510
Michael Hendrickse8964a52007-07-02 10:48:34 -0600511core.excludesfile::
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100512 In addition to '.gitignore' (per-directory) and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100513 '.git/info/exclude', Git looks into this file for patterns
Jeff King6cf378f2012-04-26 04:51:57 -0400514 of files which are not meant to be tracked. "`~/`" is expanded
515 to the value of `$HOME` and "`~user/`" to the specified user's
Huynh Khoi Nguyen Nguyendc796872012-06-22 11:03:24 +0200516 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
517 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
518 is used instead. See linkgit:gitignore[5].
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100519
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200520core.askpass::
521 Some commands (e.g. svn and http interfaces) that interactively
522 ask for a password can be told to use an external program given
Knut Franke453842c2010-08-30 15:40:29 +0200523 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
524 environment variable. If not set, fall back to the value of the
525 'SSH_ASKPASS' environment variable or, failing that, a simple password
526 prompt. The external program shall be given a suitable prompt as
527 command line argument and write the password on its STDOUT.
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200528
Petr Onderka6df42ab2010-09-01 00:42:43 +0200529core.attributesfile::
530 In addition to '.gitattributes' (per-directory) and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100531 '.git/info/attributes', Git looks into this file for attributes
Petr Onderka6df42ab2010-09-01 00:42:43 +0200532 (see linkgit:gitattributes[5]). Path expansions are made the same
Huynh Khoi Nguyen Nguyen684e40f2012-06-22 11:03:25 +0200533 way as for `core.excludesfile`. Its default value is
534 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
535 set or empty, $HOME/.config/git/attributes is used instead.
Petr Onderka6df42ab2010-09-01 00:42:43 +0200536
Adam Robenef0c2ab2007-07-19 22:09:35 -0700537core.editor::
538 Commands such as `commit` and `tag` that lets you edit
Brian Hetro02783072007-08-23 20:44:13 -0400539 messages by launching an editor uses the value of this
Adam Robenef0c2ab2007-07-19 22:09:35 -0700540 variable when it is set, and the environment variable
Jonathan Niederb4479f02009-10-30 20:42:34 -0500541 `GIT_EDITOR` is not set. See linkgit:git-var[1].
Adam Robenef0c2ab2007-07-19 22:09:35 -0700542
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100543core.commentchar::
544 Commands such as `commit` and `tag` that lets you edit
545 messages consider a line that begins with this character
546 commented, and removes them after the editor returns
547 (default '#').
548
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200549sequence.editor::
Matthias Krüger3322ad42013-03-27 23:53:50 +0100550 Text editor used by `git rebase -i` for editing the rebase instruction file.
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200551 The value is meant to be interpreted by the shell when it is used.
552 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
553 When not configured the default commit message editor is used instead.
554
Brian Gernhardt54adf372007-07-03 14:18:11 -0400555core.pager::
Junio C Hamano97d01f22013-08-28 13:26:12 -0700556 Text viewer for use by Git commands (e.g., 'less'). The value
557 is meant to be interpreted by the shell. The order of preference
558 is the `$GIT_PAGER` environment variable, then `core.pager`
559 configuration, then `$PAGER`, and then the default chosen at
560 compile time (usually 'less').
561+
562When the `LESS` environment variable is unset, Git sets it to `FRSX`
563(if `LESS` environment variable is set, Git does not change it at
564all). If you want to selectively override Git's default setting
565for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
566be passed to the shell by Git, which will translate the final
567command to `LESS=FRSX less -+S`. The environment tells the command
568to set the `S` option to chop long lines but the command line
569resets it to the default to fold long lines.
Jonathan Niedere54c1f22014-01-06 18:14:05 -0800570+
571Likewise, when the `LV` environment variable is unset, Git sets it
572to `-c`. You can override this setting by exporting `LV` with
573another value or setting `core.pager` to `lv +c`.
Brian Gernhardt54adf372007-07-03 14:18:11 -0400574
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800575core.whitespace::
576 A comma separated list of common whitespace problems to
Thomas Rast0b444cd2010-01-10 00:33:00 +0100577 notice. 'git diff' will use `color.diff.whitespace` to
578 highlight them, and 'git apply --whitespace=error' will
Junio C Hamanoc921cc92008-07-25 00:34:47 -0700579 consider them as errors. You can prefix `-` to disable
580 any of them (e.g. `-trailing-space`):
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800581+
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700582* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800583 as an error (enabled by default).
584* `space-before-tab` treats a space character that appears immediately
585 before a tab character in the initial indent part of the line as an
586 error (enabled by default).
Wesley J. Landaker2ce4fee2012-09-17 08:22:15 -0600587* `indent-with-non-tab` treats a line that is indented with space
588 characters instead of the equivalent tabs as an error (not enabled by
589 default).
Chris Webb3e3ec2a2010-04-03 00:37:08 +0100590* `tab-in-indent` treats a tab character in the initial indent part of
591 the line as an error (not enabled by default).
Junio C Hamano77b15bb2009-09-03 16:02:32 -0700592* `blank-at-eof` treats blank lines added at the end of file as an error
593 (enabled by default).
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700594* `trailing-space` is a short-hand to cover both `blank-at-eol` and
595 `blank-at-eof`.
Junio C Hamanob2979ff2008-01-15 00:59:05 -0800596* `cr-at-eol` treats a carriage-return at the end of line as
597 part of the line terminator, i.e. with it, `trailing-space`
598 does not trigger if the character before such a carriage-return
599 is not a whitespace (not enabled by default).
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100600* `tabwidth=<n>` tells how many character positions a tab occupies; this
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100601 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100602 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800603
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700604core.fsyncobjectfiles::
605 This boolean will enable 'fsync()' when writing object files.
606+
607This is a total waste of time and effort on a filesystem that orders
608data writes properly, but can be useful for filesystems that do not use
609journalling (traditional UNIX filesystems) or that only journal metadata
610and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
611
Linus Torvalds671c9b72008-11-13 16:36:30 -0800612core.preloadindex::
613 Enable parallel index preload for operations like 'git diff'
614+
615This can speed up operations like 'git diff' and 'git status' especially
616on filesystems like NFS that have weak caching semantics and thus
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100617relatively high IO latencies. With this set to 'true', Git will do the
Linus Torvalds671c9b72008-11-13 16:36:30 -0800618index comparison to the filesystem data in parallel, allowing
619overlapping IO's.
620
Johannes Schindelin348df162009-04-28 00:32:25 +0200621core.createObject::
622 You can set this to 'link', in which case a hardlink followed by
623 a delete of the source are used to make sure that object creation
624 will not overwrite existing objects.
625+
626On some file system/operating system combinations, this is unreliable.
627Set this config setting to 'rename' there; However, This will remove the
628check that makes sure that existing object files will not get overwritten.
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200629
Johannes Schindelina97a7462009-10-09 12:21:57 +0200630core.notesRef::
631 When showing commit messages, also show notes which are stored in
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500632 the given ref. The ref must be fully qualified. If the given
633 ref does not exist, it is not an error but means that no
634 notes should be printed.
Johannes Schindelina97a7462009-10-09 12:21:57 +0200635+
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500636This setting defaults to "refs/notes/commits", and it can be overridden by
637the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Johannes Schindelina97a7462009-10-09 12:21:57 +0200638
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +0700639core.sparseCheckout::
640 Enable "sparse checkout" feature. See section "Sparse checkout" in
641 linkgit:git-read-tree[1] for more information.
642
Junio C Hamanoa71f09f2011-03-20 22:26:24 -0700643core.abbrev::
Linus Torvaldsdce96482010-10-28 11:28:04 -0700644 Set the length object names are abbreviated to. If unspecified,
645 many commands abbreviate to 7 hexdigits, which may not be enough
646 for abbreviated object names to stay unique for sufficiently long
647 time.
648
Stephen Boyd13bd2132009-05-30 22:08:02 -0700649add.ignore-errors::
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600650add.ignoreErrors::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100651 Tells 'git add' to continue adding files when some files cannot be
Stephen Boyd13bd2132009-05-30 22:08:02 -0700652 added due to indexing errors. Equivalent to the '--ignore-errors'
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100653 option of linkgit:git-add[1]. Older versions of Git accept only
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600654 `add.ignore-errors`, which does not follow the usual naming
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100655 convention for configuration variables. Newer versions of Git
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600656 honor `add.ignoreErrors` as well.
Stephen Boyd13bd2132009-05-30 22:08:02 -0700657
Petr Baudis4514ad42006-06-07 20:43:50 +0200658alias.*::
Dan McGee5162e692007-12-29 00:20:38 -0600659 Command aliases for the linkgit:git[1] command wrapper - e.g.
Petr Baudis4514ad42006-06-07 20:43:50 +0200660 after defining "alias.last = cat-file commit HEAD", the invocation
661 "git last" is equivalent to "git cat-file commit HEAD". To avoid
Petr Baudis99b41c82006-06-07 17:25:21 -0700662 confusion and troubles with script usage, aliases that
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100663 hide existing Git commands are ignored. Arguments are split by
Petr Baudis99b41c82006-06-07 17:25:21 -0700664 spaces, the usual shell quoting and escaping is supported.
665 quote pair and a backslash can be used to quote them.
Junio C Hamanof368f5a2007-09-01 04:01:54 -0700666+
667If the alias expansion is prefixed with an exclamation point,
668it will be treated as a shell command. For example, defining
669"alias.new = !gitk --all --not ORIG_HEAD", the invocation
670"git new" is equivalent to running the shell command
Sitaram Chamarty595b8db2009-07-01 21:30:31 +0530671"gitk --all --not ORIG_HEAD". Note that shell commands will be
672executed from the top-level directory of a repository, which may
673not necessarily be the current directory.
Michael J Gruber7cf16a12011-04-27 10:36:27 +0200674'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
675from the original current directory. See linkgit:git-rev-parse[1].
Theodore Ts'odfd42a32007-02-10 19:33:58 -0500676
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100677am.keepcr::
678 If true, git-am will call git-mailsplit for patches in mbox format
679 with parameter '--keep-cr'. In this case git-mailsplit will
Ville Skyttä6b677a22010-07-20 00:17:17 +0300680 not remove `\r` from lines ending with `\r\n`. Can be overridden
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100681 by giving '--no-keep-cr' from the command line.
682 See linkgit:git-am[1], linkgit:git-mailsplit[1].
683
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200684apply.ignorewhitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100685 When set to 'change', tells 'git apply' to ignore changes in
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200686 whitespace, in the same way as the '--ignore-space-change'
687 option.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100688 When set to one of: no, none, never, false tells 'git apply' to
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200689 respect all whitespace differences.
690 See linkgit:git-apply[1].
691
Petr Baudis1ab661d2006-04-25 00:59:33 +0200692apply.whitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100693 Tells 'git apply' how to handle whitespaces, in the same way
Dan McGee5162e692007-12-29 00:20:38 -0600694 as the '--whitespace' option. See linkgit:git-apply[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200695
Paolo Bonzini99023872007-05-23 07:07:54 +0200696branch.autosetupmerge::
Junio C Hamanoadd09512010-01-20 20:28:49 -0800697 Tells 'git branch' and 'git checkout' to set up new branches
Jay Soffian572fc812008-02-19 11:24:38 -0500698 so that linkgit:git-pull[1] will appropriately merge from the
699 starting point branch. Note that even if this option is not set,
Paolo Bonzini99023872007-05-23 07:07:54 +0200700 this behavior can be chosen per-branch using the `--track`
Jay Soffian572fc812008-02-19 11:24:38 -0500701 and `--no-track` options. The valid settings are: `false` -- no
702 automatic setup is done; `true` -- automatic setup is done when the
Matthieu Moy29b9a662010-11-02 16:31:24 +0100703 starting point is a remote-tracking branch; `always` --
704 automatic setup is done when the starting point is either a
705 local branch or remote-tracking
Jay Soffian572fc812008-02-19 11:24:38 -0500706 branch. This option defaults to true.
Paolo Bonzini99023872007-05-23 07:07:54 +0200707
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700708branch.autosetuprebase::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100709 When a new branch is created with 'git branch' or 'git checkout'
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100710 that tracks another branch, this variable tells Git to set
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700711 up pull to rebase instead of merge (see "branch.<name>.rebase").
712 When `never`, rebase is never automatically set to true.
713 When `local`, rebase is set to true for tracked branches of
714 other local branches.
715 When `remote`, rebase is set to true for tracked branches of
Matthieu Moy29b9a662010-11-02 16:31:24 +0100716 remote-tracking branches.
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700717 When `always`, rebase will be set to true for all tracking
718 branches.
719 See "branch.autosetupmerge" for details on how to set up a
720 branch to track another branch.
721 This option defaults to never.
722
Santi Béjar648ad182006-09-23 12:05:43 +0200723branch.<name>.remote::
Ramkumar Ramachandra224c2172013-04-02 13:10:33 +0530724 When on branch <name>, it tells 'git fetch' and 'git push'
725 which remote to fetch from/push to. The remote to push to
726 may be overridden with `remote.pushdefault` (for all branches).
Ramkumar Ramachandra9f765ce2013-04-02 13:10:34 +0530727 The remote to push to, for the current branch, may be further
728 overridden by `branch.<name>.pushremote`. If no remote is
729 configured, or if you are not on any branch, it defaults to
730 `origin` for fetching and `remote.pushdefault` for pushing.
Philip Oakleyb85ecea2013-09-13 22:23:16 +0100731 Additionally, `.` (a period) is the current local repository
732 (a dot-repository), see `branch.<name>.merge`'s final note below.
Ramkumar Ramachandra9f765ce2013-04-02 13:10:34 +0530733
734branch.<name>.pushremote::
735 When on branch <name>, it overrides `branch.<name>.remote` for
736 pushing. It also overrides `remote.pushdefault` for pushing
737 from branch <name>. When you pull from one place (e.g. your
738 upstream) and push to another place (e.g. your own publishing
739 repository), you would want to set `remote.pushdefault` to
740 specify the remote to push to for all branches, and use this
741 option to override it for a specific branch.
Santi Béjar648ad182006-09-23 12:05:43 +0200742
Santi Béjar53728062006-09-23 22:53:04 +0200743branch.<name>.merge::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200744 Defines, together with branch.<name>.remote, the upstream branch
Martin von Zweigbergk15a147e2011-02-09 20:54:02 -0500745 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Thomas Rast0b444cd2010-01-10 00:33:00 +0100746 branch to merge and can also affect 'git push' (see push.default).
747 When in branch <name>, it tells 'git fetch' the default
Daniel Barkalowb888d612007-09-10 23:03:25 -0400748 refspec to be marked for merging in FETCH_HEAD. The value is
749 handled like the remote part of a refspec, and must match a
750 ref which is fetched from the remote given by
751 "branch.<name>.remote".
Thomas Rast0b444cd2010-01-10 00:33:00 +0100752 The merge information is used by 'git pull' (which at first calls
753 'git fetch') to lookup the default branch for merging. Without
754 this option, 'git pull' defaults to merge the first refspec fetched.
Josef Weidendorfer62b339a2006-12-09 02:28:26 +0100755 Specify multiple values to get an octopus merge.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100756 If you wish to setup 'git pull' so that it merges into <name> from
Paolo Bonzini9debc322007-03-15 09:23:20 +0100757 another branch in the local repository, you can point
Philip Oakleyb85ecea2013-09-13 22:23:16 +0100758 branch.<name>.merge to the desired branch, and use the relative path
759 setting `.` (a period) for branch.<name>.remote.
Santi Béjar53728062006-09-23 22:53:04 +0200760
Lars Hjemliaec7b362007-09-24 00:51:43 +0200761branch.<name>.mergeoptions::
762 Sets default options for merging into branch <name>. The syntax and
Jonathan Nieder25dcc0d2009-10-09 13:51:14 -0500763 supported options are the same as those of linkgit:git-merge[1], but
Lars Hjemliaec7b362007-09-24 00:51:43 +0200764 option values containing whitespace characters are currently not
765 supported.
766
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000767branch.<name>.rebase::
768 When true, rebase the branch <name> on top of the fetched branch,
Dustin Sallings15ddb6f2008-05-08 11:28:07 -0700769 instead of merging the default branch from the default remote when
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100770 "git pull" is run. See "pull.rebase" for doing this in a non
771 branch-specific manner.
772+
Stephen Haberman66713ef2013-08-12 22:43:42 -0500773 When preserve, also pass `--preserve-merges` along to 'git rebase'
774 so that locally committed merge commits will not be flattened
775 by running 'git pull'.
776+
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100777*NOTE*: this is a possibly dangerous operation; do *not* use
778it unless you understand the implications (see linkgit:git-rebase[1]
779for details).
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000780
Nguyễn Thái Ngọc Duya5ba2cb2013-01-01 16:30:53 +0700781branch.<name>.description::
782 Branch description, can be edited with
783 `git branch --edit-description`. Branch description is
784 automatically added in the format-patch cover letter or
785 request-pull summary.
786
Christian Couder1658c612008-03-14 05:56:53 +0100787browser.<tool>.cmd::
788 Specify the command to invoke the specified browser. The
789 specified command is evaluated in shell with the URLs passed
Jonathan Nieder565e1352011-06-29 00:35:10 -0500790 as arguments. (See linkgit:git-web{litdd}browse[1].)
Christian Couder1658c612008-03-14 05:56:53 +0100791
Christian Couder584627b2008-01-29 07:08:22 +0100792browser.<tool>.path::
793 Override the path for the given tool that may be used to
Christian Couderab989ad2008-01-29 07:08:44 +0100794 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
795 working repository in gitweb (see linkgit:git-instaweb[1]).
Christian Couder584627b2008-01-29 07:08:22 +0100796
Josh Triplett21225912007-04-23 17:18:16 -0700797clean.requireForce::
Jiang Xinf85f7942013-08-28 09:28:32 +0800798 A boolean to make git-clean do nothing unless given -f,
799 -i or -n. Defaults to true.
Josh Triplett21225912007-04-23 17:18:16 -0700800
Brian Gernhardtf3673982007-01-03 10:36:29 -0500801color.branch::
802 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600803 linkgit:git-branch[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800804 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Brian Gernhardtf3673982007-01-03 10:36:29 -0500805 only when the output is to a terminal. Defaults to false.
806
807color.branch.<slot>::
808 Use customized color for branch coloration. `<slot>` is one of
809 `current` (the current branch), `local` (a local branch),
Felipe Contrerasdbda21f2013-04-14 21:37:49 -0500810 `remote` (a remote-tracking branch in refs/remotes/),
811 `upstream` (upstream tracking branch), `plain` (other
Mark Wooding4f193f22007-01-28 15:17:36 +0000812 refs).
813+
814The value for these configuration variables is a list of colors (at most
815two) and attributes (at most one), separated by spaces. The colors
816accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
817`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
818`blink` and `reverse`. The first color given is the foreground; the
819second is the background. The position of the attribute, if any,
820doesn't matter.
Brian Gernhardtf3673982007-01-03 10:36:29 -0500821
Andy Parkinsa159ca02006-12-13 09:13:28 +0000822color.diff::
Michael J Gruber6999c542011-04-27 09:38:27 +0200823 Whether to use ANSI escape sequences to add color to patches.
824 If this is set to `always`, linkgit:git-diff[1],
825 linkgit:git-log[1], and linkgit:git-show[1] will use color
826 for all patches. If it is set to `true` or `auto`, those
827 commands will only use color when output is to the terminal.
828 Defaults to false.
829+
830This does not affect linkgit:git-format-patch[1] nor the
831'git-diff-{asterisk}' plumbing commands. Can be overridden on the
832command line with the `--color[=<when>]` option.
Junio C Hamanob5376642006-07-07 05:28:05 -0700833
Andy Parkinsa159ca02006-12-13 09:13:28 +0000834color.diff.<slot>::
Mark Wooding4f193f22007-01-28 15:17:36 +0000835 Use customized color for diff colorization. `<slot>` specifies
836 which part of the patch to use the specified color, and is one
837 of `plain` (context text), `meta` (metainformation), `frag`
Bert Wesarg89cb73a2009-11-27 07:55:18 +0100838 (hunk header), 'func' (function in hunk header), `old` (removed lines),
839 `new` (added lines), `commit` (commit headers), or `whitespace`
840 (highlighting whitespace errors). The values of these variables may be
841 specified as in color.branch.<slot>.
Junio C Hamanob5376642006-07-07 05:28:05 -0700842
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800843color.decorate.<slot>::
844 Use customized color for 'git log --decorate' output. `<slot>` is one
845 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Matthieu Moy0e615b22010-11-02 16:31:20 +0100846 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800847
René Scharfe7e8f59d2009-03-07 13:32:32 +0100848color.grep::
849 When set to `always`, always highlight matches. When `false` (or
850 `never`), never. When set to `true` or `auto`, use color only
851 when the output is written to the terminal. Defaults to `false`.
852
Mark Lodato55f638b2010-03-07 11:52:46 -0500853color.grep.<slot>::
854 Use customized color for grep colorization. `<slot>` specifies which
855 part of the line to use the specified color, and is one of
856+
857--
Mark Lodato00588bb2010-03-07 11:52:47 -0500858`context`;;
859 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500860`filename`;;
861 filename prefix (when not using `-h`)
Mark Lodato00588bb2010-03-07 11:52:47 -0500862`function`;;
863 function name lines (when using `-p`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500864`linenumber`;;
865 line number prefix (when using `-n`)
866`match`;;
867 matching text
Mark Lodato00588bb2010-03-07 11:52:47 -0500868`selected`;;
869 non-matching text in selected lines
Mark Lodato55f638b2010-03-07 11:52:46 -0500870`separator`;;
871 separators between fields on a line (`:`, `-`, and `=`)
872 and between hunks (`--`)
873--
874+
875The values of these variables may be specified as in color.branch.<slot>.
René Scharfe7e8f59d2009-03-07 13:32:32 +0100876
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800877color.interactive::
Jeff King47ee06f2008-01-05 04:57:44 -0500878 When set to `always`, always use colors for interactive prompts
Jiang Xin7a9b0b82013-06-25 23:53:50 +0800879 and displays (such as those used by "git-add --interactive" and
880 "git-clean --interactive"). When false (or `never`), never.
881 When set to `true` or `auto`, use colors only when the output is
882 to the terminal. Defaults to false.
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800883
884color.interactive.<slot>::
Jiang Xin7a9b0b82013-06-25 23:53:50 +0800885 Use customized color for 'git add --interactive' and 'git clean
886 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
887 or `error`, for four distinct types of normal output from
888 interactive commands. The values of these variables may be
889 specified as in color.branch.<slot>.
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800890
Junio C Hamano1d770432006-12-13 12:11:03 -0800891color.pager::
892 A boolean to enable/disable colored output when the pager is in
893 use (default is true).
894
Markus Heidelbergab07ba22009-04-22 23:41:25 +0200895color.showbranch::
896 A boolean to enable/disable color in the output of
897 linkgit:git-show-branch[1]. May be set to `always`,
898 `false` (or `never`) or `auto` (or `true`), in which case colors are used
899 only when the output is to a terminal. Defaults to false.
900
Junio C Hamano1d770432006-12-13 12:11:03 -0800901color.status::
902 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600903 linkgit:git-status[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800904 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamano1d770432006-12-13 12:11:03 -0800905 only when the output is to a terminal. Defaults to false.
906
907color.status.<slot>::
908 Use customized color for status colorization. `<slot>` is
909 one of `header` (the header text of the status message),
Shawn O. Pearce82dca842006-12-15 21:53:13 -0500910 `added` or `updated` (files which are added but not committed),
911 `changed` (files which are changed but not added in the index),
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100912 `untracked` (files which are not tracked by Git),
Aleksi Aalto1d282322010-11-18 01:40:05 +0200913 `branch` (the current branch), or
Chris Parsons950ce2e2008-05-22 08:50:02 -0400914 `nobranch` (the color the 'no branch' warning is shown in, defaulting
915 to red). The values of these variables may be specified as in
916 color.branch.<slot>.
Junio C Hamano1d770432006-12-13 12:11:03 -0800917
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100918color.ui::
Michael J Gruber6999c542011-04-27 09:38:27 +0200919 This variable determines the default value for variables such
920 as `color.diff` and `color.grep` that control the use of color
921 per command family. Its scope will expand as more commands learn
922 configuration to set a default for the `--color` option. Set it
Matthieu Moy4c7f1812013-06-10 16:26:09 +0200923 to `false` or `never` if you prefer Git commands not to use
924 color unless enabled explicitly with some other configuration
925 or the `--color` option. Set it to `always` if you want all
926 output not intended for machine consumption to use color, to
927 `true` or `auto` (this is the default since Git 1.8.4) if you
928 want such output to use color when written to the terminal.
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100929
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700930column.ui::
931 Specify whether supported commands should output in columns.
932 This variable consists of a list of tokens separated by spaces
933 or commas:
934+
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530935These options control when the feature should be enabled
936(defaults to 'never'):
937+
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700938--
939`always`;;
940 always show in columns
941`never`;;
942 never show in columns
943`auto`;;
944 show in columns if the output is to the terminal
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530945--
946+
947These options control layout (defaults to 'column'). Setting any
948of these implies 'always' if none of 'always', 'never', or 'auto' are
949specified.
950+
951--
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700952`column`;;
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530953 fill columns before rows
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700954`row`;;
955 fill rows before columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700956`plain`;;
957 show in one column
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530958--
959+
960Finally, these options can be combined with a layout option (defaults
961to 'nodense'):
962+
963--
Nguyễn Thái Ngọc Duy3f8eccb2012-04-13 17:54:36 +0700964`dense`;;
965 make unequal size columns to utilize more space
966`nodense`;;
967 make equal size columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700968--
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700969
Nguyễn Thái Ngọc Duyebe31ef2012-04-13 17:54:38 +0700970column.branch::
971 Specify whether to output branch listing in `git branch` in columns.
972 See `column.ui` for details.
973
Jiang Xin1b8fd462013-06-25 23:53:49 +0800974column.clean::
975 Specify the layout when list items in `git clean -i`, which always
976 shows files and directories in columns. See `column.ui` for details.
977
Nguyễn Thái Ngọc Duy323d0532012-04-13 17:54:39 +0700978column.status::
979 Specify whether to output untracked files in `git status` in columns.
980 See `column.ui` for details.
981
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700982column.tag::
983 Specify whether to output tag listing in `git tag` in columns.
984 See `column.ui` for details.
985
Ralf Thielow51fb3a32013-01-10 18:45:59 +0100986commit.cleanup::
987 This setting overrides the default of the `--cleanup` option in
988 `git commit`. See linkgit:git-commit[1] for details. Changing the
989 default can be useful when you always want to keep lines that begin
990 with comment character `#` in your log message, in which case you
991 would do `git config commit.cleanup whitespace` (note that you will
992 have to remove the help lines that begin with `#` in the commit log
993 template yourself, if you do this).
994
Thomas Rast88955ed2010-01-23 23:13:17 +0100995commit.status::
James P. Howard, IIbed575e2009-12-07 17:45:27 -0500996 A boolean to enable/disable inclusion of status information in the
997 commit message template when using an editor to prepare the commit
998 message. Defaults to true.
999
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001000commit.template::
1001 Specify a file to use as the template for new commit messages.
Jeff King6cf378f2012-04-26 04:51:57 -04001002 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Matthieu Moydf2a79f2009-11-19 16:21:15 +01001003 specified user's home directory.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001004
Jeff Kinga6fc9fd2011-12-10 05:31:38 -05001005credential.helper::
1006 Specify an external helper to be called when a username or
1007 password credential is needed; the helper may consult external
1008 storage to avoid prompting the user for the credentials. See
1009 linkgit:gitcredentials[7] for details.
1010
1011credential.useHttpPath::
1012 When acquiring credentials, consider the "path" component of an http
1013 or https URL to be important. Defaults to false. See
1014 linkgit:gitcredentials[7] for more information.
1015
1016credential.username::
1017 If no username is set for a network authentication, use this username
1018 by default. See credential.<context>.* below, and
1019 linkgit:gitcredentials[7].
1020
1021credential.<url>.*::
1022 Any of the credential.* options above can be applied selectively to
1023 some credentials. For example "credential.https://example.com.username"
1024 would set the default username only for https connections to
1025 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1026 matched.
1027
Ramkumar Ramachandra19299a82011-04-07 00:16:49 +05301028include::diff-config.txt[]
David Aguilarafcbc8e2009-04-07 01:21:20 -07001029
1030difftool.<tool>.path::
1031 Override the path for the given tool. This is useful in case
1032 your tool is not in the PATH.
1033
1034difftool.<tool>.cmd::
1035 Specify the command to invoke the specified diff tool.
1036 The specified command is evaluated in shell with the following
1037 variables available: 'LOCAL' is set to the name of the temporary
1038 file containing the contents of the diff pre-image and 'REMOTE'
1039 is set to the name of the temporary file containing the contents
1040 of the diff post-image.
1041
David Aguilara9043922009-04-07 01:21:22 -07001042difftool.prompt::
1043 Prompt before each invocation of the diff tool.
1044
Jens Lehmannbe254a02010-11-11 00:55:02 +01001045fetch.recurseSubmodules::
Jens Lehmann1fb25502011-03-06 23:11:48 +01001046 This option can be either set to a boolean value or to 'on-demand'.
1047 Setting it to a boolean changes the behavior of fetch and pull to
1048 unconditionally recurse into submodules when set to true or to not
1049 recurse at all when set to false. When set to 'on-demand' (the default
1050 value), fetch and pull will only recurse into a populated submodule
1051 when its superproject retrieves a commit that updates the submodule's
1052 reference.
Jens Lehmannbe254a02010-11-11 00:55:02 +01001053
Junio C Hamano5e838ea2011-09-04 12:26:14 -07001054fetch.fsckObjects::
1055 If it is set to true, git-fetch-pack will check all fetched
1056 objects. It will abort in the case of a malformed object or a
1057 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001058 Defaults to false. If not set, the value of `transfer.fsckObjects`
1059 is used instead.
Junio C Hamano5e838ea2011-09-04 12:26:14 -07001060
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001061fetch.unpackLimit::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001062 If the number of objects fetched over the Git native
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001063 transfer is below this
1064 limit, then the objects will be unpacked into loose object
1065 files. However if the number of received objects equals or
1066 exceeds this limit then the received pack will be stored as
1067 a pack, after adding any missing delta bases. Storing the
1068 pack from a push can make the push operation complete faster,
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001069 especially on slow filesystems. If not set, the value of
1070 `transfer.unpackLimit` is used instead.
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001071
Michael Schubert737c5a92013-07-13 11:36:24 +02001072fetch.prune::
1073 If true, fetch will automatically behave as if the `--prune`
1074 option was given on the command line. See also `remote.<name>.prune`.
1075
Stephen Boyd48d34482009-04-23 02:37:56 -07001076format.attach::
1077 Enable multipart/mixed attachments as the default for
1078 'format-patch'. The value can also be a double quoted string
1079 which will enable attachments as the default and set the
1080 value as the boundary. See the --attach option in
1081 linkgit:git-format-patch[1].
1082
Brian Gernhardt49604a42007-11-03 23:38:24 -04001083format.numbered::
Brian Gernhardta567fdc2008-10-02 16:55:39 -04001084 A boolean which can enable or disable sequence numbers in patch
1085 subjects. It defaults to "auto" which enables it only if there
1086 is more than one patch. It can be enabled or disabled for all
1087 messages by setting it to "true" or "false". See --numbered
1088 option in linkgit:git-format-patch[1].
Brian Gernhardt49604a42007-11-03 23:38:24 -04001089
Petr Baudis1ab661d2006-04-25 00:59:33 +02001090format.headers::
1091 Additional email headers to include in a patch to be submitted
Dan McGee5162e692007-12-29 00:20:38 -06001092 by mail. See linkgit:git-format-patch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001093
Miklos Vajna312a30e2010-07-12 20:58:38 +02001094format.to::
Stephen Boyd48d34482009-04-23 02:37:56 -07001095format.cc::
Miklos Vajna312a30e2010-07-12 20:58:38 +02001096 Additional recipients to include in a patch to be submitted
1097 by mail. See the --to and --cc options in
1098 linkgit:git-format-patch[1].
Stephen Boyd48d34482009-04-23 02:37:56 -07001099
1100format.subjectprefix::
1101 The default for format-patch is to output files with the '[PATCH]'
1102 subject prefix. Use this variable to change that prefix.
1103
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001104format.signature::
1105 The default for format-patch is to output a signature containing
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001106 the Git version number. Use this variable to change that default.
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001107 Set this variable to the empty string ("") to suppress
1108 signature generation.
1109
Johannes Schindelin78cb59c2007-03-04 00:17:23 +01001110format.suffix::
1111 The default for format-patch is to output files with the suffix
1112 `.patch`. Use this variable to change that suffix (make sure to
1113 include the dot if you want it).
1114
Denis Cheng94c22a52008-03-02 17:05:53 +08001115format.pretty::
1116 The default pretty format for log/show/whatchanged command,
1117 See linkgit:git-log[1], linkgit:git-show[1],
1118 linkgit:git-whatchanged[1].
1119
Thomas Rast30984ed2009-02-19 22:26:33 +01001120format.thread::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001121 The default threading style for 'git format-patch'. Can be
Jonathan Nieder578b62b2010-01-09 21:01:21 -06001122 a boolean value, or `shallow` or `deep`. `shallow` threading
1123 makes every mail a reply to the head of the series,
Thomas Rast30984ed2009-02-19 22:26:33 +01001124 where the head is chosen from the cover letter, the
Jeff King6cf378f2012-04-26 04:51:57 -04001125 `--in-reply-to`, and the first patch mail, in this order.
Stephen Boydfd1ff302009-04-23 02:37:57 -07001126 `deep` threading makes every mail a reply to the previous one.
Thomas Rast30984ed2009-02-19 22:26:33 +01001127 A true boolean value is the same as `shallow`, and a false
1128 value disables threading.
1129
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001130format.signoff::
Felipe Contreras240ae2b2013-04-27 17:00:07 -05001131 A boolean value which lets you enable the `-s/--signoff` option of
1132 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1133 patch should be a conscious act and means that you certify you have
1134 the rights to submit this work under the same open source license.
1135 Please see the 'SubmittingPatches' document for further discussion.
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001136
Felipe Contreras2a4c2602013-04-07 12:46:23 -05001137format.coverLetter::
1138 A boolean that controls whether to generate a cover-letter when
1139 format-patch is invoked, but in addition can be set to "auto", to
1140 generate a cover-letter only when there's more than one patch.
1141
Ramkumar Ramachandra26488f52011-04-07 00:16:48 +05301142filter.<driver>.clean::
1143 The command which is used to convert the content of a worktree
1144 file to a blob upon checkin. See linkgit:gitattributes[5] for
1145 details.
1146
1147filter.<driver>.smudge::
1148 The command which is used to convert the content of a blob
1149 object to a worktree file upon checkout. See
1150 linkgit:gitattributes[5] for details.
1151
Theodore Tso0d7566a2007-05-09 15:48:39 -04001152gc.aggressiveWindow::
1153 The window size parameter used in the delta compression
Thomas Rast0b444cd2010-01-10 00:33:00 +01001154 algorithm used by 'git gc --aggressive'. This defaults
Jay Soffianf78683f2010-04-13 12:52:55 -04001155 to 250.
Theodore Tso0d7566a2007-05-09 15:48:39 -04001156
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001157gc.auto::
1158 When there are approximately more than this many loose
1159 objects in the repository, `git gc --auto` will pack them.
1160 Some Porcelain commands use this command to perform a
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001161 light-weight garbage collection from time to time. The
1162 default value is 6700. Setting this to 0 disables it.
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001163
Junio C Hamano17815502007-09-17 00:55:13 -07001164gc.autopacklimit::
1165 When there are more than this many packs that are not
1166 marked with `*.keep` file in the repository, `git gc
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001167 --auto` consolidates them into one larger pack. The
Junio C Hamano97063972008-03-23 00:04:48 -07001168 default value is 50. Setting this to 0 disables it.
Junio C Hamano17815502007-09-17 00:55:13 -07001169
Nguyễn Thái Ngọc Duy9f673f92014-02-08 14:08:52 +07001170gc.autodetach::
1171 Make `git gc --auto` return immediately andrun in background
1172 if the system supports it. Default is true.
1173
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001174gc.packrefs::
Jonathan Niederefc266e2010-01-09 20:59:41 -06001175 Running `git pack-refs` in a repository renders it
1176 unclonable by Git versions prior to 1.5.1.2 over dumb
1177 transports such as HTTP. This variable determines whether
Jiang Xin4be0c352010-12-16 15:16:49 +08001178 'git gc' runs `git pack-refs`. This can be set to `notbare`
Jonathan Niederefc266e2010-01-09 20:59:41 -06001179 to enable it within all non-bare repos or it can be set to a
1180 boolean value. The default is `true`.
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001181
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001182gc.pruneexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001183 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Nicolas Pitre8e8daf32008-12-30 14:45:11 -05001184 Override the grace period with this config variable. The value
1185 "now" may be used to disable this grace period and always prune
1186 unreachable objects immediately.
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001187
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001188gc.reflogexpire::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001189gc.<pattern>.reflogexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001190 'git reflog expire' removes reflog entries older than
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001191 this time; defaults to 90 days. With "<pattern>" (e.g.
1192 "refs/stash") in the middle the setting applies only to
1193 the refs that match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001194
1195gc.reflogexpireunreachable::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001196gc.<ref>.reflogexpireunreachable::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001197 'git reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001198 this time and are not reachable from the current tip;
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001199 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1200 in the middle, the setting applies only to the refs that
1201 match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001202
Junio C Hamano48c32422006-12-27 01:24:05 -08001203gc.rerereresolved::
1204 Records of conflicted merge you resolved earlier are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001205 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001206 The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001207
1208gc.rerereunresolved::
1209 Records of conflicted merge you have not resolved are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001210 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001211 The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001212
Fabian Emmes280514e2009-01-02 16:40:13 +01001213gitcvs.commitmsgannotation::
1214 Append this string to each commit message. Set to empty string
1215 to disable this feature. Defaults to "via git-CVS emulator".
1216
Petr Baudis1ab661d2006-04-25 00:59:33 +02001217gitcvs.enabled::
Brian Hetrodb218722007-08-23 20:40:08 -04001218 Whether the CVS server interface is enabled for this repository.
Dan McGee5162e692007-12-29 00:20:38 -06001219 See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001220
1221gitcvs.logfile::
Brian Hetrodb218722007-08-23 20:40:08 -04001222 Path to a log file where the CVS server interface well... logs
Dan McGee5162e692007-12-29 00:20:38 -06001223 various stuff. See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001224
Teemu Likonen1707adb2008-08-29 10:29:42 +03001225gitcvs.usecrlfattr::
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001226 If true, the server will look up the end-of-line conversion
1227 attributes for files to determine the '-k' modes to use. If
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001228 the attributes force Git to treat a file as text,
Ville Skyttä6b677a22010-07-20 00:17:17 +03001229 the '-k' mode will be left blank so CVS clients will
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001230 treat it as text. If they suppress text conversion, the file
Mike Ralphson1168d402008-08-05 17:12:05 +01001231 will be set with '-kb' mode, which suppresses any newline munging
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001232 the client might otherwise do. If the attributes do not allow
1233 the file type to be determined, then 'gitcvs.allbinary' is
1234 used. See linkgit:gitattributes[5].
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001235
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001236gitcvs.allbinary::
Matthew Ogilvie90948a42008-05-14 22:35:48 -06001237 This is used if 'gitcvs.usecrlfattr' does not resolve
1238 the correct '-kb' mode to use. If true, all
1239 unresolved files are sent to the client in
1240 mode '-kb'. This causes the client to treat them
1241 as binary files, which suppresses any newline munging it
1242 otherwise might do. Alternatively, if it is set to "guess",
1243 then the contents of the file are examined to decide if
1244 it is binary, similar to 'core.autocrlf'.
Junio C Hamanoabbf5942007-04-17 22:17:46 -07001245
Frank Lichtenheld04752862007-04-13 18:13:42 +02001246gitcvs.dbname::
1247 Database used by git-cvsserver to cache revision information
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001248 derived from the Git repository. The exact meaning depends on the
Frank Lichtenheld04752862007-04-13 18:13:42 +02001249 used database driver, for SQLite (which is the default driver) this
1250 is a filename. Supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001251 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001252 Default: '%Ggitcvs.%m.sqlite'
1253
1254gitcvs.dbdriver::
1255 Used Perl DBI driver. You can specify any available driver
Felipe Contreras240ae2b2013-04-27 17:00:07 -05001256 for this here, but it might not work. git-cvsserver is tested
Frank Lichtenheld04752862007-04-13 18:13:42 +02001257 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1258 reported *not* to work with 'DBD::mysql'. Experimental feature.
1259 May not contain double colons (`:`). Default: 'SQLite'.
Dan McGee5162e692007-12-29 00:20:38 -06001260 See linkgit:git-cvsserver[1].
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001261
Frank Lichtenheld04752862007-04-13 18:13:42 +02001262gitcvs.dbuser, gitcvs.dbpass::
1263 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1264 since SQLite has no concept of database users and/or passwords.
1265 'gitcvs.dbuser' supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001266 linkgit:git-cvsserver[1] for details).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001267
Josh Elsasser6aeeffd2008-03-27 14:02:14 -07001268gitcvs.dbTableNamePrefix::
1269 Database table name prefix. Prepended to the names of any
1270 database tables used, allowing a single database to be used
1271 for several repositories. Supports variable substitution (see
1272 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1273 characters will be replaced with underscores.
1274
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001275All gitcvs variables except for 'gitcvs.usecrlfattr' and
1276'gitcvs.allbinary' can also be specified as
1277'gitcvs.<access_method>.<varname>' (where 'access_method'
Brian Hetro02783072007-08-23 20:44:13 -04001278is one of "ext" and "pserver") to make them apply only for the given
1279access method.
Frank Lichtenheld04752862007-04-13 18:13:42 +02001280
Jakub Narebskicd823232011-10-16 13:07:34 +02001281gitweb.category::
1282gitweb.description::
1283gitweb.owner::
1284gitweb.url::
1285 See linkgit:gitweb[1] for description.
1286
1287gitweb.avatar::
1288gitweb.blame::
1289gitweb.grep::
1290gitweb.highlight::
1291gitweb.patches::
1292gitweb.pickaxe::
1293gitweb.remote_heads::
1294gitweb.showsizes::
1295gitweb.snapshot::
1296 See linkgit:gitweb.conf[5] for description.
1297
Joe Rattermanb22520a2011-03-30 14:31:05 -05001298grep.lineNumber::
1299 If set to true, enable '-n' option by default.
1300
J Smith84befcd2012-08-03 10:53:50 -04001301grep.patternType::
1302 Set the default matching behavior. Using a value of 'basic', 'extended',
1303 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1304 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1305 value 'default' will return to the default matching behavior.
1306
Joe Rattermanb22520a2011-03-30 14:31:05 -05001307grep.extendedRegexp::
J Smith84befcd2012-08-03 10:53:50 -04001308 If set to true, enable '--extended-regexp' option by default. This
1309 option is ignored when the 'grep.patternType' option is set to a value
1310 other than 'default'.
Joe Rattermanb22520a2011-03-30 14:31:05 -05001311
Junio C Hamano0c5e70f2011-11-29 12:29:48 -08001312gpg.program::
1313 Use this custom program instead of "gpg" found on $PATH when
1314 making or verifying a PGP signature. The program must support the
1315 same command line interface as GPG, namely, to verify a detached
1316 signature, "gpg --verify $file - <$signature" is run, and the
1317 program is expected to signal a good signature by exiting with
1318 code 0, and to generate an ascii-armored detached signature, the
1319 standard input of "gpg -bsau $key" is fed with the contents to be
1320 signed, and the program is expected to send the result to its
1321 standard output.
1322
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001323gui.commitmsgwidth::
1324 Defines how wide the commit message window is in the
1325 linkgit:git-gui[1]. "75" is the default.
1326
1327gui.diffcontext::
1328 Specifies how many context lines should be used in calls to diff
1329 made by the linkgit:git-gui[1]. The default is "5".
1330
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001331gui.encoding::
1332 Specifies the default encoding to use for displaying of
1333 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1334 It can be overridden by setting the 'encoding' attribute
1335 for relevant files (see linkgit:gitattributes[5]).
1336 If this option is not set, the tools default to the
1337 locale encoding.
1338
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001339gui.matchtrackingbranch::
1340 Determines if new branches created with linkgit:git-gui[1] should
1341 default to tracking remote branches with matching names or
1342 not. Default: "false".
1343
1344gui.newbranchtemplate::
1345 Is used as suggested name when creating new branches using the
1346 linkgit:git-gui[1].
1347
1348gui.pruneduringfetch::
Matthieu Moy8b3f3f82010-11-02 16:31:23 +01001349 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001350 performing a fetch. The default value is "false".
1351
1352gui.trustmtime::
1353 Determines if linkgit:git-gui[1] should trust the file modification
1354 timestamp or not. By default the timestamps are not trusted.
1355
1356gui.spellingdictionary::
1357 Specifies the dictionary used for spell checking commit messages in
1358 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1359 off.
1360
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001361gui.fastcopyblame::
Thomas Rastca768282010-01-07 17:49:12 +01001362 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001363 location detection. It makes blame significantly faster on huge
1364 repositories at the expense of less thorough copy detection.
1365
1366gui.copyblamethreshold::
Ralf Wildenhues76bac892008-11-27 08:32:01 +01001367 Specifies the threshold to use in 'git gui blame' original location
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001368 detection, measured in alphanumeric characters. See the
1369 linkgit:git-blame[1] manual for more information on copy detection.
1370
1371gui.blamehistoryctx::
1372 Specifies the radius of history context in days to show in
1373 linkgit:gitk[1] for the selected commit, when the `Show History
1374 Context` menu item is invoked from 'git gui blame'. If this
1375 variable is set to zero, the whole history is shown.
1376
Alexander Gavrilov390c3482008-12-14 22:44:32 +03001377guitool.<name>.cmd::
1378 Specifies the shell command line to execute when the corresponding item
1379 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1380 mandatory for every tool. The command is executed from the root of
1381 the working directory, and in the environment it receives the name of
1382 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1383 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1384 the head is detached, 'CUR_BRANCH' is empty).
1385
1386guitool.<name>.needsfile::
1387 Run the tool only if a diff is selected in the GUI. It guarantees
1388 that 'FILENAME' is not empty.
1389
1390guitool.<name>.noconsole::
1391 Run the command silently, without creating a window to display its
1392 output.
1393
1394guitool.<name>.norescan::
1395 Don't rescan the working directory for changes after the tool
1396 finishes execution.
1397
1398guitool.<name>.confirm::
1399 Show a confirmation dialog before actually running the tool.
1400
1401guitool.<name>.argprompt::
1402 Request a string argument from the user, and pass it to the tool
1403 through the 'ARGS' environment variable. Since requesting an
1404 argument implies confirmation, the 'confirm' option has no effect
1405 if this is enabled. If the option is set to 'true', 'yes', or '1',
1406 the dialog uses a built-in generic prompt; otherwise the exact
1407 value of the variable is used.
1408
1409guitool.<name>.revprompt::
1410 Request a single valid revision from the user, and set the
1411 'REVISION' environment variable. In other aspects this option
1412 is similar to 'argprompt', and can be used together with it.
1413
1414guitool.<name>.revunmerged::
1415 Show only unmerged branches in the 'revprompt' subdialog.
1416 This is useful for tools similar to merge or rebase, but not
1417 for things like checkout or reset.
1418
1419guitool.<name>.title::
1420 Specifies the title to use for the prompt dialog. The default
1421 is the tool name.
1422
1423guitool.<name>.prompt::
1424 Specifies the general prompt string to display at the top of
1425 the dialog, before subsections for 'argprompt' and 'revprompt'.
1426 The default value includes the actual command.
1427
Christian Couder983a9ee2008-01-08 04:55:14 +01001428help.browser::
1429 Specify the browser that will be used to display help in the
1430 'web' format. See linkgit:git-help[1].
1431
1432help.format::
1433 Override the default help format used by linkgit:git-help[1].
1434 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1435 the default. 'web' and 'html' are the same.
1436
Alex Riesenf0e90712008-08-31 15:54:58 +02001437help.autocorrect::
1438 Automatically correct and execute mistyped commands after
1439 waiting for the given number of deciseconds (0.1 sec). If more
1440 than one command can be deduced from the entered text, nothing
1441 will be executed. If the value of this option is negative,
1442 the corrected command will be executed immediately. If the
1443 value is 0 - the command will be just shown but not executed.
1444 This is the default.
1445
Sebastian Staudtb1f809d2013-01-15 21:56:21 +01001446help.htmlpath::
1447 Specify the path where the HTML documentation resides. File system paths
1448 and URLs are supported. HTML pages will be prefixed with this path when
1449 help is displayed in the 'web' format. This defaults to the documentation
1450 path of your Git installation.
1451
Sam Vilain9c5665a2007-11-23 13:07:00 +13001452http.proxy::
Clemens Buchacherb2c8c6d2012-03-04 17:50:43 +01001453 Override the HTTP proxy, normally configured using the 'http_proxy',
1454 'https_proxy', and 'all_proxy' environment variables (see
1455 `curl(1)`). This can be overridden on a per-remote basis; see
1456 remote.<name>.proxy
Sam Vilain9c5665a2007-11-23 13:07:00 +13001457
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001458http.cookiefile::
1459 File containing previously stored cookie lines which should be used
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001460 in the Git http session, if they match the server. The file format
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001461 of the file to read cookies from should be plain HTTP headers or
1462 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1463 NOTE that the file specified with http.cookiefile is only used as
Dave Borowitz912b2ac2013-07-23 15:40:17 -07001464 input unless http.saveCookies is set.
1465
1466http.savecookies::
1467 If set, store cookies received during requests to the file specified by
1468 http.cookiefile. Has no effect if http.cookiefile is unset.
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001469
Petr Baudis1ab661d2006-04-25 00:59:33 +02001470http.sslVerify::
1471 Whether to verify the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001472 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001473 variable.
1474
1475http.sslCert::
1476 File containing the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001477 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001478 variable.
1479
1480http.sslKey::
1481 File containing the SSL private key when fetching or pushing
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001482 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001483 variable.
1484
Mark Lodato754ae192009-05-27 23:16:03 -04001485http.sslCertPasswordProtected::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001486 Enable Git's password prompt for the SSL certificate. Otherwise
Mark Lodato754ae192009-05-27 23:16:03 -04001487 OpenSSL will prompt the user, possibly many times, if the
1488 certificate or private key is encrypted. Can be overridden by the
1489 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1490
Petr Baudis1ab661d2006-04-25 00:59:33 +02001491http.sslCAInfo::
1492 File containing the certificates to verify the peer with when
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001493 fetching or pushing over HTTPS. Can be overridden by the
Petr Baudis1ab661d2006-04-25 00:59:33 +02001494 'GIT_SSL_CAINFO' environment variable.
1495
1496http.sslCAPath::
1497 Path containing files with the CA certificates to verify the peer
Francis Daly37425062006-06-07 13:56:45 +01001498 with when fetching or pushing over HTTPS. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001499 by the 'GIT_SSL_CAPATH' environment variable.
1500
Modestas Vainius4bc444e2013-04-07 22:10:39 +03001501http.sslTry::
1502 Attempt to use AUTH SSL/TLS and encrypted data transfers
1503 when connecting via regular FTP protocol. This might be needed
1504 if the FTP server requires it for security reasons or you wish
1505 to connect securely whenever remote FTP server supports it.
1506 Default is false since it might trigger certificate verification
1507 errors on misconfigured servers.
1508
Petr Baudis1ab661d2006-04-25 00:59:33 +02001509http.maxRequests::
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001510 How many HTTP requests to launch in parallel. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001511 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1512
Tay Ray Chuanad75ebe2009-11-27 23:42:26 +08001513http.minSessions::
1514 The number of curl sessions (counted across slots) to be kept across
1515 requests. They will not be ended with curl_easy_cleanup() until
1516 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1517 value will be capped at 1. Defaults to 1.
1518
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -07001519http.postBuffer::
1520 Maximum size in bytes of the buffer used by smart HTTP
1521 transports when POSTing data to the remote system.
1522 For requests larger than this buffer size, HTTP/1.1 and
1523 Transfer-Encoding: chunked is used to avoid creating a
1524 massive pack file locally. Default is 1 MiB, which is
1525 sufficient for most requests.
1526
Petr Baudis1ab661d2006-04-25 00:59:33 +02001527http.lowSpeedLimit, http.lowSpeedTime::
1528 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1529 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001530 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Petr Baudis1ab661d2006-04-25 00:59:33 +02001531 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1532
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001533http.noEPSV::
1534 A boolean which disables using of EPSV ftp command by curl.
Frank Lichtenheldbefc9c42007-04-13 18:02:33 +02001535 This can helpful with some "poor" ftp servers which don't
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001536 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1537 environment variable. Default is false (curl will use EPSV).
1538
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001539http.useragent::
1540 The HTTP USER_AGENT string presented to an HTTP server. The default
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001541 value represents the version of the client Git such as git/1.7.1.
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001542 This option allows you to override this value to a more common value
1543 such as Mozilla/4.0. This may be necessary, for instance, if
1544 connecting through a firewall that restricts HTTP connections to a set
1545 of common USER_AGENT strings (but not including those like git/1.7.1).
1546 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1547
Kyle J. McKay6a569932013-08-05 13:20:36 -07001548http.<url>.*::
1549 Any of the http.* options above can be applied selectively to some urls.
1550 For a config key to match a URL, each element of the config key is
1551 compared to that of the URL, in the following order:
1552+
1553--
1554. Scheme (e.g., `https` in `https://example.com/`). This field
1555 must match exactly between the config key and the URL.
1556
1557. Host/domain name (e.g., `example.com` in `https://example.com/`).
1558 This field must match exactly between the config key and the URL.
1559
1560. Port number (e.g., `8080` in `http://example.com:8080/`).
1561 This field must match exactly between the config key and the URL.
1562 Omitted port numbers are automatically converted to the correct
1563 default for the scheme before matching.
1564
1565. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1566 path field of the config key must match the path field of the URL
1567 either exactly or as a prefix of slash-delimited path elements. This means
1568 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1569 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1570 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1571 key with just path `foo/`).
1572
1573. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1574 the config key has a user name it must match the user name in the
1575 URL exactly. If the config key does not have a user name, that
1576 config key will match a URL with any user name (including none),
1577 but at a lower precedence than a config key with a user name.
1578--
1579+
1580The list above is ordered by decreasing precedence; a URL that matches
1581a config key's path is preferred to one that matches its user name. For example,
1582if the URL is `https://user@example.com/foo/bar` a config key match of
1583`https://example.com/foo` will be preferred over a config key match of
1584`https://user@example.com`.
1585+
1586All URLs are normalized before attempting any matching (the password part,
1587if embedded in the URL, is always ignored for matching purposes) so that
1588equivalent urls that are simply spelled differently will match properly.
1589Environment variable settings always override any matches. The urls that are
1590matched against are those given directly to Git commands. This means any URLs
1591visited as a result of a redirection do not participate in matching.
1592
Petr Baudis1ab661d2006-04-25 00:59:33 +02001593i18n.commitEncoding::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001594 Character encoding the commit messages are stored in; Git itself
Petr Baudis1ab661d2006-04-25 00:59:33 +02001595 does not care per se, but this information is necessary e.g. when
1596 importing commits from emails or in the gitk graphical history
1597 browser (and possibly at other places in the future or in other
Dan McGee5162e692007-12-29 00:20:38 -06001598 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Petr Baudis1ab661d2006-04-25 00:59:33 +02001599
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001600i18n.logOutputEncoding::
1601 Character encoding the commit messages are converted to when
Thomas Rast0b444cd2010-01-10 00:33:00 +01001602 running 'git log' and friends.
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001603
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001604imap::
1605 The configuration variables in the 'imap' section are described
1606 in linkgit:git-imap-send[1].
1607
Steven Draked8a84882010-02-17 12:44:46 +13001608init.templatedir::
1609 Specify the directory from which templates will be copied.
1610 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1611
Christian Couder983a9ee2008-01-08 04:55:14 +01001612instaweb.browser::
1613 Specify the program that will be used to browse your working
1614 repository in gitweb. See linkgit:git-instaweb[1].
1615
1616instaweb.httpd::
1617 The HTTP daemon command-line to start gitweb on your working
1618 repository. See linkgit:git-instaweb[1].
1619
1620instaweb.local::
1621 If true the web server started by linkgit:git-instaweb[1] will
1622 be bound to the local IP (127.0.0.1).
1623
1624instaweb.modulepath::
Ville Skyttä6b677a22010-07-20 00:17:17 +03001625 The default module path for linkgit:git-instaweb[1] to use
1626 instead of /usr/lib/apache2/modules. Only used if httpd
1627 is Apache.
Christian Couder983a9ee2008-01-08 04:55:14 +01001628
1629instaweb.port::
1630 The port number to bind the gitweb httpd to. See
1631 linkgit:git-instaweb[1].
1632
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001633interactive.singlekey::
Ori Avtalion57f6ec02009-08-07 17:24:21 +03001634 In interactive commands, allow the user to provide one-letter
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001635 input with a single key (i.e., without hitting enter).
Jeff King6cf378f2012-04-26 04:51:57 -04001636 Currently this is used by the `--patch` mode of
Conrad Irwine6b57a82011-05-07 10:59:04 -07001637 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1638 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1639 setting is silently ignored if portable keystroke input
1640 is not available.
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001641
Jay Soffian0c476952011-05-18 13:56:04 -04001642log.abbrevCommit::
1643 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Jeff King6cf378f2012-04-26 04:51:57 -04001644 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1645 override this option with `--no-abbrev-commit`.
Jay Soffian0c476952011-05-18 13:56:04 -04001646
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001647log.date::
Jonathan Niedere8607952010-08-20 05:20:36 -05001648 Set the default date-time mode for the 'log' command.
1649 Setting a value for log.date is similar to using 'git log''s
Jeff King6cf378f2012-04-26 04:51:57 -04001650 `--date` option. Possible values are `relative`, `local`,
Jonathan Niedere8607952010-08-20 05:20:36 -05001651 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1652 for details.
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001653
Steven Drakeeb734452010-02-17 12:39:52 +13001654log.decorate::
1655 Print out the ref names of any commits that are shown by the log
1656 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1657 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1658 specified, the full ref name (including prefix) will be printed.
1659 This is the same as the log commands '--decorate' option.
1660
Peter Baumann0f03ca92006-11-23 10:36:33 +01001661log.showroot::
1662 If true, the initial commit will be shown as a big creation event.
1663 This is equivalent to a diff against an empty tree.
Dan McGee5162e692007-12-29 00:20:38 -06001664 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Peter Baumann0f03ca92006-11-23 10:36:33 +01001665 normally hide the root commit will now show it. True by default.
1666
Antoine Pelissee6bb5f72013-01-05 22:26:46 +01001667log.mailmap::
1668 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1669 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1670
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001671mailmap.file::
1672 The location of an augmenting mailmap file. The default
1673 mailmap, located in the root of the repository, is loaded
1674 first, then the mailmap file pointed to by this variable.
1675 The location of the mailmap file may be in a repository
1676 subdirectory, or somewhere outside of the repository itself.
1677 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1678
Jeff King08610902012-12-12 06:04:04 -05001679mailmap.blob::
1680 Like `mailmap.file`, but consider the value as a reference to a
Jeff King8c473ce2012-12-13 08:04:47 -05001681 blob in the repository. If both `mailmap.file` and
1682 `mailmap.blob` are given, both are parsed, with entries from
1683 `mailmap.file` taking precedence. In a bare repository, this
1684 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1685 defaults to empty.
Jeff King08610902012-12-12 06:04:04 -05001686
Christian Couderb5578f32008-03-07 08:46:55 +01001687man.viewer::
Christian Couderb8322ea2008-03-13 06:48:46 +01001688 Specify the programs that may be used to display help in the
Christian Couderb5578f32008-03-07 08:46:55 +01001689 'man' format. See linkgit:git-help[1].
1690
Christian Couder0bb64002008-04-25 08:25:35 +02001691man.<tool>.cmd::
1692 Specify the command to invoke the specified man viewer. The
1693 specified command is evaluated in shell with the man page
1694 passed as argument. (See linkgit:git-help[1].)
1695
Christian Couder7e8114c2008-04-25 08:24:41 +02001696man.<tool>.path::
1697 Override the path for the given tool that may be used to
1698 display help in the 'man' format. See linkgit:git-help[1].
1699
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001700include::merge-config.txt[]
Junio C Hamanob5412482008-08-29 10:49:56 -07001701
Johannes Schindelin77680ca2007-12-17 12:21:22 +00001702mergetool.<tool>.path::
1703 Override the path for the given tool. This is useful in case
1704 your tool is not in the PATH.
1705
Charles Bailey964473a2008-02-21 23:31:12 +00001706mergetool.<tool>.cmd::
1707 Specify the command to invoke the specified merge tool. The
1708 specified command is evaluated in shell with the following
1709 variables available: 'BASE' is the name of a temporary file
1710 containing the common base of the files to be merged, if available;
1711 'LOCAL' is the name of a temporary file containing the contents of
1712 the file on the current branch; 'REMOTE' is the name of a temporary
1713 file containing the contents of the file from the branch being
1714 merged; 'MERGED' contains the name of the file to which the merge
1715 tool should write the results of a successful merge.
1716
1717mergetool.<tool>.trustExitCode::
1718 For a custom merge command, specify whether the exit code of
1719 the merge command can be used to determine whether the merge was
1720 successful. If this is not set to true then the merge target file
1721 timestamp is checked and the merge assumed to have been successful
1722 if the file has been updated, otherwise the user is prompted to
1723 indicate the success of the merge.
1724
Charles Bailey44c36d12008-02-21 23:30:02 +00001725mergetool.keepBackup::
1726 After performing a merge, the original file with conflict markers
1727 can be saved as a file with a `.orig` extension. If this variable
1728 is set to `false` then this file is not preserved. Defaults to
1729 `true` (i.e. keep the backup files).
1730
Charles Bailey162eba82008-12-12 21:48:41 +00001731mergetool.keepTemporaries::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001732 When invoking a custom merge tool, Git uses a set of temporary
Charles Bailey162eba82008-12-12 21:48:41 +00001733 files to pass to the tool. If the tool returns an error and this
1734 variable is set to `true`, then these temporary files will be
1735 preserved, otherwise they will be removed after the tool has
1736 exited. Defaults to `false`.
1737
Charles Bailey682b4512008-11-13 12:41:14 +00001738mergetool.prompt::
1739 Prompt before each invocation of the merge resolution program.
1740
Thomas Rast894a9d32010-03-12 18:04:26 +01001741notes.displayRef::
1742 The (fully qualified) refname from which to show notes when
1743 showing commit messages. The value of this variable can be set
1744 to a glob, in which case notes from all matching refs will be
1745 shown. You may also specify this configuration variable
1746 several times. A warning will be issued for refs that do not
1747 exist, but a glob that does not match any refs is silently
1748 ignored.
1749+
1750This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1751environment variable, which must be a colon separated list of refs or
1752globs.
1753+
1754The effective value of "core.notesRef" (possibly overridden by
1755GIT_NOTES_REF) is also implicitly added to the list of refs to be
1756displayed.
1757
Thomas Rast6956f852010-03-12 18:04:32 +01001758notes.rewrite.<command>::
1759 When rewriting commits with <command> (currently `amend` or
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001760 `rebase`) and this variable is set to `true`, Git
Thomas Rast6956f852010-03-12 18:04:32 +01001761 automatically copies your notes from the original to the
1762 rewritten commit. Defaults to `true`, but see
1763 "notes.rewriteRef" below.
Thomas Rast6956f852010-03-12 18:04:32 +01001764
1765notes.rewriteMode::
1766 When copying notes during a rewrite (see the
1767 "notes.rewrite.<command>" option), determines what to do if
1768 the target commit already has a note. Must be one of
1769 `overwrite`, `concatenate`, or `ignore`. Defaults to
1770 `concatenate`.
1771+
1772This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1773environment variable.
1774
1775notes.rewriteRef::
1776 When copying notes during a rewrite, specifies the (fully
1777 qualified) ref whose notes should be copied. The ref may be a
1778 glob, in which case notes in all matching refs will be copied.
1779 You may also specify this configuration several times.
1780+
1781Does not have a default value; you must configure this variable to
Thomas Rast2b4aa892011-09-13 09:32:42 +02001782enable note rewriting. Set it to `refs/notes/commits` to enable
1783rewriting for the default commit notes.
Leif Arne Storsetcfb88e92010-05-05 16:16:25 +02001784+
1785This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1786environment variable, which must be a colon separated list of refs or
1787globs.
Thomas Rast6956f852010-03-12 18:04:32 +01001788
Jeff King4812a932006-07-23 01:50:30 -04001789pack.window::
Dan McGee5162e692007-12-29 00:20:38 -06001790 The size of the window used by linkgit:git-pack-objects[1] when no
Jeff King4812a932006-07-23 01:50:30 -04001791 window size is given on the command line. Defaults to 10.
1792
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001793pack.depth::
Dan McGee5162e692007-12-29 00:20:38 -06001794 The maximum delta depth used by linkgit:git-pack-objects[1] when no
Theodore Ts'o618e6132007-05-08 09:28:26 -04001795 maximum depth is given on the command line. Defaults to 50.
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001796
Brian Downinge93b15c2007-07-12 07:55:52 -05001797pack.windowMemory::
Dan McGee5162e692007-12-29 00:20:38 -06001798 The window memory size limit used by linkgit:git-pack-objects[1]
Brian Downinge93b15c2007-07-12 07:55:52 -05001799 when no limit is given on the command line. The value can be
1800 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1801 limit.
1802
Dana How960ccca2007-05-09 13:56:50 -07001803pack.compression::
1804 An integer -1..9, indicating the compression level for objects
1805 in a pack file. -1 is the zlib default. 0 means no
1806 compression, and 1..9 are various speed/size tradeoffs, 9 being
1807 slowest. If not set, defaults to core.compression. If that is
Brian Downingdec92302007-11-19 10:58:51 -06001808 not set, defaults to -1, the zlib default, which is "a default
1809 compromise between speed and compression (currently equivalent
1810 to level 6)."
Jan Krüger89d71f72010-09-27 14:21:58 +02001811+
1812Note that changing the compression level will not automatically recompress
1813all existing objects. You can force recompression by passing the -F option
1814to linkgit:git-repack[1].
Dana How960ccca2007-05-09 13:56:50 -07001815
Martin Koegler074b2ee2007-05-28 23:20:58 +02001816pack.deltaCacheSize::
Brian Hetro02783072007-08-23 20:44:13 -04001817 The maximum memory in bytes used for caching deltas in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001818 linkgit:git-pack-objects[1] before writing them out to a pack.
1819 This cache is used to speed up the writing object phase by not
1820 having to recompute the final delta result once the best match
1821 for all objects is found. Repacking large repositories on machines
1822 which are tight with memory might be badly impacted by this though,
1823 especially if this cache pushes the system into swapping.
1824 A value of 0 means no limit. The smallest size of 1 byte may be
1825 used to virtually disable this cache. Defaults to 256 MiB.
Martin Koegler074b2ee2007-05-28 23:20:58 +02001826
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001827pack.deltaCacheLimit::
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001828 The maximum size of a delta, that is cached in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001829 linkgit:git-pack-objects[1]. This cache is used to speed up the
1830 writing object phase by not having to recompute the final delta
1831 result once the best match for all objects is found. Defaults to 1000.
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001832
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001833pack.threads::
1834 Specifies the number of threads to spawn when searching for best
Dan McGee5162e692007-12-29 00:20:38 -06001835 delta matches. This requires that linkgit:git-pack-objects[1]
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001836 be compiled with pthreads otherwise this option is ignored with a
1837 warning. This is meant to reduce packing time on multiprocessor
1838 machines. The required amount of memory for the delta search window
1839 is however multiplied by the number of threads.
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001840 Specifying 0 will cause Git to auto-detect the number of CPU's
Andreas Ericsson833e3df2008-02-22 20:11:56 -06001841 and set the number of threads accordingly.
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001842
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001843pack.indexVersion::
1844 Specify the default pack index version. Valid values are 1 for
1845 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1846 the new pack index with capabilities for packs larger than 4 GB
1847 as well as proper protection against the repacking of corrupted
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001848 packs. Version 2 is the default. Note that version 2 is enforced
1849 and this config option ignored whenever the corresponding pack is
1850 larger than 2 GB.
1851+
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001852If you have an old Git that does not understand the version 2 `*.idx` file,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001853cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Jeff King6cf378f2012-04-26 04:51:57 -04001854that will copy both `*.pack` file and corresponding `*.idx` file from the
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001855other side may give you a repository that cannot be accessed with your
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001856older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001857you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Jeff King6cf378f2012-04-26 04:51:57 -04001858the `*.idx` file.
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001859
Junio C Hamanodbdbfec2008-03-12 23:11:15 -07001860pack.packSizeLimit::
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001861 The maximum size of a pack. This setting only affects
1862 packing to a file when repacking, i.e. the git:// protocol
Jeff King6cf378f2012-04-26 04:51:57 -04001863 is unaffected. It can be overridden by the `--max-pack-size`
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001864 option of linkgit:git-repack[1]. The minimum size allowed is
1865 limited to 1 MiB. The default is unlimited.
1866 Common unit suffixes of 'k', 'm', or 'g' are
1867 supported.
Johannes Schindelin2b84b5a2008-02-05 14:25:04 +00001868
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001869pager.<cmd>::
Jeff King9bad7232010-11-17 12:04:12 -05001870 If the value is boolean, turns on or off pagination of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001871 output of a particular Git subcommand when writing to a tty.
Jeff King9bad7232010-11-17 12:04:12 -05001872 Otherwise, turns on pagination for the subcommand using the
Jeff King6cf378f2012-04-26 04:51:57 -04001873 pager specified by the value of `pager.<cmd>`. If `--paginate`
1874 or `--no-pager` is specified on the command line, it takes
Jeff King9bad7232010-11-17 12:04:12 -05001875 precedence over this option. To disable pagination for all
1876 commands, set `core.pager` or `GIT_PAGER` to `cat`.
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001877
Will Palmer80281842010-05-02 12:00:44 +01001878pretty.<name>::
1879 Alias for a --pretty= format string, as specified in
1880 linkgit:git-log[1]. Any aliases defined here can be used just
1881 as the built-in pretty formats could. For example,
Jeff King6cf378f2012-04-26 04:51:57 -04001882 running `git config pretty.changelog "format:* %H %s"`
Will Palmer80281842010-05-02 12:00:44 +01001883 would cause the invocation `git log --pretty=changelog`
Jeff King6cf378f2012-04-26 04:51:57 -04001884 to be equivalent to running `git log "--pretty=format:* %H %s"`.
Will Palmer80281842010-05-02 12:00:44 +01001885 Note that an alias with the same name as a built-in format
1886 will be silently ignored.
1887
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001888pull.rebase::
1889 When true, rebase branches on top of the fetched branch, instead
1890 of merging the default branch from the default remote when "git
1891 pull" is run. See "branch.<name>.rebase" for setting this on a
1892 per-branch basis.
1893+
Stephen Haberman66713ef2013-08-12 22:43:42 -05001894 When preserve, also pass `--preserve-merges` along to 'git rebase'
1895 so that locally committed merge commits will not be flattened
1896 by running 'git pull'.
1897+
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001898*NOTE*: this is a possibly dangerous operation; do *not* use
1899it unless you understand the implications (see linkgit:git-rebase[1]
1900for details).
1901
Petr Baudis1ab661d2006-04-25 00:59:33 +02001902pull.octopus::
1903 The default merge strategy to use when pulling multiple branches
1904 at once.
1905
1906pull.twohead::
1907 The default merge strategy to use when pulling a single branch.
1908
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001909push.default::
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05301910 Defines the action `git push` should take if no refspec is
1911 explicitly given. Different values are well-suited for
1912 specific workflows; for instance, in a purely central workflow
1913 (i.e. the fetch source is equal to the push destination),
1914 `upstream` is probably what you want. Possible values are:
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001915+
Andreas Schwabb1290512012-06-23 15:18:00 +02001916--
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05301917
1918* `nothing` - do not push anything (error out) unless a refspec is
1919 explicitly given. This is primarily meant for people who want to
1920 avoid mistakes by always being explicit.
1921
1922* `current` - push the current branch to update a branch with the same
1923 name on the receiving end. Works in both central and non-central
1924 workflows.
1925
1926* `upstream` - push the current branch back to the branch whose
1927 changes are usually integrated into the current branch (which is
1928 called `@{upstream}`). This mode only makes sense if you are
1929 pushing to the same repository you would normally pull from
1930 (i.e. central workflow).
1931
Ramkumar Ramachandraed2b1822013-06-19 16:41:41 +05301932* `simple` - in centralized workflow, work like `upstream` with an
1933 added safety to refuse to push if the upstream branch's name is
1934 different from the local one.
Andreas Schwabb1290512012-06-23 15:18:00 +02001935+
Ramkumar Ramachandraed2b1822013-06-19 16:41:41 +05301936When pushing to a remote that is different from the remote you normally
1937pull from, work as `current`. This is the safest option and is suited
1938for beginners.
Andreas Schwabb1290512012-06-23 15:18:00 +02001939+
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05301940This mode will become the default in Git 2.0.
1941
1942* `matching` - push all branches having the same name on both ends.
1943 This makes the repository you are pushing to remember the set of
1944 branches that will be pushed out (e.g. if you always push 'maint'
1945 and 'master' there and no other branches, the repository you push
1946 to will have these two branches, and your local 'maint' and
1947 'master' will be pushed there).
1948+
1949To use this mode effectively, you have to make sure _all_ the
1950branches you would push out are ready to be pushed out before
1951running 'git push', as the whole point of this mode is to allow you
1952to push all of the branches in one go. If you usually finish work
1953on only one branch and push out the result, while other branches are
1954unfinished, this mode is not for you. Also this mode is not
1955suitable for pushing into a shared central repository, as other
1956people may add new branches there, or update the tip of existing
1957branches outside your control.
1958+
1959This is currently the default, but Git 2.0 will change the default
1960to `simple`.
1961
1962--
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001963
Tor Arne Vestbøa9c38212009-03-01 23:11:38 +01001964rebase.stat::
1965 Whether to show a diffstat of what changed upstream since the last
1966 rebase. False by default.
1967
Heiko Voigtdd1e5b32010-07-14 13:59:57 +02001968rebase.autosquash::
1969 If set to true enable '--autosquash' option by default.
1970
Ramkumar Ramachandra58794772013-05-12 17:26:41 +05301971rebase.autostash::
1972 When set to true, automatically create a temporary stash
1973 before the operation begins, and apply it after the operation
1974 ends. This means that you can run rebase on a dirty worktree.
1975 However, use with care: the final stash application after a
1976 successful rebase might result in non-trivial conflicts.
1977 Defaults to false.
1978
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001979receive.autogc::
1980 By default, git-receive-pack will run "git-gc --auto" after
1981 receiving data from git-push and updating refs. You can stop
1982 it by setting this variable to false.
1983
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001984receive.fsckObjects::
1985 If it is set to true, git-receive-pack will check all received
1986 objects. It will abort in the case of a malformed object or a
1987 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001988 Defaults to false. If not set, the value of `transfer.fsckObjects`
1989 is used instead.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001990
1991receive.unpackLimit::
1992 If the number of objects received in a push is below this
1993 limit then the objects will be unpacked into loose object
1994 files. However if the number of received objects equals or
1995 exceeds this limit then the received pack will be stored as
1996 a pack, after adding any missing delta bases. Storing the
1997 pack from a push can make the push operation complete faster,
1998 especially on slow filesystems. If not set, the value of
1999 `transfer.unpackLimit` is used instead.
2000
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002001receive.denyDeletes::
2002 If set to true, git-receive-pack will deny a ref update that deletes
2003 the ref. Use this to prevent such a ref deletion via a push.
2004
Thomas Rast662c83f2010-07-24 18:07:53 +02002005receive.denyDeleteCurrent::
2006 If set to true, git-receive-pack will deny a ref update that
2007 deletes the currently checked out branch of a non-bare repository.
2008
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002009receive.denyCurrentBranch::
Michael J Gruberf3838ce2010-05-13 14:51:38 +02002010 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002011 to the currently checked out branch of a non-bare repository.
2012 Such a push is potentially dangerous because it brings the HEAD
2013 out of sync with the index and working tree. If set to "warn",
2014 print a warning of such a push to stderr, but allow the push to
2015 proceed. If set to false or "ignore", allow such pushes with no
Thomas Rast7d182f52010-03-17 12:14:57 +01002016 message. Defaults to "refuse".
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002017
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002018receive.denyNonFastForwards::
2019 If set to true, git-receive-pack will deny a ref update which is
Felipe Contrerasa75d7b52009-10-24 11:31:32 +03002020 not a fast-forward. Use this to prevent such an update via a push,
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002021 even if that push is forced. This configuration variable is
2022 set when initializing a shared repository.
2023
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002024receive.hiderefs::
2025 String(s) `receive-pack` uses to decide which refs to omit
2026 from its initial advertisement. Use more than one
2027 definitions to specify multiple prefix strings. A ref that
2028 are under the hierarchies listed on the value of this
2029 variable is excluded, and is hidden when responding to `git
2030 push`, and an attempt to update or delete a hidden ref by
2031 `git push` is rejected.
2032
Junio C Hamano77e3efb2009-10-20 14:56:40 -07002033receive.updateserverinfo::
2034 If set to true, git-receive-pack will run git-update-server-info
2035 after receiving data from git-push and updating refs.
2036
Nguyễn Thái Ngọc Duy0a1bc122013-12-05 20:02:47 +07002037receive.shallowupdate::
2038 If set to true, .git/shallow can be updated when new refs
2039 require new shallow roots. Otherwise those refs are rejected.
2040
Ramkumar Ramachandra224c2172013-04-02 13:10:33 +05302041remote.pushdefault::
2042 The remote to push to by default. Overrides
Ramkumar Ramachandra9f765ce2013-04-02 13:10:34 +05302043 `branch.<name>.remote` for all branches, and is overridden by
2044 `branch.<name>.pushremote` for specific branches.
Ramkumar Ramachandra224c2172013-04-02 13:10:33 +05302045
Santi Béjar0cc6d342006-10-23 18:42:14 +02002046remote.<name>.url::
Dan McGee5162e692007-12-29 00:20:38 -06002047 The URL of a remote repository. See linkgit:git-fetch[1] or
2048 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02002049
Michael J Gruber20346232009-06-09 18:01:34 +02002050remote.<name>.pushurl::
2051 The push URL of a remote repository. See linkgit:git-push[1].
2052
Sam Vilain14c98212007-12-04 10:48:54 +13002053remote.<name>.proxy::
2054 For remotes that require curl (http, https and ftp), the URL to
2055 the proxy to use for that remote. Set to the empty string to
2056 disable proxying for that remote.
2057
Santi Béjar0cc6d342006-10-23 18:42:14 +02002058remote.<name>.fetch::
Dan McGee5162e692007-12-29 00:20:38 -06002059 The default set of "refspec" for linkgit:git-fetch[1]. See
2060 linkgit:git-fetch[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02002061
2062remote.<name>.push::
Dan McGee5162e692007-12-29 00:20:38 -06002063 The default set of "refspec" for linkgit:git-push[1]. See
2064 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02002065
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02002066remote.<name>.mirror::
2067 If true, pushing to this remote will automatically behave
Jeff King6cf378f2012-04-26 04:51:57 -04002068 as if the `--mirror` option was given on the command line.
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02002069
Theodore Ts'o19182782007-02-20 15:13:43 -05002070remote.<name>.skipDefaultUpdate::
2071 If true, this remote will be skipped by default when updating
Björn Gustavsson7cc91a22009-11-09 21:11:06 +01002072 using linkgit:git-fetch[1] or the `update` subcommand of
2073 linkgit:git-remote[1].
2074
2075remote.<name>.skipFetchAll::
2076 If true, this remote will be skipped by default when updating
2077 using linkgit:git-fetch[1] or the `update` subcommand of
2078 linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05002079
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01002080remote.<name>.receivepack::
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01002081 The default program to execute on the remote side when pushing. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01002082 option \--receive-pack of linkgit:git-push[1].
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01002083
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01002084remote.<name>.uploadpack::
2085 The default program to execute on the remote side when fetching. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01002086 option \--upload-pack of linkgit:git-fetch-pack[1].
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01002087
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05302088remote.<name>.tagopt::
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01002089 Setting this value to \--no-tags disables automatic tag following when
Samuel Tardieu944163a2010-04-20 01:31:25 +02002090 fetching from remote <name>. Setting it to \--tags will fetch every
2091 tag from remote <name>, even if they are not reachable from remote
Daniel Johnsoned368542010-08-11 18:57:20 -04002092 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2093 override this setting. See options \--tags and \--no-tags of
2094 linkgit:git-fetch[1].
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05302095
Daniel Barkalowc578f512009-11-18 02:42:25 +01002096remote.<name>.vcs::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002097 Setting this to a value <vcs> will cause Git to interact with
Daniel Barkalowc578f512009-11-18 02:42:25 +01002098 the remote with the git-remote-<vcs> helper.
2099
Michael Schubert737c5a92013-07-13 11:36:24 +02002100remote.<name>.prune::
2101 When set to true, fetching from this remote by default will also
Michael Haggerty0838bf42013-10-30 06:33:00 +01002102 remove any remote-tracking references that no longer exist on the
2103 remote (as if the `--prune` option was given on the command line).
Michael Schubert737c5a92013-07-13 11:36:24 +02002104 Overrides `fetch.prune` settings, if any.
2105
Theodore Ts'o19182782007-02-20 15:13:43 -05002106remotes.<group>::
2107 The list of remotes which are fetched by "git remote update
Dan McGee5162e692007-12-29 00:20:38 -06002108 <group>". See linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05002109
Junio C Hamanob6945f52006-10-13 21:28:58 -07002110repack.usedeltabaseoffset::
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04002111 By default, linkgit:git-repack[1] creates packs that use
2112 delta-base offset. If you need to share your repository with
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002113 Git older than version 1.4.4, either directly or via a dumb
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04002114 protocol such as http, then you need to set this option to
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002115 "false" and repack. Access from old Git versions over the
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04002116 native protocol are unaffected by this option.
Junio C Hamanob6945f52006-10-13 21:28:58 -07002117
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002118rerere.autoupdate::
2119 When set to true, `git-rerere` updates the index with the
2120 resulting contents after it cleanly resolves conflicts using
2121 previously recorded resolution. Defaults to false.
2122
2123rerere.enabled::
2124 Activate recording of resolved conflicts, so that identical
Thomas Rast07b88a02012-01-06 14:08:02 +01002125 conflict hunks can be resolved automatically, should they be
2126 encountered again. By default, linkgit:git-rerere[1] is
2127 enabled if there is an `rr-cache` directory under the
Junio C Hamanob6fb7fe2012-01-10 15:57:27 +01002128 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2129 repository.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002130
Yann Dirson65180c62009-07-22 23:39:30 +02002131sendemail.identity::
2132 A configuration identity. When given, causes values in the
2133 'sendemail.<identity>' subsection to take precedence over
2134 values in the 'sendemail' section. The default identity is
2135 the value of 'sendemail.identity'.
2136
2137sendemail.smtpencryption::
2138 See linkgit:git-send-email[1] for description. Note that this
2139 setting is not subject to the 'identity' mechanism.
2140
2141sendemail.smtpssl::
2142 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2143
Ramkumar Ramachandra35035bb2013-07-18 09:53:11 -07002144sendemail.smtpsslcertpath::
2145 Path to ca-certificates (either a directory or a single file).
2146 Set it to an empty string to disable certificate verification.
2147
Yann Dirson65180c62009-07-22 23:39:30 +02002148sendemail.<identity>.*::
2149 Identity-specific versions of the 'sendemail.*' parameters
2150 found below, taking precedence over those when the this
2151 identity is selected, through command-line or
2152 'sendemail.identity'.
2153
2154sendemail.aliasesfile::
2155sendemail.aliasfiletype::
Felipe Contreras402596a2013-04-07 01:10:27 -06002156sendemail.annotate::
Yann Dirson65180c62009-07-22 23:39:30 +02002157sendemail.bcc::
2158sendemail.cc::
2159sendemail.cccmd::
2160sendemail.chainreplyto::
2161sendemail.confirm::
2162sendemail.envelopesender::
2163sendemail.from::
2164sendemail.multiedit::
2165sendemail.signedoffbycc::
2166sendemail.smtppass::
2167sendemail.suppresscc::
2168sendemail.suppressfrom::
2169sendemail.to::
Brian Gernhardt69cf7bf2010-04-10 10:53:56 -04002170sendemail.smtpdomain::
Yann Dirson65180c62009-07-22 23:39:30 +02002171sendemail.smtpserver::
2172sendemail.smtpserverport::
Pascal Obry052fbea2010-09-06 20:12:11 +02002173sendemail.smtpserveroption::
Yann Dirson65180c62009-07-22 23:39:30 +02002174sendemail.smtpuser::
2175sendemail.thread::
2176sendemail.validate::
2177 See linkgit:git-send-email[1] for description.
2178
2179sendemail.signedoffcc::
2180 Deprecated alias for 'sendemail.signedoffbycc'.
2181
Petr Baudis1ab661d2006-04-25 00:59:33 +02002182showbranch.default::
Dan McGee5162e692007-12-29 00:20:38 -06002183 The default set of branches for linkgit:git-show-branch[1].
2184 See linkgit:git-show-branch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002185
Jeff King46f721c2007-12-07 16:26:07 -05002186status.relativePaths::
Dan McGee5162e692007-12-29 00:20:38 -06002187 By default, linkgit:git-status[1] shows paths relative to the
Jeff King46f721c2007-12-07 16:26:07 -05002188 current directory. Setting this variable to `false` shows paths
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002189 relative to the repository root (this was the default for Git
Jeff King46f721c2007-12-07 16:26:07 -05002190 prior to v1.5.4).
2191
Jorge Juan Garcia Garcia4fb51662013-06-11 15:34:04 +02002192status.short::
2193 Set to true to enable --short by default in linkgit:git-status[1].
2194 The option --no-short takes precedence over this variable.
2195
Jorge Juan Garcia Garciaec85d072013-06-11 15:34:05 +02002196status.branch::
2197 Set to true to enable --branch by default in linkgit:git-status[1].
2198 The option --no-branch takes precedence over this variable.
2199
Matthieu Moy2556b992013-09-06 19:43:07 +02002200status.displayCommentPrefix::
2201 If set to true, linkgit:git-status[1] will insert a comment
2202 prefix before each output line (starting with
2203 `core.commentChar`, i.e. `#` by default). This was the
2204 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2205 Defaults to false.
2206
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02002207status.showUntrackedFiles::
2208 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2209 files which are not currently tracked by Git. Directories which
2210 contain only untracked files, are shown with the directory name
2211 only. Showing untracked files means that Git needs to lstat() all
2212 all the files in the whole repository, which might be slow on some
2213 systems. So, this variable controls how the commands displays
2214 the untracked files. Possible values are:
2215+
2216--
Cliff Frey9373bdc2010-10-17 20:10:45 -07002217* `no` - Show no untracked files.
2218* `normal` - Show untracked files and directories.
2219* `all` - Show also individual files in untracked directories.
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02002220--
2221+
2222If this variable is not specified, it defaults to 'normal'.
2223This variable can be overridden with the -u|--untracked-files option
2224of linkgit:git-status[1] and linkgit:git-commit[1].
2225
Michael J Gruber4b2343f2010-05-20 17:55:42 +02002226status.submodulesummary::
2227 Defaults to false.
2228 If this is set to a non zero number or true (identical to -1 or an
2229 unlimited number), the submodule summary will be enabled and a
2230 summary of commits for modified submodules will be shown (see
Jens Lehmannbb58b692013-09-11 21:07:15 +02002231 --summary-limit option of linkgit:git-submodule[1]). Please note
2232 that the summary output command will be suppressed for all
2233 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2234 for those submodules where `submodule.<name>.ignore=all`. To
2235 also view the summary for ignored submodules you can either use
2236 the --ignore-submodules=dirty command line option or the 'git
2237 submodule summary' command, which shows a similar output but does
2238 not honor these settings.
Michael J Gruber4b2343f2010-05-20 17:55:42 +02002239
Jonathan Nieder0ad0a612010-07-15 02:51:19 -05002240submodule.<name>.path::
2241submodule.<name>.url::
2242submodule.<name>.update::
2243 The path within this project, URL, and the updating strategy
2244 for a submodule. These variables are initially populated
2245 by 'git submodule init'; edit them to override the
2246 URL and other values found in the `.gitmodules` file. See
2247 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2248
W. Trevor King06b1abb2012-12-19 11:03:32 -05002249submodule.<name>.branch::
2250 The remote branch name for a submodule, used by `git submodule
2251 update --remote`. Set this option to override the value found in
2252 the `.gitmodules` file. See linkgit:git-submodule[1] and
2253 linkgit:gitmodules[5] for details.
2254
Jens Lehmannc1a3c362010-11-11 00:55:41 +01002255submodule.<name>.fetchRecurseSubmodules::
Jens Lehmannbf42b382011-03-06 23:12:19 +01002256 This option can be used to control recursive fetching of this
Ralf Wildenhues469bfc92011-01-03 20:03:34 +01002257 submodule. It can be overridden by using the --[no-]recurse-submodules
Jens Lehmannc1a3c362010-11-11 00:55:41 +01002258 command line option to "git fetch" and "git pull".
2259 This setting will override that from in the linkgit:gitmodules[5]
2260 file.
2261
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002262submodule.<name>.ignore::
2263 Defines under what circumstances "git status" and the diff family show
2264 a submodule as modified. When set to "all", it will never be considered
2265 modified, "dirty" will ignore all changes to the submodules work tree and
2266 takes only differences between the HEAD of the submodule and the commit
2267 recorded in the superproject into account. "untracked" will additionally
2268 let submodules with modified tracked files in their work tree show up.
2269 Using "none" (the default when this option is not set) also shows
2270 submodules that have untracked files in their work tree as changed.
Jens Lehmann302ad7a2010-08-06 00:40:48 +02002271 This setting overrides any setting made in .gitmodules for this submodule,
Ralf Wildenhues3776ea92010-08-22 13:12:12 +02002272 both settings can be overridden on the command line by using the
Jens Lehmannbb58b692013-09-11 21:07:15 +02002273 "--ignore-submodules" option. The 'git submodule' commands are not
2274 affected by this setting.
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002275
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002276tar.umask::
René Scharfe687157c2007-08-21 20:01:16 +02002277 This variable can be used to restrict the permission bits of
2278 tar archive entries. The default is 0002, which turns off the
2279 world write bit. The special value "user" indicates that the
2280 archiving user's umask will be used instead. See umask(2) and
Dan McGee5162e692007-12-29 00:20:38 -06002281 linkgit:git-archive[1].
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002282
Junio C Hamanodab76d32011-09-04 12:37:45 -07002283transfer.fsckObjects::
2284 When `fetch.fsckObjects` or `receive.fsckObjects` are
2285 not set, the value of this variable is used instead.
2286 Defaults to false.
2287
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002288transfer.hiderefs::
2289 This variable can be used to set both `receive.hiderefs`
2290 and `uploadpack.hiderefs` at the same time to the same
2291 values. See entries for these other variables.
2292
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002293transfer.unpackLimit::
2294 When `fetch.unpackLimit` or `receive.unpackLimit` are
2295 not set, the value of this variable is used instead.
2296 The default value is 100.
2297
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002298uploadpack.hiderefs::
2299 String(s) `upload-pack` uses to decide which refs to omit
2300 from its initial advertisement. Use more than one
2301 definitions to specify multiple prefix strings. A ref that
2302 are under the hierarchies listed on the value of this
2303 variable is excluded, and is hidden from `git ls-remote`,
2304 `git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano390eb362013-01-28 21:49:57 -08002305 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2306
2307uploadpack.allowtipsha1inwant::
2308 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2309 to accept a fetch request that asks for an object at the tip
2310 of a hidden ref (by default, such a request is rejected).
2311 see also `uploadpack.hiderefs`.
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002312
Jeff King05e95152013-09-08 05:01:31 -04002313uploadpack.keepalive::
2314 When `upload-pack` has started `pack-objects`, there may be a
2315 quiet period while `pack-objects` prepares the pack. Normally
2316 it would output progress information, but if `--quiet` was used
2317 for the fetch, `pack-objects` will output nothing at all until
2318 the pack data begins. Some clients and networks may consider
2319 the server to be hung and give up. Setting this option instructs
2320 `upload-pack` to send an empty keepalive packet every
2321 `uploadpack.keepalive` seconds. Setting this option to 0
Jeff King115dedd2013-09-08 05:02:06 -04002322 disables keepalive packets entirely. The default is 5 seconds.
Jeff King05e95152013-09-08 05:01:31 -04002323
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002324url.<base>.insteadOf::
2325 Any URL that starts with this value will be rewritten to
2326 start, instead, with <base>. In cases where some site serves a
2327 large number of repositories, and serves them with multiple
2328 access methods, and some users need to use different access
2329 methods, this feature allows people to specify any of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002330 equivalent URLs and have Git automatically rewrite the URL to
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002331 the best alternative for the particular user, even for a
Junio C Hamano844112c2008-02-24 22:25:04 -08002332 never-before-seen repository on the site. When more than one
2333 insteadOf strings match a given URL, the longest match is used.
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002334
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002335url.<base>.pushInsteadOf::
2336 Any URL that starts with this value will not be pushed to;
2337 instead, it will be rewritten to start with <base>, and the
2338 resulting URL will be pushed to. In cases where some site serves
2339 a large number of repositories, and serves them with multiple
2340 access methods, some of which do not allow push, this feature
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002341 allows people to specify a pull-only URL and have Git
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002342 automatically use an appropriate URL to push, even for a
2343 never-before-seen repository on the site. When more than one
2344 pushInsteadOf strings match a given URL, the longest match is
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002345 used. If a remote has an explicit pushurl, Git will ignore this
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002346 setting for that remote.
2347
Petr Baudis1ab661d2006-04-25 00:59:33 +02002348user.email::
2349 Your email address to be recorded in any newly created commits.
Josh Triplett28a94f82007-04-28 18:40:28 -07002350 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Dan McGee5162e692007-12-29 00:20:38 -06002351 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002352
2353user.name::
2354 Your full name to be recorded in any newly created commits.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04002355 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Dan McGee5162e692007-12-29 00:20:38 -06002356 environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002357
Andy Parkinsd67778e2007-01-26 14:13:46 +00002358user.signingkey::
Nicolas Vigierf0551692013-10-14 19:04:36 +02002359 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2360 key you want it to automatically when creating a signed tag or
2361 commit, you can override the default selection with this variable.
2362 This option is passed unchanged to gpg's --local-user parameter,
2363 so you may specify a key using any method that gpg supports.
Andy Parkinsd67778e2007-01-26 14:13:46 +00002364
Christian Couder983a9ee2008-01-08 04:55:14 +01002365web.browser::
2366 Specify a web browser that may be used by some commands.
2367 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2368 may use it.