blob: 0bcea8a949e96d53ebc7aa956d70ef7873551320 [file] [log] [blame]
Petr Baudis1ab661d2006-04-25 00:59:33 +02001CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Stephen Boyd773002a2009-04-23 02:38:00 -07005the git command's 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
Stephen Boydb7ee2262009-04-23 02:38:01 -070011The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
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--
143 pushNonFastForward::
Christopher Tiwaldf25950f2012-03-20 00:31:33 -0400144 Set this variable to 'false' if you want to disable
145 'pushNonFFCurrent', 'pushNonFFDefault', and
146 'pushNonFFMatching' simultaneously.
147 pushNonFFCurrent::
148 Advice shown when linkgit:git-push[1] fails due to a
149 non-fast-forward update to the current branch.
150 pushNonFFDefault::
151 Advice to set 'push.default' to 'upstream' or 'current'
152 when you ran linkgit:git-push[1] and pushed 'matching
153 refs' by default (i.e. you did not provide an explicit
154 refspec, and no 'push.default' configuration was set)
155 and it resulted in a non-fast-forward error.
156 pushNonFFMatching::
157 Advice shown when you ran linkgit:git-push[1] and pushed
158 'matching refs' explicitly (i.e. you used ':', or
159 specified a refspec that isn't your current branch) and
160 it resulted in a non-fast-forward error.
Jeff Kingedf563f2009-09-09 07:43:03 -0400161 statusHints::
Lucien Kong83c750a2012-06-05 22:21:24 +0200162 Show directions on how to proceed from the current
163 state in the output of linkgit:git-status[1] and in
164 the template shown when writing commit messages in
165 linkgit:git-commit[1].
Matthieu Moy4c371f92009-11-22 23:26:17 +0100166 commitBeforeMerge::
167 Advice shown when linkgit:git-merge[1] refuses to
Ville Skyttä6b677a22010-07-20 00:17:17 +0300168 merge to avoid overwriting local changes.
Matthieu Moyd38a30d2010-01-12 10:54:44 +0100169 resolveConflict::
170 Advices shown by various commands when conflicts
171 prevent the operation from being performed.
Jeff Kingb706fcf2010-01-13 15:17:08 -0500172 implicitIdentity::
173 Advice on how to set your identity configuration when
174 your information is guessed from the system username and
Junio C Hamano26e94af2011-12-18 21:35:01 -0800175 domain name.
Junio C Hamano13be3e32010-01-29 22:03:24 -0800176 detachedHead::
Junio C Hamano26e94af2011-12-18 21:35:01 -0800177 Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano13be3e32010-01-29 22:03:24 -0800178 move to the detach HEAD state, to instruct how to create
Junio C Hamano26e94af2011-12-18 21:35:01 -0800179 a local branch after the fact.
Jeff King75194432009-09-09 07:38:58 -0400180--
181
Petr Baudis1ab661d2006-04-25 00:59:33 +0200182core.fileMode::
183 If false, the executable bit differences between the index and
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200184 the working tree are ignored; useful on broken filesystems like FAT.
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700185 See linkgit:git-update-index[1].
186+
187The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
188will probe and set core.fileMode false if appropriate when the
189repository is created.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200190
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400191core.ignoreCygwinFSTricks::
192 This option is only used by Cygwin implementation of Git. If false,
193 the Cygwin stat() and lstat() functions are used. This may be useful
194 if your repository consists of a few separate directories joined in
195 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
196 whenever it is possible and falls back to Cygwin functions only to
197 handle symbol links. The native mode is more than twice faster than
Mark Levedahl7faee6b2008-10-13 00:33:31 -0400198 normal Cygwin l/stat() functions. True by default, unless core.filemode
199 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
200 POSIX emulation is required to support core.filemode.
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400201
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700202core.ignorecase::
203 If true, this option enables various workarounds to enable
204 git to work better on filesystems that are not case sensitive,
205 like FAT. For example, if a directory listing finds
206 "makefile" when git expects "Makefile", git will assume
207 it is really the same file, and continue to remember it as
208 "Makefile".
209+
210The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
211will probe and set core.ignorecase true if appropriate when the repository
212is created.
213
Alex Riesen1ce47902008-07-28 08:31:28 +0200214core.trustctime::
215 If false, the ctime differences between the index and the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200216 working tree are ignored; useful when the inode change time
Alex Riesen1ce47902008-07-28 08:31:28 +0200217 is regularly modified by something outside Git (file system
218 crawlers and some backup systems).
219 See linkgit:git-update-index[1]. True by default.
220
Junio C Hamano9378c162007-06-24 15:11:24 -0700221core.quotepath::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500222 The commands that output paths (e.g. 'ls-files',
223 'diff'), when not given the `-z` option, will quote
Junio C Hamano9378c162007-06-24 15:11:24 -0700224 "unusual" characters in the pathname by enclosing the
225 pathname in a double-quote pair and with backslashes the
226 same way strings in C source code are quoted. If this
227 variable is set to false, the bytes higher than 0x80 are
228 not quoted but output as verbatim. Note that double
229 quote, backslash and control characters are always
230 quoted without `-z` regardless of the setting of this
231 variable.
232
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200233core.eol::
234 Sets the line ending type to use in the working directory for
235 files that have the `text` property set. Alternatives are
236 'lf', 'crlf' and 'native', which uses the platform's native
237 line ending. The default value is `native`. See
238 linkgit:gitattributes[5] for more information on end-of-line
239 conversion.
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200240
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100241core.safecrlf::
Eyvind Bernhardsenfd6cce92010-05-19 22:43:10 +0200242 If true, makes git check if converting `CRLF` is reversible when
243 end-of-line conversion is active. Git will verify if a command
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100244 modifies a file in the work tree either directly or indirectly.
245 For example, committing a file followed by checking out the
246 same file should yield the original file in the work tree. If
247 this is not the case for the current setting of
248 `core.autocrlf`, git will reject the file. The variable can
249 be set to "warn", in which case git will only warn about an
250 irreversible conversion but continue the operation.
251+
252CRLF conversion bears a slight chance of corrupting data.
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200253When it is enabled, git will convert CRLF to LF during commit and LF to
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100254CRLF during checkout. A file that contains a mixture of LF and
255CRLF before the commit cannot be recreated by git. For text
256files this is the right thing to do: it corrects line endings
257such that we have only LF line endings in the repository.
258But for binary files that are accidentally classified as text the
259conversion can corrupt data.
260+
261If you recognize such corruption early you can easily fix it by
262setting the conversion type explicitly in .gitattributes. Right
263after committing you still have the original file in your work
264tree and this file is not yet corrupted. You can explicitly tell
265git that this file is binary and git will handle the file
266appropriately.
267+
268Unfortunately, the desired effect of cleaning up text files with
269mixed line endings and the undesired effect of corrupting binary
270files cannot be distinguished. In both cases CRLFs are removed
271in an irreversible way. For text files this is the right thing
272to do because CRLFs are line endings, while for binary files
273converting CRLFs corrupts data.
274+
275Note, this safety check does not mean that a checkout will generate a
276file identical to the original file for a different setting of
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200277`core.eol` and `core.autocrlf`, but only for the current one. For
278example, a text file with `LF` would be accepted with `core.eol=lf`
279and could later be checked out with `core.eol=crlf`, in which case the
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100280resulting file would contain `CRLF`, although the original file
281contained `LF`. However, in both work trees the line endings would be
282consistent, that is either all `LF` or all `CRLF`, but never mixed. A
283file with mixed line endings would be reported by the `core.safecrlf`
284mechanism.
285
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200286core.autocrlf::
287 Setting this variable to "true" is almost the same as setting
288 the `text` attribute to "auto" on all files except that text
289 files are not guaranteed to be normalized: files that contain
290 `CRLF` in the repository will not be touched. Use this
291 setting if you want to have `CRLF` line endings in your
292 working directory even though the repository does not have
293 normalized line endings. This variable can be set to 'input',
294 in which case no output conversion is performed.
295
Johannes Sixt78a8d642007-03-02 22:11:30 +0100296core.symlinks::
297 If false, symbolic links are checked out as small plain files that
Dan McGee5162e692007-12-29 00:20:38 -0600298 contain the link text. linkgit:git-update-index[1] and
299 linkgit:git-add[1] will not change the recorded type to regular
Johannes Sixt78a8d642007-03-02 22:11:30 +0100300 file. Useful on filesystems like FAT that do not support
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700301 symbolic links.
302+
303The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
304will probe and set core.symlinks false if appropriate when the repository
305is created.
Johannes Sixt78a8d642007-03-02 22:11:30 +0100306
Petr Baudis1ab661d2006-04-25 00:59:33 +0200307core.gitProxy::
308 A "proxy command" to execute (as 'command host port') instead
309 of establishing direct connection to the remote server when
310 using the git protocol for fetching. If the variable value is
311 in the "COMMAND for DOMAIN" format, the command is applied only
312 on hostnames ending with the specified domain string. This variable
313 may be set multiple times and is matched in the given order;
314 the first match wins.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100315+
316Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
317(which always applies universally, without the special "for"
318handling).
Emil Sit642d0842009-03-17 13:31:42 -0400319+
320The special string `none` can be used as the proxy command to
321specify that no proxy be used for a given domain pattern.
322This is useful for excluding servers inside a firewall from
323proxy use, while defaulting to a common proxy for external domains.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200324
325core.ignoreStat::
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200326 If true, commands which modify both the working tree and the index
327 will mark the updated paths with the "assume unchanged" bit in the
328 index. These marked files are then assumed to stay unchanged in the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200329 working tree, until you mark them otherwise manually - Git will not
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200330 detect the file changes by lstat() calls. This is useful on systems
331 where those are very slow, such as Microsoft Windows.
332 See linkgit:git-update-index[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200333 False by default.
334
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700335core.preferSymlinkRefs::
336 Instead of the default "symref" format for HEAD
337 and other symbolic reference files, use symbolic links.
338 This is sometimes needed to work with old scripts that
339 expect HEAD to be a symbolic link.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200340
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500341core.bare::
342 If true this repository is assumed to be 'bare' and has no
343 working directory associated with it. If this is the case a
344 number of commands that require a working directory will be
Dan McGee5162e692007-12-29 00:20:38 -0600345 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500346+
Dan McGee5162e692007-12-29 00:20:38 -0600347This setting is automatically guessed by linkgit:git-clone[1] or
348linkgit:git-init[1] when the repository was created. By default a
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500349repository that ends in "/.git" is assumed to be not bare (bare =
350false), while all other repositories are assumed to be bare (bare
351= true).
352
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200353core.worktree::
Junio C Hamanoea472c12011-01-23 15:49:41 -0800354 Set the path to the root of the working tree.
Ralf Wildenhues06ada152007-10-09 23:00:03 +0200355 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoea472c12011-01-23 15:49:41 -0800356 variable and the '--work-tree' command line option.
SZEDER Gábord424a472011-04-04 16:59:25 +0200357 The value can be an absolute path or relative to the path to
Junio C Hamanoea472c12011-01-23 15:49:41 -0800358 the .git directory, which is either specified by --git-dir
359 or GIT_DIR, or automatically discovered.
360 If --git-dir or GIT_DIR is specified but none of
Liu Yubao302cc112008-04-29 04:09:20 +0800361 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanoea472c12011-01-23 15:49:41 -0800362 the current working directory is regarded as the top level
Nguyễn Thái Ngọc Duy98acf752010-11-26 22:32:42 +0700363 of your working tree.
Junio C Hamanoea472c12011-01-23 15:49:41 -0800364+
365Note that this variable is honored even when set in a configuration
366file in a ".git" subdirectory of a directory and its value differs
367from the latter directory (e.g. "/path/to/.git/config" has
368core.worktree set to "/different/path"), which is most likely a
369misconfiguration. Running git commands in the "/path/to" directory will
370still use "/different/path" as the root of the work tree and can cause
371confusion unless you know what you are doing (e.g. you are creating a
372read-only snapshot of the same index to a location different from the
373repository's usual working tree).
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200374
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400375core.logAllRefUpdates::
Lukas Sandström14cd5602007-08-19 23:38:57 +0200376 Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano4057deb2006-10-08 01:35:18 -0700377 "$GIT_DIR/logs/<ref>", by appending the new and old
378 SHA1, the date/time and the reason of the update, but
379 only when the file exists. If this configuration
380 variable is set to true, missing "$GIT_DIR/logs/<ref>"
Bert Wesargcd8e3712011-07-11 11:14:18 +0200381 file is automatically created for branch heads (i.e. under
382 refs/heads/), remote refs (i.e. under refs/remotes/),
383 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamanoa862f972006-12-30 22:39:24 -0800384+
385This information can be used to determine what commit
386was the tip of a branch "2 days ago".
387+
388This value is true by default in a repository that has
389a working directory associated with it, and false by
390default in a bare repository.
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400391
Petr Baudis1ab661d2006-04-25 00:59:33 +0200392core.repositoryFormatVersion::
393 Internal variable identifying the repository format and layout
394 version.
395
396core.sharedRepository::
Jonas Fonsecad5dc6a72006-08-09 02:26:23 +0200397 When 'group' (or 'true'), the repository is made shareable between
398 several users in a group (making sure all the files and objects are
399 group-writable). When 'all' (or 'world' or 'everybody'), the
400 repository will be readable by all users, additionally to being
401 group-shareable. When 'umask' (or 'false'), git will use permissions
Heikki Orsila06cbe852008-04-16 11:34:24 +0300402 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
403 files in the repository will have this mode value. '0xxx' will override
Johan Herland098082f2009-04-14 15:15:42 +0200404 user's umask value (whereas the other options will only override
405 requested parts of the user's umask value). Examples: '0660' will make
406 the repo read/write-able for the owner and group, but inaccessible to
407 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Heikki Orsila06cbe852008-04-16 11:34:24 +0300408 repository that is group-readable but not group-writable.
409 See linkgit:git-init[1]. False by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200410
411core.warnAmbiguousRefs::
412 If true, git will warn you if the ref name you passed it is ambiguous
413 and might match multiple refs in the .git/refs/ tree. True by default.
414
Joachim Berdal Haga3d3e95a2006-07-06 22:35:54 +0200415core.compression::
Dana How960ccca2007-05-09 13:56:50 -0700416 An integer -1..9, indicating a default compression level.
417 -1 is the zlib default. 0 means no compression,
418 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Brian Downingdec92302007-11-19 10:58:51 -0600419 If set, this provides a default to other compression variables,
420 such as 'core.loosecompression' and 'pack.compression'.
Dana How960ccca2007-05-09 13:56:50 -0700421
422core.loosecompression::
Joachim B Haga12f6c302006-07-03 22:11:47 +0200423 An integer -1..9, indicating the compression level for objects that
Dana How960ccca2007-05-09 13:56:50 -0700424 are not in a pack file. -1 is the zlib default. 0 means no
Joachim B Haga12f6c302006-07-03 22:11:47 +0200425 compression, and 1..9 are various speed/size tradeoffs, 9 being
Dana How960ccca2007-05-09 13:56:50 -0700426 slowest. If not set, defaults to core.compression. If that is
Brian Downingde1b2462007-11-19 10:58:50 -0600427 not set, defaults to 1 (best speed).
Joachim B Haga12f6c302006-07-03 22:11:47 +0200428
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500429core.packedGitWindowSize::
430 Number of bytes of a pack file to map into memory in a
431 single mapping operation. Larger window sizes may allow
432 your system to process a smaller number of large pack files
433 more quickly. Smaller window sizes will negatively affect
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500434 performance due to increased calls to the operating system's
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500435 memory manager, but may improve performance when accessing
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500436 a large number of large pack files.
437+
438Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
439MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
440be reasonable for all users/operating systems. You probably do
441not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500442+
443Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500444
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500445core.packedGitLimit::
446 Maximum number of bytes to map simultaneously into memory
447 from pack files. If Git needs to access more than this many
448 bytes at once to complete an operation it will unmap existing
449 regions to reclaim virtual address space within the process.
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500450+
451Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
452This should be reasonable for all users/operating systems, except on
453the largest projects. You probably do not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500454+
455Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500456
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400457core.deltaBaseCacheLimit::
458 Maximum number of bytes to reserve for caching base objects
Ville Skyttä6b677a22010-07-20 00:17:17 +0300459 that may be referenced by multiple deltified objects. By storing the
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400460 entire decompressed base objects in a cache Git is able
461 to avoid unpacking and decompressing frequently used base
462 objects multiple times.
463+
464Default is 16 MiB on all platforms. This should be reasonable
465for all users/operating systems, except on the largest projects.
466You probably do not need to adjust this value.
467+
468Common unit suffixes of 'k', 'm', or 'g' are supported.
469
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800470core.bigFileThreshold::
471 Files larger than this size are stored deflated, without
472 attempting delta compression. Storing large files without
473 delta compression avoids excessive memory usage, at the
474 slight expense of increased disk usage.
475+
476Default is 512 MiB on all platforms. This should be reasonable
477for most projects as source code and other text files can still
478be delta compressed, but larger binary media files won't be.
479+
480Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800481
Michael Hendrickse8964a52007-07-02 10:48:34 -0600482core.excludesfile::
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100483 In addition to '.gitignore' (per-directory) and
484 '.git/info/exclude', git looks into this file for patterns
Jeff King6cf378f2012-04-26 04:51:57 -0400485 of files which are not meant to be tracked. "`~/`" is expanded
486 to the value of `$HOME` and "`~user/`" to the specified user's
Matthieu Moydf2a79f2009-11-19 16:21:15 +0100487 home directory. See linkgit:gitignore[5].
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100488
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200489core.askpass::
490 Some commands (e.g. svn and http interfaces) that interactively
491 ask for a password can be told to use an external program given
Knut Franke453842c2010-08-30 15:40:29 +0200492 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
493 environment variable. If not set, fall back to the value of the
494 'SSH_ASKPASS' environment variable or, failing that, a simple password
495 prompt. The external program shall be given a suitable prompt as
496 command line argument and write the password on its STDOUT.
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200497
Petr Onderka6df42ab2010-09-01 00:42:43 +0200498core.attributesfile::
499 In addition to '.gitattributes' (per-directory) and
500 '.git/info/attributes', git looks into this file for attributes
501 (see linkgit:gitattributes[5]). Path expansions are made the same
502 way as for `core.excludesfile`.
503
Adam Robenef0c2ab2007-07-19 22:09:35 -0700504core.editor::
505 Commands such as `commit` and `tag` that lets you edit
Brian Hetro02783072007-08-23 20:44:13 -0400506 messages by launching an editor uses the value of this
Adam Robenef0c2ab2007-07-19 22:09:35 -0700507 variable when it is set, and the environment variable
Jonathan Niederb4479f02009-10-30 20:42:34 -0500508 `GIT_EDITOR` is not set. See linkgit:git-var[1].
Adam Robenef0c2ab2007-07-19 22:09:35 -0700509
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200510sequence.editor::
511 Text editor used by `git rebase -i` for editing the rebase insn file.
512 The value is meant to be interpreted by the shell when it is used.
513 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
514 When not configured the default commit message editor is used instead.
515
Brian Gernhardt54adf372007-07-03 14:18:11 -0400516core.pager::
Jonathan Niederab54cd62008-08-24 00:28:32 -0500517 The command that git will use to paginate output. Can
518 be overridden with the `GIT_PAGER` environment
519 variable. Note that git sets the `LESS` environment
520 variable to `FRSX` if it is unset when it runs the
521 pager. One can change these settings by setting the
Chris Freyfee75452008-09-24 19:21:28 -0400522 `LESS` variable to some other value. Alternately,
523 these settings can be overridden on a project or
524 global basis by setting the `core.pager` option.
525 Setting `core.pager` has no affect on the `LESS`
526 environment variable behaviour above, so if you want
527 to override git's default settings this way, you need
528 to be explicit. For example, to disable the S option
529 in a backward compatible manner, set `core.pager`
Chris Johnsendcb11262009-03-15 06:30:52 -0500530 to `less -+$LESS -FRX`. This will be passed to the
Chris Freyfee75452008-09-24 19:21:28 -0400531 shell by git, which will translate the final command to
Chris Johnsendcb11262009-03-15 06:30:52 -0500532 `LESS=FRSX less -+FRSX -FRX`.
Brian Gernhardt54adf372007-07-03 14:18:11 -0400533
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800534core.whitespace::
535 A comma separated list of common whitespace problems to
Thomas Rast0b444cd2010-01-10 00:33:00 +0100536 notice. 'git diff' will use `color.diff.whitespace` to
537 highlight them, and 'git apply --whitespace=error' will
Junio C Hamanoc921cc92008-07-25 00:34:47 -0700538 consider them as errors. You can prefix `-` to disable
539 any of them (e.g. `-trailing-space`):
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800540+
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700541* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800542 as an error (enabled by default).
543* `space-before-tab` treats a space character that appears immediately
544 before a tab character in the initial indent part of the line as an
545 error (enabled by default).
546* `indent-with-non-tab` treats a line that is indented with 8 or more
J. Bruce Fields127f72e2007-12-16 11:31:42 -0500547 space characters as an error (not enabled by default).
Chris Webb3e3ec2a2010-04-03 00:37:08 +0100548* `tab-in-indent` treats a tab character in the initial indent part of
549 the line as an error (not enabled by default).
Junio C Hamano77b15bb2009-09-03 16:02:32 -0700550* `blank-at-eof` treats blank lines added at the end of file as an error
551 (enabled by default).
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700552* `trailing-space` is a short-hand to cover both `blank-at-eol` and
553 `blank-at-eof`.
Junio C Hamanob2979ff2008-01-15 00:59:05 -0800554* `cr-at-eol` treats a carriage-return at the end of line as
555 part of the line terminator, i.e. with it, `trailing-space`
556 does not trigger if the character before such a carriage-return
557 is not a whitespace (not enabled by default).
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100558* `tabwidth=<n>` tells how many character positions a tab occupies; this
559 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
560 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800561
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700562core.fsyncobjectfiles::
563 This boolean will enable 'fsync()' when writing object files.
564+
565This is a total waste of time and effort on a filesystem that orders
566data writes properly, but can be useful for filesystems that do not use
567journalling (traditional UNIX filesystems) or that only journal metadata
568and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
569
Linus Torvalds671c9b72008-11-13 16:36:30 -0800570core.preloadindex::
571 Enable parallel index preload for operations like 'git diff'
572+
573This can speed up operations like 'git diff' and 'git status' especially
574on filesystems like NFS that have weak caching semantics and thus
575relatively high IO latencies. With this set to 'true', git will do the
576index comparison to the filesystem data in parallel, allowing
577overlapping IO's.
578
Johannes Schindelin348df162009-04-28 00:32:25 +0200579core.createObject::
580 You can set this to 'link', in which case a hardlink followed by
581 a delete of the source are used to make sure that object creation
582 will not overwrite existing objects.
583+
584On some file system/operating system combinations, this is unreliable.
585Set this config setting to 'rename' there; However, This will remove the
586check that makes sure that existing object files will not get overwritten.
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200587
Johannes Schindelina97a7462009-10-09 12:21:57 +0200588core.notesRef::
589 When showing commit messages, also show notes which are stored in
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500590 the given ref. The ref must be fully qualified. If the given
591 ref does not exist, it is not an error but means that no
592 notes should be printed.
Johannes Schindelina97a7462009-10-09 12:21:57 +0200593+
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500594This setting defaults to "refs/notes/commits", and it can be overridden by
595the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Johannes Schindelina97a7462009-10-09 12:21:57 +0200596
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +0700597core.sparseCheckout::
598 Enable "sparse checkout" feature. See section "Sparse checkout" in
599 linkgit:git-read-tree[1] for more information.
600
Junio C Hamanoa71f09f2011-03-20 22:26:24 -0700601core.abbrev::
Linus Torvaldsdce96482010-10-28 11:28:04 -0700602 Set the length object names are abbreviated to. If unspecified,
603 many commands abbreviate to 7 hexdigits, which may not be enough
604 for abbreviated object names to stay unique for sufficiently long
605 time.
606
Stephen Boyd13bd2132009-05-30 22:08:02 -0700607add.ignore-errors::
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600608add.ignoreErrors::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100609 Tells 'git add' to continue adding files when some files cannot be
Stephen Boyd13bd2132009-05-30 22:08:02 -0700610 added due to indexing errors. Equivalent to the '--ignore-errors'
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600611 option of linkgit:git-add[1]. Older versions of git accept only
612 `add.ignore-errors`, which does not follow the usual naming
613 convention for configuration variables. Newer versions of git
614 honor `add.ignoreErrors` as well.
Stephen Boyd13bd2132009-05-30 22:08:02 -0700615
Petr Baudis4514ad42006-06-07 20:43:50 +0200616alias.*::
Dan McGee5162e692007-12-29 00:20:38 -0600617 Command aliases for the linkgit:git[1] command wrapper - e.g.
Petr Baudis4514ad42006-06-07 20:43:50 +0200618 after defining "alias.last = cat-file commit HEAD", the invocation
619 "git last" is equivalent to "git cat-file commit HEAD". To avoid
Petr Baudis99b41c82006-06-07 17:25:21 -0700620 confusion and troubles with script usage, aliases that
621 hide existing git commands are ignored. Arguments are split by
622 spaces, the usual shell quoting and escaping is supported.
623 quote pair and a backslash can be used to quote them.
Junio C Hamanof368f5a2007-09-01 04:01:54 -0700624+
625If the alias expansion is prefixed with an exclamation point,
626it will be treated as a shell command. For example, defining
627"alias.new = !gitk --all --not ORIG_HEAD", the invocation
628"git new" is equivalent to running the shell command
Sitaram Chamarty595b8db2009-07-01 21:30:31 +0530629"gitk --all --not ORIG_HEAD". Note that shell commands will be
630executed from the top-level directory of a repository, which may
631not necessarily be the current directory.
Michael J Gruber7cf16a12011-04-27 10:36:27 +0200632'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
633from the original current directory. See linkgit:git-rev-parse[1].
Theodore Ts'odfd42a32007-02-10 19:33:58 -0500634
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100635am.keepcr::
636 If true, git-am will call git-mailsplit for patches in mbox format
637 with parameter '--keep-cr'. In this case git-mailsplit will
Ville Skyttä6b677a22010-07-20 00:17:17 +0300638 not remove `\r` from lines ending with `\r\n`. Can be overridden
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100639 by giving '--no-keep-cr' from the command line.
640 See linkgit:git-am[1], linkgit:git-mailsplit[1].
641
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200642apply.ignorewhitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100643 When set to 'change', tells 'git apply' to ignore changes in
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200644 whitespace, in the same way as the '--ignore-space-change'
645 option.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100646 When set to one of: no, none, never, false tells 'git apply' to
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200647 respect all whitespace differences.
648 See linkgit:git-apply[1].
649
Petr Baudis1ab661d2006-04-25 00:59:33 +0200650apply.whitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100651 Tells 'git apply' how to handle whitespaces, in the same way
Dan McGee5162e692007-12-29 00:20:38 -0600652 as the '--whitespace' option. See linkgit:git-apply[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200653
Paolo Bonzini99023872007-05-23 07:07:54 +0200654branch.autosetupmerge::
Junio C Hamanoadd09512010-01-20 20:28:49 -0800655 Tells 'git branch' and 'git checkout' to set up new branches
Jay Soffian572fc812008-02-19 11:24:38 -0500656 so that linkgit:git-pull[1] will appropriately merge from the
657 starting point branch. Note that even if this option is not set,
Paolo Bonzini99023872007-05-23 07:07:54 +0200658 this behavior can be chosen per-branch using the `--track`
Jay Soffian572fc812008-02-19 11:24:38 -0500659 and `--no-track` options. The valid settings are: `false` -- no
660 automatic setup is done; `true` -- automatic setup is done when the
Matthieu Moy29b9a662010-11-02 16:31:24 +0100661 starting point is a remote-tracking branch; `always` --
662 automatic setup is done when the starting point is either a
663 local branch or remote-tracking
Jay Soffian572fc812008-02-19 11:24:38 -0500664 branch. This option defaults to true.
Paolo Bonzini99023872007-05-23 07:07:54 +0200665
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700666branch.autosetuprebase::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100667 When a new branch is created with 'git branch' or 'git checkout'
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700668 that tracks another branch, this variable tells git to set
669 up pull to rebase instead of merge (see "branch.<name>.rebase").
670 When `never`, rebase is never automatically set to true.
671 When `local`, rebase is set to true for tracked branches of
672 other local branches.
673 When `remote`, rebase is set to true for tracked branches of
Matthieu Moy29b9a662010-11-02 16:31:24 +0100674 remote-tracking branches.
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700675 When `always`, rebase will be set to true for all tracking
676 branches.
677 See "branch.autosetupmerge" for details on how to set up a
678 branch to track another branch.
679 This option defaults to never.
680
Santi Béjar648ad182006-09-23 12:05:43 +0200681branch.<name>.remote::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100682 When in branch <name>, it tells 'git fetch' and 'git push' which
Santi Béjar76d3cc52009-03-30 12:11:40 +0200683 remote to fetch from/push to. It defaults to `origin` if no remote is
684 configured. `origin` is also used if you are not on any branch.
Santi Béjar648ad182006-09-23 12:05:43 +0200685
Santi Béjar53728062006-09-23 22:53:04 +0200686branch.<name>.merge::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200687 Defines, together with branch.<name>.remote, the upstream branch
Martin von Zweigbergk15a147e2011-02-09 20:54:02 -0500688 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Thomas Rast0b444cd2010-01-10 00:33:00 +0100689 branch to merge and can also affect 'git push' (see push.default).
690 When in branch <name>, it tells 'git fetch' the default
Daniel Barkalowb888d612007-09-10 23:03:25 -0400691 refspec to be marked for merging in FETCH_HEAD. The value is
692 handled like the remote part of a refspec, and must match a
693 ref which is fetched from the remote given by
694 "branch.<name>.remote".
Thomas Rast0b444cd2010-01-10 00:33:00 +0100695 The merge information is used by 'git pull' (which at first calls
696 'git fetch') to lookup the default branch for merging. Without
697 this option, 'git pull' defaults to merge the first refspec fetched.
Josef Weidendorfer62b339a2006-12-09 02:28:26 +0100698 Specify multiple values to get an octopus merge.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100699 If you wish to setup 'git pull' so that it merges into <name> from
Paolo Bonzini9debc322007-03-15 09:23:20 +0100700 another branch in the local repository, you can point
701 branch.<name>.merge to the desired branch, and use the special setting
702 `.` (a period) for branch.<name>.remote.
Santi Béjar53728062006-09-23 22:53:04 +0200703
Lars Hjemliaec7b362007-09-24 00:51:43 +0200704branch.<name>.mergeoptions::
705 Sets default options for merging into branch <name>. The syntax and
Jonathan Nieder25dcc0d2009-10-09 13:51:14 -0500706 supported options are the same as those of linkgit:git-merge[1], but
Lars Hjemliaec7b362007-09-24 00:51:43 +0200707 option values containing whitespace characters are currently not
708 supported.
709
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000710branch.<name>.rebase::
711 When true, rebase the branch <name> on top of the fetched branch,
Dustin Sallings15ddb6f2008-05-08 11:28:07 -0700712 instead of merging the default branch from the default remote when
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100713 "git pull" is run. See "pull.rebase" for doing this in a non
714 branch-specific manner.
715+
716*NOTE*: this is a possibly dangerous operation; do *not* use
717it unless you understand the implications (see linkgit:git-rebase[1]
718for details).
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000719
Christian Couder1658c612008-03-14 05:56:53 +0100720browser.<tool>.cmd::
721 Specify the command to invoke the specified browser. The
722 specified command is evaluated in shell with the URLs passed
Jonathan Nieder565e1352011-06-29 00:35:10 -0500723 as arguments. (See linkgit:git-web{litdd}browse[1].)
Christian Couder1658c612008-03-14 05:56:53 +0100724
Christian Couder584627b2008-01-29 07:08:22 +0100725browser.<tool>.path::
726 Override the path for the given tool that may be used to
Christian Couderab989ad2008-01-29 07:08:44 +0100727 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
728 working repository in gitweb (see linkgit:git-instaweb[1]).
Christian Couder584627b2008-01-29 07:08:22 +0100729
Josh Triplett21225912007-04-23 17:18:16 -0700730clean.requireForce::
Junio C Hamano562ca192007-11-01 17:32:04 -0700731 A boolean to make git-clean do nothing unless given -f
732 or -n. Defaults to true.
Josh Triplett21225912007-04-23 17:18:16 -0700733
Brian Gernhardtf3673982007-01-03 10:36:29 -0500734color.branch::
735 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600736 linkgit:git-branch[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800737 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Brian Gernhardtf3673982007-01-03 10:36:29 -0500738 only when the output is to a terminal. Defaults to false.
739
740color.branch.<slot>::
741 Use customized color for branch coloration. `<slot>` is one of
742 `current` (the current branch), `local` (a local branch),
Matthieu Moy8b3f3f82010-11-02 16:31:23 +0100743 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Mark Wooding4f193f22007-01-28 15:17:36 +0000744 refs).
745+
746The value for these configuration variables is a list of colors (at most
747two) and attributes (at most one), separated by spaces. The colors
748accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
749`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
750`blink` and `reverse`. The first color given is the foreground; the
751second is the background. The position of the attribute, if any,
752doesn't matter.
Brian Gernhardtf3673982007-01-03 10:36:29 -0500753
Andy Parkinsa159ca02006-12-13 09:13:28 +0000754color.diff::
Michael J Gruber6999c542011-04-27 09:38:27 +0200755 Whether to use ANSI escape sequences to add color to patches.
756 If this is set to `always`, linkgit:git-diff[1],
757 linkgit:git-log[1], and linkgit:git-show[1] will use color
758 for all patches. If it is set to `true` or `auto`, those
759 commands will only use color when output is to the terminal.
760 Defaults to false.
761+
762This does not affect linkgit:git-format-patch[1] nor the
763'git-diff-{asterisk}' plumbing commands. Can be overridden on the
764command line with the `--color[=<when>]` option.
Junio C Hamanob5376642006-07-07 05:28:05 -0700765
Andy Parkinsa159ca02006-12-13 09:13:28 +0000766color.diff.<slot>::
Mark Wooding4f193f22007-01-28 15:17:36 +0000767 Use customized color for diff colorization. `<slot>` specifies
768 which part of the patch to use the specified color, and is one
769 of `plain` (context text), `meta` (metainformation), `frag`
Bert Wesarg89cb73a2009-11-27 07:55:18 +0100770 (hunk header), 'func' (function in hunk header), `old` (removed lines),
771 `new` (added lines), `commit` (commit headers), or `whitespace`
772 (highlighting whitespace errors). The values of these variables may be
773 specified as in color.branch.<slot>.
Junio C Hamanob5376642006-07-07 05:28:05 -0700774
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800775color.decorate.<slot>::
776 Use customized color for 'git log --decorate' output. `<slot>` is one
777 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Matthieu Moy0e615b22010-11-02 16:31:20 +0100778 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800779
René Scharfe7e8f59d2009-03-07 13:32:32 +0100780color.grep::
781 When set to `always`, always highlight matches. When `false` (or
782 `never`), never. When set to `true` or `auto`, use color only
783 when the output is written to the terminal. Defaults to `false`.
784
Mark Lodato55f638b2010-03-07 11:52:46 -0500785color.grep.<slot>::
786 Use customized color for grep colorization. `<slot>` specifies which
787 part of the line to use the specified color, and is one of
788+
789--
Mark Lodato00588bb2010-03-07 11:52:47 -0500790`context`;;
791 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500792`filename`;;
793 filename prefix (when not using `-h`)
Mark Lodato00588bb2010-03-07 11:52:47 -0500794`function`;;
795 function name lines (when using `-p`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500796`linenumber`;;
797 line number prefix (when using `-n`)
798`match`;;
799 matching text
Mark Lodato00588bb2010-03-07 11:52:47 -0500800`selected`;;
801 non-matching text in selected lines
Mark Lodato55f638b2010-03-07 11:52:46 -0500802`separator`;;
803 separators between fields on a line (`:`, `-`, and `=`)
804 and between hunks (`--`)
805--
806+
807The values of these variables may be specified as in color.branch.<slot>.
René Scharfe7e8f59d2009-03-07 13:32:32 +0100808
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800809color.interactive::
Jeff King47ee06f2008-01-05 04:57:44 -0500810 When set to `always`, always use colors for interactive prompts
Jonathan Nieder467c0192008-07-03 00:28:15 -0500811 and displays (such as those used by "git-add --interactive").
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800812 When false (or `never`), never. When set to `true` or `auto`, use
813 colors only when the output is to the terminal. Defaults to false.
814
815color.interactive.<slot>::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100816 Use customized color for 'git add --interactive'
Thomas Rasta3019732009-02-05 09:28:27 +0100817 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
818 four distinct types of normal output from interactive
Ori Avtalion57f6ec02009-08-07 17:24:21 +0300819 commands. The values of these variables may be specified as
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800820 in color.branch.<slot>.
821
Junio C Hamano1d770432006-12-13 12:11:03 -0800822color.pager::
823 A boolean to enable/disable colored output when the pager is in
824 use (default is true).
825
Markus Heidelbergab07ba22009-04-22 23:41:25 +0200826color.showbranch::
827 A boolean to enable/disable color in the output of
828 linkgit:git-show-branch[1]. May be set to `always`,
829 `false` (or `never`) or `auto` (or `true`), in which case colors are used
830 only when the output is to a terminal. Defaults to false.
831
Junio C Hamano1d770432006-12-13 12:11:03 -0800832color.status::
833 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600834 linkgit:git-status[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800835 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamano1d770432006-12-13 12:11:03 -0800836 only when the output is to a terminal. Defaults to false.
837
838color.status.<slot>::
839 Use customized color for status colorization. `<slot>` is
840 one of `header` (the header text of the status message),
Shawn O. Pearce82dca842006-12-15 21:53:13 -0500841 `added` or `updated` (files which are added but not committed),
842 `changed` (files which are changed but not added in the index),
Aleksi Aalto1d282322010-11-18 01:40:05 +0200843 `untracked` (files which are not tracked by git),
844 `branch` (the current branch), or
Chris Parsons950ce2e2008-05-22 08:50:02 -0400845 `nobranch` (the color the 'no branch' warning is shown in, defaulting
846 to red). The values of these variables may be specified as in
847 color.branch.<slot>.
Junio C Hamano1d770432006-12-13 12:11:03 -0800848
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100849color.ui::
Michael J Gruber6999c542011-04-27 09:38:27 +0200850 This variable determines the default value for variables such
851 as `color.diff` and `color.grep` that control the use of color
852 per command family. Its scope will expand as more commands learn
853 configuration to set a default for the `--color` option. Set it
854 to `always` if you want all output not intended for machine
855 consumption to use color, to `true` or `auto` if you want such
856 output to use color when written to the terminal, or to `false` or
857 `never` if you prefer git commands not to use color unless enabled
858 explicitly with some other configuration or the `--color` option.
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100859
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700860column.ui::
861 Specify whether supported commands should output in columns.
862 This variable consists of a list of tokens separated by spaces
863 or commas:
864+
865--
866`always`;;
867 always show in columns
868`never`;;
869 never show in columns
870`auto`;;
871 show in columns if the output is to the terminal
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700872`column`;;
873 fill columns before rows (default)
874`row`;;
875 fill rows before columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700876`plain`;;
877 show in one column
Nguyễn Thái Ngọc Duy3f8eccb2012-04-13 17:54:36 +0700878`dense`;;
879 make unequal size columns to utilize more space
880`nodense`;;
881 make equal size columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700882--
883+
Andreas Schwabb1290512012-06-23 15:18:00 +0200884This option defaults to 'never'.
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700885
Nguyễn Thái Ngọc Duyebe31ef2012-04-13 17:54:38 +0700886column.branch::
887 Specify whether to output branch listing in `git branch` in columns.
888 See `column.ui` for details.
889
Nguyễn Thái Ngọc Duy323d0532012-04-13 17:54:39 +0700890column.status::
891 Specify whether to output untracked files in `git status` in columns.
892 See `column.ui` for details.
893
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700894column.tag::
895 Specify whether to output tag listing in `git tag` in columns.
896 See `column.ui` for details.
897
Thomas Rast88955ed2010-01-23 23:13:17 +0100898commit.status::
James P. Howard, IIbed575e2009-12-07 17:45:27 -0500899 A boolean to enable/disable inclusion of status information in the
900 commit message template when using an editor to prepare the commit
901 message. Defaults to true.
902
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500903commit.template::
904 Specify a file to use as the template for new commit messages.
Jeff King6cf378f2012-04-26 04:51:57 -0400905 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Matthieu Moydf2a79f2009-11-19 16:21:15 +0100906 specified user's home directory.
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500907
Jeff Kinga6fc9fd2011-12-10 05:31:38 -0500908credential.helper::
909 Specify an external helper to be called when a username or
910 password credential is needed; the helper may consult external
911 storage to avoid prompting the user for the credentials. See
912 linkgit:gitcredentials[7] for details.
913
914credential.useHttpPath::
915 When acquiring credentials, consider the "path" component of an http
916 or https URL to be important. Defaults to false. See
917 linkgit:gitcredentials[7] for more information.
918
919credential.username::
920 If no username is set for a network authentication, use this username
921 by default. See credential.<context>.* below, and
922 linkgit:gitcredentials[7].
923
924credential.<url>.*::
925 Any of the credential.* options above can be applied selectively to
926 some credentials. For example "credential.https://example.com.username"
927 would set the default username only for https connections to
928 example.com. See linkgit:gitcredentials[7] for details on how URLs are
929 matched.
930
Ramkumar Ramachandra19299a82011-04-07 00:16:49 +0530931include::diff-config.txt[]
David Aguilarafcbc8e2009-04-07 01:21:20 -0700932
933difftool.<tool>.path::
934 Override the path for the given tool. This is useful in case
935 your tool is not in the PATH.
936
937difftool.<tool>.cmd::
938 Specify the command to invoke the specified diff tool.
939 The specified command is evaluated in shell with the following
940 variables available: 'LOCAL' is set to the name of the temporary
941 file containing the contents of the diff pre-image and 'REMOTE'
942 is set to the name of the temporary file containing the contents
943 of the diff post-image.
944
David Aguilara9043922009-04-07 01:21:22 -0700945difftool.prompt::
946 Prompt before each invocation of the diff tool.
947
Boyd Stephen Smith Jrae3b9702009-01-20 22:59:54 -0600948diff.wordRegex::
Boyd Stephen Smith Jr98a4d872009-01-20 21:46:57 -0600949 A POSIX Extended Regular Expression used to determine what is a "word"
950 when performing word-by-word difference calculations. Character
951 sequences that match the regular expression are "words", all other
952 characters are *ignorable* whitespace.
953
Jens Lehmannbe254a02010-11-11 00:55:02 +0100954fetch.recurseSubmodules::
Jens Lehmann1fb25502011-03-06 23:11:48 +0100955 This option can be either set to a boolean value or to 'on-demand'.
956 Setting it to a boolean changes the behavior of fetch and pull to
957 unconditionally recurse into submodules when set to true or to not
958 recurse at all when set to false. When set to 'on-demand' (the default
959 value), fetch and pull will only recurse into a populated submodule
960 when its superproject retrieves a commit that updates the submodule's
961 reference.
Jens Lehmannbe254a02010-11-11 00:55:02 +0100962
Junio C Hamano5e838ea2011-09-04 12:26:14 -0700963fetch.fsckObjects::
964 If it is set to true, git-fetch-pack will check all fetched
965 objects. It will abort in the case of a malformed object or a
966 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -0700967 Defaults to false. If not set, the value of `transfer.fsckObjects`
968 is used instead.
Junio C Hamano5e838ea2011-09-04 12:26:14 -0700969
Junio C Hamanoaf7cf262007-01-24 16:47:24 -0800970fetch.unpackLimit::
971 If the number of objects fetched over the git native
972 transfer is below this
973 limit, then the objects will be unpacked into loose object
974 files. However if the number of received objects equals or
975 exceeds this limit then the received pack will be stored as
976 a pack, after adding any missing delta bases. Storing the
977 pack from a push can make the push operation complete faster,
Michele Ballabio80cd9cf2008-01-11 22:11:13 +0100978 especially on slow filesystems. If not set, the value of
979 `transfer.unpackLimit` is used instead.
Junio C Hamanoaf7cf262007-01-24 16:47:24 -0800980
Stephen Boyd48d34482009-04-23 02:37:56 -0700981format.attach::
982 Enable multipart/mixed attachments as the default for
983 'format-patch'. The value can also be a double quoted string
984 which will enable attachments as the default and set the
985 value as the boundary. See the --attach option in
986 linkgit:git-format-patch[1].
987
Brian Gernhardt49604a42007-11-03 23:38:24 -0400988format.numbered::
Brian Gernhardta567fdc2008-10-02 16:55:39 -0400989 A boolean which can enable or disable sequence numbers in patch
990 subjects. It defaults to "auto" which enables it only if there
991 is more than one patch. It can be enabled or disabled for all
992 messages by setting it to "true" or "false". See --numbered
993 option in linkgit:git-format-patch[1].
Brian Gernhardt49604a42007-11-03 23:38:24 -0400994
Petr Baudis1ab661d2006-04-25 00:59:33 +0200995format.headers::
996 Additional email headers to include in a patch to be submitted
Dan McGee5162e692007-12-29 00:20:38 -0600997 by mail. See linkgit:git-format-patch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200998
Miklos Vajna312a30e2010-07-12 20:58:38 +0200999format.to::
Stephen Boyd48d34482009-04-23 02:37:56 -07001000format.cc::
Miklos Vajna312a30e2010-07-12 20:58:38 +02001001 Additional recipients to include in a patch to be submitted
1002 by mail. See the --to and --cc options in
1003 linkgit:git-format-patch[1].
Stephen Boyd48d34482009-04-23 02:37:56 -07001004
1005format.subjectprefix::
1006 The default for format-patch is to output files with the '[PATCH]'
1007 subject prefix. Use this variable to change that prefix.
1008
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001009format.signature::
1010 The default for format-patch is to output a signature containing
1011 the git version number. Use this variable to change that default.
1012 Set this variable to the empty string ("") to suppress
1013 signature generation.
1014
Johannes Schindelin78cb59c2007-03-04 00:17:23 +01001015format.suffix::
1016 The default for format-patch is to output files with the suffix
1017 `.patch`. Use this variable to change that suffix (make sure to
1018 include the dot if you want it).
1019
Denis Cheng94c22a52008-03-02 17:05:53 +08001020format.pretty::
1021 The default pretty format for log/show/whatchanged command,
1022 See linkgit:git-log[1], linkgit:git-show[1],
1023 linkgit:git-whatchanged[1].
1024
Thomas Rast30984ed2009-02-19 22:26:33 +01001025format.thread::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001026 The default threading style for 'git format-patch'. Can be
Jonathan Nieder578b62b2010-01-09 21:01:21 -06001027 a boolean value, or `shallow` or `deep`. `shallow` threading
1028 makes every mail a reply to the head of the series,
Thomas Rast30984ed2009-02-19 22:26:33 +01001029 where the head is chosen from the cover letter, the
Jeff King6cf378f2012-04-26 04:51:57 -04001030 `--in-reply-to`, and the first patch mail, in this order.
Stephen Boydfd1ff302009-04-23 02:37:57 -07001031 `deep` threading makes every mail a reply to the previous one.
Thomas Rast30984ed2009-02-19 22:26:33 +01001032 A true boolean value is the same as `shallow`, and a false
1033 value disables threading.
1034
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001035format.signoff::
1036 A boolean value which lets you enable the `-s/--signoff` option of
1037 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1038 patch should be a conscious act and means that you certify you have
1039 the rights to submit this work under the same open source license.
1040 Please see the 'SubmittingPatches' document for further discussion.
1041
Ramkumar Ramachandra26488f52011-04-07 00:16:48 +05301042filter.<driver>.clean::
1043 The command which is used to convert the content of a worktree
1044 file to a blob upon checkin. See linkgit:gitattributes[5] for
1045 details.
1046
1047filter.<driver>.smudge::
1048 The command which is used to convert the content of a blob
1049 object to a worktree file upon checkout. See
1050 linkgit:gitattributes[5] for details.
1051
Theodore Tso0d7566a2007-05-09 15:48:39 -04001052gc.aggressiveWindow::
1053 The window size parameter used in the delta compression
Thomas Rast0b444cd2010-01-10 00:33:00 +01001054 algorithm used by 'git gc --aggressive'. This defaults
Jay Soffianf78683f2010-04-13 12:52:55 -04001055 to 250.
Theodore Tso0d7566a2007-05-09 15:48:39 -04001056
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001057gc.auto::
1058 When there are approximately more than this many loose
1059 objects in the repository, `git gc --auto` will pack them.
1060 Some Porcelain commands use this command to perform a
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001061 light-weight garbage collection from time to time. The
1062 default value is 6700. Setting this to 0 disables it.
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001063
Junio C Hamano17815502007-09-17 00:55:13 -07001064gc.autopacklimit::
1065 When there are more than this many packs that are not
1066 marked with `*.keep` file in the repository, `git gc
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001067 --auto` consolidates them into one larger pack. The
Junio C Hamano97063972008-03-23 00:04:48 -07001068 default value is 50. Setting this to 0 disables it.
Junio C Hamano17815502007-09-17 00:55:13 -07001069
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001070gc.packrefs::
Jonathan Niederefc266e2010-01-09 20:59:41 -06001071 Running `git pack-refs` in a repository renders it
1072 unclonable by Git versions prior to 1.5.1.2 over dumb
1073 transports such as HTTP. This variable determines whether
Jiang Xin4be0c352010-12-16 15:16:49 +08001074 'git gc' runs `git pack-refs`. This can be set to `notbare`
Jonathan Niederefc266e2010-01-09 20:59:41 -06001075 to enable it within all non-bare repos or it can be set to a
1076 boolean value. The default is `true`.
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001077
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001078gc.pruneexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001079 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Nicolas Pitre8e8daf32008-12-30 14:45:11 -05001080 Override the grace period with this config variable. The value
1081 "now" may be used to disable this grace period and always prune
1082 unreachable objects immediately.
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001083
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001084gc.reflogexpire::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001085gc.<pattern>.reflogexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001086 'git reflog expire' removes reflog entries older than
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001087 this time; defaults to 90 days. With "<pattern>" (e.g.
1088 "refs/stash") in the middle the setting applies only to
1089 the refs that match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001090
1091gc.reflogexpireunreachable::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001092gc.<ref>.reflogexpireunreachable::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001093 'git reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001094 this time and are not reachable from the current tip;
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001095 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1096 in the middle, the setting applies only to the refs that
1097 match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001098
Junio C Hamano48c32422006-12-27 01:24:05 -08001099gc.rerereresolved::
1100 Records of conflicted merge you resolved earlier are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001101 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001102 The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001103
1104gc.rerereunresolved::
1105 Records of conflicted merge you have not resolved are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001106 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001107 The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001108
Fabian Emmes280514e2009-01-02 16:40:13 +01001109gitcvs.commitmsgannotation::
1110 Append this string to each commit message. Set to empty string
1111 to disable this feature. Defaults to "via git-CVS emulator".
1112
Petr Baudis1ab661d2006-04-25 00:59:33 +02001113gitcvs.enabled::
Brian Hetrodb218722007-08-23 20:40:08 -04001114 Whether the CVS server interface is enabled for this repository.
Dan McGee5162e692007-12-29 00:20:38 -06001115 See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001116
1117gitcvs.logfile::
Brian Hetrodb218722007-08-23 20:40:08 -04001118 Path to a log file where the CVS server interface well... logs
Dan McGee5162e692007-12-29 00:20:38 -06001119 various stuff. See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001120
Teemu Likonen1707adb2008-08-29 10:29:42 +03001121gitcvs.usecrlfattr::
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001122 If true, the server will look up the end-of-line conversion
1123 attributes for files to determine the '-k' modes to use. If
1124 the attributes force git to treat a file as text,
Ville Skyttä6b677a22010-07-20 00:17:17 +03001125 the '-k' mode will be left blank so CVS clients will
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001126 treat it as text. If they suppress text conversion, the file
Mike Ralphson1168d402008-08-05 17:12:05 +01001127 will be set with '-kb' mode, which suppresses any newline munging
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001128 the client might otherwise do. If the attributes do not allow
1129 the file type to be determined, then 'gitcvs.allbinary' is
1130 used. See linkgit:gitattributes[5].
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001131
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001132gitcvs.allbinary::
Matthew Ogilvie90948a42008-05-14 22:35:48 -06001133 This is used if 'gitcvs.usecrlfattr' does not resolve
1134 the correct '-kb' mode to use. If true, all
1135 unresolved files are sent to the client in
1136 mode '-kb'. This causes the client to treat them
1137 as binary files, which suppresses any newline munging it
1138 otherwise might do. Alternatively, if it is set to "guess",
1139 then the contents of the file are examined to decide if
1140 it is binary, similar to 'core.autocrlf'.
Junio C Hamanoabbf5942007-04-17 22:17:46 -07001141
Frank Lichtenheld04752862007-04-13 18:13:42 +02001142gitcvs.dbname::
1143 Database used by git-cvsserver to cache revision information
1144 derived from the git repository. The exact meaning depends on the
1145 used database driver, for SQLite (which is the default driver) this
1146 is a filename. Supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001147 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001148 Default: '%Ggitcvs.%m.sqlite'
1149
1150gitcvs.dbdriver::
1151 Used Perl DBI driver. You can specify any available driver
1152 for this here, but it might not work. git-cvsserver is tested
1153 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1154 reported *not* to work with 'DBD::mysql'. Experimental feature.
1155 May not contain double colons (`:`). Default: 'SQLite'.
Dan McGee5162e692007-12-29 00:20:38 -06001156 See linkgit:git-cvsserver[1].
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001157
Frank Lichtenheld04752862007-04-13 18:13:42 +02001158gitcvs.dbuser, gitcvs.dbpass::
1159 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1160 since SQLite has no concept of database users and/or passwords.
1161 'gitcvs.dbuser' supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001162 linkgit:git-cvsserver[1] for details).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001163
Josh Elsasser6aeeffd2008-03-27 14:02:14 -07001164gitcvs.dbTableNamePrefix::
1165 Database table name prefix. Prepended to the names of any
1166 database tables used, allowing a single database to be used
1167 for several repositories. Supports variable substitution (see
1168 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1169 characters will be replaced with underscores.
1170
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001171All gitcvs variables except for 'gitcvs.usecrlfattr' and
1172'gitcvs.allbinary' can also be specified as
1173'gitcvs.<access_method>.<varname>' (where 'access_method'
Brian Hetro02783072007-08-23 20:44:13 -04001174is one of "ext" and "pserver") to make them apply only for the given
1175access method.
Frank Lichtenheld04752862007-04-13 18:13:42 +02001176
Jakub Narebskicd823232011-10-16 13:07:34 +02001177gitweb.category::
1178gitweb.description::
1179gitweb.owner::
1180gitweb.url::
1181 See linkgit:gitweb[1] for description.
1182
1183gitweb.avatar::
1184gitweb.blame::
1185gitweb.grep::
1186gitweb.highlight::
1187gitweb.patches::
1188gitweb.pickaxe::
1189gitweb.remote_heads::
1190gitweb.showsizes::
1191gitweb.snapshot::
1192 See linkgit:gitweb.conf[5] for description.
1193
Joe Rattermanb22520a2011-03-30 14:31:05 -05001194grep.lineNumber::
1195 If set to true, enable '-n' option by default.
1196
1197grep.extendedRegexp::
1198 If set to true, enable '--extended-regexp' option by default.
1199
Junio C Hamano0c5e70f2011-11-29 12:29:48 -08001200gpg.program::
1201 Use this custom program instead of "gpg" found on $PATH when
1202 making or verifying a PGP signature. The program must support the
1203 same command line interface as GPG, namely, to verify a detached
1204 signature, "gpg --verify $file - <$signature" is run, and the
1205 program is expected to signal a good signature by exiting with
1206 code 0, and to generate an ascii-armored detached signature, the
1207 standard input of "gpg -bsau $key" is fed with the contents to be
1208 signed, and the program is expected to send the result to its
1209 standard output.
1210
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001211gui.commitmsgwidth::
1212 Defines how wide the commit message window is in the
1213 linkgit:git-gui[1]. "75" is the default.
1214
1215gui.diffcontext::
1216 Specifies how many context lines should be used in calls to diff
1217 made by the linkgit:git-gui[1]. The default is "5".
1218
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001219gui.encoding::
1220 Specifies the default encoding to use for displaying of
1221 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1222 It can be overridden by setting the 'encoding' attribute
1223 for relevant files (see linkgit:gitattributes[5]).
1224 If this option is not set, the tools default to the
1225 locale encoding.
1226
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001227gui.matchtrackingbranch::
1228 Determines if new branches created with linkgit:git-gui[1] should
1229 default to tracking remote branches with matching names or
1230 not. Default: "false".
1231
1232gui.newbranchtemplate::
1233 Is used as suggested name when creating new branches using the
1234 linkgit:git-gui[1].
1235
1236gui.pruneduringfetch::
Matthieu Moy8b3f3f82010-11-02 16:31:23 +01001237 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001238 performing a fetch. The default value is "false".
1239
1240gui.trustmtime::
1241 Determines if linkgit:git-gui[1] should trust the file modification
1242 timestamp or not. By default the timestamps are not trusted.
1243
1244gui.spellingdictionary::
1245 Specifies the dictionary used for spell checking commit messages in
1246 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1247 off.
1248
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001249gui.fastcopyblame::
Thomas Rastca768282010-01-07 17:49:12 +01001250 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001251 location detection. It makes blame significantly faster on huge
1252 repositories at the expense of less thorough copy detection.
1253
1254gui.copyblamethreshold::
Ralf Wildenhues76bac892008-11-27 08:32:01 +01001255 Specifies the threshold to use in 'git gui blame' original location
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001256 detection, measured in alphanumeric characters. See the
1257 linkgit:git-blame[1] manual for more information on copy detection.
1258
1259gui.blamehistoryctx::
1260 Specifies the radius of history context in days to show in
1261 linkgit:gitk[1] for the selected commit, when the `Show History
1262 Context` menu item is invoked from 'git gui blame'. If this
1263 variable is set to zero, the whole history is shown.
1264
Alexander Gavrilov390c3482008-12-14 22:44:32 +03001265guitool.<name>.cmd::
1266 Specifies the shell command line to execute when the corresponding item
1267 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1268 mandatory for every tool. The command is executed from the root of
1269 the working directory, and in the environment it receives the name of
1270 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1271 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1272 the head is detached, 'CUR_BRANCH' is empty).
1273
1274guitool.<name>.needsfile::
1275 Run the tool only if a diff is selected in the GUI. It guarantees
1276 that 'FILENAME' is not empty.
1277
1278guitool.<name>.noconsole::
1279 Run the command silently, without creating a window to display its
1280 output.
1281
1282guitool.<name>.norescan::
1283 Don't rescan the working directory for changes after the tool
1284 finishes execution.
1285
1286guitool.<name>.confirm::
1287 Show a confirmation dialog before actually running the tool.
1288
1289guitool.<name>.argprompt::
1290 Request a string argument from the user, and pass it to the tool
1291 through the 'ARGS' environment variable. Since requesting an
1292 argument implies confirmation, the 'confirm' option has no effect
1293 if this is enabled. If the option is set to 'true', 'yes', or '1',
1294 the dialog uses a built-in generic prompt; otherwise the exact
1295 value of the variable is used.
1296
1297guitool.<name>.revprompt::
1298 Request a single valid revision from the user, and set the
1299 'REVISION' environment variable. In other aspects this option
1300 is similar to 'argprompt', and can be used together with it.
1301
1302guitool.<name>.revunmerged::
1303 Show only unmerged branches in the 'revprompt' subdialog.
1304 This is useful for tools similar to merge or rebase, but not
1305 for things like checkout or reset.
1306
1307guitool.<name>.title::
1308 Specifies the title to use for the prompt dialog. The default
1309 is the tool name.
1310
1311guitool.<name>.prompt::
1312 Specifies the general prompt string to display at the top of
1313 the dialog, before subsections for 'argprompt' and 'revprompt'.
1314 The default value includes the actual command.
1315
Christian Couder983a9ee2008-01-08 04:55:14 +01001316help.browser::
1317 Specify the browser that will be used to display help in the
1318 'web' format. See linkgit:git-help[1].
1319
1320help.format::
1321 Override the default help format used by linkgit:git-help[1].
1322 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1323 the default. 'web' and 'html' are the same.
1324
Alex Riesenf0e90712008-08-31 15:54:58 +02001325help.autocorrect::
1326 Automatically correct and execute mistyped commands after
1327 waiting for the given number of deciseconds (0.1 sec). If more
1328 than one command can be deduced from the entered text, nothing
1329 will be executed. If the value of this option is negative,
1330 the corrected command will be executed immediately. If the
1331 value is 0 - the command will be just shown but not executed.
1332 This is the default.
1333
Sam Vilain9c5665a2007-11-23 13:07:00 +13001334http.proxy::
Clemens Buchacherb2c8c6d2012-03-04 17:50:43 +01001335 Override the HTTP proxy, normally configured using the 'http_proxy',
1336 'https_proxy', and 'all_proxy' environment variables (see
1337 `curl(1)`). This can be overridden on a per-remote basis; see
1338 remote.<name>.proxy
Sam Vilain9c5665a2007-11-23 13:07:00 +13001339
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001340http.cookiefile::
1341 File containing previously stored cookie lines which should be used
1342 in the git http session, if they match the server. The file format
1343 of the file to read cookies from should be plain HTTP headers or
1344 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1345 NOTE that the file specified with http.cookiefile is only used as
1346 input. No cookies will be stored in the file.
1347
Petr Baudis1ab661d2006-04-25 00:59:33 +02001348http.sslVerify::
1349 Whether to verify the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001350 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001351 variable.
1352
1353http.sslCert::
1354 File containing the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001355 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001356 variable.
1357
1358http.sslKey::
1359 File containing the SSL private key when fetching or pushing
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001360 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001361 variable.
1362
Mark Lodato754ae192009-05-27 23:16:03 -04001363http.sslCertPasswordProtected::
1364 Enable git's password prompt for the SSL certificate. Otherwise
1365 OpenSSL will prompt the user, possibly many times, if the
1366 certificate or private key is encrypted. Can be overridden by the
1367 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1368
Petr Baudis1ab661d2006-04-25 00:59:33 +02001369http.sslCAInfo::
1370 File containing the certificates to verify the peer with when
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001371 fetching or pushing over HTTPS. Can be overridden by the
Petr Baudis1ab661d2006-04-25 00:59:33 +02001372 'GIT_SSL_CAINFO' environment variable.
1373
1374http.sslCAPath::
1375 Path containing files with the CA certificates to verify the peer
Francis Daly37425062006-06-07 13:56:45 +01001376 with when fetching or pushing over HTTPS. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001377 by the 'GIT_SSL_CAPATH' environment variable.
1378
1379http.maxRequests::
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001380 How many HTTP requests to launch in parallel. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001381 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1382
Tay Ray Chuanad75ebe2009-11-27 23:42:26 +08001383http.minSessions::
1384 The number of curl sessions (counted across slots) to be kept across
1385 requests. They will not be ended with curl_easy_cleanup() until
1386 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1387 value will be capped at 1. Defaults to 1.
1388
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -07001389http.postBuffer::
1390 Maximum size in bytes of the buffer used by smart HTTP
1391 transports when POSTing data to the remote system.
1392 For requests larger than this buffer size, HTTP/1.1 and
1393 Transfer-Encoding: chunked is used to avoid creating a
1394 massive pack file locally. Default is 1 MiB, which is
1395 sufficient for most requests.
1396
Petr Baudis1ab661d2006-04-25 00:59:33 +02001397http.lowSpeedLimit, http.lowSpeedTime::
1398 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1399 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001400 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Petr Baudis1ab661d2006-04-25 00:59:33 +02001401 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1402
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001403http.noEPSV::
1404 A boolean which disables using of EPSV ftp command by curl.
Frank Lichtenheldbefc9c42007-04-13 18:02:33 +02001405 This can helpful with some "poor" ftp servers which don't
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001406 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1407 environment variable. Default is false (curl will use EPSV).
1408
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001409http.useragent::
1410 The HTTP USER_AGENT string presented to an HTTP server. The default
1411 value represents the version of the client git such as git/1.7.1.
1412 This option allows you to override this value to a more common value
1413 such as Mozilla/4.0. This may be necessary, for instance, if
1414 connecting through a firewall that restricts HTTP connections to a set
1415 of common USER_AGENT strings (but not including those like git/1.7.1).
1416 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1417
Petr Baudis1ab661d2006-04-25 00:59:33 +02001418i18n.commitEncoding::
1419 Character encoding the commit messages are stored in; git itself
1420 does not care per se, but this information is necessary e.g. when
1421 importing commits from emails or in the gitk graphical history
1422 browser (and possibly at other places in the future or in other
Dan McGee5162e692007-12-29 00:20:38 -06001423 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Petr Baudis1ab661d2006-04-25 00:59:33 +02001424
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001425i18n.logOutputEncoding::
1426 Character encoding the commit messages are converted to when
Thomas Rast0b444cd2010-01-10 00:33:00 +01001427 running 'git log' and friends.
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001428
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001429imap::
1430 The configuration variables in the 'imap' section are described
1431 in linkgit:git-imap-send[1].
1432
Steven Draked8a84882010-02-17 12:44:46 +13001433init.templatedir::
1434 Specify the directory from which templates will be copied.
1435 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1436
Christian Couder983a9ee2008-01-08 04:55:14 +01001437instaweb.browser::
1438 Specify the program that will be used to browse your working
1439 repository in gitweb. See linkgit:git-instaweb[1].
1440
1441instaweb.httpd::
1442 The HTTP daemon command-line to start gitweb on your working
1443 repository. See linkgit:git-instaweb[1].
1444
1445instaweb.local::
1446 If true the web server started by linkgit:git-instaweb[1] will
1447 be bound to the local IP (127.0.0.1).
1448
1449instaweb.modulepath::
Ville Skyttä6b677a22010-07-20 00:17:17 +03001450 The default module path for linkgit:git-instaweb[1] to use
1451 instead of /usr/lib/apache2/modules. Only used if httpd
1452 is Apache.
Christian Couder983a9ee2008-01-08 04:55:14 +01001453
1454instaweb.port::
1455 The port number to bind the gitweb httpd to. See
1456 linkgit:git-instaweb[1].
1457
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001458interactive.singlekey::
Ori Avtalion57f6ec02009-08-07 17:24:21 +03001459 In interactive commands, allow the user to provide one-letter
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001460 input with a single key (i.e., without hitting enter).
Jeff King6cf378f2012-04-26 04:51:57 -04001461 Currently this is used by the `--patch` mode of
Conrad Irwine6b57a82011-05-07 10:59:04 -07001462 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1463 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1464 setting is silently ignored if portable keystroke input
1465 is not available.
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001466
Jay Soffian0c476952011-05-18 13:56:04 -04001467log.abbrevCommit::
1468 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Jeff King6cf378f2012-04-26 04:51:57 -04001469 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1470 override this option with `--no-abbrev-commit`.
Jay Soffian0c476952011-05-18 13:56:04 -04001471
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001472log.date::
Jonathan Niedere8607952010-08-20 05:20:36 -05001473 Set the default date-time mode for the 'log' command.
1474 Setting a value for log.date is similar to using 'git log''s
Jeff King6cf378f2012-04-26 04:51:57 -04001475 `--date` option. Possible values are `relative`, `local`,
Jonathan Niedere8607952010-08-20 05:20:36 -05001476 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1477 for details.
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001478
Steven Drakeeb734452010-02-17 12:39:52 +13001479log.decorate::
1480 Print out the ref names of any commits that are shown by the log
1481 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1482 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1483 specified, the full ref name (including prefix) will be printed.
1484 This is the same as the log commands '--decorate' option.
1485
Peter Baumann0f03ca92006-11-23 10:36:33 +01001486log.showroot::
1487 If true, the initial commit will be shown as a big creation event.
1488 This is equivalent to a diff against an empty tree.
Dan McGee5162e692007-12-29 00:20:38 -06001489 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Peter Baumann0f03ca92006-11-23 10:36:33 +01001490 normally hide the root commit will now show it. True by default.
1491
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001492mailmap.file::
1493 The location of an augmenting mailmap file. The default
1494 mailmap, located in the root of the repository, is loaded
1495 first, then the mailmap file pointed to by this variable.
1496 The location of the mailmap file may be in a repository
1497 subdirectory, or somewhere outside of the repository itself.
1498 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1499
Christian Couderb5578f32008-03-07 08:46:55 +01001500man.viewer::
Christian Couderb8322ea2008-03-13 06:48:46 +01001501 Specify the programs that may be used to display help in the
Christian Couderb5578f32008-03-07 08:46:55 +01001502 'man' format. See linkgit:git-help[1].
1503
Christian Couder0bb64002008-04-25 08:25:35 +02001504man.<tool>.cmd::
1505 Specify the command to invoke the specified man viewer. The
1506 specified command is evaluated in shell with the man page
1507 passed as argument. (See linkgit:git-help[1].)
1508
Christian Couder7e8114c2008-04-25 08:24:41 +02001509man.<tool>.path::
1510 Override the path for the given tool that may be used to
1511 display help in the 'man' format. See linkgit:git-help[1].
1512
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001513include::merge-config.txt[]
Junio C Hamanob5412482008-08-29 10:49:56 -07001514
Johannes Schindelin77680ca2007-12-17 12:21:22 +00001515mergetool.<tool>.path::
1516 Override the path for the given tool. This is useful in case
1517 your tool is not in the PATH.
1518
Charles Bailey964473a2008-02-21 23:31:12 +00001519mergetool.<tool>.cmd::
1520 Specify the command to invoke the specified merge tool. The
1521 specified command is evaluated in shell with the following
1522 variables available: 'BASE' is the name of a temporary file
1523 containing the common base of the files to be merged, if available;
1524 'LOCAL' is the name of a temporary file containing the contents of
1525 the file on the current branch; 'REMOTE' is the name of a temporary
1526 file containing the contents of the file from the branch being
1527 merged; 'MERGED' contains the name of the file to which the merge
1528 tool should write the results of a successful merge.
1529
1530mergetool.<tool>.trustExitCode::
1531 For a custom merge command, specify whether the exit code of
1532 the merge command can be used to determine whether the merge was
1533 successful. If this is not set to true then the merge target file
1534 timestamp is checked and the merge assumed to have been successful
1535 if the file has been updated, otherwise the user is prompted to
1536 indicate the success of the merge.
1537
Charles Bailey44c36d12008-02-21 23:30:02 +00001538mergetool.keepBackup::
1539 After performing a merge, the original file with conflict markers
1540 can be saved as a file with a `.orig` extension. If this variable
1541 is set to `false` then this file is not preserved. Defaults to
1542 `true` (i.e. keep the backup files).
1543
Charles Bailey162eba82008-12-12 21:48:41 +00001544mergetool.keepTemporaries::
1545 When invoking a custom merge tool, git uses a set of temporary
1546 files to pass to the tool. If the tool returns an error and this
1547 variable is set to `true`, then these temporary files will be
1548 preserved, otherwise they will be removed after the tool has
1549 exited. Defaults to `false`.
1550
Charles Bailey682b4512008-11-13 12:41:14 +00001551mergetool.prompt::
1552 Prompt before each invocation of the merge resolution program.
1553
Thomas Rast894a9d32010-03-12 18:04:26 +01001554notes.displayRef::
1555 The (fully qualified) refname from which to show notes when
1556 showing commit messages. The value of this variable can be set
1557 to a glob, in which case notes from all matching refs will be
1558 shown. You may also specify this configuration variable
1559 several times. A warning will be issued for refs that do not
1560 exist, but a glob that does not match any refs is silently
1561 ignored.
1562+
1563This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1564environment variable, which must be a colon separated list of refs or
1565globs.
1566+
1567The effective value of "core.notesRef" (possibly overridden by
1568GIT_NOTES_REF) is also implicitly added to the list of refs to be
1569displayed.
1570
Thomas Rast6956f852010-03-12 18:04:32 +01001571notes.rewrite.<command>::
1572 When rewriting commits with <command> (currently `amend` or
1573 `rebase`) and this variable is set to `true`, git
1574 automatically copies your notes from the original to the
1575 rewritten commit. Defaults to `true`, but see
1576 "notes.rewriteRef" below.
Thomas Rast6956f852010-03-12 18:04:32 +01001577
1578notes.rewriteMode::
1579 When copying notes during a rewrite (see the
1580 "notes.rewrite.<command>" option), determines what to do if
1581 the target commit already has a note. Must be one of
1582 `overwrite`, `concatenate`, or `ignore`. Defaults to
1583 `concatenate`.
1584+
1585This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1586environment variable.
1587
1588notes.rewriteRef::
1589 When copying notes during a rewrite, specifies the (fully
1590 qualified) ref whose notes should be copied. The ref may be a
1591 glob, in which case notes in all matching refs will be copied.
1592 You may also specify this configuration several times.
1593+
1594Does not have a default value; you must configure this variable to
Thomas Rast2b4aa892011-09-13 09:32:42 +02001595enable note rewriting. Set it to `refs/notes/commits` to enable
1596rewriting for the default commit notes.
Leif Arne Storsetcfb88e92010-05-05 16:16:25 +02001597+
1598This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1599environment variable, which must be a colon separated list of refs or
1600globs.
Thomas Rast6956f852010-03-12 18:04:32 +01001601
Jeff King4812a932006-07-23 01:50:30 -04001602pack.window::
Dan McGee5162e692007-12-29 00:20:38 -06001603 The size of the window used by linkgit:git-pack-objects[1] when no
Jeff King4812a932006-07-23 01:50:30 -04001604 window size is given on the command line. Defaults to 10.
1605
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001606pack.depth::
Dan McGee5162e692007-12-29 00:20:38 -06001607 The maximum delta depth used by linkgit:git-pack-objects[1] when no
Theodore Ts'o618e6132007-05-08 09:28:26 -04001608 maximum depth is given on the command line. Defaults to 50.
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001609
Brian Downinge93b15c2007-07-12 07:55:52 -05001610pack.windowMemory::
Dan McGee5162e692007-12-29 00:20:38 -06001611 The window memory size limit used by linkgit:git-pack-objects[1]
Brian Downinge93b15c2007-07-12 07:55:52 -05001612 when no limit is given on the command line. The value can be
1613 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1614 limit.
1615
Dana How960ccca2007-05-09 13:56:50 -07001616pack.compression::
1617 An integer -1..9, indicating the compression level for objects
1618 in a pack file. -1 is the zlib default. 0 means no
1619 compression, and 1..9 are various speed/size tradeoffs, 9 being
1620 slowest. If not set, defaults to core.compression. If that is
Brian Downingdec92302007-11-19 10:58:51 -06001621 not set, defaults to -1, the zlib default, which is "a default
1622 compromise between speed and compression (currently equivalent
1623 to level 6)."
Jan Krüger89d71f72010-09-27 14:21:58 +02001624+
1625Note that changing the compression level will not automatically recompress
1626all existing objects. You can force recompression by passing the -F option
1627to linkgit:git-repack[1].
Dana How960ccca2007-05-09 13:56:50 -07001628
Martin Koegler074b2ee2007-05-28 23:20:58 +02001629pack.deltaCacheSize::
Brian Hetro02783072007-08-23 20:44:13 -04001630 The maximum memory in bytes used for caching deltas in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001631 linkgit:git-pack-objects[1] before writing them out to a pack.
1632 This cache is used to speed up the writing object phase by not
1633 having to recompute the final delta result once the best match
1634 for all objects is found. Repacking large repositories on machines
1635 which are tight with memory might be badly impacted by this though,
1636 especially if this cache pushes the system into swapping.
1637 A value of 0 means no limit. The smallest size of 1 byte may be
1638 used to virtually disable this cache. Defaults to 256 MiB.
Martin Koegler074b2ee2007-05-28 23:20:58 +02001639
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001640pack.deltaCacheLimit::
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001641 The maximum size of a delta, that is cached in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001642 linkgit:git-pack-objects[1]. This cache is used to speed up the
1643 writing object phase by not having to recompute the final delta
1644 result once the best match for all objects is found. Defaults to 1000.
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001645
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001646pack.threads::
1647 Specifies the number of threads to spawn when searching for best
Dan McGee5162e692007-12-29 00:20:38 -06001648 delta matches. This requires that linkgit:git-pack-objects[1]
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001649 be compiled with pthreads otherwise this option is ignored with a
1650 warning. This is meant to reduce packing time on multiprocessor
1651 machines. The required amount of memory for the delta search window
1652 is however multiplied by the number of threads.
Andreas Ericsson833e3df2008-02-22 20:11:56 -06001653 Specifying 0 will cause git to auto-detect the number of CPU's
1654 and set the number of threads accordingly.
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001655
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001656pack.indexVersion::
1657 Specify the default pack index version. Valid values are 1 for
1658 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1659 the new pack index with capabilities for packs larger than 4 GB
1660 as well as proper protection against the repacking of corrupted
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001661 packs. Version 2 is the default. Note that version 2 is enforced
1662 and this config option ignored whenever the corresponding pack is
1663 larger than 2 GB.
1664+
Jeff King6cf378f2012-04-26 04:51:57 -04001665If you have an old git that does not understand the version 2 `*.idx` file,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001666cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Jeff King6cf378f2012-04-26 04:51:57 -04001667that will copy both `*.pack` file and corresponding `*.idx` file from the
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001668other side may give you a repository that cannot be accessed with your
Jeff King6cf378f2012-04-26 04:51:57 -04001669older version of git. If the `*.pack` file is smaller than 2 GB, however,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001670you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Jeff King6cf378f2012-04-26 04:51:57 -04001671the `*.idx` file.
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001672
Junio C Hamanodbdbfec2008-03-12 23:11:15 -07001673pack.packSizeLimit::
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001674 The maximum size of a pack. This setting only affects
1675 packing to a file when repacking, i.e. the git:// protocol
Jeff King6cf378f2012-04-26 04:51:57 -04001676 is unaffected. It can be overridden by the `--max-pack-size`
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001677 option of linkgit:git-repack[1]. The minimum size allowed is
1678 limited to 1 MiB. The default is unlimited.
1679 Common unit suffixes of 'k', 'm', or 'g' are
1680 supported.
Johannes Schindelin2b84b5a2008-02-05 14:25:04 +00001681
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001682pager.<cmd>::
Jeff King9bad7232010-11-17 12:04:12 -05001683 If the value is boolean, turns on or off pagination of the
1684 output of a particular git subcommand when writing to a tty.
1685 Otherwise, turns on pagination for the subcommand using the
Jeff King6cf378f2012-04-26 04:51:57 -04001686 pager specified by the value of `pager.<cmd>`. If `--paginate`
1687 or `--no-pager` is specified on the command line, it takes
Jeff King9bad7232010-11-17 12:04:12 -05001688 precedence over this option. To disable pagination for all
1689 commands, set `core.pager` or `GIT_PAGER` to `cat`.
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001690
Will Palmer80281842010-05-02 12:00:44 +01001691pretty.<name>::
1692 Alias for a --pretty= format string, as specified in
1693 linkgit:git-log[1]. Any aliases defined here can be used just
1694 as the built-in pretty formats could. For example,
Jeff King6cf378f2012-04-26 04:51:57 -04001695 running `git config pretty.changelog "format:* %H %s"`
Will Palmer80281842010-05-02 12:00:44 +01001696 would cause the invocation `git log --pretty=changelog`
Jeff King6cf378f2012-04-26 04:51:57 -04001697 to be equivalent to running `git log "--pretty=format:* %H %s"`.
Will Palmer80281842010-05-02 12:00:44 +01001698 Note that an alias with the same name as a built-in format
1699 will be silently ignored.
1700
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001701pull.rebase::
1702 When true, rebase branches on top of the fetched branch, instead
1703 of merging the default branch from the default remote when "git
1704 pull" is run. See "branch.<name>.rebase" for setting this on a
1705 per-branch basis.
1706+
1707*NOTE*: this is a possibly dangerous operation; do *not* use
1708it unless you understand the implications (see linkgit:git-rebase[1]
1709for details).
1710
Petr Baudis1ab661d2006-04-25 00:59:33 +02001711pull.octopus::
1712 The default merge strategy to use when pulling multiple branches
1713 at once.
1714
1715pull.twohead::
1716 The default merge strategy to use when pulling a single branch.
1717
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001718push.default::
1719 Defines the action git push should take if no refspec is given
1720 on the command line, no refspec is configured in the remote, and
1721 no refspec is implied by any of the options given on the command
Santi Béjar01eadaf2009-03-30 12:11:41 +02001722 line. Possible values are:
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001723+
Andreas Schwabb1290512012-06-23 15:18:00 +02001724--
Cliff Frey9373bdc2010-10-17 20:10:45 -07001725* `nothing` - do not push anything.
Matthieu Moy185c0872012-04-24 09:50:00 +02001726* `matching` - push all branches having the same name in both ends.
1727 This is for those who prepare all the branches into a publishable
1728 shape and then push them out with a single command. It is not
1729 appropriate for pushing into a repository shared by multiple users,
1730 since locally stalled branches will attempt a non-fast forward push
Matthieu Moy67804c22012-04-24 09:50:05 +02001731 if other users updated the branch.
1732 +
1733 This is currently the default, but Git 2.0 will change the default
1734 to `simple`.
Johan Herland53c40312011-02-16 01:54:24 +01001735* `upstream` - push the current branch to its upstream branch.
Matthieu Moy185c0872012-04-24 09:50:00 +02001736 With this, `git push` will update the same remote ref as the one which
1737 is merged by `git pull`, making `push` and `pull` symmetrical.
1738 See "branch.<name>.merge" for how to configure the upstream branch.
Junio C Hamanof4d80d22012-04-24 12:21:12 -07001739* `simple` - like `upstream`, but refuses to push if the upstream
1740 branch's name is different from the local one. This is the safest
1741 option and is well-suited for beginners. It will become the default
1742 in Git 2.0.
Cliff Frey9373bdc2010-10-17 20:10:45 -07001743* `current` - push the current branch to a branch of the same name.
Andreas Schwabb1290512012-06-23 15:18:00 +02001744--
1745+
1746The `simple`, `current` and `upstream` modes are for those who want to
1747push out a single branch after finishing work, even when the other
1748branches are not yet ready to be pushed out. If you are working with
1749other people to push into the same shared repository, you would want
1750to use one of these.
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001751
Tor Arne Vestbøa9c38212009-03-01 23:11:38 +01001752rebase.stat::
1753 Whether to show a diffstat of what changed upstream since the last
1754 rebase. False by default.
1755
Heiko Voigtdd1e5b32010-07-14 13:59:57 +02001756rebase.autosquash::
1757 If set to true enable '--autosquash' option by default.
1758
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001759receive.autogc::
1760 By default, git-receive-pack will run "git-gc --auto" after
1761 receiving data from git-push and updating refs. You can stop
1762 it by setting this variable to false.
1763
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001764receive.fsckObjects::
1765 If it is set to true, git-receive-pack will check all received
1766 objects. It will abort in the case of a malformed object or a
1767 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001768 Defaults to false. If not set, the value of `transfer.fsckObjects`
1769 is used instead.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001770
1771receive.unpackLimit::
1772 If the number of objects received in a push is below this
1773 limit then the objects will be unpacked into loose object
1774 files. However if the number of received objects equals or
1775 exceeds this limit then the received pack will be stored as
1776 a pack, after adding any missing delta bases. Storing the
1777 pack from a push can make the push operation complete faster,
1778 especially on slow filesystems. If not set, the value of
1779 `transfer.unpackLimit` is used instead.
1780
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001781receive.denyDeletes::
1782 If set to true, git-receive-pack will deny a ref update that deletes
1783 the ref. Use this to prevent such a ref deletion via a push.
1784
Thomas Rast662c83f2010-07-24 18:07:53 +02001785receive.denyDeleteCurrent::
1786 If set to true, git-receive-pack will deny a ref update that
1787 deletes the currently checked out branch of a non-bare repository.
1788
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001789receive.denyCurrentBranch::
Michael J Gruberf3838ce2010-05-13 14:51:38 +02001790 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001791 to the currently checked out branch of a non-bare repository.
1792 Such a push is potentially dangerous because it brings the HEAD
1793 out of sync with the index and working tree. If set to "warn",
1794 print a warning of such a push to stderr, but allow the push to
1795 proceed. If set to false or "ignore", allow such pushes with no
Thomas Rast7d182f52010-03-17 12:14:57 +01001796 message. Defaults to "refuse".
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001797
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001798receive.denyNonFastForwards::
1799 If set to true, git-receive-pack will deny a ref update which is
Felipe Contrerasa75d7b52009-10-24 11:31:32 +03001800 not a fast-forward. Use this to prevent such an update via a push,
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001801 even if that push is forced. This configuration variable is
1802 set when initializing a shared repository.
1803
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001804receive.updateserverinfo::
1805 If set to true, git-receive-pack will run git-update-server-info
1806 after receiving data from git-push and updating refs.
1807
Santi Béjar0cc6d342006-10-23 18:42:14 +02001808remote.<name>.url::
Dan McGee5162e692007-12-29 00:20:38 -06001809 The URL of a remote repository. See linkgit:git-fetch[1] or
1810 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001811
Michael J Gruber20346232009-06-09 18:01:34 +02001812remote.<name>.pushurl::
1813 The push URL of a remote repository. See linkgit:git-push[1].
1814
Sam Vilain14c98212007-12-04 10:48:54 +13001815remote.<name>.proxy::
1816 For remotes that require curl (http, https and ftp), the URL to
1817 the proxy to use for that remote. Set to the empty string to
1818 disable proxying for that remote.
1819
Santi Béjar0cc6d342006-10-23 18:42:14 +02001820remote.<name>.fetch::
Dan McGee5162e692007-12-29 00:20:38 -06001821 The default set of "refspec" for linkgit:git-fetch[1]. See
1822 linkgit:git-fetch[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001823
1824remote.<name>.push::
Dan McGee5162e692007-12-29 00:20:38 -06001825 The default set of "refspec" for linkgit:git-push[1]. See
1826 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001827
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001828remote.<name>.mirror::
1829 If true, pushing to this remote will automatically behave
Jeff King6cf378f2012-04-26 04:51:57 -04001830 as if the `--mirror` option was given on the command line.
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001831
Theodore Ts'o19182782007-02-20 15:13:43 -05001832remote.<name>.skipDefaultUpdate::
1833 If true, this remote will be skipped by default when updating
Björn Gustavsson7cc91a22009-11-09 21:11:06 +01001834 using linkgit:git-fetch[1] or the `update` subcommand of
1835 linkgit:git-remote[1].
1836
1837remote.<name>.skipFetchAll::
1838 If true, this remote will be skipped by default when updating
1839 using linkgit:git-fetch[1] or the `update` subcommand of
1840 linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001841
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001842remote.<name>.receivepack::
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001843 The default program to execute on the remote side when pushing. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001844 option \--receive-pack of linkgit:git-push[1].
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001845
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001846remote.<name>.uploadpack::
1847 The default program to execute on the remote side when fetching. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001848 option \--upload-pack of linkgit:git-fetch-pack[1].
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001849
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301850remote.<name>.tagopt::
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001851 Setting this value to \--no-tags disables automatic tag following when
Samuel Tardieu944163a2010-04-20 01:31:25 +02001852 fetching from remote <name>. Setting it to \--tags will fetch every
1853 tag from remote <name>, even if they are not reachable from remote
Daniel Johnsoned368542010-08-11 18:57:20 -04001854 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1855 override this setting. See options \--tags and \--no-tags of
1856 linkgit:git-fetch[1].
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301857
Daniel Barkalowc578f512009-11-18 02:42:25 +01001858remote.<name>.vcs::
1859 Setting this to a value <vcs> will cause git to interact with
1860 the remote with the git-remote-<vcs> helper.
1861
Theodore Ts'o19182782007-02-20 15:13:43 -05001862remotes.<group>::
1863 The list of remotes which are fetched by "git remote update
Dan McGee5162e692007-12-29 00:20:38 -06001864 <group>". See linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001865
Junio C Hamanob6945f52006-10-13 21:28:58 -07001866repack.usedeltabaseoffset::
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04001867 By default, linkgit:git-repack[1] creates packs that use
1868 delta-base offset. If you need to share your repository with
1869 git older than version 1.4.4, either directly or via a dumb
1870 protocol such as http, then you need to set this option to
1871 "false" and repack. Access from old git versions over the
1872 native protocol are unaffected by this option.
Junio C Hamanob6945f52006-10-13 21:28:58 -07001873
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001874rerere.autoupdate::
1875 When set to true, `git-rerere` updates the index with the
1876 resulting contents after it cleanly resolves conflicts using
1877 previously recorded resolution. Defaults to false.
1878
1879rerere.enabled::
1880 Activate recording of resolved conflicts, so that identical
Thomas Rast07b88a02012-01-06 14:08:02 +01001881 conflict hunks can be resolved automatically, should they be
1882 encountered again. By default, linkgit:git-rerere[1] is
1883 enabled if there is an `rr-cache` directory under the
Junio C Hamanob6fb7fe2012-01-10 15:57:27 +01001884 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1885 repository.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001886
Yann Dirson65180c62009-07-22 23:39:30 +02001887sendemail.identity::
1888 A configuration identity. When given, causes values in the
1889 'sendemail.<identity>' subsection to take precedence over
1890 values in the 'sendemail' section. The default identity is
1891 the value of 'sendemail.identity'.
1892
1893sendemail.smtpencryption::
1894 See linkgit:git-send-email[1] for description. Note that this
1895 setting is not subject to the 'identity' mechanism.
1896
1897sendemail.smtpssl::
1898 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1899
1900sendemail.<identity>.*::
1901 Identity-specific versions of the 'sendemail.*' parameters
1902 found below, taking precedence over those when the this
1903 identity is selected, through command-line or
1904 'sendemail.identity'.
1905
1906sendemail.aliasesfile::
1907sendemail.aliasfiletype::
1908sendemail.bcc::
1909sendemail.cc::
1910sendemail.cccmd::
1911sendemail.chainreplyto::
1912sendemail.confirm::
1913sendemail.envelopesender::
1914sendemail.from::
1915sendemail.multiedit::
1916sendemail.signedoffbycc::
1917sendemail.smtppass::
1918sendemail.suppresscc::
1919sendemail.suppressfrom::
1920sendemail.to::
Brian Gernhardt69cf7bf2010-04-10 10:53:56 -04001921sendemail.smtpdomain::
Yann Dirson65180c62009-07-22 23:39:30 +02001922sendemail.smtpserver::
1923sendemail.smtpserverport::
Pascal Obry052fbea2010-09-06 20:12:11 +02001924sendemail.smtpserveroption::
Yann Dirson65180c62009-07-22 23:39:30 +02001925sendemail.smtpuser::
1926sendemail.thread::
1927sendemail.validate::
1928 See linkgit:git-send-email[1] for description.
1929
1930sendemail.signedoffcc::
1931 Deprecated alias for 'sendemail.signedoffbycc'.
1932
Petr Baudis1ab661d2006-04-25 00:59:33 +02001933showbranch.default::
Dan McGee5162e692007-12-29 00:20:38 -06001934 The default set of branches for linkgit:git-show-branch[1].
1935 See linkgit:git-show-branch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001936
Jeff King46f721c2007-12-07 16:26:07 -05001937status.relativePaths::
Dan McGee5162e692007-12-29 00:20:38 -06001938 By default, linkgit:git-status[1] shows paths relative to the
Jeff King46f721c2007-12-07 16:26:07 -05001939 current directory. Setting this variable to `false` shows paths
1940 relative to the repository root (this was the default for git
1941 prior to v1.5.4).
1942
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02001943status.showUntrackedFiles::
1944 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1945 files which are not currently tracked by Git. Directories which
1946 contain only untracked files, are shown with the directory name
1947 only. Showing untracked files means that Git needs to lstat() all
1948 all the files in the whole repository, which might be slow on some
1949 systems. So, this variable controls how the commands displays
1950 the untracked files. Possible values are:
1951+
1952--
Cliff Frey9373bdc2010-10-17 20:10:45 -07001953* `no` - Show no untracked files.
1954* `normal` - Show untracked files and directories.
1955* `all` - Show also individual files in untracked directories.
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02001956--
1957+
1958If this variable is not specified, it defaults to 'normal'.
1959This variable can be overridden with the -u|--untracked-files option
1960of linkgit:git-status[1] and linkgit:git-commit[1].
1961
Michael J Gruber4b2343f2010-05-20 17:55:42 +02001962status.submodulesummary::
1963 Defaults to false.
1964 If this is set to a non zero number or true (identical to -1 or an
1965 unlimited number), the submodule summary will be enabled and a
1966 summary of commits for modified submodules will be shown (see
1967 --summary-limit option of linkgit:git-submodule[1]).
1968
Jonathan Nieder0ad0a612010-07-15 02:51:19 -05001969submodule.<name>.path::
1970submodule.<name>.url::
1971submodule.<name>.update::
1972 The path within this project, URL, and the updating strategy
1973 for a submodule. These variables are initially populated
1974 by 'git submodule init'; edit them to override the
1975 URL and other values found in the `.gitmodules` file. See
1976 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1977
Jens Lehmannc1a3c362010-11-11 00:55:41 +01001978submodule.<name>.fetchRecurseSubmodules::
Jens Lehmannbf42b382011-03-06 23:12:19 +01001979 This option can be used to control recursive fetching of this
Ralf Wildenhues469bfc92011-01-03 20:03:34 +01001980 submodule. It can be overridden by using the --[no-]recurse-submodules
Jens Lehmannc1a3c362010-11-11 00:55:41 +01001981 command line option to "git fetch" and "git pull".
1982 This setting will override that from in the linkgit:gitmodules[5]
1983 file.
1984
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02001985submodule.<name>.ignore::
1986 Defines under what circumstances "git status" and the diff family show
1987 a submodule as modified. When set to "all", it will never be considered
1988 modified, "dirty" will ignore all changes to the submodules work tree and
1989 takes only differences between the HEAD of the submodule and the commit
1990 recorded in the superproject into account. "untracked" will additionally
1991 let submodules with modified tracked files in their work tree show up.
1992 Using "none" (the default when this option is not set) also shows
1993 submodules that have untracked files in their work tree as changed.
Jens Lehmann302ad7a2010-08-06 00:40:48 +02001994 This setting overrides any setting made in .gitmodules for this submodule,
Ralf Wildenhues3776ea92010-08-22 13:12:12 +02001995 both settings can be overridden on the command line by using the
Johannes Schindelinbe4f2b42010-08-05 10:49:55 +02001996 "--ignore-submodules" option.
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02001997
Willy Tarreauce1a79b2006-07-20 11:30:44 +02001998tar.umask::
René Scharfe687157c2007-08-21 20:01:16 +02001999 This variable can be used to restrict the permission bits of
2000 tar archive entries. The default is 0002, which turns off the
2001 world write bit. The special value "user" indicates that the
2002 archiving user's umask will be used instead. See umask(2) and
Dan McGee5162e692007-12-29 00:20:38 -06002003 linkgit:git-archive[1].
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002004
Junio C Hamanodab76d32011-09-04 12:37:45 -07002005transfer.fsckObjects::
2006 When `fetch.fsckObjects` or `receive.fsckObjects` are
2007 not set, the value of this variable is used instead.
2008 Defaults to false.
2009
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002010transfer.unpackLimit::
2011 When `fetch.unpackLimit` or `receive.unpackLimit` are
2012 not set, the value of this variable is used instead.
2013 The default value is 100.
2014
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002015url.<base>.insteadOf::
2016 Any URL that starts with this value will be rewritten to
2017 start, instead, with <base>. In cases where some site serves a
2018 large number of repositories, and serves them with multiple
2019 access methods, and some users need to use different access
2020 methods, this feature allows people to specify any of the
2021 equivalent URLs and have git automatically rewrite the URL to
2022 the best alternative for the particular user, even for a
Junio C Hamano844112c2008-02-24 22:25:04 -08002023 never-before-seen repository on the site. When more than one
2024 insteadOf strings match a given URL, the longest match is used.
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002025
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002026url.<base>.pushInsteadOf::
2027 Any URL that starts with this value will not be pushed to;
2028 instead, it will be rewritten to start with <base>, and the
2029 resulting URL will be pushed to. In cases where some site serves
2030 a large number of repositories, and serves them with multiple
2031 access methods, some of which do not allow push, this feature
2032 allows people to specify a pull-only URL and have git
2033 automatically use an appropriate URL to push, even for a
2034 never-before-seen repository on the site. When more than one
2035 pushInsteadOf strings match a given URL, the longest match is
2036 used. If a remote has an explicit pushurl, git will ignore this
2037 setting for that remote.
2038
Petr Baudis1ab661d2006-04-25 00:59:33 +02002039user.email::
2040 Your email address to be recorded in any newly created commits.
Josh Triplett28a94f82007-04-28 18:40:28 -07002041 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Dan McGee5162e692007-12-29 00:20:38 -06002042 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002043
2044user.name::
2045 Your full name to be recorded in any newly created commits.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04002046 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Dan McGee5162e692007-12-29 00:20:38 -06002047 environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002048
Andy Parkinsd67778e2007-01-26 14:13:46 +00002049user.signingkey::
Dan McGee5162e692007-12-29 00:20:38 -06002050 If linkgit:git-tag[1] is not selecting the key you want it to
Andy Parkinsd67778e2007-01-26 14:13:46 +00002051 automatically when creating a signed tag, you can override the
2052 default selection with this variable. This option is passed
2053 unchanged to gpg's --local-user parameter, so you may specify a key
2054 using any method that gpg supports.
2055
Christian Couder983a9ee2008-01-08 04:55:14 +01002056web.browser::
2057 Specify a web browser that may be used by some commands.
2058 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2059 may use it.