blob: 915cb5a547896966377e9f39059527e3142b27c8 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
Junio C Hamano81d540a2012-03-02 19:52:4715dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
Junio C Hamano07824ce2006-04-25 07:36:5418
Junio C Hamanobee172f2007-01-23 08:44:1819Syntax
20~~~~~~
21
Junio C Hamano07824ce2006-04-25 07:36:5422The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1823ignored. 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
Junio C Hamanoea82cff2009-03-18 01:54:4829characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5930must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1832
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5935in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1836
37--------
38[section "subsection"]
39
40--------
41
Junio C Hamanof4581102009-04-25 08:29:5942Subsection 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
Junio C Hamanobee172f2007-01-23 08:44:1845lines. 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
Junio C Hamano6231f822011-10-24 05:18:5249There 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.
Junio C Hamanobee172f2007-01-23 08:44:1853
Junio C Hamanoaa2cd762009-07-26 08:14:0154All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1856'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".
Junio C Hamano81d540a2012-03-02 19:52:4758The 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.
Junio C Hamanobee172f2007-01-23 08:44:1862
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,
Junio C Hamano059bca52011-03-30 22:47:46681/0, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1869converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4370'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1871
72String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5973You 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
Junio C Hamanoea82cff2009-03-18 01:54:4877be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1878
Junio C Hamanoea82cff2009-03-18 01:54:4879The 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
Junio C Hamanobee172f2007-01-23 08:44:1882char sequences are valid.
83
Junio C Hamanof4581102009-04-25 08:29:5984Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1885customary UNIX fashion.
86
Junio C Hamanof4581102009-04-25 08:29:5987Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5488
Junio C Hamanoe0238c22012-02-23 22:45:5089Includes
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
Junio C Hamano22700fb2012-05-03 23:07:2598found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:22100user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:50101
Junio C Hamano07824ce2006-04-25 07:36:54102Example
103~~~~~~~
104
105# Core variables
106[core]
107; Don't trust file modes
108filemode = false
109
110# Our diff algorithm
111[diff]
Junio C Hamano85c71572008-07-28 00:03:31112external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54113renames = true
114
Junio C Hamano52401ef2006-12-19 00:54:38115[branch "devel"]
116remote = origin
117merge = refs/heads/devel
118
Junio C Hamanobee172f2007-01-23 08:44:18119# Proxy settings
120[core]
Junio C Hamanoc71a8732007-08-04 00:27:26121gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18122gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38123
Junio C Hamanoe0238c22012-02-23 22:45:50124[include]
125path = /path/to/foo.inc ; include by absolute path
126path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22127path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50128
Junio C Hamano07824ce2006-04-25 07:36:54129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17133For command-specific variables, you will find a more detailed description
134in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54135porcelain configuration variables in the respective porcelain documentation.
136
Junio C Hamano7df6dcf2009-09-13 09:51:17137advice.*::
Junio C Hamano0df92712011-12-21 22:30:44138These variables control various optional help messages designed to
139aid new users. All 'advice.*' variables default to 'true', and you
140can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17141+
142--
143pushNonFastForward::
Junio C Hamano0c1b64e2012-04-20 23:50:49144Set this variable to 'false' if you want to disable
145'pushNonFFCurrent', 'pushNonFFDefault', and
146'pushNonFFMatching' simultaneously.
147pushNonFFCurrent::
148Advice shown when linkgit:git-push[1] fails due to a
149non-fast-forward update to the current branch.
150pushNonFFDefault::
151Advice to set 'push.default' to 'upstream' or 'current'
152when you ran linkgit:git-push[1] and pushed 'matching
153refs' by default (i.e. you did not provide an explicit
154refspec, and no 'push.default' configuration was set)
155and it resulted in a non-fast-forward error.
156pushNonFFMatching::
157Advice shown when you ran linkgit:git-push[1] and pushed
158'matching refs' explicitly (i.e. you used ':', or
159specified a refspec that isn't your current branch) and
160it resulted in a non-fast-forward error.
Junio C Hamano7df6dcf2009-09-13 09:51:17161statusHints::
162Directions on how to stage/unstage/add shown in the
163output of linkgit:git-status[1] and the template shown
Junio C Hamano0df92712011-12-21 22:30:44164when writing commit messages.
Junio C Hamano5706e0b2009-11-24 10:54:16165commitBeforeMerge::
166Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35167merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16168resolveConflict::
169Advices shown by various commands when conflicts
170prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16171implicitIdentity::
172Advice on how to set your identity configuration when
173your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44174domain name.
Junio C Hamano74a198f2010-02-22 00:13:31175detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44176Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31177move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44178a local branch after the fact.
Junio C Hamano7df6dcf2009-09-13 09:51:17179--
180
Junio C Hamano07824ce2006-04-25 07:36:54181core.fileMode::
182If false, the executable bit differences between the index and
Junio C Hamano8fb66e52011-10-05 20:59:51183the working tree are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27184See 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.
Junio C Hamano07824ce2006-04-25 07:36:54189
Junio C Hamanoa476efa2008-10-10 15:31:42190core.ignoreCygwinFSTricks::
191This option is only used by Cygwin implementation of Git. If false,
192the Cygwin stat() and lstat() functions are used. This may be useful
193if your repository consists of a few separate directories joined in
194one hierarchy using Cygwin mount. If true, Git uses native Win32 API
195whenever it is possible and falls back to Cygwin functions only to
196handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33197normal Cygwin l/stat() functions. True by default, unless core.filemode
198is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
199POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42200
Junio C Hamano9df0c662009-11-23 11:09:27201core.ignorecase::
202If true, this option enables various workarounds to enable
203git to work better on filesystems that are not case sensitive,
204like FAT. For example, if a directory listing finds
205"makefile" when git expects "Makefile", git will assume
206it 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
Junio C Hamano90ccff32008-07-29 08:17:24213core.trustctime::
214If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51215working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24216is regularly modified by something outside Git (file system
217crawlers and some backup systems).
218See linkgit:git-update-index[1]. True by default.
219
Junio C Hamanod526ba92007-07-02 00:17:42220core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31221The commands that output paths (e.g. 'ls-files',
222'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42223"unusual" characters in the pathname by enclosing the
224pathname in a double-quote pair and with backslashes the
225same way strings in C source code are quoted. If this
226variable is set to false, the bytes higher than 0x80 are
227not quoted but output as verbatim. Note that double
228quote, backslash and control characters are always
229quoted without `-z` regardless of the setting of this
230variable.
231
Junio C Hamanobb88cf42010-06-21 15:23:55232core.eol::
233Sets the line ending type to use in the working directory for
234files that have the `text` property set. Alternatives are
235'lf', 'crlf' and 'native', which uses the platform's native
236line ending. The default value is `native`. See
237linkgit:gitattributes[5] for more information on end-of-line
238conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04239
Junio C Hamano26e590a2008-02-17 03:53:51240core.safecrlf::
Junio C Hamanobb88cf42010-06-21 15:23:55241If true, makes git check if converting `CRLF` is reversible when
242end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51243modifies a file in the work tree either directly or indirectly.
244For example, committing a file followed by checking out the
245same file should yield the original file in the work tree. If
246this is not the case for the current setting of
247`core.autocrlf`, git will reject the file. The variable can
248be set to "warn", in which case git will only warn about an
249irreversible conversion but continue the operation.
250+
251CRLF conversion bears a slight chance of corrupting data.
Junio C Hamanobb88cf42010-06-21 15:23:55252When it is enabled, git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51253CRLF 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
Junio C Hamanobb88cf42010-06-21 15:23:55276`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
Junio C Hamano26e590a2008-02-17 03:53:51279resulting 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
Junio C Hamanobb88cf42010-06-21 15:23:55285core.autocrlf::
286Setting this variable to "true" is almost the same as setting
287the `text` attribute to "auto" on all files except that text
288files are not guaranteed to be normalized: files that contain
289`CRLF` in the repository will not be touched. Use this
290setting if you want to have `CRLF` line endings in your
291working directory even though the repository does not have
292normalized line endings. This variable can be set to 'input',
293in which case no output conversion is performed.
294
Junio C Hamanoaa83a7d2007-03-05 02:37:29295core.symlinks::
296If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46297contain the link text. linkgit:git-update-index[1] and
298linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29299file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27300symbolic 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.
Junio C Hamanoaa83a7d2007-03-05 02:37:29305
Junio C Hamano07824ce2006-04-25 07:36:54306core.gitProxy::
307A "proxy command" to execute (as 'command host port') instead
308of establishing direct connection to the remote server when
309using the git protocol for fetching. If the variable value is
310in the "COMMAND for DOMAIN" format, the command is applied only
311on hostnames ending with the specified domain string. This variable
312may be set multiple times and is matched in the given order;
313the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17314+
315Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
316(which always applies universally, without the special "for"
317handling).
Junio C Hamanoea82cff2009-03-18 01:54:48318+
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.
Junio C Hamano07824ce2006-04-25 07:36:54323
324core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34325If true, commands which modify both the working tree and the index
326will mark the updated paths with the "assume unchanged" bit in the
327index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51328working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34329detect the file changes by lstat() calls. This is useful on systems
330where those are very slow, such as Microsoft Windows.
331See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54332False by default.
333
Junio C Hamano88a3a072006-05-04 08:01:43334core.preferSymlinkRefs::
335Instead of the default "symref" format for HEAD
336and other symbolic reference files, use symbolic links.
337This is sometimes needed to work with old scripts that
338expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54339
Junio C Hamano1025e752007-02-23 07:21:26340core.bare::
341If true this repository is assumed to be 'bare' and has no
342working directory associated with it. If this is the case a
343number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46344disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26345+
Junio C Hamano35738e82008-01-07 07:55:46346This setting is automatically guessed by linkgit:git-clone[1] or
347linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26348repository 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
Junio C Hamanod526ba92007-07-02 00:17:42352core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52353Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31354This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52355variable and the '--work-tree' command line option.
Junio C Hamano5cd15182011-04-05 00:21:10356The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52357the .git directory, which is either specified by --git-dir
358or GIT_DIR, or automatically discovered.
359If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27360--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52361the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52362of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52363+
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).
Junio C Hamanod526ba92007-07-02 00:17:42373
Junio C Hamano341071d2006-06-04 07:24:48374core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49375Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48376"$GIT_DIR/logs/<ref>", by appending the new and old
377SHA1, the date/time and the reason of the update, but
378only when the file exists. If this configuration
379variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59380file is automatically created for branch heads (i.e. under
381refs/heads/), remote refs (i.e. under refs/remotes/),
382note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35383+
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.
Junio C Hamano341071d2006-06-04 07:24:48390
Junio C Hamano07824ce2006-04-25 07:36:54391core.repositoryFormatVersion::
392Internal variable identifying the repository format and layout
393version.
394
395core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42396When 'group' (or 'true'), the repository is made shareable between
397several users in a group (making sure all the files and objects are
398group-writable). When 'all' (or 'world' or 'everybody'), the
399repository will be readable by all users, additionally to being
400group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37401reported by umask(2). When '0xxx', where '0xxx' is an octal number,
402files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00403user's umask value (whereas the other options will only override
404requested parts of the user's umask value). Examples: '0660' will make
405the repo read/write-able for the owner and group, but inaccessible to
406others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37407repository that is group-readable but not group-writable.
408See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54409
410core.warnAmbiguousRefs::
411If true, git will warn you if the ref name you passed it is ambiguous
412and might match multiple refs in the .git/refs/ tree. True by default.
413
Junio C Hamano7ec15722006-07-07 02:03:59414core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09415An integer -1..9, indicating a default compression level.
416-1 is the zlib default. 0 means no compression,
417and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42418If set, this provides a default to other compression variables,
419such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26420
Junio C Hamanof2ce2972007-05-20 19:12:09421core.loosecompression::
422An integer -1..9, indicating the compression level for objects that
423are not in a pack file. -1 is the zlib default. 0 means no
424compression, and 1..9 are various speed/size tradeoffs, 9 being
425slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42426not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49427
Junio C Hamanofc4d38c2007-01-08 06:53:32428core.packedGitWindowSize::
429Number of bytes of a pack file to map into memory in a
430single mapping operation. Larger window sizes may allow
431your system to process a smaller number of large pack files
432more quickly. Smaller window sizes will negatively affect
433performance due to increased calls to the operating system's
434memory manager, but may improve performance when accessing
435a 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.
441+
442Common unit suffixes of 'k', 'm', or 'g' are supported.
443
444core.packedGitLimit::
445Maximum number of bytes to map simultaneously into memory
446from pack files. If Git needs to access more than this many
447bytes at once to complete an operation it will unmap existing
448regions to reclaim virtual address space within the process.
449+
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.
453+
454Common unit suffixes of 'k', 'm', or 'g' are supported.
455
Junio C Hamanob8c51282007-03-19 10:43:30456core.deltaBaseCacheLimit::
457Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35458that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30459entire decompressed base objects in a cache Git is able
460to avoid unpacking and decompressing frequently used base
461objects 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
Junio C Hamano5c246f22010-02-03 07:34:53469core.bigFileThreshold::
470Files larger than this size are stored deflated, without
471attempting delta compression. Storing large files without
472delta compression avoids excessive memory usage, at the
473slight 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.
Junio C Hamano5c246f22010-02-03 07:34:53480
Junio C Hamano1d90cb02007-07-03 07:05:31481core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37482In addition to '.gitignore' (per-directory) and
483'.git/info/exclude', git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46484of files which are not meant to be tracked. "`~/`" is expanded
485to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamanobf984de2009-11-23 06:11:19486home directory. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37487
Junio C Hamano3fd7b262010-09-08 22:44:20488core.askpass::
489Some commands (e.g. svn and http interfaces) that interactively
490ask for a password can be told to use an external program given
491via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
492environment variable. If not set, fall back to the value of the
493'SSH_ASKPASS' environment variable or, failing that, a simple password
494prompt. The external program shall be given a suitable prompt as
495command line argument and write the password on its STDOUT.
496
Junio C Hamano3b4609d2010-09-30 00:04:34497core.attributesfile::
498In addition to '.gitattributes' (per-directory) and
499'.git/info/attributes', git looks into this file for attributes
500(see linkgit:gitattributes[5]). Path expansions are made the same
501way as for `core.excludesfile`.
502
Junio C Hamanof6002a92007-07-20 10:28:22503core.editor::
504Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27505messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22506variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37507`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22508
Junio C Hamano6231f822011-10-24 05:18:52509sequence.editor::
510Text editor used by `git rebase -i` for editing the rebase insn file.
511The value is meant to be interpreted by the shell when it is used.
512It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
513When not configured the default commit message editor is used instead.
514
Junio C Hamano28d8ede2007-07-05 05:51:38515core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33516The command that git will use to paginate output. Can
517be overridden with the `GIT_PAGER` environment
518variable. Note that git sets the `LESS` environment
519variable to `FRSX` if it is unset when it runs the
520pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42521`LESS` variable to some other value. Alternately,
522these settings can be overridden on a project or
523global basis by setting the `core.pager` option.
524Setting `core.pager` has no affect on the `LESS`
525environment variable behaviour above, so if you want
526to override git's default settings this way, you need
527to be explicit. For example, to disable the S option
528in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48529to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42530shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48531`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38532
Junio C Hamano942b35e2007-12-09 10:19:33533core.whitespace::
534A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43535notice. 'git diff' will use `color.diff.whitespace` to
536highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59537consider them as errors. You can prefix `-` to disable
538any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33539+
Junio C Hamanob71a22d2009-10-17 08:23:47540* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33541 as an error (enabled by default).
542* `space-before-tab` treats a space character that appears immediately
543 before a tab character in the initial indent part of the line as an
544 error (enabled by default).
545* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42546 space characters as an error (not enabled by default).
Junio C Hamanocb39aea2010-05-09 07:24:48547* `tab-in-indent` treats a tab character in the initial indent part of
548 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47549* `blank-at-eof` treats blank lines added at the end of file as an error
550 (enabled by default).
551* `trailing-space` is a short-hand to cover both `blank-at-eol` and
552 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42553* `cr-at-eol` treats a carriage-return at the end of line as
554 part of the line terminator, i.e. with it, `trailing-space`
555 does not trigger if the character before such a carriage-return
556 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58557* `tabwidth=<n>` tells how many character positions a tab occupies; this
558 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
559 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33560
Junio C Hamano9eb57532008-06-26 06:33:46561core.fsyncobjectfiles::
562This boolean will enable 'fsync()' when writing object files.
563+
564This is a total waste of time and effort on a filesystem that orders
565data writes properly, but can be useful for filesystems that do not use
566journalling (traditional UNIX filesystems) or that only journal metadata
567and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
568
Junio C Hamano610d1762008-11-28 06:27:13569core.preloadindex::
570Enable parallel index preload for operations like 'git diff'
571+
572This can speed up operations like 'git diff' and 'git status' especially
573on filesystems like NFS that have weak caching semantics and thus
574relatively high IO latencies. With this set to 'true', git will do the
575index comparison to the filesystem data in parallel, allowing
576overlapping IO's.
577
Junio C Hamanoa9499de2009-04-30 03:38:48578core.createObject::
579You can set this to 'link', in which case a hardlink followed by
580a delete of the source are used to make sure that object creation
581will not overwrite existing objects.
582+
583On some file system/operating system combinations, this is unreliable.
584Set this config setting to 'rename' there; However, This will remove the
585check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41586
Junio C Hamano3b70d3c2009-11-21 17:37:37587core.notesRef::
588When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10589the given ref. The ref must be fully qualified. If the given
590ref does not exist, it is not an error but means that no
591notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37592+
Junio C Hamanoa574a092010-06-13 19:57:10593This setting defaults to "refs/notes/commits", and it can be overridden by
594the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37595
Junio C Hamano3c8d6702010-01-13 23:09:03596core.sparseCheckout::
597Enable "sparse checkout" feature. See section "Sparse checkout" in
598linkgit:git-read-tree[1] for more information.
599
Junio C Hamano6371b0e2011-03-23 23:36:21600core.abbrev::
601Set the length object names are abbreviated to. If unspecified,
602many commands abbreviate to 7 hexdigits, which may not be enough
603for abbreviated object names to stay unique for sufficiently long
604time.
605
Junio C Hamano3d141512009-06-01 01:22:40606add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26607add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43608Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40609added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano60186642010-12-02 14:18:26610option of linkgit:git-add[1]. Older versions of git accept only
611`add.ignore-errors`, which does not follow the usual naming
612convention for configuration variables. Newer versions of git
613honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40614
Junio C Hamano33db4372006-06-07 19:51:45615alias.*::
Junio C Hamano35738e82008-01-07 07:55:46616Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45617after defining "alias.last = cat-file commit HEAD", the invocation
618"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17619confusion and troubles with script usage, aliases that
620hide existing git commands are ignored. Arguments are split by
621spaces, the usual shell quoting and escaping is supported.
622quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39623+
624If the alias expansion is prefixed with an exclamation point,
625it will be treated as a shell command. For example, defining
626"alias.new = !gitk --all --not ORIG_HEAD", the invocation
627"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19628"gitk --all --not ORIG_HEAD". Note that shell commands will be
629executed from the top-level directory of a repository, which may
630not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48631'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
632from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05633
Junio C Hamanocaa712a2010-03-11 01:17:35634am.keepcr::
635If true, git-am will call git-mailsplit for patches in mbox format
636with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35637not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35638by giving '--no-keep-cr' from the command line.
639See linkgit:git-am[1], linkgit:git-mailsplit[1].
640
Junio C Hamanofe24db02009-08-22 05:10:47641apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43642When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47643whitespace, in the same way as the '--ignore-space-change'
644option.
Junio C Hamano1aa40d22010-01-21 17:46:43645When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47646respect all whitespace differences.
647See linkgit:git-apply[1].
648
Junio C Hamano07824ce2006-04-25 07:36:54649apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43650Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46651as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54652
Junio C Hamano7fd84172007-05-24 07:00:32653branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43654Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44655so that linkgit:git-pull[1] will appropriately merge from the
656starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32657this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44658and `--no-track` options. The valid settings are: `false` -- no
659automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07660starting point is a remote-tracking branch; `always` --
661automatic setup is done when the starting point is either a
662local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44663branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32664
Junio C Hamano869bb802008-05-12 00:29:47665branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43666When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano869bb802008-05-12 00:29:47667that tracks another branch, this variable tells git to set
668up pull to rebase instead of merge (see "branch.<name>.rebase").
669When `never`, rebase is never automatically set to true.
670When `local`, rebase is set to true for tracked branches of
671other local branches.
672When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07673remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47674When `always`, rebase will be set to true for all tracking
675branches.
676See "branch.autosetupmerge" for details on how to set up a
677branch to track another branch.
678This option defaults to never.
679
Junio C Hamano47c1e3c2006-09-25 04:45:55680branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43681When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19682remote to fetch from/push to. It defaults to `origin` if no remote is
683configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55684
685branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19686Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02687for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43688branch to merge and can also affect 'git push' (see push.default).
689When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31690refspec to be marked for merging in FETCH_HEAD. The value is
691handled like the remote part of a refspec, and must match a
692ref which is fetched from the remote given by
693"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43694The merge information is used by 'git pull' (which at first calls
695'git fetch') to lookup the default branch for merging. Without
696this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46697Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43698If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07699another branch in the local repository, you can point
700branch.<name>.merge to the desired branch, and use the special setting
701`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55702
Junio C Hamano1b50ce92007-10-03 12:05:53703branch.<name>.mergeoptions::
704Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29705supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53706option values containing whitespace characters are currently not
707supported.
708
Junio C Hamano0c999702007-12-03 09:57:55709branch.<name>.rebase::
710When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08711instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20712"git pull" is run. See "pull.rebase" for doing this in a non
713branch-specific manner.
714+
715*NOTE*: this is a possibly dangerous operation; do *not* use
716it unless you understand the implications (see linkgit:git-rebase[1]
717for details).
Junio C Hamano0c999702007-12-03 09:57:55718
Junio C Hamano8760ea62008-03-14 08:58:45719browser.<tool>.cmd::
720Specify the command to invoke the specified browser. The
721specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56722as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45723
Junio C Hamanoe35a6fc2008-01-29 09:46:27724browser.<tool>.path::
725Override the path for the given tool that may be used to
726browse HTML help (see '-w' option in linkgit:git-help[1]) or a
727working repository in gitweb (see linkgit:git-instaweb[1]).
728
Junio C Hamano47b9acd2007-04-24 07:34:34729clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45730A boolean to make git-clean do nothing unless given -f
731or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34732
Junio C Hamanoeb692952007-01-03 22:02:12733color.branch::
734A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46735linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21736`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12737only when the output is to a terminal. Defaults to false.
738
739color.branch.<slot>::
740Use customized color for branch coloration. `<slot>` is one of
741`current` (the current branch), `local` (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07742`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22743refs).
744+
745The value for these configuration variables is a list of colors (at most
746two) and attributes (at most one), separated by spaces. The colors
747accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
748`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
749`blink` and `reverse`. The first color given is the foreground; the
750second is the background. The position of the attribute, if any,
751doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12752
Junio C Hamano3f403b02006-12-13 10:14:13753color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48754Whether to use ANSI escape sequences to add color to patches.
755If this is set to `always`, linkgit:git-diff[1],
756linkgit:git-log[1], and linkgit:git-show[1] will use color
757for all patches. If it is set to `true` or `auto`, those
758commands will only use color when output is to the terminal.
759Defaults to false.
760+
761This does not affect linkgit:git-format-patch[1] nor the
762'git-diff-{asterisk}' plumbing commands. Can be overridden on the
763command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34764
Junio C Hamano3f403b02006-12-13 10:14:13765color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22766Use customized color for diff colorization. `<slot>` specifies
767which part of the patch to use the specified color, and is one
768of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59769(hunk header), 'func' (function in hunk header), `old` (removed lines),
770`new` (added lines), `commit` (commit headers), or `whitespace`
771(highlighting whitespace errors). The values of these variables may be
772specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34773
Junio C Hamano7d449522010-07-01 00:08:51774color.decorate.<slot>::
775Use customized color for 'git log --decorate' output. `<slot>` is one
776of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07777branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51778
Junio C Hamanod257cff2009-03-18 05:27:16779color.grep::
780When set to `always`, always highlight matches. When `false` (or
781`never`), never. When set to `true` or `auto`, use color only
782when the output is written to the terminal. Defaults to `false`.
783
Junio C Hamano0299d922010-03-20 20:59:31784color.grep.<slot>::
785Use customized color for grep colorization. `<slot>` specifies which
786part of the line to use the specified color, and is one of
787+
788--
789`context`;;
790non-matching text in context lines (when using `-A`, `-B`, or `-C`)
791`filename`;;
792filename prefix (when not using `-h`)
793`function`;;
794function name lines (when using `-p`)
795`linenumber`;;
796line number prefix (when using `-n`)
797`match`;;
798matching text
799`selected`;;
800non-matching text in selected lines
801`separator`;;
802separators between fields on a line (`:`, `-`, and `=`)
803and between hunks (`--`)
804--
805+
806The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16807
Junio C Hamano00b8b632007-12-07 09:50:49808color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46809When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31810and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49811When false (or `never`), never. When set to `true` or `auto`, use
812colors only when the output is to the terminal. Defaults to false.
813
814color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43815Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10816output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
817four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00818commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49819in color.branch.<slot>.
820
Junio C Hamanoe7935c42006-12-13 21:32:17821color.pager::
822A boolean to enable/disable colored output when the pager is in
823use (default is true).
824
Junio C Hamano52ba2952009-05-18 17:43:02825color.showbranch::
826A boolean to enable/disable color in the output of
827linkgit:git-show-branch[1]. May be set to `always`,
828`false` (or `never`) or `auto` (or `true`), in which case colors are used
829only when the output is to a terminal. Defaults to false.
830
Junio C Hamanoe7935c42006-12-13 21:32:17831color.status::
832A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46833linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21834`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17835only when the output is to a terminal. Defaults to false.
836
837color.status.<slot>::
838Use customized color for status colorization. `<slot>` is
839one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04840`added` or `updated` (files which are added but not committed),
841`changed` (files which are changed but not added in the index),
Junio C Hamano0d75e872010-12-17 06:57:26842`untracked` (files which are not tracked by git),
843`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30844`nobranch` (the color the 'no branch' warning is shown in, defaulting
845to red). The values of these variables may be specified as in
846color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17847
Junio C Hamano83d46a22008-02-21 02:29:42848color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48849This variable determines the default value for variables such
850as `color.diff` and `color.grep` that control the use of color
851per command family. Its scope will expand as more commands learn
852configuration to set a default for the `--color` option. Set it
853to `always` if you want all output not intended for machine
854consumption to use color, to `true` or `auto` if you want such
855output to use color when written to the terminal, or to `false` or
856`never` if you prefer git commands not to use color unless enabled
857explicitly with some other configuration or the `--color` option.
Junio C Hamano83d46a22008-02-21 02:29:42858
Junio C Hamano22700fb2012-05-03 23:07:25859column.ui::
860Specify whether supported commands should output in columns.
861This variable consists of a list of tokens separated by spaces
862or commas:
863+
864--
865`always`;;
866always show in columns
867`never`;;
868never show in columns
869`auto`;;
870show in columns if the output is to the terminal
871`column`;;
872fill columns before rows (default)
873`row`;;
874fill rows before columns
875`plain`;;
876show in one column
877`dense`;;
878make unequal size columns to utilize more space
879`nodense`;;
880make equal size columns
881--
882+
883This option defaults to 'never'.
884
885column.branch::
886Specify whether to output branch listing in `git branch` in columns.
887See `column.ui` for details.
888
889column.status::
890Specify whether to output untracked files in `git status` in columns.
891See `column.ui` for details.
892
893column.tag::
894Specify whether to output tag listing in `git tag` in columns.
895See `column.ui` for details.
896
Junio C Hamanod0d892c2010-01-24 20:06:29897commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50898A boolean to enable/disable inclusion of status information in the
899commit message template when using an editor to prepare the commit
900message. Defaults to true.
901
Junio C Hamano4653c6f2008-11-26 22:50:20902commit.template::
903Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:46904"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:19905specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20906
Junio C Hamano0df92712011-12-21 22:30:44907credential.helper::
908Specify an external helper to be called when a username or
909password credential is needed; the helper may consult external
910storage to avoid prompting the user for the credentials. See
911linkgit:gitcredentials[7] for details.
912
913credential.useHttpPath::
914When acquiring credentials, consider the "path" component of an http
915or https URL to be important. Defaults to false. See
916linkgit:gitcredentials[7] for more information.
917
918credential.username::
919If no username is set for a network authentication, use this username
920by default. See credential.<context>.* below, and
921linkgit:gitcredentials[7].
922
923credential.<url>.*::
924Any of the credential.* options above can be applied selectively to
925some credentials. For example "credential.https://example.com.username"
926would set the default username only for https connections to
927example.com. See linkgit:gitcredentials[7] for details on how URLs are
928matched.
929
Junio C Hamano209ebe82011-04-27 21:09:59930include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:56931
932difftool.<tool>.path::
933Override the path for the given tool. This is useful in case
934your tool is not in the PATH.
935
936difftool.<tool>.cmd::
937Specify the command to invoke the specified diff tool.
938The specified command is evaluated in shell with the following
939variables available: 'LOCAL' is set to the name of the temporary
940file containing the contents of the diff pre-image and 'REMOTE'
941is set to the name of the temporary file containing the contents
942of the diff post-image.
943
944difftool.prompt::
945Prompt before each invocation of the diff tool.
946
Junio C Hamano20d47e32009-01-26 06:36:02947diff.wordRegex::
948A POSIX Extended Regular Expression used to determine what is a "word"
949when performing word-by-word difference calculations. Character
950sequences that match the regular expression are "words", all other
951characters are *ignorable* whitespace.
952
Junio C Hamano0d75e872010-12-17 06:57:26953fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:10954This option can be either set to a boolean value or to 'on-demand'.
955Setting it to a boolean changes the behavior of fetch and pull to
956unconditionally recurse into submodules when set to true or to not
957recurse at all when set to false. When set to 'on-demand' (the default
958value), fetch and pull will only recurse into a populated submodule
959when its superproject retrieves a commit that updates the submodule's
960reference.
Junio C Hamano0d75e872010-12-17 06:57:26961
Junio C Hamano8fb66e52011-10-05 20:59:51962fetch.fsckObjects::
963If it is set to true, git-fetch-pack will check all fetched
964objects. It will abort in the case of a malformed object or a
965broken link. The result of an abort are only dangling objects.
966Defaults to false. If not set, the value of `transfer.fsckObjects`
967is used instead.
968
Junio C Hamano54ea8d32007-01-25 07:59:48969fetch.unpackLimit::
970If the number of objects fetched over the git native
971transfer is below this
972limit, then the objects will be unpacked into loose object
973files. However if the number of received objects equals or
974exceeds this limit then the received pack will be stored as
975a pack, after adding any missing delta bases. Storing the
976pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17977especially on slow filesystems. If not set, the value of
978`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48979
Junio C Hamanof4581102009-04-25 08:29:59980format.attach::
981Enable multipart/mixed attachments as the default for
982'format-patch'. The value can also be a double quoted string
983which will enable attachments as the default and set the
984value as the boundary. See the --attach option in
985linkgit:git-format-patch[1].
986
Junio C Hamano8c5802d2007-11-15 00:13:36987format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33988A boolean which can enable or disable sequence numbers in patch
989subjects. It defaults to "auto" which enables it only if there
990is more than one patch. It can be enabled or disabled for all
991messages by setting it to "true" or "false". See --numbered
992option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36993
Junio C Hamano07824ce2006-04-25 07:36:54994format.headers::
995Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46996by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54997
Junio C Hamano70664a02010-07-13 22:48:05998format.to::
Junio C Hamanof4581102009-04-25 08:29:59999format.cc::
Junio C Hamano70664a02010-07-13 22:48:051000Additional recipients to include in a patch to be submitted
1001by mail. See the --to and --cc options in
1002linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591003
1004format.subjectprefix::
1005The default for format-patch is to output files with the '[PATCH]'
1006subject prefix. Use this variable to change that prefix.
1007
Junio C Hamano89a57342010-06-22 23:22:551008format.signature::
1009The default for format-patch is to output a signature containing
1010the git version number. Use this variable to change that default.
1011Set this variable to the empty string ("") to suppress
1012signature generation.
1013
Junio C Hamanod4c8e112007-03-04 10:32:381014format.suffix::
1015The default for format-patch is to output files with the suffix
1016`.patch`. Use this variable to change that suffix (make sure to
1017include the dot if you want it).
1018
Junio C Hamano86bcccc2008-03-08 09:33:551019format.pretty::
1020The default pretty format for log/show/whatchanged command,
1021See linkgit:git-log[1], linkgit:git-show[1],
1022linkgit:git-whatchanged[1].
1023
Junio C Hamanoea6a7642009-03-11 23:56:191024format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431025The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141026a boolean value, or `shallow` or `deep`. `shallow` threading
1027makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191028where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461029`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591030`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191031A true boolean value is the same as `shallow`, and a false
1032value disables threading.
1033
Junio C Hamano5f9a6f02009-04-06 08:26:561034format.signoff::
1035 A boolean value which lets you enable the `-s/--signoff` option of
1036 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1037 patch should be a conscious act and means that you certify you have
1038 the rights to submit this work under the same open source license.
1039 Please see the 'SubmittingPatches' document for further discussion.
1040
Junio C Hamano209ebe82011-04-27 21:09:591041filter.<driver>.clean::
1042The command which is used to convert the content of a worktree
1043file to a blob upon checkin. See linkgit:gitattributes[5] for
1044details.
1045
1046filter.<driver>.smudge::
1047The command which is used to convert the content of a blob
1048object to a worktree file upon checkout. See
1049linkgit:gitattributes[5] for details.
1050
Junio C Hamanof2ce2972007-05-20 19:12:091051gc.aggressiveWindow::
1052The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431053algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361054to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091055
Junio C Hamano1b50ce92007-10-03 12:05:531056gc.auto::
1057When there are approximately more than this many loose
1058objects in the repository, `git gc --auto` will pack them.
1059Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171060light-weight garbage collection from time to time. The
1061default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531062
1063gc.autopacklimit::
1064When there are more than this many packs that are not
1065marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171066--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371067default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531068
Junio C Hamano9d52e572007-02-13 23:48:201069gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:141070Running `git pack-refs` in a repository renders it
1071unclonable by Git versions prior to 1.5.1.2 over dumb
1072transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001073'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141074to enable it within all non-bare repos or it can be set to a
1075boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201076
Junio C Hamano09a926d2008-03-13 07:55:291077gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431078When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571079Override the grace period with this config variable. The value
1080"now" may be used to disable this grace period and always prune
1081unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291082
Junio C Hamano74640642006-12-27 10:59:551083gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531084gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431085'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531086this time; defaults to 90 days. With "<pattern>" (e.g.
1087"refs/stash") in the middle the setting applies only to
1088the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551089
1090gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531091gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431092'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551093this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531094defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1095in the middle, the setting applies only to the refs that
1096match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551097
1098gc.rerereresolved::
1099Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431100kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461101The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551102
1103gc.rerereunresolved::
1104Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431105kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461106The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551107
Junio C Hamanoa3148f52009-01-14 08:49:571108gitcvs.commitmsgannotation::
1109Append this string to each commit message. Set to empty string
1110to disable this feature. Defaults to "via git-CVS emulator".
1111
Junio C Hamano07824ce2006-04-25 07:36:541112gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271113Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461114See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541115
1116gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271117Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461118various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541119
Junio C Hamano17bd2272008-09-01 06:11:171120gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551121If true, the server will look up the end-of-line conversion
1122attributes for files to determine the '-k' modes to use. If
1123the attributes force git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351124the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551125treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331126will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551127the client might otherwise do. If the attributes do not allow
1128the file type to be determined, then 'gitcvs.allbinary' is
1129used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141130
Junio C Hamanod9e0e5d2007-04-14 16:22:041131gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141132This is used if 'gitcvs.usecrlfattr' does not resolve
1133the correct '-kb' mode to use. If true, all
1134unresolved files are sent to the client in
1135mode '-kb'. This causes the client to treat them
1136as binary files, which suppresses any newline munging it
1137otherwise might do. Alternatively, if it is set to "guess",
1138then the contents of the file are examined to decide if
1139it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041140
1141gitcvs.dbname::
1142Database used by git-cvsserver to cache revision information
1143derived from the git repository. The exact meaning depends on the
1144used database driver, for SQLite (which is the default driver) this
1145is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461146linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041147Default: '%Ggitcvs.%m.sqlite'
1148
1149gitcvs.dbdriver::
1150Used Perl DBI driver. You can specify any available driver
1151 for this here, but it might not work. git-cvsserver is tested
1152with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1153reported *not* to work with 'DBD::mysql'. Experimental feature.
1154May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461155See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041156
Junio C Hamanoa2ad99e2007-04-18 09:57:041157gitcvs.dbuser, gitcvs.dbpass::
1158Database user and password. Only useful if setting 'gitcvs.dbdriver',
1159since SQLite has no concept of database users and/or passwords.
1160'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461161linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041162
Junio C Hamanoa74efce2008-04-02 08:39:081163gitcvs.dbTableNamePrefix::
1164Database table name prefix. Prepended to the names of any
1165database tables used, allowing a single database to be used
1166for several repositories. Supports variable substitution (see
1167linkgit:git-cvsserver[1] for details). Any non-alphabetic
1168characters will be replaced with underscores.
1169
Junio C Hamanodfccbb02008-05-26 01:16:141170All gitcvs variables except for 'gitcvs.usecrlfattr' and
1171'gitcvs.allbinary' can also be specified as
1172'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271173is one of "ext" and "pserver") to make them apply only for the given
1174access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041175
Junio C Hamano11821ed2011-10-19 18:42:091176gitweb.category::
1177gitweb.description::
1178gitweb.owner::
1179gitweb.url::
1180See linkgit:gitweb[1] for description.
1181
1182gitweb.avatar::
1183gitweb.blame::
1184gitweb.grep::
1185gitweb.highlight::
1186gitweb.patches::
1187gitweb.pickaxe::
1188gitweb.remote_heads::
1189gitweb.showsizes::
1190gitweb.snapshot::
1191See linkgit:gitweb.conf[5] for description.
1192
Junio C Hamanoa03ac862011-04-02 04:32:291193grep.lineNumber::
1194If set to true, enable '-n' option by default.
1195
1196grep.extendedRegexp::
1197If set to true, enable '--extended-regexp' option by default.
1198
Junio C Hamano4fd24422012-01-06 21:52:431199gpg.program::
1200Use this custom program instead of "gpg" found on $PATH when
1201making or verifying a PGP signature. The program must support the
1202same command line interface as GPG, namely, to verify a detached
1203signature, "gpg --verify $file - <$signature" is run, and the
1204program is expected to signal a good signature by exiting with
1205code 0, and to generate an ascii-armored detached signature, the
1206standard input of "gpg -bsau $key" is fed with the contents to be
1207signed, and the program is expected to send the result to its
1208standard output.
1209
Junio C Hamano6d76d612008-05-09 05:46:081210gui.commitmsgwidth::
1211Defines how wide the commit message window is in the
1212linkgit:git-gui[1]. "75" is the default.
1213
1214gui.diffcontext::
1215Specifies how many context lines should be used in calls to diff
1216made by the linkgit:git-gui[1]. The default is "5".
1217
Junio C Hamanod3452a02008-11-15 08:07:551218gui.encoding::
1219Specifies the default encoding to use for displaying of
1220file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1221It can be overridden by setting the 'encoding' attribute
1222for relevant files (see linkgit:gitattributes[5]).
1223If this option is not set, the tools default to the
1224locale encoding.
1225
Junio C Hamano6d76d612008-05-09 05:46:081226gui.matchtrackingbranch::
1227Determines if new branches created with linkgit:git-gui[1] should
1228default to tracking remote branches with matching names or
1229not. Default: "false".
1230
1231gui.newbranchtemplate::
1232Is used as suggested name when creating new branches using the
1233linkgit:git-gui[1].
1234
1235gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071236"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081237performing a fetch. The default value is "false".
1238
1239gui.trustmtime::
1240Determines if linkgit:git-gui[1] should trust the file modification
1241timestamp or not. By default the timestamps are not trusted.
1242
1243gui.spellingdictionary::
1244Specifies the dictionary used for spell checking commit messages in
1245the linkgit:git-gui[1]. When set to "none" spell checking is turned
1246off.
1247
Junio C Hamanod3452a02008-11-15 08:07:551248gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431249If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551250location detection. It makes blame significantly faster on huge
1251repositories at the expense of less thorough copy detection.
1252
1253gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131254Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551255detection, measured in alphanumeric characters. See the
1256linkgit:git-blame[1] manual for more information on copy detection.
1257
1258gui.blamehistoryctx::
1259Specifies the radius of history context in days to show in
1260linkgit:gitk[1] for the selected commit, when the `Show History
1261Context` menu item is invoked from 'git gui blame'. If this
1262variable is set to zero, the whole history is shown.
1263
Junio C Hamano92d312a2008-12-15 07:22:201264guitool.<name>.cmd::
1265Specifies the shell command line to execute when the corresponding item
1266of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1267mandatory for every tool. The command is executed from the root of
1268the working directory, and in the environment it receives the name of
1269the tool as 'GIT_GUITOOL', the name of the currently selected file as
1270'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1271the head is detached, 'CUR_BRANCH' is empty).
1272
1273guitool.<name>.needsfile::
1274Run the tool only if a diff is selected in the GUI. It guarantees
1275that 'FILENAME' is not empty.
1276
1277guitool.<name>.noconsole::
1278Run the command silently, without creating a window to display its
1279output.
1280
1281guitool.<name>.norescan::
1282Don't rescan the working directory for changes after the tool
1283finishes execution.
1284
1285guitool.<name>.confirm::
1286Show a confirmation dialog before actually running the tool.
1287
1288guitool.<name>.argprompt::
1289Request a string argument from the user, and pass it to the tool
1290through the 'ARGS' environment variable. Since requesting an
1291argument implies confirmation, the 'confirm' option has no effect
1292if this is enabled. If the option is set to 'true', 'yes', or '1',
1293the dialog uses a built-in generic prompt; otherwise the exact
1294value of the variable is used.
1295
1296guitool.<name>.revprompt::
1297Request a single valid revision from the user, and set the
1298'REVISION' environment variable. In other aspects this option
1299is similar to 'argprompt', and can be used together with it.
1300
1301guitool.<name>.revunmerged::
1302Show only unmerged branches in the 'revprompt' subdialog.
1303This is useful for tools similar to merge or rebase, but not
1304for things like checkout or reset.
1305
1306guitool.<name>.title::
1307Specifies the title to use for the prompt dialog. The default
1308is the tool name.
1309
1310guitool.<name>.prompt::
1311Specifies the general prompt string to display at the top of
1312the dialog, before subsections for 'argprompt' and 'revprompt'.
1313The default value includes the actual command.
1314
Junio C Hamano4e272312008-01-08 09:13:211315help.browser::
1316Specify the browser that will be used to display help in the
1317'web' format. See linkgit:git-help[1].
1318
1319help.format::
1320Override the default help format used by linkgit:git-help[1].
1321Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1322the default. 'web' and 'html' are the same.
1323
Junio C Hamanof24b8062008-09-09 01:34:391324help.autocorrect::
1325Automatically correct and execute mistyped commands after
1326waiting for the given number of deciseconds (0.1 sec). If more
1327than one command can be deduced from the entered text, nothing
1328will be executed. If the value of this option is negative,
1329the corrected command will be executed immediately. If the
1330value is 0 - the command will be just shown but not executed.
1331This is the default.
1332
Junio C Hamano58256872007-12-04 08:31:131333http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111334Override the HTTP proxy, normally configured using the 'http_proxy',
1335'https_proxy', and 'all_proxy' environment variables (see
1336`curl(1)`). This can be overridden on a per-remote basis; see
1337remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131338
Junio C Hamano4c4b0122011-06-30 01:19:321339http.cookiefile::
1340File containing previously stored cookie lines which should be used
1341in the git http session, if they match the server. The file format
1342of the file to read cookies from should be plain HTTP headers or
1343the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1344NOTE that the file specified with http.cookiefile is only used as
1345input. No cookies will be stored in the file.
1346
Junio C Hamano07824ce2006-04-25 07:36:541347http.sslVerify::
1348Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451349over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541350variable.
1351
1352http.sslCert::
1353File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451354over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541355variable.
1356
1357http.sslKey::
1358File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481359over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541360variable.
1361
Junio C Hamano48bc1ce2009-07-09 16:49:191362http.sslCertPasswordProtected::
1363Enable git's password prompt for the SSL certificate. Otherwise
1364OpenSSL will prompt the user, possibly many times, if the
1365certificate or private key is encrypted. Can be overridden by the
1366'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1367
Junio C Hamano07824ce2006-04-25 07:36:541368http.sslCAInfo::
1369File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481370fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541371'GIT_SSL_CAINFO' environment variable.
1372
1373http.sslCAPath::
1374Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451375with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541376by the 'GIT_SSL_CAPATH' environment variable.
1377
1378http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481379How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541380by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1381
Junio C Hamanob141a922010-01-10 19:55:141382http.minSessions::
1383The number of curl sessions (counted across slots) to be kept across
1384requests. They will not be ended with curl_easy_cleanup() until
1385http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1386value will be capped at 1. Defaults to 1.
1387
Junio C Hamano3b70d3c2009-11-21 17:37:371388http.postBuffer::
1389Maximum size in bytes of the buffer used by smart HTTP
1390transports when POSTing data to the remote system.
1391For requests larger than this buffer size, HTTP/1.1 and
1392Transfer-Encoding: chunked is used to avoid creating a
1393massive pack file locally. Default is 1 MiB, which is
1394sufficient for most requests.
1395
Junio C Hamano07824ce2006-04-25 07:36:541396http.lowSpeedLimit, http.lowSpeedTime::
1397If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1398for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481399Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541400'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1401
Junio C Hamanof1dcdfe2006-09-29 08:10:511402http.noEPSV::
1403A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041404This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511405support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1406environment variable. Default is false (curl will use EPSV).
1407
Junio C Hamano53ba6d02010-08-22 07:25:121408http.useragent::
1409The HTTP USER_AGENT string presented to an HTTP server. The default
1410value represents the version of the client git such as git/1.7.1.
1411This option allows you to override this value to a more common value
1412such as Mozilla/4.0. This may be necessary, for instance, if
1413connecting through a firewall that restricts HTTP connections to a set
1414of common USER_AGENT strings (but not including those like git/1.7.1).
1415Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1416
Junio C Hamano07824ce2006-04-25 07:36:541417i18n.commitEncoding::
1418Character encoding the commit messages are stored in; git itself
1419does not care per se, but this information is necessary e.g. when
1420importing commits from emails or in the gitk graphical history
1421browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461422porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541423
Junio C Hamano51f92e22006-12-29 05:18:281424i18n.logOutputEncoding::
1425Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431426running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281427
Junio C Hamano4653c6f2008-11-26 22:50:201428imap::
1429The configuration variables in the 'imap' section are described
1430in linkgit:git-imap-send[1].
1431
Junio C Hamanocaa712a2010-03-11 01:17:351432init.templatedir::
1433Specify the directory from which templates will be copied.
1434(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1435
Junio C Hamano4e272312008-01-08 09:13:211436instaweb.browser::
1437Specify the program that will be used to browse your working
1438repository in gitweb. See linkgit:git-instaweb[1].
1439
1440instaweb.httpd::
1441The HTTP daemon command-line to start gitweb on your working
1442repository. See linkgit:git-instaweb[1].
1443
1444instaweb.local::
1445If true the web server started by linkgit:git-instaweb[1] will
1446be bound to the local IP (127.0.0.1).
1447
1448instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351449The default module path for linkgit:git-instaweb[1] to use
1450instead of /usr/lib/apache2/modules. Only used if httpd
1451is Apache.
Junio C Hamano4e272312008-01-08 09:13:211452
1453instaweb.port::
1454The port number to bind the gitweb httpd to. See
1455linkgit:git-instaweb[1].
1456
Junio C Hamanoe5bf6c12009-02-07 21:43:101457interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001458In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101459input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461460Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341461linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1462linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1463setting is silently ignored if portable keystroke input
1464is not available.
Junio C Hamanoe5bf6c12009-02-07 21:43:101465
Junio C Hamanof93530e2011-05-25 23:59:591466log.abbrevCommit::
1467If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461468linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1469override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591470
Junio C Hamanob713ff12008-05-24 01:12:301471log.date::
Junio C Hamano2db3e752010-09-03 21:33:061472Set the default date-time mode for the 'log' command.
1473Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461474`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061475`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1476for details.
Junio C Hamanob713ff12008-05-24 01:12:301477
Junio C Hamanocb39aea2010-05-09 07:24:481478log.decorate::
1479Print out the ref names of any commits that are shown by the log
1480command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1481'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1482specified, the full ref name (including prefix) will be printed.
1483This is the same as the log commands '--decorate' option.
1484
Junio C Hamanofe9acab2006-11-24 12:10:551485log.showroot::
1486If true, the initial commit will be shown as a big creation event.
1487This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461488Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551489normally hide the root commit will now show it. True by default.
1490
Junio C Hamano8bc410e2009-02-15 10:38:191491mailmap.file::
1492The location of an augmenting mailmap file. The default
1493mailmap, located in the root of the repository, is loaded
1494first, then the mailmap file pointed to by this variable.
1495The location of the mailmap file may be in a repository
1496subdirectory, or somewhere outside of the repository itself.
1497See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1498
Junio C Hamano8b588d52008-03-15 09:48:371499man.viewer::
1500Specify the programs that may be used to display help in the
1501'man' format. See linkgit:git-help[1].
1502
Junio C Hamano6d76d612008-05-09 05:46:081503man.<tool>.cmd::
1504Specify the command to invoke the specified man viewer. The
1505specified command is evaluated in shell with the man page
1506passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261507
Junio C Hamano6d76d612008-05-09 05:46:081508man.<tool>.path::
1509Override the path for the given tool that may be used to
1510display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131511
Junio C Hamano4653c6f2008-11-26 22:50:201512include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421513
Junio C Hamano1fbbbc12007-12-18 07:01:271514mergetool.<tool>.path::
1515Override the path for the given tool. This is useful in case
1516your tool is not in the PATH.
1517
Junio C Hamano86bcccc2008-03-08 09:33:551518mergetool.<tool>.cmd::
1519Specify the command to invoke the specified merge tool. The
1520specified command is evaluated in shell with the following
1521variables available: 'BASE' is the name of a temporary file
1522containing the common base of the files to be merged, if available;
1523'LOCAL' is the name of a temporary file containing the contents of
1524the file on the current branch; 'REMOTE' is the name of a temporary
1525file containing the contents of the file from the branch being
1526merged; 'MERGED' contains the name of the file to which the merge
1527tool should write the results of a successful merge.
1528
1529mergetool.<tool>.trustExitCode::
1530For a custom merge command, specify whether the exit code of
1531the merge command can be used to determine whether the merge was
1532successful. If this is not set to true then the merge target file
1533timestamp is checked and the merge assumed to have been successful
1534if the file has been updated, otherwise the user is prompted to
1535indicate the success of the merge.
1536
1537mergetool.keepBackup::
1538After performing a merge, the original file with conflict markers
1539can be saved as a file with a `.orig` extension. If this variable
1540is set to `false` then this file is not preserved. Defaults to
1541`true` (i.e. keep the backup files).
1542
Junio C Hamano10b7a342009-01-01 22:05:171543mergetool.keepTemporaries::
1544When invoking a custom merge tool, git uses a set of temporary
1545files to pass to the tool. If the tool returns an error and this
1546variable is set to `true`, then these temporary files will be
1547preserved, otherwise they will be removed after the tool has
1548exited. Defaults to `false`.
1549
1550mergetool.prompt::
1551Prompt before each invocation of the merge resolution program.
1552
Junio C Hamano31667362010-03-25 00:38:531553notes.displayRef::
1554The (fully qualified) refname from which to show notes when
1555showing commit messages. The value of this variable can be set
1556to a glob, in which case notes from all matching refs will be
1557shown. You may also specify this configuration variable
1558several times. A warning will be issued for refs that do not
1559exist, but a glob that does not match any refs is silently
1560ignored.
1561+
1562This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1563environment variable, which must be a colon separated list of refs or
1564globs.
1565+
1566The effective value of "core.notesRef" (possibly overridden by
1567GIT_NOTES_REF) is also implicitly added to the list of refs to be
1568displayed.
1569
1570notes.rewrite.<command>::
1571When rewriting commits with <command> (currently `amend` or
1572`rebase`) and this variable is set to `true`, git
1573automatically copies your notes from the original to the
1574rewritten commit. Defaults to `true`, but see
1575"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531576
1577notes.rewriteMode::
1578When copying notes during a rewrite (see the
1579"notes.rewrite.<command>" option), determines what to do if
1580the target commit already has a note. Must be one of
1581`overwrite`, `concatenate`, or `ignore`. Defaults to
1582`concatenate`.
1583+
1584This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1585environment variable.
1586
1587notes.rewriteRef::
1588When copying notes during a rewrite, specifies the (fully
1589qualified) ref whose notes should be copied. The ref may be a
1590glob, in which case notes in all matching refs will be copied.
1591You may also specify this configuration several times.
1592+
1593Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511594enable note rewriting. Set it to `refs/notes/commits` to enable
1595rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181596+
1597This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1598environment variable, which must be a colon separated list of refs or
1599globs.
Junio C Hamano31667362010-03-25 00:38:531600
Junio C Hamano75cc4c92006-07-24 08:25:031601pack.window::
Junio C Hamano35738e82008-01-07 07:55:461602The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031603window size is given on the command line. Defaults to 10.
1604
Junio C Hamano91d44c52007-05-09 07:16:071605pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461606The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071607maximum depth is given on the command line. Defaults to 50.
1608
Junio C Hamano235d53f2007-07-13 00:25:151609pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461610The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151611when no limit is given on the command line. The value can be
1612suffixed with "k", "m", or "g". Defaults to 0, meaning no
1613limit.
1614
Junio C Hamanof2ce2972007-05-20 19:12:091615pack.compression::
1616An integer -1..9, indicating the compression level for objects
1617in a pack file. -1 is the zlib default. 0 means no
1618compression, and 1..9 are various speed/size tradeoffs, 9 being
1619slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421620not set, defaults to -1, the zlib default, which is "a default
1621compromise between speed and compression (currently equivalent
1622to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241623+
1624Note that changing the compression level will not automatically recompress
1625all existing objects. You can force recompression by passing the -F option
1626to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091627
Junio C Hamano679d22d2007-06-02 21:13:441628pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271629The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521630linkgit:git-pack-objects[1] before writing them out to a pack.
1631This cache is used to speed up the writing object phase by not
1632having to recompute the final delta result once the best match
1633for all objects is found. Repacking large repositories on machines
1634which are tight with memory might be badly impacted by this though,
1635especially if this cache pushes the system into swapping.
1636A value of 0 means no limit. The smallest size of 1 byte may be
1637used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441638
1639pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141640The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521641linkgit:git-pack-objects[1]. This cache is used to speed up the
1642writing object phase by not having to recompute the final delta
1643result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441644
Junio C Hamano58155b42007-09-15 07:46:141645pack.threads::
1646Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461647delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141648be compiled with pthreads otherwise this option is ignored with a
1649warning. This is meant to reduce packing time on multiprocessor
1650machines. The required amount of memory for the delta search window
1651is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441652Specifying 0 will cause git to auto-detect the number of CPU's
1653and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141654
Junio C Hamanod814b6d2007-11-04 11:13:491655pack.indexVersion::
1656Specify the default pack index version. Valid values are 1 for
1657legacy pack index used by Git versions prior to 1.5.2, and 2 for
1658the new pack index with capabilities for packs larger than 4 GB
1659as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381660packs. Version 2 is the default. Note that version 2 is enforced
1661and this config option ignored whenever the corresponding pack is
1662larger than 2 GB.
1663+
Junio C Hamanob76a6862012-05-02 22:02:461664If you have an old git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381665cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461666that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381667other side may give you a repository that cannot be accessed with your
Junio C Hamanob76a6862012-05-02 22:02:461668older version of git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381669you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461670the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491671
Junio C Hamano09a926d2008-03-13 07:55:291672pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291673The maximum size of a pack. This setting only affects
1674packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461675is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291676option of linkgit:git-repack[1]. The minimum size allowed is
1677limited to 1 MiB. The default is unlimited.
1678Common unit suffixes of 'k', 'm', or 'g' are
1679supported.
Junio C Hamano49dccaf2008-02-10 10:48:011680
Junio C Hamano9e96a1a2008-08-16 10:23:181681pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431682If the value is boolean, turns on or off pagination of the
1683output of a particular git subcommand when writing to a tty.
1684Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:461685pager specified by the value of `pager.<cmd>`. If `--paginate`
1686or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:431687precedence over this option. To disable pagination for all
1688commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181689
Junio C Hamanoa574a092010-06-13 19:57:101690pretty.<name>::
1691Alias for a --pretty= format string, as specified in
1692linkgit:git-log[1]. Any aliases defined here can be used just
1693as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:461694running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:101695would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:461696to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:101697Note that an alias with the same name as a built-in format
1698will be silently ignored.
1699
Junio C Hamano515ab1d2011-12-09 23:41:201700pull.rebase::
1701When true, rebase branches on top of the fetched branch, instead
1702of merging the default branch from the default remote when "git
1703pull" is run. See "branch.<name>.rebase" for setting this on a
1704per-branch basis.
1705+
1706*NOTE*: this is a possibly dangerous operation; do *not* use
1707it unless you understand the implications (see linkgit:git-rebase[1]
1708for details).
1709
Junio C Hamano07824ce2006-04-25 07:36:541710pull.octopus::
1711The default merge strategy to use when pulling multiple branches
1712at once.
1713
1714pull.twohead::
1715The default merge strategy to use when pulling a single branch.
1716
Junio C Hamano1de75722009-03-26 08:39:381717push.default::
1718Defines the action git push should take if no refspec is given
1719on the command line, no refspec is configured in the remote, and
1720no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191721line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381722+
Junio C Hamano7f9fa862010-10-19 23:51:141723* `nothing` - do not push anything.
Junio C Hamanob76a6862012-05-02 22:02:461724* `matching` - push all branches having the same name in both ends.
1725 This is for those who prepare all the branches into a publishable
1726 shape and then push them out with a single command. It is not
1727 appropriate for pushing into a repository shared by multiple users,
1728 since locally stalled branches will attempt a non-fast forward push
1729 if other users updated the branch.
1730 +
1731 This is currently the default, but Git 2.0 will change the default
1732 to `simple`.
Junio C Hamano63c2bc92011-02-28 06:41:281733* `upstream` - push the current branch to its upstream branch.
Junio C Hamanob76a6862012-05-02 22:02:461734 With this, `git push` will update the same remote ref as the one which
1735 is merged by `git pull`, making `push` and `pull` symmetrical.
1736 See "branch.<name>.merge" for how to configure the upstream branch.
1737* `simple` - like `upstream`, but refuses to push if the upstream
1738 branch's name is different from the local one. This is the safest
1739 option and is well-suited for beginners. It will become the default
1740 in Git 2.0.
Junio C Hamano7f9fa862010-10-19 23:51:141741* `current` - push the current branch to a branch of the same name.
Junio C Hamanob76a6862012-05-02 22:02:461742 +
1743 The `simple`, `current` and `upstream` modes are for those who want to
1744 push out a single branch after finishing work, even when the other
1745 branches are not yet ready to be pushed out. If you are working with
1746 other people to push into the same shared repository, you would want
1747 to use one of these.
Junio C Hamano1de75722009-03-26 08:39:381748
Junio C Hamanoea6a7642009-03-11 23:56:191749rebase.stat::
1750Whether to show a diffstat of what changed upstream since the last
1751rebase. False by default.
1752
Junio C Hamano075ae872010-09-01 18:43:071753rebase.autosquash::
1754If set to true enable '--autosquash' option by default.
1755
Junio C Hamano621e1232009-10-26 05:16:471756receive.autogc::
1757By default, git-receive-pack will run "git-gc --auto" after
1758receiving data from git-push and updating refs. You can stop
1759it by setting this variable to false.
1760
Junio C Hamano4653c6f2008-11-26 22:50:201761receive.fsckObjects::
1762If it is set to true, git-receive-pack will check all received
1763objects. It will abort in the case of a malformed object or a
1764broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:511765Defaults to false. If not set, the value of `transfer.fsckObjects`
1766is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:201767
1768receive.unpackLimit::
1769If the number of objects received in a push is below this
1770limit then the objects will be unpacked into loose object
1771files. However if the number of received objects equals or
1772exceeds this limit then the received pack will be stored as
1773a pack, after adding any missing delta bases. Storing the
1774pack from a push can make the push operation complete faster,
1775especially on slow filesystems. If not set, the value of
1776`transfer.unpackLimit` is used instead.
1777
1778receive.denyDeletes::
1779If set to true, git-receive-pack will deny a ref update that deletes
1780the ref. Use this to prevent such a ref deletion via a push.
1781
Junio C Hamanob4448a82010-07-26 09:02:321782receive.denyDeleteCurrent::
1783If set to true, git-receive-pack will deny a ref update that
1784deletes the currently checked out branch of a non-bare repository.
1785
Junio C Hamano4653c6f2008-11-26 22:50:201786receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:581787If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:201788to the currently checked out branch of a non-bare repository.
1789Such a push is potentially dangerous because it brings the HEAD
1790out of sync with the index and working tree. If set to "warn",
1791print a warning of such a push to stderr, but allow the push to
1792proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:151793message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:201794
1795receive.denyNonFastForwards::
1796If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541797not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201798even if that push is forced. This configuration variable is
1799set when initializing a shared repository.
1800
Junio C Hamano621e1232009-10-26 05:16:471801receive.updateserverinfo::
1802If set to true, git-receive-pack will run git-update-server-info
1803after receiving data from git-push and updating refs.
1804
Junio C Hamano249572f2006-10-24 05:44:081805remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461806The URL of a remote repository. See linkgit:git-fetch[1] or
1807linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081808
Junio C Hamano0e88f3e2009-06-21 08:03:251809remote.<name>.pushurl::
1810The push URL of a remote repository. See linkgit:git-push[1].
1811
Junio C Hamano58256872007-12-04 08:31:131812remote.<name>.proxy::
1813For remotes that require curl (http, https and ftp), the URL to
1814the proxy to use for that remote. Set to the empty string to
1815disable proxying for that remote.
1816
Junio C Hamano249572f2006-10-24 05:44:081817remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461818The default set of "refspec" for linkgit:git-fetch[1]. See
1819linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081820
1821remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461822The default set of "refspec" for linkgit:git-push[1]. See
1823linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081824
Junio C Hamano47d68a52008-05-06 06:35:401825remote.<name>.mirror::
1826If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:461827as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:401828
Junio C Hamano118d2772007-02-21 20:24:101829remote.<name>.skipDefaultUpdate::
1830If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271831using linkgit:git-fetch[1] or the `update` subcommand of
1832linkgit:git-remote[1].
1833
1834remote.<name>.skipFetchAll::
1835If true, this remote will be skipped by default when updating
1836using linkgit:git-fetch[1] or the `update` subcommand of
1837linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101838
Junio C Hamano4ad294b2007-01-20 02:22:501839remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481840The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551841option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501842
Junio C Hamano54ea8d32007-01-25 07:59:481843remote.<name>.uploadpack::
1844The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551845option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481846
Junio C Hamano17dde0e2007-02-26 09:50:211847remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551848Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:531849fetching from remote <name>. Setting it to \--tags will fetch every
1850tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:071851branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1852override this setting. See options \--tags and \--no-tags of
1853linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:211854
Junio C Hamano096dde22009-12-26 23:14:111855remote.<name>.vcs::
1856Setting this to a value <vcs> will cause git to interact with
1857the remote with the git-remote-<vcs> helper.
1858
Junio C Hamano118d2772007-02-21 20:24:101859remotes.<group>::
1860The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461861<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101862
Junio C Hamano77b7e902006-10-23 07:18:501863repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381864By default, linkgit:git-repack[1] creates packs that use
1865delta-base offset. If you need to share your repository with
1866git older than version 1.4.4, either directly or via a dumb
1867protocol such as http, then you need to set this option to
1868"false" and repack. Access from old git versions over the
1869native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501870
Junio C Hamano4653c6f2008-11-26 22:50:201871rerere.autoupdate::
1872When set to true, `git-rerere` updates the index with the
1873resulting contents after it cleanly resolves conflicts using
1874previously recorded resolution. Defaults to false.
1875
1876rerere.enabled::
1877Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:431878conflict hunks can be resolved automatically, should they be
1879encountered again. By default, linkgit:git-rerere[1] is
1880enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:051881`$GIT_DIR`, e.g. if "rerere" was previously used in the
1882repository.
Junio C Hamano4653c6f2008-11-26 22:50:201883
Junio C Hamano1bbd0f42009-07-23 06:20:291884sendemail.identity::
1885A configuration identity. When given, causes values in the
1886'sendemail.<identity>' subsection to take precedence over
1887values in the 'sendemail' section. The default identity is
1888the value of 'sendemail.identity'.
1889
1890sendemail.smtpencryption::
1891See linkgit:git-send-email[1] for description. Note that this
1892setting is not subject to the 'identity' mechanism.
1893
1894sendemail.smtpssl::
1895Deprecated alias for 'sendemail.smtpencryption = ssl'.
1896
1897sendemail.<identity>.*::
1898Identity-specific versions of the 'sendemail.*' parameters
1899found below, taking precedence over those when the this
1900identity is selected, through command-line or
1901'sendemail.identity'.
1902
1903sendemail.aliasesfile::
1904sendemail.aliasfiletype::
1905sendemail.bcc::
1906sendemail.cc::
1907sendemail.cccmd::
1908sendemail.chainreplyto::
1909sendemail.confirm::
1910sendemail.envelopesender::
1911sendemail.from::
1912sendemail.multiedit::
1913sendemail.signedoffbycc::
1914sendemail.smtppass::
1915sendemail.suppresscc::
1916sendemail.suppressfrom::
1917sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:481918sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:291919sendemail.smtpserver::
1920sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:541921sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:291922sendemail.smtpuser::
1923sendemail.thread::
1924sendemail.validate::
1925See linkgit:git-send-email[1] for description.
1926
1927sendemail.signedoffcc::
1928Deprecated alias for 'sendemail.signedoffbycc'.
1929
Junio C Hamano07824ce2006-04-25 07:36:541930showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461931The default set of branches for linkgit:git-show-branch[1].
1932See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541933
Junio C Hamano942b35e2007-12-09 10:19:331934status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461935By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331936current directory. Setting this variable to `false` shows paths
1937relative to the repository root (this was the default for git
1938prior to v1.5.4).
1939
Junio C Hamano4224f992008-06-23 07:14:081940status.showUntrackedFiles::
1941By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1942files which are not currently tracked by Git. Directories which
1943contain only untracked files, are shown with the directory name
1944only. Showing untracked files means that Git needs to lstat() all
1945all the files in the whole repository, which might be slow on some
1946systems. So, this variable controls how the commands displays
1947the untracked files. Possible values are:
1948+
1949--
Junio C Hamano7f9fa862010-10-19 23:51:141950* `no` - Show no untracked files.
1951* `normal` - Show untracked files and directories.
1952* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:081953--
1954+
1955If this variable is not specified, it defaults to 'normal'.
1956This variable can be overridden with the -u|--untracked-files option
1957of linkgit:git-status[1] and linkgit:git-commit[1].
1958
Junio C Hamanob671fb52010-06-01 05:06:141959status.submodulesummary::
1960Defaults to false.
1961If this is set to a non zero number or true (identical to -1 or an
1962unlimited number), the submodule summary will be enabled and a
1963summary of commits for modified submodules will be shown (see
1964--summary-limit option of linkgit:git-submodule[1]).
1965
Junio C Hamano78e3a782010-07-15 22:24:451966submodule.<name>.path::
1967submodule.<name>.url::
1968submodule.<name>.update::
1969The path within this project, URL, and the updating strategy
1970for a submodule. These variables are initially populated
1971by 'git submodule init'; edit them to override the
1972URL and other values found in the `.gitmodules` file. See
1973linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1974
Junio C Hamano0d75e872010-12-17 06:57:261975submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101976This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:181977submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:261978command line option to "git fetch" and "git pull".
1979This setting will override that from in the linkgit:gitmodules[5]
1980file.
1981
Junio C Hamano619596a2010-08-18 22:15:351982submodule.<name>.ignore::
1983Defines under what circumstances "git status" and the diff family show
1984a submodule as modified. When set to "all", it will never be considered
1985modified, "dirty" will ignore all changes to the submodules work tree and
1986takes only differences between the HEAD of the submodule and the commit
1987recorded in the superproject into account. "untracked" will additionally
1988let submodules with modified tracked files in their work tree show up.
1989Using "none" (the default when this option is not set) also shows
1990submodules that have untracked files in their work tree as changed.
1991This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:181992both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:351993"--ignore-submodules" option.
1994
Junio C Hamano75cc4c92006-07-24 08:25:031995tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091996This variable can be used to restrict the permission bits of
1997tar archive entries. The default is 0002, which turns off the
1998world write bit. The special value "user" indicates that the
1999archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462000linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032001
Junio C Hamano8fb66e52011-10-05 20:59:512002transfer.fsckObjects::
2003When `fetch.fsckObjects` or `receive.fsckObjects` are
2004not set, the value of this variable is used instead.
2005Defaults to false.
2006
Junio C Hamano4653c6f2008-11-26 22:50:202007transfer.unpackLimit::
2008When `fetch.unpackLimit` or `receive.unpackLimit` are
2009not set, the value of this variable is used instead.
2010The default value is 100.
2011
Junio C Hamano24bc09a2008-02-28 00:27:442012url.<base>.insteadOf::
2013Any URL that starts with this value will be rewritten to
2014start, instead, with <base>. In cases where some site serves a
2015large number of repositories, and serves them with multiple
2016access methods, and some users need to use different access
2017methods, this feature allows people to specify any of the
2018equivalent URLs and have git automatically rewrite the URL to
2019the best alternative for the particular user, even for a
2020never-before-seen repository on the site. When more than one
2021insteadOf strings match a given URL, the longest match is used.
2022
Junio C Hamano7df6dcf2009-09-13 09:51:172023url.<base>.pushInsteadOf::
2024Any URL that starts with this value will not be pushed to;
2025instead, it will be rewritten to start with <base>, and the
2026resulting URL will be pushed to. In cases where some site serves
2027a large number of repositories, and serves them with multiple
2028access methods, some of which do not allow push, this feature
2029allows people to specify a pull-only URL and have git
2030automatically use an appropriate URL to push, even for a
2031never-before-seen repository on the site. When more than one
2032pushInsteadOf strings match a given URL, the longest match is
2033used. If a remote has an explicit pushurl, git will ignore this
2034setting for that remote.
2035
Junio C Hamano07824ce2006-04-25 07:36:542036user.email::
2037Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342038Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462039'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542040
2041user.name::
2042Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482043Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462044environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542045
Junio C Hamanoa890c4f2007-01-28 10:29:212046user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:462047If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:212048automatically when creating a signed tag, you can override the
2049default selection with this variable. This option is passed
2050unchanged to gpg's --local-user parameter, so you may specify a key
2051using any method that gpg supports.
2052
Junio C Hamano4e272312008-01-08 09:13:212053web.browser::
2054Specify a web browser that may be used by some commands.
2055Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2056may use it.