blob: 20e95318f3d998306d0ccbb174edc3e25ea87cf5 [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::
162 Directions on how to stage/unstage/add shown in the
163 output of linkgit:git-status[1] and the template shown
Junio C Hamano26e94af2011-12-18 21:35:01 -0800164 when writing commit messages.
Matthieu Moy4c371f92009-11-22 23:26:17 +0100165 commitBeforeMerge::
166 Advice shown when linkgit:git-merge[1] refuses to
Ville Skyttä6b677a22010-07-20 00:17:17 +0300167 merge to avoid overwriting local changes.
Matthieu Moyd38a30d2010-01-12 10:54:44 +0100168 resolveConflict::
169 Advices shown by various commands when conflicts
170 prevent the operation from being performed.
Jeff Kingb706fcf2010-01-13 15:17:08 -0500171 implicitIdentity::
172 Advice on how to set your identity configuration when
173 your information is guessed from the system username and
Junio C Hamano26e94af2011-12-18 21:35:01 -0800174 domain name.
Junio C Hamano13be3e32010-01-29 22:03:24 -0800175 detachedHead::
Junio C Hamano26e94af2011-12-18 21:35:01 -0800176 Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano13be3e32010-01-29 22:03:24 -0800177 move to the detach HEAD state, to instruct how to create
Junio C Hamano26e94af2011-12-18 21:35:01 -0800178 a local branch after the fact.
Jeff King75194432009-09-09 07:38:58 -0400179--
180
Petr Baudis1ab661d2006-04-25 00:59:33 +0200181core.fileMode::
182 If false, the executable bit differences between the index and
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200183 the working tree are ignored; useful on broken filesystems like FAT.
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700184 See linkgit:git-update-index[1].
185+
186The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
187will probe and set core.fileMode false if appropriate when the
188repository is created.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200189
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400190core.ignoreCygwinFSTricks::
191 This option is only used by Cygwin implementation of Git. If false,
192 the Cygwin stat() and lstat() functions are used. This may be useful
193 if your repository consists of a few separate directories joined in
194 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
195 whenever it is possible and falls back to Cygwin functions only to
196 handle symbol links. The native mode is more than twice faster than
Mark Levedahl7faee6b2008-10-13 00:33:31 -0400197 normal Cygwin l/stat() functions. True by default, unless core.filemode
198 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
199 POSIX emulation is required to support core.filemode.
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400200
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700201core.ignorecase::
202 If true, this option enables various workarounds to enable
203 git to work better on filesystems that are not case sensitive,
204 like FAT. For example, if a directory listing finds
205 "makefile" when git expects "Makefile", git will assume
206 it is really the same file, and continue to remember it as
207 "Makefile".
208+
209The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
210will probe and set core.ignorecase true if appropriate when the repository
211is created.
212
Alex Riesen1ce47902008-07-28 08:31:28 +0200213core.trustctime::
214 If false, the ctime differences between the index and the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200215 working tree are ignored; useful when the inode change time
Alex Riesen1ce47902008-07-28 08:31:28 +0200216 is regularly modified by something outside Git (file system
217 crawlers and some backup systems).
218 See linkgit:git-update-index[1]. True by default.
219
Junio C Hamano9378c162007-06-24 15:11:24 -0700220core.quotepath::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500221 The commands that output paths (e.g. 'ls-files',
222 'diff'), when not given the `-z` option, will quote
Junio C Hamano9378c162007-06-24 15:11:24 -0700223 "unusual" characters in the pathname by enclosing the
224 pathname in a double-quote pair and with backslashes the
225 same way strings in C source code are quoted. If this
226 variable is set to false, the bytes higher than 0x80 are
227 not quoted but output as verbatim. Note that double
228 quote, backslash and control characters are always
229 quoted without `-z` regardless of the setting of this
230 variable.
231
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200232core.eol::
233 Sets the line ending type to use in the working directory for
234 files that have the `text` property set. Alternatives are
235 'lf', 'crlf' and 'native', which uses the platform's native
236 line ending. The default value is `native`. See
237 linkgit:gitattributes[5] for more information on end-of-line
238 conversion.
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200239
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100240core.safecrlf::
Eyvind Bernhardsenfd6cce92010-05-19 22:43:10 +0200241 If true, makes git check if converting `CRLF` is reversible when
242 end-of-line conversion is active. Git will verify if a command
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100243 modifies a file in the work tree either directly or indirectly.
244 For example, committing a file followed by checking out the
245 same file should yield the original file in the work tree. If
246 this is not the case for the current setting of
247 `core.autocrlf`, git will reject the file. The variable can
248 be set to "warn", in which case git will only warn about an
249 irreversible conversion but continue the operation.
250+
251CRLF conversion bears a slight chance of corrupting data.
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200252When it is enabled, git will convert CRLF to LF during commit and LF to
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100253CRLF during checkout. A file that contains a mixture of LF and
254CRLF before the commit cannot be recreated by git. For text
255files this is the right thing to do: it corrects line endings
256such that we have only LF line endings in the repository.
257But for binary files that are accidentally classified as text the
258conversion can corrupt data.
259+
260If you recognize such corruption early you can easily fix it by
261setting the conversion type explicitly in .gitattributes. Right
262after committing you still have the original file in your work
263tree and this file is not yet corrupted. You can explicitly tell
264git that this file is binary and git will handle the file
265appropriately.
266+
267Unfortunately, the desired effect of cleaning up text files with
268mixed line endings and the undesired effect of corrupting binary
269files cannot be distinguished. In both cases CRLFs are removed
270in an irreversible way. For text files this is the right thing
271to do because CRLFs are line endings, while for binary files
272converting CRLFs corrupts data.
273+
274Note, this safety check does not mean that a checkout will generate a
275file identical to the original file for a different setting of
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200276`core.eol` and `core.autocrlf`, but only for the current one. For
277example, a text file with `LF` would be accepted with `core.eol=lf`
278and could later be checked out with `core.eol=crlf`, in which case the
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100279resulting file would contain `CRLF`, although the original file
280contained `LF`. However, in both work trees the line endings would be
281consistent, that is either all `LF` or all `CRLF`, but never mixed. A
282file with mixed line endings would be reported by the `core.safecrlf`
283mechanism.
284
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200285core.autocrlf::
286 Setting this variable to "true" is almost the same as setting
287 the `text` attribute to "auto" on all files except that text
288 files are not guaranteed to be normalized: files that contain
289 `CRLF` in the repository will not be touched. Use this
290 setting if you want to have `CRLF` line endings in your
291 working directory even though the repository does not have
292 normalized line endings. This variable can be set to 'input',
293 in which case no output conversion is performed.
294
Johannes Sixt78a8d642007-03-02 22:11:30 +0100295core.symlinks::
296 If false, symbolic links are checked out as small plain files that
Dan McGee5162e692007-12-29 00:20:38 -0600297 contain the link text. linkgit:git-update-index[1] and
298 linkgit:git-add[1] will not change the recorded type to regular
Johannes Sixt78a8d642007-03-02 22:11:30 +0100299 file. Useful on filesystems like FAT that do not support
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700300 symbolic links.
301+
302The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
303will probe and set core.symlinks false if appropriate when the repository
304is created.
Johannes Sixt78a8d642007-03-02 22:11:30 +0100305
Petr Baudis1ab661d2006-04-25 00:59:33 +0200306core.gitProxy::
307 A "proxy command" to execute (as 'command host port') instead
308 of establishing direct connection to the remote server when
309 using the git protocol for fetching. If the variable value is
310 in the "COMMAND for DOMAIN" format, the command is applied only
311 on hostnames ending with the specified domain string. This variable
312 may be set multiple times and is matched in the given order;
313 the first match wins.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100314+
315Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
316(which always applies universally, without the special "for"
317handling).
Emil Sit642d0842009-03-17 13:31:42 -0400318+
319The special string `none` can be used as the proxy command to
320specify that no proxy be used for a given domain pattern.
321This is useful for excluding servers inside a firewall from
322proxy use, while defaulting to a common proxy for external domains.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200323
324core.ignoreStat::
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200325 If true, commands which modify both the working tree and the index
326 will mark the updated paths with the "assume unchanged" bit in the
327 index. These marked files are then assumed to stay unchanged in the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200328 working tree, until you mark them otherwise manually - Git will not
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200329 detect the file changes by lstat() calls. This is useful on systems
330 where those are very slow, such as Microsoft Windows.
331 See linkgit:git-update-index[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200332 False by default.
333
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700334core.preferSymlinkRefs::
335 Instead of the default "symref" format for HEAD
336 and other symbolic reference files, use symbolic links.
337 This is sometimes needed to work with old scripts that
338 expect HEAD to be a symbolic link.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200339
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500340core.bare::
341 If true this repository is assumed to be 'bare' and has no
342 working directory associated with it. If this is the case a
343 number of commands that require a working directory will be
Dan McGee5162e692007-12-29 00:20:38 -0600344 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500345+
Dan McGee5162e692007-12-29 00:20:38 -0600346This setting is automatically guessed by linkgit:git-clone[1] or
347linkgit:git-init[1] when the repository was created. By default a
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500348repository that ends in "/.git" is assumed to be not bare (bare =
349false), while all other repositories are assumed to be bare (bare
350= true).
351
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200352core.worktree::
Junio C Hamanoea472c12011-01-23 15:49:41 -0800353 Set the path to the root of the working tree.
Ralf Wildenhues06ada152007-10-09 23:00:03 +0200354 This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoea472c12011-01-23 15:49:41 -0800355 variable and the '--work-tree' command line option.
SZEDER Gábord424a472011-04-04 16:59:25 +0200356 The value can be an absolute path or relative to the path to
Junio C Hamanoea472c12011-01-23 15:49:41 -0800357 the .git directory, which is either specified by --git-dir
358 or GIT_DIR, or automatically discovered.
359 If --git-dir or GIT_DIR is specified but none of
Liu Yubao302cc112008-04-29 04:09:20 +0800360 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanoea472c12011-01-23 15:49:41 -0800361 the current working directory is regarded as the top level
Nguyễn Thái Ngọc Duy98acf752010-11-26 22:32:42 +0700362 of your working tree.
Junio C Hamanoea472c12011-01-23 15:49:41 -0800363+
364Note that this variable is honored even when set in a configuration
365file in a ".git" subdirectory of a directory and its value differs
366from the latter directory (e.g. "/path/to/.git/config" has
367core.worktree set to "/different/path"), which is most likely a
368misconfiguration. Running git commands in the "/path/to" directory will
369still use "/different/path" as the root of the work tree and can cause
370confusion unless you know what you are doing (e.g. you are creating a
371read-only snapshot of the same index to a location different from the
372repository's usual working tree).
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200373
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400374core.logAllRefUpdates::
Lukas Sandström14cd5602007-08-19 23:38:57 +0200375 Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano4057deb2006-10-08 01:35:18 -0700376 "$GIT_DIR/logs/<ref>", by appending the new and old
377 SHA1, the date/time and the reason of the update, but
378 only when the file exists. If this configuration
379 variable is set to true, missing "$GIT_DIR/logs/<ref>"
Bert Wesargcd8e3712011-07-11 11:14:18 +0200380 file is automatically created for branch heads (i.e. under
381 refs/heads/), remote refs (i.e. under refs/remotes/),
382 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamanoa862f972006-12-30 22:39:24 -0800383+
384This information can be used to determine what commit
385was the tip of a branch "2 days ago".
386+
387This value is true by default in a repository that has
388a working directory associated with it, and false by
389default in a bare repository.
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400390
Petr Baudis1ab661d2006-04-25 00:59:33 +0200391core.repositoryFormatVersion::
392 Internal variable identifying the repository format and layout
393 version.
394
395core.sharedRepository::
Jonas Fonsecad5dc6a72006-08-09 02:26:23 +0200396 When 'group' (or 'true'), the repository is made shareable between
397 several users in a group (making sure all the files and objects are
398 group-writable). When 'all' (or 'world' or 'everybody'), the
399 repository will be readable by all users, additionally to being
400 group-shareable. When 'umask' (or 'false'), git will use permissions
Heikki Orsila06cbe852008-04-16 11:34:24 +0300401 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
402 files in the repository will have this mode value. '0xxx' will override
Johan Herland098082f2009-04-14 15:15:42 +0200403 user's umask value (whereas the other options will only override
404 requested parts of the user's umask value). Examples: '0660' will make
405 the repo read/write-able for the owner and group, but inaccessible to
406 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Heikki Orsila06cbe852008-04-16 11:34:24 +0300407 repository that is group-readable but not group-writable.
408 See linkgit:git-init[1]. False by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200409
410core.warnAmbiguousRefs::
411 If true, git will warn you if the ref name you passed it is ambiguous
412 and might match multiple refs in the .git/refs/ tree. True by default.
413
Joachim Berdal Haga3d3e95a2006-07-06 22:35:54 +0200414core.compression::
Dana How960ccca2007-05-09 13:56:50 -0700415 An integer -1..9, indicating a default compression level.
416 -1 is the zlib default. 0 means no compression,
417 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Brian Downingdec92302007-11-19 10:58:51 -0600418 If set, this provides a default to other compression variables,
419 such as 'core.loosecompression' and 'pack.compression'.
Dana How960ccca2007-05-09 13:56:50 -0700420
421core.loosecompression::
Joachim B Haga12f6c302006-07-03 22:11:47 +0200422 An integer -1..9, indicating the compression level for objects that
Dana How960ccca2007-05-09 13:56:50 -0700423 are not in a pack file. -1 is the zlib default. 0 means no
Joachim B Haga12f6c302006-07-03 22:11:47 +0200424 compression, and 1..9 are various speed/size tradeoffs, 9 being
Dana How960ccca2007-05-09 13:56:50 -0700425 slowest. If not set, defaults to core.compression. If that is
Brian Downingde1b2462007-11-19 10:58:50 -0600426 not set, defaults to 1 (best speed).
Joachim B Haga12f6c302006-07-03 22:11:47 +0200427
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500428core.packedGitWindowSize::
429 Number of bytes of a pack file to map into memory in a
430 single mapping operation. Larger window sizes may allow
431 your system to process a smaller number of large pack files
432 more quickly. Smaller window sizes will negatively affect
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500433 performance due to increased calls to the operating system's
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500434 memory manager, but may improve performance when accessing
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500435 a large number of large pack files.
436+
437Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
438MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
439be reasonable for all users/operating systems. You probably do
440not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500441+
442Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500443
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500444core.packedGitLimit::
445 Maximum number of bytes to map simultaneously into memory
446 from pack files. If Git needs to access more than this many
447 bytes at once to complete an operation it will unmap existing
448 regions to reclaim virtual address space within the process.
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500449+
450Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
451This should be reasonable for all users/operating systems, except on
452the largest projects. You probably do not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500453+
454Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500455
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400456core.deltaBaseCacheLimit::
457 Maximum number of bytes to reserve for caching base objects
Ville Skyttä6b677a22010-07-20 00:17:17 +0300458 that may be referenced by multiple deltified objects. By storing the
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400459 entire decompressed base objects in a cache Git is able
460 to avoid unpacking and decompressing frequently used base
461 objects multiple times.
462+
463Default is 16 MiB on all platforms. This should be reasonable
464for all users/operating systems, except on the largest projects.
465You probably do not need to adjust this value.
466+
467Common unit suffixes of 'k', 'm', or 'g' are supported.
468
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800469core.bigFileThreshold::
470 Files larger than this size are stored deflated, without
471 attempting delta compression. Storing large files without
472 delta compression avoids excessive memory usage, at the
473 slight expense of increased disk usage.
474+
475Default is 512 MiB on all platforms. This should be reasonable
476for most projects as source code and other text files can still
477be delta compressed, but larger binary media files won't be.
478+
479Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800480
Michael Hendrickse8964a52007-07-02 10:48:34 -0600481core.excludesfile::
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100482 In addition to '.gitignore' (per-directory) and
483 '.git/info/exclude', git looks into this file for patterns
Jeff King6cf378f2012-04-26 04:51:57 -0400484 of files which are not meant to be tracked. "`~/`" is expanded
485 to the value of `$HOME` and "`~user/`" to the specified user's
Huynh Khoi Nguyen Nguyendc796872012-06-22 11:03:24 +0200486 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
487 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
488 is used instead. See linkgit:gitignore[5].
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100489
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200490core.askpass::
491 Some commands (e.g. svn and http interfaces) that interactively
492 ask for a password can be told to use an external program given
Knut Franke453842c2010-08-30 15:40:29 +0200493 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
494 environment variable. If not set, fall back to the value of the
495 'SSH_ASKPASS' environment variable or, failing that, a simple password
496 prompt. The external program shall be given a suitable prompt as
497 command line argument and write the password on its STDOUT.
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200498
Petr Onderka6df42ab2010-09-01 00:42:43 +0200499core.attributesfile::
500 In addition to '.gitattributes' (per-directory) and
501 '.git/info/attributes', git looks into this file for attributes
502 (see linkgit:gitattributes[5]). Path expansions are made the same
503 way as for `core.excludesfile`.
504
Adam Robenef0c2ab2007-07-19 22:09:35 -0700505core.editor::
506 Commands such as `commit` and `tag` that lets you edit
Brian Hetro02783072007-08-23 20:44:13 -0400507 messages by launching an editor uses the value of this
Adam Robenef0c2ab2007-07-19 22:09:35 -0700508 variable when it is set, and the environment variable
Jonathan Niederb4479f02009-10-30 20:42:34 -0500509 `GIT_EDITOR` is not set. See linkgit:git-var[1].
Adam Robenef0c2ab2007-07-19 22:09:35 -0700510
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200511sequence.editor::
512 Text editor used by `git rebase -i` for editing the rebase insn file.
513 The value is meant to be interpreted by the shell when it is used.
514 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
515 When not configured the default commit message editor is used instead.
516
Brian Gernhardt54adf372007-07-03 14:18:11 -0400517core.pager::
Jonathan Niederab54cd62008-08-24 00:28:32 -0500518 The command that git will use to paginate output. Can
519 be overridden with the `GIT_PAGER` environment
520 variable. Note that git sets the `LESS` environment
521 variable to `FRSX` if it is unset when it runs the
522 pager. One can change these settings by setting the
Chris Freyfee75452008-09-24 19:21:28 -0400523 `LESS` variable to some other value. Alternately,
524 these settings can be overridden on a project or
525 global basis by setting the `core.pager` option.
526 Setting `core.pager` has no affect on the `LESS`
527 environment variable behaviour above, so if you want
528 to override git's default settings this way, you need
529 to be explicit. For example, to disable the S option
530 in a backward compatible manner, set `core.pager`
Chris Johnsendcb11262009-03-15 06:30:52 -0500531 to `less -+$LESS -FRX`. This will be passed to the
Chris Freyfee75452008-09-24 19:21:28 -0400532 shell by git, which will translate the final command to
Chris Johnsendcb11262009-03-15 06:30:52 -0500533 `LESS=FRSX less -+FRSX -FRX`.
Brian Gernhardt54adf372007-07-03 14:18:11 -0400534
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800535core.whitespace::
536 A comma separated list of common whitespace problems to
Thomas Rast0b444cd2010-01-10 00:33:00 +0100537 notice. 'git diff' will use `color.diff.whitespace` to
538 highlight them, and 'git apply --whitespace=error' will
Junio C Hamanoc921cc92008-07-25 00:34:47 -0700539 consider them as errors. You can prefix `-` to disable
540 any of them (e.g. `-trailing-space`):
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800541+
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700542* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800543 as an error (enabled by default).
544* `space-before-tab` treats a space character that appears immediately
545 before a tab character in the initial indent part of the line as an
546 error (enabled by default).
547* `indent-with-non-tab` treats a line that is indented with 8 or more
J. Bruce Fields127f72e2007-12-16 11:31:42 -0500548 space characters as an error (not enabled by default).
Chris Webb3e3ec2a2010-04-03 00:37:08 +0100549* `tab-in-indent` treats a tab character in the initial indent part of
550 the line as an error (not enabled by default).
Junio C Hamano77b15bb2009-09-03 16:02:32 -0700551* `blank-at-eof` treats blank lines added at the end of file as an error
552 (enabled by default).
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700553* `trailing-space` is a short-hand to cover both `blank-at-eol` and
554 `blank-at-eof`.
Junio C Hamanob2979ff2008-01-15 00:59:05 -0800555* `cr-at-eol` treats a carriage-return at the end of line as
556 part of the line terminator, i.e. with it, `trailing-space`
557 does not trigger if the character before such a carriage-return
558 is not a whitespace (not enabled by default).
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100559* `tabwidth=<n>` tells how many character positions a tab occupies; this
560 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
561 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800562
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700563core.fsyncobjectfiles::
564 This boolean will enable 'fsync()' when writing object files.
565+
566This is a total waste of time and effort on a filesystem that orders
567data writes properly, but can be useful for filesystems that do not use
568journalling (traditional UNIX filesystems) or that only journal metadata
569and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
570
Linus Torvalds671c9b72008-11-13 16:36:30 -0800571core.preloadindex::
572 Enable parallel index preload for operations like 'git diff'
573+
574This can speed up operations like 'git diff' and 'git status' especially
575on filesystems like NFS that have weak caching semantics and thus
576relatively high IO latencies. With this set to 'true', git will do the
577index comparison to the filesystem data in parallel, allowing
578overlapping IO's.
579
Johannes Schindelin348df162009-04-28 00:32:25 +0200580core.createObject::
581 You can set this to 'link', in which case a hardlink followed by
582 a delete of the source are used to make sure that object creation
583 will not overwrite existing objects.
584+
585On some file system/operating system combinations, this is unreliable.
586Set this config setting to 'rename' there; However, This will remove the
587check that makes sure that existing object files will not get overwritten.
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200588
Johannes Schindelina97a7462009-10-09 12:21:57 +0200589core.notesRef::
590 When showing commit messages, also show notes which are stored in
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500591 the given ref. The ref must be fully qualified. If the given
592 ref does not exist, it is not an error but means that no
593 notes should be printed.
Johannes Schindelina97a7462009-10-09 12:21:57 +0200594+
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500595This setting defaults to "refs/notes/commits", and it can be overridden by
596the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Johannes Schindelina97a7462009-10-09 12:21:57 +0200597
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +0700598core.sparseCheckout::
599 Enable "sparse checkout" feature. See section "Sparse checkout" in
600 linkgit:git-read-tree[1] for more information.
601
Junio C Hamanoa71f09f2011-03-20 22:26:24 -0700602core.abbrev::
Linus Torvaldsdce96482010-10-28 11:28:04 -0700603 Set the length object names are abbreviated to. If unspecified,
604 many commands abbreviate to 7 hexdigits, which may not be enough
605 for abbreviated object names to stay unique for sufficiently long
606 time.
607
Stephen Boyd13bd2132009-05-30 22:08:02 -0700608add.ignore-errors::
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600609add.ignoreErrors::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100610 Tells 'git add' to continue adding files when some files cannot be
Stephen Boyd13bd2132009-05-30 22:08:02 -0700611 added due to indexing errors. Equivalent to the '--ignore-errors'
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600612 option of linkgit:git-add[1]. Older versions of git accept only
613 `add.ignore-errors`, which does not follow the usual naming
614 convention for configuration variables. Newer versions of git
615 honor `add.ignoreErrors` as well.
Stephen Boyd13bd2132009-05-30 22:08:02 -0700616
Petr Baudis4514ad42006-06-07 20:43:50 +0200617alias.*::
Dan McGee5162e692007-12-29 00:20:38 -0600618 Command aliases for the linkgit:git[1] command wrapper - e.g.
Petr Baudis4514ad42006-06-07 20:43:50 +0200619 after defining "alias.last = cat-file commit HEAD", the invocation
620 "git last" is equivalent to "git cat-file commit HEAD". To avoid
Petr Baudis99b41c82006-06-07 17:25:21 -0700621 confusion and troubles with script usage, aliases that
622 hide existing git commands are ignored. Arguments are split by
623 spaces, the usual shell quoting and escaping is supported.
624 quote pair and a backslash can be used to quote them.
Junio C Hamanof368f5a2007-09-01 04:01:54 -0700625+
626If the alias expansion is prefixed with an exclamation point,
627it will be treated as a shell command. For example, defining
628"alias.new = !gitk --all --not ORIG_HEAD", the invocation
629"git new" is equivalent to running the shell command
Sitaram Chamarty595b8db2009-07-01 21:30:31 +0530630"gitk --all --not ORIG_HEAD". Note that shell commands will be
631executed from the top-level directory of a repository, which may
632not necessarily be the current directory.
Michael J Gruber7cf16a12011-04-27 10:36:27 +0200633'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
634from the original current directory. See linkgit:git-rev-parse[1].
Theodore Ts'odfd42a32007-02-10 19:33:58 -0500635
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100636am.keepcr::
637 If true, git-am will call git-mailsplit for patches in mbox format
638 with parameter '--keep-cr'. In this case git-mailsplit will
Ville Skyttä6b677a22010-07-20 00:17:17 +0300639 not remove `\r` from lines ending with `\r\n`. Can be overridden
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100640 by giving '--no-keep-cr' from the command line.
641 See linkgit:git-am[1], linkgit:git-mailsplit[1].
642
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200643apply.ignorewhitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100644 When set to 'change', tells 'git apply' to ignore changes in
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200645 whitespace, in the same way as the '--ignore-space-change'
646 option.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100647 When set to one of: no, none, never, false tells 'git apply' to
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200648 respect all whitespace differences.
649 See linkgit:git-apply[1].
650
Petr Baudis1ab661d2006-04-25 00:59:33 +0200651apply.whitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100652 Tells 'git apply' how to handle whitespaces, in the same way
Dan McGee5162e692007-12-29 00:20:38 -0600653 as the '--whitespace' option. See linkgit:git-apply[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200654
Paolo Bonzini99023872007-05-23 07:07:54 +0200655branch.autosetupmerge::
Junio C Hamanoadd09512010-01-20 20:28:49 -0800656 Tells 'git branch' and 'git checkout' to set up new branches
Jay Soffian572fc812008-02-19 11:24:38 -0500657 so that linkgit:git-pull[1] will appropriately merge from the
658 starting point branch. Note that even if this option is not set,
Paolo Bonzini99023872007-05-23 07:07:54 +0200659 this behavior can be chosen per-branch using the `--track`
Jay Soffian572fc812008-02-19 11:24:38 -0500660 and `--no-track` options. The valid settings are: `false` -- no
661 automatic setup is done; `true` -- automatic setup is done when the
Matthieu Moy29b9a662010-11-02 16:31:24 +0100662 starting point is a remote-tracking branch; `always` --
663 automatic setup is done when the starting point is either a
664 local branch or remote-tracking
Jay Soffian572fc812008-02-19 11:24:38 -0500665 branch. This option defaults to true.
Paolo Bonzini99023872007-05-23 07:07:54 +0200666
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700667branch.autosetuprebase::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100668 When a new branch is created with 'git branch' or 'git checkout'
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700669 that tracks another branch, this variable tells git to set
670 up pull to rebase instead of merge (see "branch.<name>.rebase").
671 When `never`, rebase is never automatically set to true.
672 When `local`, rebase is set to true for tracked branches of
673 other local branches.
674 When `remote`, rebase is set to true for tracked branches of
Matthieu Moy29b9a662010-11-02 16:31:24 +0100675 remote-tracking branches.
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700676 When `always`, rebase will be set to true for all tracking
677 branches.
678 See "branch.autosetupmerge" for details on how to set up a
679 branch to track another branch.
680 This option defaults to never.
681
Santi Béjar648ad182006-09-23 12:05:43 +0200682branch.<name>.remote::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100683 When in branch <name>, it tells 'git fetch' and 'git push' which
Santi Béjar76d3cc52009-03-30 12:11:40 +0200684 remote to fetch from/push to. It defaults to `origin` if no remote is
685 configured. `origin` is also used if you are not on any branch.
Santi Béjar648ad182006-09-23 12:05:43 +0200686
Santi Béjar53728062006-09-23 22:53:04 +0200687branch.<name>.merge::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200688 Defines, together with branch.<name>.remote, the upstream branch
Martin von Zweigbergk15a147e2011-02-09 20:54:02 -0500689 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Thomas Rast0b444cd2010-01-10 00:33:00 +0100690 branch to merge and can also affect 'git push' (see push.default).
691 When in branch <name>, it tells 'git fetch' the default
Daniel Barkalowb888d612007-09-10 23:03:25 -0400692 refspec to be marked for merging in FETCH_HEAD. The value is
693 handled like the remote part of a refspec, and must match a
694 ref which is fetched from the remote given by
695 "branch.<name>.remote".
Thomas Rast0b444cd2010-01-10 00:33:00 +0100696 The merge information is used by 'git pull' (which at first calls
697 'git fetch') to lookup the default branch for merging. Without
698 this option, 'git pull' defaults to merge the first refspec fetched.
Josef Weidendorfer62b339a2006-12-09 02:28:26 +0100699 Specify multiple values to get an octopus merge.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100700 If you wish to setup 'git pull' so that it merges into <name> from
Paolo Bonzini9debc322007-03-15 09:23:20 +0100701 another branch in the local repository, you can point
702 branch.<name>.merge to the desired branch, and use the special setting
703 `.` (a period) for branch.<name>.remote.
Santi Béjar53728062006-09-23 22:53:04 +0200704
Lars Hjemliaec7b362007-09-24 00:51:43 +0200705branch.<name>.mergeoptions::
706 Sets default options for merging into branch <name>. The syntax and
Jonathan Nieder25dcc0d2009-10-09 13:51:14 -0500707 supported options are the same as those of linkgit:git-merge[1], but
Lars Hjemliaec7b362007-09-24 00:51:43 +0200708 option values containing whitespace characters are currently not
709 supported.
710
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000711branch.<name>.rebase::
712 When true, rebase the branch <name> on top of the fetched branch,
Dustin Sallings15ddb6f2008-05-08 11:28:07 -0700713 instead of merging the default branch from the default remote when
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100714 "git pull" is run. See "pull.rebase" for doing this in a non
715 branch-specific manner.
716+
717*NOTE*: this is a possibly dangerous operation; do *not* use
718it unless you understand the implications (see linkgit:git-rebase[1]
719for details).
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000720
Christian Couder1658c612008-03-14 05:56:53 +0100721browser.<tool>.cmd::
722 Specify the command to invoke the specified browser. The
723 specified command is evaluated in shell with the URLs passed
Jonathan Nieder565e1352011-06-29 00:35:10 -0500724 as arguments. (See linkgit:git-web{litdd}browse[1].)
Christian Couder1658c612008-03-14 05:56:53 +0100725
Christian Couder584627b2008-01-29 07:08:22 +0100726browser.<tool>.path::
727 Override the path for the given tool that may be used to
Christian Couderab989ad2008-01-29 07:08:44 +0100728 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
729 working repository in gitweb (see linkgit:git-instaweb[1]).
Christian Couder584627b2008-01-29 07:08:22 +0100730
Josh Triplett21225912007-04-23 17:18:16 -0700731clean.requireForce::
Junio C Hamano562ca192007-11-01 17:32:04 -0700732 A boolean to make git-clean do nothing unless given -f
733 or -n. Defaults to true.
Josh Triplett21225912007-04-23 17:18:16 -0700734
Brian Gernhardtf3673982007-01-03 10:36:29 -0500735color.branch::
736 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600737 linkgit:git-branch[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800738 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Brian Gernhardtf3673982007-01-03 10:36:29 -0500739 only when the output is to a terminal. Defaults to false.
740
741color.branch.<slot>::
742 Use customized color for branch coloration. `<slot>` is one of
743 `current` (the current branch), `local` (a local branch),
Matthieu Moy8b3f3f82010-11-02 16:31:23 +0100744 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Mark Wooding4f193f22007-01-28 15:17:36 +0000745 refs).
746+
747The value for these configuration variables is a list of colors (at most
748two) and attributes (at most one), separated by spaces. The colors
749accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
750`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
751`blink` and `reverse`. The first color given is the foreground; the
752second is the background. The position of the attribute, if any,
753doesn't matter.
Brian Gernhardtf3673982007-01-03 10:36:29 -0500754
Andy Parkinsa159ca02006-12-13 09:13:28 +0000755color.diff::
Michael J Gruber6999c542011-04-27 09:38:27 +0200756 Whether to use ANSI escape sequences to add color to patches.
757 If this is set to `always`, linkgit:git-diff[1],
758 linkgit:git-log[1], and linkgit:git-show[1] will use color
759 for all patches. If it is set to `true` or `auto`, those
760 commands will only use color when output is to the terminal.
761 Defaults to false.
762+
763This does not affect linkgit:git-format-patch[1] nor the
764'git-diff-{asterisk}' plumbing commands. Can be overridden on the
765command line with the `--color[=<when>]` option.
Junio C Hamanob5376642006-07-07 05:28:05 -0700766
Andy Parkinsa159ca02006-12-13 09:13:28 +0000767color.diff.<slot>::
Mark Wooding4f193f22007-01-28 15:17:36 +0000768 Use customized color for diff colorization. `<slot>` specifies
769 which part of the patch to use the specified color, and is one
770 of `plain` (context text), `meta` (metainformation), `frag`
Bert Wesarg89cb73a2009-11-27 07:55:18 +0100771 (hunk header), 'func' (function in hunk header), `old` (removed lines),
772 `new` (added lines), `commit` (commit headers), or `whitespace`
773 (highlighting whitespace errors). The values of these variables may be
774 specified as in color.branch.<slot>.
Junio C Hamanob5376642006-07-07 05:28:05 -0700775
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800776color.decorate.<slot>::
777 Use customized color for 'git log --decorate' output. `<slot>` is one
778 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Matthieu Moy0e615b22010-11-02 16:31:20 +0100779 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800780
René Scharfe7e8f59d2009-03-07 13:32:32 +0100781color.grep::
782 When set to `always`, always highlight matches. When `false` (or
783 `never`), never. When set to `true` or `auto`, use color only
784 when the output is written to the terminal. Defaults to `false`.
785
Mark Lodato55f638b2010-03-07 11:52:46 -0500786color.grep.<slot>::
787 Use customized color for grep colorization. `<slot>` specifies which
788 part of the line to use the specified color, and is one of
789+
790--
Mark Lodato00588bb2010-03-07 11:52:47 -0500791`context`;;
792 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500793`filename`;;
794 filename prefix (when not using `-h`)
Mark Lodato00588bb2010-03-07 11:52:47 -0500795`function`;;
796 function name lines (when using `-p`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500797`linenumber`;;
798 line number prefix (when using `-n`)
799`match`;;
800 matching text
Mark Lodato00588bb2010-03-07 11:52:47 -0500801`selected`;;
802 non-matching text in selected lines
Mark Lodato55f638b2010-03-07 11:52:46 -0500803`separator`;;
804 separators between fields on a line (`:`, `-`, and `=`)
805 and between hunks (`--`)
806--
807+
808The values of these variables may be specified as in color.branch.<slot>.
René Scharfe7e8f59d2009-03-07 13:32:32 +0100809
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800810color.interactive::
Jeff King47ee06f2008-01-05 04:57:44 -0500811 When set to `always`, always use colors for interactive prompts
Jonathan Nieder467c0192008-07-03 00:28:15 -0500812 and displays (such as those used by "git-add --interactive").
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800813 When false (or `never`), never. When set to `true` or `auto`, use
814 colors only when the output is to the terminal. Defaults to false.
815
816color.interactive.<slot>::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100817 Use customized color for 'git add --interactive'
Thomas Rasta3019732009-02-05 09:28:27 +0100818 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
819 four distinct types of normal output from interactive
Ori Avtalion57f6ec02009-08-07 17:24:21 +0300820 commands. The values of these variables may be specified as
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800821 in color.branch.<slot>.
822
Junio C Hamano1d770432006-12-13 12:11:03 -0800823color.pager::
824 A boolean to enable/disable colored output when the pager is in
825 use (default is true).
826
Markus Heidelbergab07ba22009-04-22 23:41:25 +0200827color.showbranch::
828 A boolean to enable/disable color in the output of
829 linkgit:git-show-branch[1]. May be set to `always`,
830 `false` (or `never`) or `auto` (or `true`), in which case colors are used
831 only when the output is to a terminal. Defaults to false.
832
Junio C Hamano1d770432006-12-13 12:11:03 -0800833color.status::
834 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600835 linkgit:git-status[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800836 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamano1d770432006-12-13 12:11:03 -0800837 only when the output is to a terminal. Defaults to false.
838
839color.status.<slot>::
840 Use customized color for status colorization. `<slot>` is
841 one of `header` (the header text of the status message),
Shawn O. Pearce82dca842006-12-15 21:53:13 -0500842 `added` or `updated` (files which are added but not committed),
843 `changed` (files which are changed but not added in the index),
Aleksi Aalto1d282322010-11-18 01:40:05 +0200844 `untracked` (files which are not tracked by git),
845 `branch` (the current branch), or
Chris Parsons950ce2e2008-05-22 08:50:02 -0400846 `nobranch` (the color the 'no branch' warning is shown in, defaulting
847 to red). The values of these variables may be specified as in
848 color.branch.<slot>.
Junio C Hamano1d770432006-12-13 12:11:03 -0800849
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100850color.ui::
Michael J Gruber6999c542011-04-27 09:38:27 +0200851 This variable determines the default value for variables such
852 as `color.diff` and `color.grep` that control the use of color
853 per command family. Its scope will expand as more commands learn
854 configuration to set a default for the `--color` option. Set it
855 to `always` if you want all output not intended for machine
856 consumption to use color, to `true` or `auto` if you want such
857 output to use color when written to the terminal, or to `false` or
858 `never` if you prefer git commands not to use color unless enabled
859 explicitly with some other configuration or the `--color` option.
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100860
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700861column.ui::
862 Specify whether supported commands should output in columns.
863 This variable consists of a list of tokens separated by spaces
864 or commas:
865+
866--
867`always`;;
868 always show in columns
869`never`;;
870 never show in columns
871`auto`;;
872 show in columns if the output is to the terminal
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700873`column`;;
874 fill columns before rows (default)
875`row`;;
876 fill rows before columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700877`plain`;;
878 show in one column
Nguyễn Thái Ngọc Duy3f8eccb2012-04-13 17:54:36 +0700879`dense`;;
880 make unequal size columns to utilize more space
881`nodense`;;
882 make equal size columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700883--
884+
885 This option defaults to 'never'.
886
Nguyễn Thái Ngọc Duyebe31ef2012-04-13 17:54:38 +0700887column.branch::
888 Specify whether to output branch listing in `git branch` in columns.
889 See `column.ui` for details.
890
Nguyễn Thái Ngọc Duy323d0532012-04-13 17:54:39 +0700891column.status::
892 Specify whether to output untracked files in `git status` in columns.
893 See `column.ui` for details.
894
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700895column.tag::
896 Specify whether to output tag listing in `git tag` in columns.
897 See `column.ui` for details.
898
Thomas Rast88955ed2010-01-23 23:13:17 +0100899commit.status::
James P. Howard, IIbed575e2009-12-07 17:45:27 -0500900 A boolean to enable/disable inclusion of status information in the
901 commit message template when using an editor to prepare the commit
902 message. Defaults to true.
903
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500904commit.template::
905 Specify a file to use as the template for new commit messages.
Jeff King6cf378f2012-04-26 04:51:57 -0400906 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Matthieu Moydf2a79f2009-11-19 16:21:15 +0100907 specified user's home directory.
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500908
Jeff Kinga6fc9fd2011-12-10 05:31:38 -0500909credential.helper::
910 Specify an external helper to be called when a username or
911 password credential is needed; the helper may consult external
912 storage to avoid prompting the user for the credentials. See
913 linkgit:gitcredentials[7] for details.
914
915credential.useHttpPath::
916 When acquiring credentials, consider the "path" component of an http
917 or https URL to be important. Defaults to false. See
918 linkgit:gitcredentials[7] for more information.
919
920credential.username::
921 If no username is set for a network authentication, use this username
922 by default. See credential.<context>.* below, and
923 linkgit:gitcredentials[7].
924
925credential.<url>.*::
926 Any of the credential.* options above can be applied selectively to
927 some credentials. For example "credential.https://example.com.username"
928 would set the default username only for https connections to
929 example.com. See linkgit:gitcredentials[7] for details on how URLs are
930 matched.
931
Ramkumar Ramachandra19299a82011-04-07 00:16:49 +0530932include::diff-config.txt[]
David Aguilarafcbc8e2009-04-07 01:21:20 -0700933
934difftool.<tool>.path::
935 Override the path for the given tool. This is useful in case
936 your tool is not in the PATH.
937
938difftool.<tool>.cmd::
939 Specify the command to invoke the specified diff tool.
940 The specified command is evaluated in shell with the following
941 variables available: 'LOCAL' is set to the name of the temporary
942 file containing the contents of the diff pre-image and 'REMOTE'
943 is set to the name of the temporary file containing the contents
944 of the diff post-image.
945
David Aguilara9043922009-04-07 01:21:22 -0700946difftool.prompt::
947 Prompt before each invocation of the diff tool.
948
Boyd Stephen Smith Jrae3b9702009-01-20 22:59:54 -0600949diff.wordRegex::
Boyd Stephen Smith Jr98a4d872009-01-20 21:46:57 -0600950 A POSIX Extended Regular Expression used to determine what is a "word"
951 when performing word-by-word difference calculations. Character
952 sequences that match the regular expression are "words", all other
953 characters are *ignorable* whitespace.
954
Jens Lehmannbe254a02010-11-11 00:55:02 +0100955fetch.recurseSubmodules::
Jens Lehmann1fb25502011-03-06 23:11:48 +0100956 This option can be either set to a boolean value or to 'on-demand'.
957 Setting it to a boolean changes the behavior of fetch and pull to
958 unconditionally recurse into submodules when set to true or to not
959 recurse at all when set to false. When set to 'on-demand' (the default
960 value), fetch and pull will only recurse into a populated submodule
961 when its superproject retrieves a commit that updates the submodule's
962 reference.
Jens Lehmannbe254a02010-11-11 00:55:02 +0100963
Junio C Hamano5e838ea2011-09-04 12:26:14 -0700964fetch.fsckObjects::
965 If it is set to true, git-fetch-pack will check all fetched
966 objects. It will abort in the case of a malformed object or a
967 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -0700968 Defaults to false. If not set, the value of `transfer.fsckObjects`
969 is used instead.
Junio C Hamano5e838ea2011-09-04 12:26:14 -0700970
Junio C Hamanoaf7cf262007-01-24 16:47:24 -0800971fetch.unpackLimit::
972 If the number of objects fetched over the git native
973 transfer is below this
974 limit, then the objects will be unpacked into loose object
975 files. However if the number of received objects equals or
976 exceeds this limit then the received pack will be stored as
977 a pack, after adding any missing delta bases. Storing the
978 pack from a push can make the push operation complete faster,
Michele Ballabio80cd9cf2008-01-11 22:11:13 +0100979 especially on slow filesystems. If not set, the value of
980 `transfer.unpackLimit` is used instead.
Junio C Hamanoaf7cf262007-01-24 16:47:24 -0800981
Stephen Boyd48d34482009-04-23 02:37:56 -0700982format.attach::
983 Enable multipart/mixed attachments as the default for
984 'format-patch'. The value can also be a double quoted string
985 which will enable attachments as the default and set the
986 value as the boundary. See the --attach option in
987 linkgit:git-format-patch[1].
988
Brian Gernhardt49604a42007-11-03 23:38:24 -0400989format.numbered::
Brian Gernhardta567fdc2008-10-02 16:55:39 -0400990 A boolean which can enable or disable sequence numbers in patch
991 subjects. It defaults to "auto" which enables it only if there
992 is more than one patch. It can be enabled or disabled for all
993 messages by setting it to "true" or "false". See --numbered
994 option in linkgit:git-format-patch[1].
Brian Gernhardt49604a42007-11-03 23:38:24 -0400995
Petr Baudis1ab661d2006-04-25 00:59:33 +0200996format.headers::
997 Additional email headers to include in a patch to be submitted
Dan McGee5162e692007-12-29 00:20:38 -0600998 by mail. See linkgit:git-format-patch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200999
Miklos Vajna312a30e2010-07-12 20:58:38 +02001000format.to::
Stephen Boyd48d34482009-04-23 02:37:56 -07001001format.cc::
Miklos Vajna312a30e2010-07-12 20:58:38 +02001002 Additional recipients to include in a patch to be submitted
1003 by mail. See the --to and --cc options in
1004 linkgit:git-format-patch[1].
Stephen Boyd48d34482009-04-23 02:37:56 -07001005
1006format.subjectprefix::
1007 The default for format-patch is to output files with the '[PATCH]'
1008 subject prefix. Use this variable to change that prefix.
1009
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001010format.signature::
1011 The default for format-patch is to output a signature containing
1012 the git version number. Use this variable to change that default.
1013 Set this variable to the empty string ("") to suppress
1014 signature generation.
1015
Johannes Schindelin78cb59c2007-03-04 00:17:23 +01001016format.suffix::
1017 The default for format-patch is to output files with the suffix
1018 `.patch`. Use this variable to change that suffix (make sure to
1019 include the dot if you want it).
1020
Denis Cheng94c22a52008-03-02 17:05:53 +08001021format.pretty::
1022 The default pretty format for log/show/whatchanged command,
1023 See linkgit:git-log[1], linkgit:git-show[1],
1024 linkgit:git-whatchanged[1].
1025
Thomas Rast30984ed2009-02-19 22:26:33 +01001026format.thread::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001027 The default threading style for 'git format-patch'. Can be
Jonathan Nieder578b62b2010-01-09 21:01:21 -06001028 a boolean value, or `shallow` or `deep`. `shallow` threading
1029 makes every mail a reply to the head of the series,
Thomas Rast30984ed2009-02-19 22:26:33 +01001030 where the head is chosen from the cover letter, the
Jeff King6cf378f2012-04-26 04:51:57 -04001031 `--in-reply-to`, and the first patch mail, in this order.
Stephen Boydfd1ff302009-04-23 02:37:57 -07001032 `deep` threading makes every mail a reply to the previous one.
Thomas Rast30984ed2009-02-19 22:26:33 +01001033 A true boolean value is the same as `shallow`, and a false
1034 value disables threading.
1035
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001036format.signoff::
1037 A boolean value which lets you enable the `-s/--signoff` option of
1038 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1039 patch should be a conscious act and means that you certify you have
1040 the rights to submit this work under the same open source license.
1041 Please see the 'SubmittingPatches' document for further discussion.
1042
Ramkumar Ramachandra26488f52011-04-07 00:16:48 +05301043filter.<driver>.clean::
1044 The command which is used to convert the content of a worktree
1045 file to a blob upon checkin. See linkgit:gitattributes[5] for
1046 details.
1047
1048filter.<driver>.smudge::
1049 The command which is used to convert the content of a blob
1050 object to a worktree file upon checkout. See
1051 linkgit:gitattributes[5] for details.
1052
Theodore Tso0d7566a2007-05-09 15:48:39 -04001053gc.aggressiveWindow::
1054 The window size parameter used in the delta compression
Thomas Rast0b444cd2010-01-10 00:33:00 +01001055 algorithm used by 'git gc --aggressive'. This defaults
Jay Soffianf78683f2010-04-13 12:52:55 -04001056 to 250.
Theodore Tso0d7566a2007-05-09 15:48:39 -04001057
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001058gc.auto::
1059 When there are approximately more than this many loose
1060 objects in the repository, `git gc --auto` will pack them.
1061 Some Porcelain commands use this command to perform a
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001062 light-weight garbage collection from time to time. The
1063 default value is 6700. Setting this to 0 disables it.
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001064
Junio C Hamano17815502007-09-17 00:55:13 -07001065gc.autopacklimit::
1066 When there are more than this many packs that are not
1067 marked with `*.keep` file in the repository, `git gc
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001068 --auto` consolidates them into one larger pack. The
Junio C Hamano97063972008-03-23 00:04:48 -07001069 default value is 50. Setting this to 0 disables it.
Junio C Hamano17815502007-09-17 00:55:13 -07001070
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001071gc.packrefs::
Jonathan Niederefc266e2010-01-09 20:59:41 -06001072 Running `git pack-refs` in a repository renders it
1073 unclonable by Git versions prior to 1.5.1.2 over dumb
1074 transports such as HTTP. This variable determines whether
Jiang Xin4be0c352010-12-16 15:16:49 +08001075 'git gc' runs `git pack-refs`. This can be set to `notbare`
Jonathan Niederefc266e2010-01-09 20:59:41 -06001076 to enable it within all non-bare repos or it can be set to a
1077 boolean value. The default is `true`.
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001078
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001079gc.pruneexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001080 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Nicolas Pitre8e8daf32008-12-30 14:45:11 -05001081 Override the grace period with this config variable. The value
1082 "now" may be used to disable this grace period and always prune
1083 unreachable objects immediately.
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001084
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001085gc.reflogexpire::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001086gc.<pattern>.reflogexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001087 'git reflog expire' removes reflog entries older than
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001088 this time; defaults to 90 days. With "<pattern>" (e.g.
1089 "refs/stash") in the middle the setting applies only to
1090 the refs that match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001091
1092gc.reflogexpireunreachable::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001093gc.<ref>.reflogexpireunreachable::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001094 'git reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001095 this time and are not reachable from the current tip;
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001096 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1097 in the middle, the setting applies only to the refs that
1098 match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001099
Junio C Hamano48c32422006-12-27 01:24:05 -08001100gc.rerereresolved::
1101 Records of conflicted merge you resolved earlier are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001102 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001103 The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001104
1105gc.rerereunresolved::
1106 Records of conflicted merge you have not resolved are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001107 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001108 The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001109
Fabian Emmes280514e2009-01-02 16:40:13 +01001110gitcvs.commitmsgannotation::
1111 Append this string to each commit message. Set to empty string
1112 to disable this feature. Defaults to "via git-CVS emulator".
1113
Petr Baudis1ab661d2006-04-25 00:59:33 +02001114gitcvs.enabled::
Brian Hetrodb218722007-08-23 20:40:08 -04001115 Whether the CVS server interface is enabled for this repository.
Dan McGee5162e692007-12-29 00:20:38 -06001116 See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001117
1118gitcvs.logfile::
Brian Hetrodb218722007-08-23 20:40:08 -04001119 Path to a log file where the CVS server interface well... logs
Dan McGee5162e692007-12-29 00:20:38 -06001120 various stuff. See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001121
Teemu Likonen1707adb2008-08-29 10:29:42 +03001122gitcvs.usecrlfattr::
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001123 If true, the server will look up the end-of-line conversion
1124 attributes for files to determine the '-k' modes to use. If
1125 the attributes force git to treat a file as text,
Ville Skyttä6b677a22010-07-20 00:17:17 +03001126 the '-k' mode will be left blank so CVS clients will
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001127 treat it as text. If they suppress text conversion, the file
Mike Ralphson1168d402008-08-05 17:12:05 +01001128 will be set with '-kb' mode, which suppresses any newline munging
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001129 the client might otherwise do. If the attributes do not allow
1130 the file type to be determined, then 'gitcvs.allbinary' is
1131 used. See linkgit:gitattributes[5].
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001132
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001133gitcvs.allbinary::
Matthew Ogilvie90948a42008-05-14 22:35:48 -06001134 This is used if 'gitcvs.usecrlfattr' does not resolve
1135 the correct '-kb' mode to use. If true, all
1136 unresolved files are sent to the client in
1137 mode '-kb'. This causes the client to treat them
1138 as binary files, which suppresses any newline munging it
1139 otherwise might do. Alternatively, if it is set to "guess",
1140 then the contents of the file are examined to decide if
1141 it is binary, similar to 'core.autocrlf'.
Junio C Hamanoabbf5942007-04-17 22:17:46 -07001142
Frank Lichtenheld04752862007-04-13 18:13:42 +02001143gitcvs.dbname::
1144 Database used by git-cvsserver to cache revision information
1145 derived from the git repository. The exact meaning depends on the
1146 used database driver, for SQLite (which is the default driver) this
1147 is a filename. Supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001148 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001149 Default: '%Ggitcvs.%m.sqlite'
1150
1151gitcvs.dbdriver::
1152 Used Perl DBI driver. You can specify any available driver
1153 for this here, but it might not work. git-cvsserver is tested
1154 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1155 reported *not* to work with 'DBD::mysql'. Experimental feature.
1156 May not contain double colons (`:`). Default: 'SQLite'.
Dan McGee5162e692007-12-29 00:20:38 -06001157 See linkgit:git-cvsserver[1].
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001158
Frank Lichtenheld04752862007-04-13 18:13:42 +02001159gitcvs.dbuser, gitcvs.dbpass::
1160 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1161 since SQLite has no concept of database users and/or passwords.
1162 'gitcvs.dbuser' supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001163 linkgit:git-cvsserver[1] for details).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001164
Josh Elsasser6aeeffd2008-03-27 14:02:14 -07001165gitcvs.dbTableNamePrefix::
1166 Database table name prefix. Prepended to the names of any
1167 database tables used, allowing a single database to be used
1168 for several repositories. Supports variable substitution (see
1169 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1170 characters will be replaced with underscores.
1171
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001172All gitcvs variables except for 'gitcvs.usecrlfattr' and
1173'gitcvs.allbinary' can also be specified as
1174'gitcvs.<access_method>.<varname>' (where 'access_method'
Brian Hetro02783072007-08-23 20:44:13 -04001175is one of "ext" and "pserver") to make them apply only for the given
1176access method.
Frank Lichtenheld04752862007-04-13 18:13:42 +02001177
Jakub Narebskicd823232011-10-16 13:07:34 +02001178gitweb.category::
1179gitweb.description::
1180gitweb.owner::
1181gitweb.url::
1182 See linkgit:gitweb[1] for description.
1183
1184gitweb.avatar::
1185gitweb.blame::
1186gitweb.grep::
1187gitweb.highlight::
1188gitweb.patches::
1189gitweb.pickaxe::
1190gitweb.remote_heads::
1191gitweb.showsizes::
1192gitweb.snapshot::
1193 See linkgit:gitweb.conf[5] for description.
1194
Joe Rattermanb22520a2011-03-30 14:31:05 -05001195grep.lineNumber::
1196 If set to true, enable '-n' option by default.
1197
1198grep.extendedRegexp::
1199 If set to true, enable '--extended-regexp' option by default.
1200
Junio C Hamano0c5e70f2011-11-29 12:29:48 -08001201gpg.program::
1202 Use this custom program instead of "gpg" found on $PATH when
1203 making or verifying a PGP signature. The program must support the
1204 same command line interface as GPG, namely, to verify a detached
1205 signature, "gpg --verify $file - <$signature" is run, and the
1206 program is expected to signal a good signature by exiting with
1207 code 0, and to generate an ascii-armored detached signature, the
1208 standard input of "gpg -bsau $key" is fed with the contents to be
1209 signed, and the program is expected to send the result to its
1210 standard output.
1211
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001212gui.commitmsgwidth::
1213 Defines how wide the commit message window is in the
1214 linkgit:git-gui[1]. "75" is the default.
1215
1216gui.diffcontext::
1217 Specifies how many context lines should be used in calls to diff
1218 made by the linkgit:git-gui[1]. The default is "5".
1219
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001220gui.encoding::
1221 Specifies the default encoding to use for displaying of
1222 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1223 It can be overridden by setting the 'encoding' attribute
1224 for relevant files (see linkgit:gitattributes[5]).
1225 If this option is not set, the tools default to the
1226 locale encoding.
1227
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001228gui.matchtrackingbranch::
1229 Determines if new branches created with linkgit:git-gui[1] should
1230 default to tracking remote branches with matching names or
1231 not. Default: "false".
1232
1233gui.newbranchtemplate::
1234 Is used as suggested name when creating new branches using the
1235 linkgit:git-gui[1].
1236
1237gui.pruneduringfetch::
Matthieu Moy8b3f3f82010-11-02 16:31:23 +01001238 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001239 performing a fetch. The default value is "false".
1240
1241gui.trustmtime::
1242 Determines if linkgit:git-gui[1] should trust the file modification
1243 timestamp or not. By default the timestamps are not trusted.
1244
1245gui.spellingdictionary::
1246 Specifies the dictionary used for spell checking commit messages in
1247 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1248 off.
1249
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001250gui.fastcopyblame::
Thomas Rastca768282010-01-07 17:49:12 +01001251 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001252 location detection. It makes blame significantly faster on huge
1253 repositories at the expense of less thorough copy detection.
1254
1255gui.copyblamethreshold::
Ralf Wildenhues76bac892008-11-27 08:32:01 +01001256 Specifies the threshold to use in 'git gui blame' original location
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001257 detection, measured in alphanumeric characters. See the
1258 linkgit:git-blame[1] manual for more information on copy detection.
1259
1260gui.blamehistoryctx::
1261 Specifies the radius of history context in days to show in
1262 linkgit:gitk[1] for the selected commit, when the `Show History
1263 Context` menu item is invoked from 'git gui blame'. If this
1264 variable is set to zero, the whole history is shown.
1265
Alexander Gavrilov390c3482008-12-14 22:44:32 +03001266guitool.<name>.cmd::
1267 Specifies the shell command line to execute when the corresponding item
1268 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1269 mandatory for every tool. The command is executed from the root of
1270 the working directory, and in the environment it receives the name of
1271 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1272 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1273 the head is detached, 'CUR_BRANCH' is empty).
1274
1275guitool.<name>.needsfile::
1276 Run the tool only if a diff is selected in the GUI. It guarantees
1277 that 'FILENAME' is not empty.
1278
1279guitool.<name>.noconsole::
1280 Run the command silently, without creating a window to display its
1281 output.
1282
1283guitool.<name>.norescan::
1284 Don't rescan the working directory for changes after the tool
1285 finishes execution.
1286
1287guitool.<name>.confirm::
1288 Show a confirmation dialog before actually running the tool.
1289
1290guitool.<name>.argprompt::
1291 Request a string argument from the user, and pass it to the tool
1292 through the 'ARGS' environment variable. Since requesting an
1293 argument implies confirmation, the 'confirm' option has no effect
1294 if this is enabled. If the option is set to 'true', 'yes', or '1',
1295 the dialog uses a built-in generic prompt; otherwise the exact
1296 value of the variable is used.
1297
1298guitool.<name>.revprompt::
1299 Request a single valid revision from the user, and set the
1300 'REVISION' environment variable. In other aspects this option
1301 is similar to 'argprompt', and can be used together with it.
1302
1303guitool.<name>.revunmerged::
1304 Show only unmerged branches in the 'revprompt' subdialog.
1305 This is useful for tools similar to merge or rebase, but not
1306 for things like checkout or reset.
1307
1308guitool.<name>.title::
1309 Specifies the title to use for the prompt dialog. The default
1310 is the tool name.
1311
1312guitool.<name>.prompt::
1313 Specifies the general prompt string to display at the top of
1314 the dialog, before subsections for 'argprompt' and 'revprompt'.
1315 The default value includes the actual command.
1316
Christian Couder983a9ee2008-01-08 04:55:14 +01001317help.browser::
1318 Specify the browser that will be used to display help in the
1319 'web' format. See linkgit:git-help[1].
1320
1321help.format::
1322 Override the default help format used by linkgit:git-help[1].
1323 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1324 the default. 'web' and 'html' are the same.
1325
Alex Riesenf0e90712008-08-31 15:54:58 +02001326help.autocorrect::
1327 Automatically correct and execute mistyped commands after
1328 waiting for the given number of deciseconds (0.1 sec). If more
1329 than one command can be deduced from the entered text, nothing
1330 will be executed. If the value of this option is negative,
1331 the corrected command will be executed immediately. If the
1332 value is 0 - the command will be just shown but not executed.
1333 This is the default.
1334
Sam Vilain9c5665a2007-11-23 13:07:00 +13001335http.proxy::
Clemens Buchacherb2c8c6d2012-03-04 17:50:43 +01001336 Override the HTTP proxy, normally configured using the 'http_proxy',
1337 'https_proxy', and 'all_proxy' environment variables (see
1338 `curl(1)`). This can be overridden on a per-remote basis; see
1339 remote.<name>.proxy
Sam Vilain9c5665a2007-11-23 13:07:00 +13001340
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001341http.cookiefile::
1342 File containing previously stored cookie lines which should be used
1343 in the git http session, if they match the server. The file format
1344 of the file to read cookies from should be plain HTTP headers or
1345 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1346 NOTE that the file specified with http.cookiefile is only used as
1347 input. No cookies will be stored in the file.
1348
Petr Baudis1ab661d2006-04-25 00:59:33 +02001349http.sslVerify::
1350 Whether to verify the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001351 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001352 variable.
1353
1354http.sslCert::
1355 File containing the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001356 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001357 variable.
1358
1359http.sslKey::
1360 File containing the SSL private key when fetching or pushing
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001361 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001362 variable.
1363
Mark Lodato754ae192009-05-27 23:16:03 -04001364http.sslCertPasswordProtected::
1365 Enable git's password prompt for the SSL certificate. Otherwise
1366 OpenSSL will prompt the user, possibly many times, if the
1367 certificate or private key is encrypted. Can be overridden by the
1368 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1369
Petr Baudis1ab661d2006-04-25 00:59:33 +02001370http.sslCAInfo::
1371 File containing the certificates to verify the peer with when
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001372 fetching or pushing over HTTPS. Can be overridden by the
Petr Baudis1ab661d2006-04-25 00:59:33 +02001373 'GIT_SSL_CAINFO' environment variable.
1374
1375http.sslCAPath::
1376 Path containing files with the CA certificates to verify the peer
Francis Daly37425062006-06-07 13:56:45 +01001377 with when fetching or pushing over HTTPS. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001378 by the 'GIT_SSL_CAPATH' environment variable.
1379
1380http.maxRequests::
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001381 How many HTTP requests to launch in parallel. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001382 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1383
Tay Ray Chuanad75ebe2009-11-27 23:42:26 +08001384http.minSessions::
1385 The number of curl sessions (counted across slots) to be kept across
1386 requests. They will not be ended with curl_easy_cleanup() until
1387 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1388 value will be capped at 1. Defaults to 1.
1389
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -07001390http.postBuffer::
1391 Maximum size in bytes of the buffer used by smart HTTP
1392 transports when POSTing data to the remote system.
1393 For requests larger than this buffer size, HTTP/1.1 and
1394 Transfer-Encoding: chunked is used to avoid creating a
1395 massive pack file locally. Default is 1 MiB, which is
1396 sufficient for most requests.
1397
Petr Baudis1ab661d2006-04-25 00:59:33 +02001398http.lowSpeedLimit, http.lowSpeedTime::
1399 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1400 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001401 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Petr Baudis1ab661d2006-04-25 00:59:33 +02001402 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1403
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001404http.noEPSV::
1405 A boolean which disables using of EPSV ftp command by curl.
Frank Lichtenheldbefc9c42007-04-13 18:02:33 +02001406 This can helpful with some "poor" ftp servers which don't
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001407 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1408 environment variable. Default is false (curl will use EPSV).
1409
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001410http.useragent::
1411 The HTTP USER_AGENT string presented to an HTTP server. The default
1412 value represents the version of the client git such as git/1.7.1.
1413 This option allows you to override this value to a more common value
1414 such as Mozilla/4.0. This may be necessary, for instance, if
1415 connecting through a firewall that restricts HTTP connections to a set
1416 of common USER_AGENT strings (but not including those like git/1.7.1).
1417 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1418
Petr Baudis1ab661d2006-04-25 00:59:33 +02001419i18n.commitEncoding::
1420 Character encoding the commit messages are stored in; git itself
1421 does not care per se, but this information is necessary e.g. when
1422 importing commits from emails or in the gitk graphical history
1423 browser (and possibly at other places in the future or in other
Dan McGee5162e692007-12-29 00:20:38 -06001424 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Petr Baudis1ab661d2006-04-25 00:59:33 +02001425
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001426i18n.logOutputEncoding::
1427 Character encoding the commit messages are converted to when
Thomas Rast0b444cd2010-01-10 00:33:00 +01001428 running 'git log' and friends.
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001429
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001430imap::
1431 The configuration variables in the 'imap' section are described
1432 in linkgit:git-imap-send[1].
1433
Steven Draked8a84882010-02-17 12:44:46 +13001434init.templatedir::
1435 Specify the directory from which templates will be copied.
1436 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1437
Christian Couder983a9ee2008-01-08 04:55:14 +01001438instaweb.browser::
1439 Specify the program that will be used to browse your working
1440 repository in gitweb. See linkgit:git-instaweb[1].
1441
1442instaweb.httpd::
1443 The HTTP daemon command-line to start gitweb on your working
1444 repository. See linkgit:git-instaweb[1].
1445
1446instaweb.local::
1447 If true the web server started by linkgit:git-instaweb[1] will
1448 be bound to the local IP (127.0.0.1).
1449
1450instaweb.modulepath::
Ville Skyttä6b677a22010-07-20 00:17:17 +03001451 The default module path for linkgit:git-instaweb[1] to use
1452 instead of /usr/lib/apache2/modules. Only used if httpd
1453 is Apache.
Christian Couder983a9ee2008-01-08 04:55:14 +01001454
1455instaweb.port::
1456 The port number to bind the gitweb httpd to. See
1457 linkgit:git-instaweb[1].
1458
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001459interactive.singlekey::
Ori Avtalion57f6ec02009-08-07 17:24:21 +03001460 In interactive commands, allow the user to provide one-letter
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001461 input with a single key (i.e., without hitting enter).
Jeff King6cf378f2012-04-26 04:51:57 -04001462 Currently this is used by the `--patch` mode of
Conrad Irwine6b57a82011-05-07 10:59:04 -07001463 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1464 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1465 setting is silently ignored if portable keystroke input
1466 is not available.
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001467
Jay Soffian0c476952011-05-18 13:56:04 -04001468log.abbrevCommit::
1469 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Jeff King6cf378f2012-04-26 04:51:57 -04001470 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1471 override this option with `--no-abbrev-commit`.
Jay Soffian0c476952011-05-18 13:56:04 -04001472
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001473log.date::
Jonathan Niedere8607952010-08-20 05:20:36 -05001474 Set the default date-time mode for the 'log' command.
1475 Setting a value for log.date is similar to using 'git log''s
Jeff King6cf378f2012-04-26 04:51:57 -04001476 `--date` option. Possible values are `relative`, `local`,
Jonathan Niedere8607952010-08-20 05:20:36 -05001477 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1478 for details.
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001479
Steven Drakeeb734452010-02-17 12:39:52 +13001480log.decorate::
1481 Print out the ref names of any commits that are shown by the log
1482 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1483 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1484 specified, the full ref name (including prefix) will be printed.
1485 This is the same as the log commands '--decorate' option.
1486
Peter Baumann0f03ca92006-11-23 10:36:33 +01001487log.showroot::
1488 If true, the initial commit will be shown as a big creation event.
1489 This is equivalent to a diff against an empty tree.
Dan McGee5162e692007-12-29 00:20:38 -06001490 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Peter Baumann0f03ca92006-11-23 10:36:33 +01001491 normally hide the root commit will now show it. True by default.
1492
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001493mailmap.file::
1494 The location of an augmenting mailmap file. The default
1495 mailmap, located in the root of the repository, is loaded
1496 first, then the mailmap file pointed to by this variable.
1497 The location of the mailmap file may be in a repository
1498 subdirectory, or somewhere outside of the repository itself.
1499 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1500
Christian Couderb5578f32008-03-07 08:46:55 +01001501man.viewer::
Christian Couderb8322ea2008-03-13 06:48:46 +01001502 Specify the programs that may be used to display help in the
Christian Couderb5578f32008-03-07 08:46:55 +01001503 'man' format. See linkgit:git-help[1].
1504
Christian Couder0bb64002008-04-25 08:25:35 +02001505man.<tool>.cmd::
1506 Specify the command to invoke the specified man viewer. The
1507 specified command is evaluated in shell with the man page
1508 passed as argument. (See linkgit:git-help[1].)
1509
Christian Couder7e8114c2008-04-25 08:24:41 +02001510man.<tool>.path::
1511 Override the path for the given tool that may be used to
1512 display help in the 'man' format. See linkgit:git-help[1].
1513
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001514include::merge-config.txt[]
Junio C Hamanob5412482008-08-29 10:49:56 -07001515
Johannes Schindelin77680ca2007-12-17 12:21:22 +00001516mergetool.<tool>.path::
1517 Override the path for the given tool. This is useful in case
1518 your tool is not in the PATH.
1519
Charles Bailey964473a2008-02-21 23:31:12 +00001520mergetool.<tool>.cmd::
1521 Specify the command to invoke the specified merge tool. The
1522 specified command is evaluated in shell with the following
1523 variables available: 'BASE' is the name of a temporary file
1524 containing the common base of the files to be merged, if available;
1525 'LOCAL' is the name of a temporary file containing the contents of
1526 the file on the current branch; 'REMOTE' is the name of a temporary
1527 file containing the contents of the file from the branch being
1528 merged; 'MERGED' contains the name of the file to which the merge
1529 tool should write the results of a successful merge.
1530
1531mergetool.<tool>.trustExitCode::
1532 For a custom merge command, specify whether the exit code of
1533 the merge command can be used to determine whether the merge was
1534 successful. If this is not set to true then the merge target file
1535 timestamp is checked and the merge assumed to have been successful
1536 if the file has been updated, otherwise the user is prompted to
1537 indicate the success of the merge.
1538
Charles Bailey44c36d12008-02-21 23:30:02 +00001539mergetool.keepBackup::
1540 After performing a merge, the original file with conflict markers
1541 can be saved as a file with a `.orig` extension. If this variable
1542 is set to `false` then this file is not preserved. Defaults to
1543 `true` (i.e. keep the backup files).
1544
Charles Bailey162eba82008-12-12 21:48:41 +00001545mergetool.keepTemporaries::
1546 When invoking a custom merge tool, git uses a set of temporary
1547 files to pass to the tool. If the tool returns an error and this
1548 variable is set to `true`, then these temporary files will be
1549 preserved, otherwise they will be removed after the tool has
1550 exited. Defaults to `false`.
1551
Charles Bailey682b4512008-11-13 12:41:14 +00001552mergetool.prompt::
1553 Prompt before each invocation of the merge resolution program.
1554
Thomas Rast894a9d32010-03-12 18:04:26 +01001555notes.displayRef::
1556 The (fully qualified) refname from which to show notes when
1557 showing commit messages. The value of this variable can be set
1558 to a glob, in which case notes from all matching refs will be
1559 shown. You may also specify this configuration variable
1560 several times. A warning will be issued for refs that do not
1561 exist, but a glob that does not match any refs is silently
1562 ignored.
1563+
1564This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1565environment variable, which must be a colon separated list of refs or
1566globs.
1567+
1568The effective value of "core.notesRef" (possibly overridden by
1569GIT_NOTES_REF) is also implicitly added to the list of refs to be
1570displayed.
1571
Thomas Rast6956f852010-03-12 18:04:32 +01001572notes.rewrite.<command>::
1573 When rewriting commits with <command> (currently `amend` or
1574 `rebase`) and this variable is set to `true`, git
1575 automatically copies your notes from the original to the
1576 rewritten commit. Defaults to `true`, but see
1577 "notes.rewriteRef" below.
Thomas Rast6956f852010-03-12 18:04:32 +01001578
1579notes.rewriteMode::
1580 When copying notes during a rewrite (see the
1581 "notes.rewrite.<command>" option), determines what to do if
1582 the target commit already has a note. Must be one of
1583 `overwrite`, `concatenate`, or `ignore`. Defaults to
1584 `concatenate`.
1585+
1586This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1587environment variable.
1588
1589notes.rewriteRef::
1590 When copying notes during a rewrite, specifies the (fully
1591 qualified) ref whose notes should be copied. The ref may be a
1592 glob, in which case notes in all matching refs will be copied.
1593 You may also specify this configuration several times.
1594+
1595Does not have a default value; you must configure this variable to
Thomas Rast2b4aa892011-09-13 09:32:42 +02001596enable note rewriting. Set it to `refs/notes/commits` to enable
1597rewriting for the default commit notes.
Leif Arne Storsetcfb88e92010-05-05 16:16:25 +02001598+
1599This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1600environment variable, which must be a colon separated list of refs or
1601globs.
Thomas Rast6956f852010-03-12 18:04:32 +01001602
Jeff King4812a932006-07-23 01:50:30 -04001603pack.window::
Dan McGee5162e692007-12-29 00:20:38 -06001604 The size of the window used by linkgit:git-pack-objects[1] when no
Jeff King4812a932006-07-23 01:50:30 -04001605 window size is given on the command line. Defaults to 10.
1606
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001607pack.depth::
Dan McGee5162e692007-12-29 00:20:38 -06001608 The maximum delta depth used by linkgit:git-pack-objects[1] when no
Theodore Ts'o618e6132007-05-08 09:28:26 -04001609 maximum depth is given on the command line. Defaults to 50.
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001610
Brian Downinge93b15c2007-07-12 07:55:52 -05001611pack.windowMemory::
Dan McGee5162e692007-12-29 00:20:38 -06001612 The window memory size limit used by linkgit:git-pack-objects[1]
Brian Downinge93b15c2007-07-12 07:55:52 -05001613 when no limit is given on the command line. The value can be
1614 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1615 limit.
1616
Dana How960ccca2007-05-09 13:56:50 -07001617pack.compression::
1618 An integer -1..9, indicating the compression level for objects
1619 in a pack file. -1 is the zlib default. 0 means no
1620 compression, and 1..9 are various speed/size tradeoffs, 9 being
1621 slowest. If not set, defaults to core.compression. If that is
Brian Downingdec92302007-11-19 10:58:51 -06001622 not set, defaults to -1, the zlib default, which is "a default
1623 compromise between speed and compression (currently equivalent
1624 to level 6)."
Jan Krüger89d71f72010-09-27 14:21:58 +02001625+
1626Note that changing the compression level will not automatically recompress
1627all existing objects. You can force recompression by passing the -F option
1628to linkgit:git-repack[1].
Dana How960ccca2007-05-09 13:56:50 -07001629
Martin Koegler074b2ee2007-05-28 23:20:58 +02001630pack.deltaCacheSize::
Brian Hetro02783072007-08-23 20:44:13 -04001631 The maximum memory in bytes used for caching deltas in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001632 linkgit:git-pack-objects[1] before writing them out to a pack.
1633 This cache is used to speed up the writing object phase by not
1634 having to recompute the final delta result once the best match
1635 for all objects is found. Repacking large repositories on machines
1636 which are tight with memory might be badly impacted by this though,
1637 especially if this cache pushes the system into swapping.
1638 A value of 0 means no limit. The smallest size of 1 byte may be
1639 used to virtually disable this cache. Defaults to 256 MiB.
Martin Koegler074b2ee2007-05-28 23:20:58 +02001640
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001641pack.deltaCacheLimit::
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001642 The maximum size of a delta, that is cached in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001643 linkgit:git-pack-objects[1]. This cache is used to speed up the
1644 writing object phase by not having to recompute the final delta
1645 result once the best match for all objects is found. Defaults to 1000.
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001646
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001647pack.threads::
1648 Specifies the number of threads to spawn when searching for best
Dan McGee5162e692007-12-29 00:20:38 -06001649 delta matches. This requires that linkgit:git-pack-objects[1]
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001650 be compiled with pthreads otherwise this option is ignored with a
1651 warning. This is meant to reduce packing time on multiprocessor
1652 machines. The required amount of memory for the delta search window
1653 is however multiplied by the number of threads.
Andreas Ericsson833e3df2008-02-22 20:11:56 -06001654 Specifying 0 will cause git to auto-detect the number of CPU's
1655 and set the number of threads accordingly.
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001656
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001657pack.indexVersion::
1658 Specify the default pack index version. Valid values are 1 for
1659 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1660 the new pack index with capabilities for packs larger than 4 GB
1661 as well as proper protection against the repacking of corrupted
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001662 packs. Version 2 is the default. Note that version 2 is enforced
1663 and this config option ignored whenever the corresponding pack is
1664 larger than 2 GB.
1665+
Jeff King6cf378f2012-04-26 04:51:57 -04001666If you have an old git that does not understand the version 2 `*.idx` file,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001667cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Jeff King6cf378f2012-04-26 04:51:57 -04001668that will copy both `*.pack` file and corresponding `*.idx` file from the
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001669other side may give you a repository that cannot be accessed with your
Jeff King6cf378f2012-04-26 04:51:57 -04001670older version of git. If the `*.pack` file is smaller than 2 GB, however,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001671you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Jeff King6cf378f2012-04-26 04:51:57 -04001672the `*.idx` file.
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001673
Junio C Hamanodbdbfec2008-03-12 23:11:15 -07001674pack.packSizeLimit::
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001675 The maximum size of a pack. This setting only affects
1676 packing to a file when repacking, i.e. the git:// protocol
Jeff King6cf378f2012-04-26 04:51:57 -04001677 is unaffected. It can be overridden by the `--max-pack-size`
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001678 option of linkgit:git-repack[1]. The minimum size allowed is
1679 limited to 1 MiB. The default is unlimited.
1680 Common unit suffixes of 'k', 'm', or 'g' are
1681 supported.
Johannes Schindelin2b84b5a2008-02-05 14:25:04 +00001682
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001683pager.<cmd>::
Jeff King9bad7232010-11-17 12:04:12 -05001684 If the value is boolean, turns on or off pagination of the
1685 output of a particular git subcommand when writing to a tty.
1686 Otherwise, turns on pagination for the subcommand using the
Jeff King6cf378f2012-04-26 04:51:57 -04001687 pager specified by the value of `pager.<cmd>`. If `--paginate`
1688 or `--no-pager` is specified on the command line, it takes
Jeff King9bad7232010-11-17 12:04:12 -05001689 precedence over this option. To disable pagination for all
1690 commands, set `core.pager` or `GIT_PAGER` to `cat`.
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001691
Will Palmer80281842010-05-02 12:00:44 +01001692pretty.<name>::
1693 Alias for a --pretty= format string, as specified in
1694 linkgit:git-log[1]. Any aliases defined here can be used just
1695 as the built-in pretty formats could. For example,
Jeff King6cf378f2012-04-26 04:51:57 -04001696 running `git config pretty.changelog "format:* %H %s"`
Will Palmer80281842010-05-02 12:00:44 +01001697 would cause the invocation `git log --pretty=changelog`
Jeff King6cf378f2012-04-26 04:51:57 -04001698 to be equivalent to running `git log "--pretty=format:* %H %s"`.
Will Palmer80281842010-05-02 12:00:44 +01001699 Note that an alias with the same name as a built-in format
1700 will be silently ignored.
1701
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001702pull.rebase::
1703 When true, rebase branches on top of the fetched branch, instead
1704 of merging the default branch from the default remote when "git
1705 pull" is run. See "branch.<name>.rebase" for setting this on a
1706 per-branch basis.
1707+
1708*NOTE*: this is a possibly dangerous operation; do *not* use
1709it unless you understand the implications (see linkgit:git-rebase[1]
1710for details).
1711
Petr Baudis1ab661d2006-04-25 00:59:33 +02001712pull.octopus::
1713 The default merge strategy to use when pulling multiple branches
1714 at once.
1715
1716pull.twohead::
1717 The default merge strategy to use when pulling a single branch.
1718
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001719push.default::
1720 Defines the action git push should take if no refspec is given
1721 on the command line, no refspec is configured in the remote, and
1722 no refspec is implied by any of the options given on the command
Santi Béjar01eadaf2009-03-30 12:11:41 +02001723 line. Possible values are:
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001724+
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.
Matthieu Moy185c0872012-04-24 09:50:00 +02001744 +
Matthieu Moyb55e6772012-04-24 09:50:03 +02001745 The `simple`, `current` and `upstream` modes are for those who want to
Matthieu Moy185c0872012-04-24 09:50:00 +02001746 push out a single branch after finishing work, even when the other
1747 branches are not yet ready to be pushed out. If you are working with
1748 other people to push into the same shared repository, you would want
1749 to use one of these.
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001750
Tor Arne Vestbøa9c38212009-03-01 23:11:38 +01001751rebase.stat::
1752 Whether to show a diffstat of what changed upstream since the last
1753 rebase. False by default.
1754
Heiko Voigtdd1e5b32010-07-14 13:59:57 +02001755rebase.autosquash::
1756 If set to true enable '--autosquash' option by default.
1757
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001758receive.autogc::
1759 By default, git-receive-pack will run "git-gc --auto" after
1760 receiving data from git-push and updating refs. You can stop
1761 it by setting this variable to false.
1762
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001763receive.fsckObjects::
1764 If it is set to true, git-receive-pack will check all received
1765 objects. It will abort in the case of a malformed object or a
1766 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001767 Defaults to false. If not set, the value of `transfer.fsckObjects`
1768 is used instead.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001769
1770receive.unpackLimit::
1771 If the number of objects received in a push is below this
1772 limit then the objects will be unpacked into loose object
1773 files. However if the number of received objects equals or
1774 exceeds this limit then the received pack will be stored as
1775 a pack, after adding any missing delta bases. Storing the
1776 pack from a push can make the push operation complete faster,
1777 especially on slow filesystems. If not set, the value of
1778 `transfer.unpackLimit` is used instead.
1779
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001780receive.denyDeletes::
1781 If set to true, git-receive-pack will deny a ref update that deletes
1782 the ref. Use this to prevent such a ref deletion via a push.
1783
Thomas Rast662c83f2010-07-24 18:07:53 +02001784receive.denyDeleteCurrent::
1785 If set to true, git-receive-pack will deny a ref update that
1786 deletes the currently checked out branch of a non-bare repository.
1787
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001788receive.denyCurrentBranch::
Michael J Gruberf3838ce2010-05-13 14:51:38 +02001789 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001790 to the currently checked out branch of a non-bare repository.
1791 Such a push is potentially dangerous because it brings the HEAD
1792 out of sync with the index and working tree. If set to "warn",
1793 print a warning of such a push to stderr, but allow the push to
1794 proceed. If set to false or "ignore", allow such pushes with no
Thomas Rast7d182f52010-03-17 12:14:57 +01001795 message. Defaults to "refuse".
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001796
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001797receive.denyNonFastForwards::
1798 If set to true, git-receive-pack will deny a ref update which is
Felipe Contrerasa75d7b52009-10-24 11:31:32 +03001799 not a fast-forward. Use this to prevent such an update via a push,
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001800 even if that push is forced. This configuration variable is
1801 set when initializing a shared repository.
1802
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001803receive.updateserverinfo::
1804 If set to true, git-receive-pack will run git-update-server-info
1805 after receiving data from git-push and updating refs.
1806
Santi Béjar0cc6d342006-10-23 18:42:14 +02001807remote.<name>.url::
Dan McGee5162e692007-12-29 00:20:38 -06001808 The URL of a remote repository. See linkgit:git-fetch[1] or
1809 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001810
Michael J Gruber20346232009-06-09 18:01:34 +02001811remote.<name>.pushurl::
1812 The push URL of a remote repository. See linkgit:git-push[1].
1813
Sam Vilain14c98212007-12-04 10:48:54 +13001814remote.<name>.proxy::
1815 For remotes that require curl (http, https and ftp), the URL to
1816 the proxy to use for that remote. Set to the empty string to
1817 disable proxying for that remote.
1818
Santi Béjar0cc6d342006-10-23 18:42:14 +02001819remote.<name>.fetch::
Dan McGee5162e692007-12-29 00:20:38 -06001820 The default set of "refspec" for linkgit:git-fetch[1]. See
1821 linkgit:git-fetch[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001822
1823remote.<name>.push::
Dan McGee5162e692007-12-29 00:20:38 -06001824 The default set of "refspec" for linkgit:git-push[1]. See
1825 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001826
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001827remote.<name>.mirror::
1828 If true, pushing to this remote will automatically behave
Jeff King6cf378f2012-04-26 04:51:57 -04001829 as if the `--mirror` option was given on the command line.
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001830
Theodore Ts'o19182782007-02-20 15:13:43 -05001831remote.<name>.skipDefaultUpdate::
1832 If true, this remote will be skipped by default when updating
Björn Gustavsson7cc91a22009-11-09 21:11:06 +01001833 using linkgit:git-fetch[1] or the `update` subcommand of
1834 linkgit:git-remote[1].
1835
1836remote.<name>.skipFetchAll::
1837 If true, this remote will be skipped by default when updating
1838 using linkgit:git-fetch[1] or the `update` subcommand of
1839 linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001840
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001841remote.<name>.receivepack::
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001842 The default program to execute on the remote side when pushing. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001843 option \--receive-pack of linkgit:git-push[1].
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001844
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001845remote.<name>.uploadpack::
1846 The default program to execute on the remote side when fetching. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001847 option \--upload-pack of linkgit:git-fetch-pack[1].
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001848
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301849remote.<name>.tagopt::
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001850 Setting this value to \--no-tags disables automatic tag following when
Samuel Tardieu944163a2010-04-20 01:31:25 +02001851 fetching from remote <name>. Setting it to \--tags will fetch every
1852 tag from remote <name>, even if they are not reachable from remote
Daniel Johnsoned368542010-08-11 18:57:20 -04001853 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1854 override this setting. See options \--tags and \--no-tags of
1855 linkgit:git-fetch[1].
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301856
Daniel Barkalowc578f512009-11-18 02:42:25 +01001857remote.<name>.vcs::
1858 Setting this to a value <vcs> will cause git to interact with
1859 the remote with the git-remote-<vcs> helper.
1860
Theodore Ts'o19182782007-02-20 15:13:43 -05001861remotes.<group>::
1862 The list of remotes which are fetched by "git remote update
Dan McGee5162e692007-12-29 00:20:38 -06001863 <group>". See linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001864
Junio C Hamanob6945f52006-10-13 21:28:58 -07001865repack.usedeltabaseoffset::
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04001866 By default, linkgit:git-repack[1] creates packs that use
1867 delta-base offset. If you need to share your repository with
1868 git older than version 1.4.4, either directly or via a dumb
1869 protocol such as http, then you need to set this option to
1870 "false" and repack. Access from old git versions over the
1871 native protocol are unaffected by this option.
Junio C Hamanob6945f52006-10-13 21:28:58 -07001872
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001873rerere.autoupdate::
1874 When set to true, `git-rerere` updates the index with the
1875 resulting contents after it cleanly resolves conflicts using
1876 previously recorded resolution. Defaults to false.
1877
1878rerere.enabled::
1879 Activate recording of resolved conflicts, so that identical
Thomas Rast07b88a02012-01-06 14:08:02 +01001880 conflict hunks can be resolved automatically, should they be
1881 encountered again. By default, linkgit:git-rerere[1] is
1882 enabled if there is an `rr-cache` directory under the
Junio C Hamanob6fb7fe2012-01-10 15:57:27 +01001883 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1884 repository.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001885
Yann Dirson65180c62009-07-22 23:39:30 +02001886sendemail.identity::
1887 A configuration identity. When given, causes values in the
1888 'sendemail.<identity>' subsection to take precedence over
1889 values in the 'sendemail' section. The default identity is
1890 the value of 'sendemail.identity'.
1891
1892sendemail.smtpencryption::
1893 See linkgit:git-send-email[1] for description. Note that this
1894 setting is not subject to the 'identity' mechanism.
1895
1896sendemail.smtpssl::
1897 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1898
1899sendemail.<identity>.*::
1900 Identity-specific versions of the 'sendemail.*' parameters
1901 found below, taking precedence over those when the this
1902 identity is selected, through command-line or
1903 'sendemail.identity'.
1904
1905sendemail.aliasesfile::
1906sendemail.aliasfiletype::
1907sendemail.bcc::
1908sendemail.cc::
1909sendemail.cccmd::
1910sendemail.chainreplyto::
1911sendemail.confirm::
1912sendemail.envelopesender::
1913sendemail.from::
1914sendemail.multiedit::
1915sendemail.signedoffbycc::
1916sendemail.smtppass::
1917sendemail.suppresscc::
1918sendemail.suppressfrom::
1919sendemail.to::
Brian Gernhardt69cf7bf2010-04-10 10:53:56 -04001920sendemail.smtpdomain::
Yann Dirson65180c62009-07-22 23:39:30 +02001921sendemail.smtpserver::
1922sendemail.smtpserverport::
Pascal Obry052fbea2010-09-06 20:12:11 +02001923sendemail.smtpserveroption::
Yann Dirson65180c62009-07-22 23:39:30 +02001924sendemail.smtpuser::
1925sendemail.thread::
1926sendemail.validate::
1927 See linkgit:git-send-email[1] for description.
1928
1929sendemail.signedoffcc::
1930 Deprecated alias for 'sendemail.signedoffbycc'.
1931
Petr Baudis1ab661d2006-04-25 00:59:33 +02001932showbranch.default::
Dan McGee5162e692007-12-29 00:20:38 -06001933 The default set of branches for linkgit:git-show-branch[1].
1934 See linkgit:git-show-branch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001935
Jeff King46f721c2007-12-07 16:26:07 -05001936status.relativePaths::
Dan McGee5162e692007-12-29 00:20:38 -06001937 By default, linkgit:git-status[1] shows paths relative to the
Jeff King46f721c2007-12-07 16:26:07 -05001938 current directory. Setting this variable to `false` shows paths
1939 relative to the repository root (this was the default for git
1940 prior to v1.5.4).
1941
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02001942status.showUntrackedFiles::
1943 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1944 files which are not currently tracked by Git. Directories which
1945 contain only untracked files, are shown with the directory name
1946 only. Showing untracked files means that Git needs to lstat() all
1947 all the files in the whole repository, which might be slow on some
1948 systems. So, this variable controls how the commands displays
1949 the untracked files. Possible values are:
1950+
1951--
Cliff Frey9373bdc2010-10-17 20:10:45 -07001952* `no` - Show no untracked files.
1953* `normal` - Show untracked files and directories.
1954* `all` - Show also individual files in untracked directories.
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02001955--
1956+
1957If this variable is not specified, it defaults to 'normal'.
1958This variable can be overridden with the -u|--untracked-files option
1959of linkgit:git-status[1] and linkgit:git-commit[1].
1960
Michael J Gruber4b2343f2010-05-20 17:55:42 +02001961status.submodulesummary::
1962 Defaults to false.
1963 If this is set to a non zero number or true (identical to -1 or an
1964 unlimited number), the submodule summary will be enabled and a
1965 summary of commits for modified submodules will be shown (see
1966 --summary-limit option of linkgit:git-submodule[1]).
1967
Jonathan Nieder0ad0a612010-07-15 02:51:19 -05001968submodule.<name>.path::
1969submodule.<name>.url::
1970submodule.<name>.update::
1971 The path within this project, URL, and the updating strategy
1972 for a submodule. These variables are initially populated
1973 by 'git submodule init'; edit them to override the
1974 URL and other values found in the `.gitmodules` file. See
1975 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1976
Jens Lehmannc1a3c362010-11-11 00:55:41 +01001977submodule.<name>.fetchRecurseSubmodules::
Jens Lehmannbf42b382011-03-06 23:12:19 +01001978 This option can be used to control recursive fetching of this
Ralf Wildenhues469bfc92011-01-03 20:03:34 +01001979 submodule. It can be overridden by using the --[no-]recurse-submodules
Jens Lehmannc1a3c362010-11-11 00:55:41 +01001980 command line option to "git fetch" and "git pull".
1981 This setting will override that from in the linkgit:gitmodules[5]
1982 file.
1983
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02001984submodule.<name>.ignore::
1985 Defines under what circumstances "git status" and the diff family show
1986 a submodule as modified. When set to "all", it will never be considered
1987 modified, "dirty" will ignore all changes to the submodules work tree and
1988 takes only differences between the HEAD of the submodule and the commit
1989 recorded in the superproject into account. "untracked" will additionally
1990 let submodules with modified tracked files in their work tree show up.
1991 Using "none" (the default when this option is not set) also shows
1992 submodules that have untracked files in their work tree as changed.
Jens Lehmann302ad7a2010-08-06 00:40:48 +02001993 This setting overrides any setting made in .gitmodules for this submodule,
Ralf Wildenhues3776ea92010-08-22 13:12:12 +02001994 both settings can be overridden on the command line by using the
Johannes Schindelinbe4f2b42010-08-05 10:49:55 +02001995 "--ignore-submodules" option.
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02001996
Willy Tarreauce1a79b2006-07-20 11:30:44 +02001997tar.umask::
René Scharfe687157c2007-08-21 20:01:16 +02001998 This variable can be used to restrict the permission bits of
1999 tar archive entries. The default is 0002, which turns off the
2000 world write bit. The special value "user" indicates that the
2001 archiving user's umask will be used instead. See umask(2) and
Dan McGee5162e692007-12-29 00:20:38 -06002002 linkgit:git-archive[1].
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002003
Junio C Hamanodab76d32011-09-04 12:37:45 -07002004transfer.fsckObjects::
2005 When `fetch.fsckObjects` or `receive.fsckObjects` are
2006 not set, the value of this variable is used instead.
2007 Defaults to false.
2008
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002009transfer.unpackLimit::
2010 When `fetch.unpackLimit` or `receive.unpackLimit` are
2011 not set, the value of this variable is used instead.
2012 The default value is 100.
2013
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002014url.<base>.insteadOf::
2015 Any URL that starts with this value will be rewritten to
2016 start, instead, with <base>. In cases where some site serves a
2017 large number of repositories, and serves them with multiple
2018 access methods, and some users need to use different access
2019 methods, this feature allows people to specify any of the
2020 equivalent URLs and have git automatically rewrite the URL to
2021 the best alternative for the particular user, even for a
Junio C Hamano844112c2008-02-24 22:25:04 -08002022 never-before-seen repository on the site. When more than one
2023 insteadOf strings match a given URL, the longest match is used.
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002024
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002025url.<base>.pushInsteadOf::
2026 Any URL that starts with this value will not be pushed to;
2027 instead, it will be rewritten to start with <base>, and the
2028 resulting URL will be pushed to. In cases where some site serves
2029 a large number of repositories, and serves them with multiple
2030 access methods, some of which do not allow push, this feature
2031 allows people to specify a pull-only URL and have git
2032 automatically use an appropriate URL to push, even for a
2033 never-before-seen repository on the site. When more than one
2034 pushInsteadOf strings match a given URL, the longest match is
2035 used. If a remote has an explicit pushurl, git will ignore this
2036 setting for that remote.
2037
Petr Baudis1ab661d2006-04-25 00:59:33 +02002038user.email::
2039 Your email address to be recorded in any newly created commits.
Josh Triplett28a94f82007-04-28 18:40:28 -07002040 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Dan McGee5162e692007-12-29 00:20:38 -06002041 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002042
2043user.name::
2044 Your full name to be recorded in any newly created commits.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04002045 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Dan McGee5162e692007-12-29 00:20:38 -06002046 environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002047
Andy Parkinsd67778e2007-01-26 14:13:46 +00002048user.signingkey::
Dan McGee5162e692007-12-29 00:20:38 -06002049 If linkgit:git-tag[1] is not selecting the key you want it to
Andy Parkinsd67778e2007-01-26 14:13:46 +00002050 automatically when creating a signed tag, you can override the
2051 default selection with this variable. This option is passed
2052 unchanged to gpg's --local-user parameter, so you may specify a key
2053 using any method that gpg supports.
2054
Christian Couder983a9ee2008-01-08 04:55:14 +01002055web.browser::
2056 Specify a web browser that may be used by some commands.
2057 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2058 may use it.