blob: b5b27ba8d345e0a0bc5f5e0d406de14d2714829c [file] [log] [blame]
Petr Baudis1ab661d2006-04-25 00:59:33 +02001CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Stephen Boyd773002a2009-04-23 02:38:00 -07005the git command's behavior. The `.git/config` file in each repository
Stephen Boyd66e35fc2009-04-23 02:38:02 -07006is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
Stephen Boyd773002a2009-04-23 02:38:00 -07008fallback values for the `.git/config` file. The file `/etc/gitconfig`
Stephen Boyd66e35fc2009-04-23 02:38:02 -07009can be used to store a system-wide default configuration.
Junio C Hamano5ea56212007-01-16 22:45:35 -080010
Stephen Boydb7ee2262009-04-23 02:38:01 -070011The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Petr Baudis1ab661d2006-04-25 00:59:33 +020014dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Jakub Narebskie136f332007-01-22 16:25:47 +010018Syntax
19~~~~~~
20
Petr Baudis1ab661d2006-04-25 00:59:33 +020021The syntax is fairly flexible and permissive; whitespaces are mostly
Jakub Narebskie136f332007-01-22 16:25:47 +010022ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
Chris Johnsendcb11262009-03-15 06:30:52 -050028characters, `-` and `.` are allowed in section names. Each variable
Stephen Boyd773002a2009-04-23 02:38:00 -070029must belong to some section, which means that there must be a section
30header before the first setting of a variable.
Jakub Narebskie136f332007-01-22 16:25:47 +010031
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
Stephen Boyd773002a2009-04-23 02:38:00 -070034in the section header, like in the example below:
Jakub Narebskie136f332007-01-22 16:25:47 +010035
36--------
37 [section "subsection"]
38
39--------
40
Stephen Boydb7ee2262009-04-23 02:38:01 -070041Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers cannot span multiple
Jakub Narebskie136f332007-01-22 16:25:47 +010044lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
Stephen Boyd773002a2009-04-23 02:38:00 -070048There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
Jakub Narebskie136f332007-01-22 16:25:47 +010051
Nanako Shiraishi2ceb6392009-07-25 09:28:50 +090052All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
Jakub Narebskie136f332007-01-22 16:25:47 +010054'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
Chris Johnsendcb11262009-03-15 06:30:52 -050057characters and `-` are allowed. There can be more than one value
Jakub Narebskie136f332007-01-22 16:25:47 +010058for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
Michał Kiedrowicz0cbcf7a2009-04-17 22:34:25 +0200650/1, true/false or on/off. Case is not significant in boolean values, when
Jakub Narebskie136f332007-01-22 16:25:47 +010066converting value to the canonical form using '--bool' type specifier;
Jonathan Niederba020ef2008-07-03 00:41:41 -050067'git-config' will ensure that the output is "true" or "false".
Jakub Narebskie136f332007-01-22 16:25:47 +010068
69String values may be entirely or partially enclosed in double quotes.
Stephen Boyd773002a2009-04-23 02:38:00 -070070You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
Chris Johnsendcb11262009-03-15 06:30:52 -050074be escaped: use `\"` for `"` and `\\` for `\`.
Jakub Narebskie136f332007-01-22 16:25:47 +010075
Chris Johnsendcb11262009-03-15 06:30:52 -050076The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
Jakub Narebskie136f332007-01-22 16:25:47 +010079char sequences are valid.
80
Stephen Boyd773002a2009-04-23 02:38:00 -070081Variable values ending in a `\` are continued on the next line in the
Jakub Narebskie136f332007-01-22 16:25:47 +010082customary UNIX fashion.
83
Stephen Boyd773002a2009-04-23 02:38:00 -070084Some variables may require a special value format.
Petr Baudis1ab661d2006-04-25 00:59:33 +020085
86Example
87~~~~~~~
88
89 # Core variables
90 [core]
91 ; Don't trust file modes
92 filemode = false
93
94 # Our diff algorithm
95 [diff]
Anders Melchiorsen6bb9e512008-07-27 13:12:15 +020096 external = /usr/local/bin/diff-wrapper
Petr Baudis1ab661d2006-04-25 00:59:33 +020097 renames = true
98
Aneesh Kumar K.V910c00c2006-12-07 12:06:55 +053099 [branch "devel"]
100 remote = origin
101 merge = refs/heads/devel
102
Jakub Narebskie136f332007-01-22 16:25:47 +0100103 # Proxy settings
104 [core]
David Symonds29093c22007-08-03 08:45:56 +1000105 gitProxy="ssh" for "kernel.org"
Jakub Narebskie136f332007-01-22 16:25:47 +0100106 gitProxy=default-proxy ; for the rest
Aneesh Kumar K.V910c00c2006-12-07 12:06:55 +0530107
Petr Baudis1ab661d2006-04-25 00:59:33 +0200108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
Petr Baudis1ab661d2006-04-25 00:59:33 +0200114porcelain configuration variables in the respective porcelain documentation.
115
Jeff King75194432009-09-09 07:38:58 -0400116advice.*::
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
119 are:
120+
121--
122 pushNonFastForward::
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
Jeff Kingedf563f2009-09-09 07:43:03 -0400125 statusHints::
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
Matthieu Moy4c371f92009-11-22 23:26:17 +0100129 commitBeforeMerge::
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwritting local changes.
132 Default: true.
Jeff King75194432009-09-09 07:38:58 -0400133--
134
Petr Baudis1ab661d2006-04-25 00:59:33 +0200135core.fileMode::
136 If false, the executable bit differences between the index and
137 the working copy are ignored; useful on broken filesystems like FAT.
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700138 See linkgit:git-update-index[1].
139+
140The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
141will probe and set core.fileMode false if appropriate when the
142repository is created.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200143
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400144core.ignoreCygwinFSTricks::
145 This option is only used by Cygwin implementation of Git. If false,
146 the Cygwin stat() and lstat() functions are used. This may be useful
147 if your repository consists of a few separate directories joined in
148 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
149 whenever it is possible and falls back to Cygwin functions only to
150 handle symbol links. The native mode is more than twice faster than
Mark Levedahl7faee6b2008-10-13 00:33:31 -0400151 normal Cygwin l/stat() functions. True by default, unless core.filemode
152 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
153 POSIX emulation is required to support core.filemode.
Dmitry Potapovadbc0b62008-09-30 17:53:47 +0400154
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700155core.ignorecase::
156 If true, this option enables various workarounds to enable
157 git to work better on filesystems that are not case sensitive,
158 like FAT. For example, if a directory listing finds
159 "makefile" when git expects "Makefile", git will assume
160 it is really the same file, and continue to remember it as
161 "Makefile".
162+
163The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
164will probe and set core.ignorecase true if appropriate when the repository
165is created.
166
Alex Riesen1ce47902008-07-28 08:31:28 +0200167core.trustctime::
168 If false, the ctime differences between the index and the
169 working copy are ignored; useful when the inode change time
170 is regularly modified by something outside Git (file system
171 crawlers and some backup systems).
172 See linkgit:git-update-index[1]. True by default.
173
Junio C Hamano9378c162007-06-24 15:11:24 -0700174core.quotepath::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500175 The commands that output paths (e.g. 'ls-files',
176 'diff'), when not given the `-z` option, will quote
Junio C Hamano9378c162007-06-24 15:11:24 -0700177 "unusual" characters in the pathname by enclosing the
178 pathname in a double-quote pair and with backslashes the
179 same way strings in C source code are quoted. If this
180 variable is set to false, the bytes higher than 0x80 are
181 not quoted but output as verbatim. Note that double
182 quote, backslash and control characters are always
183 quoted without `-z` regardless of the setting of this
184 variable.
185
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200186core.autocrlf::
187 If true, makes git convert `CRLF` at the end of lines in text files to
188 `LF` when reading from the filesystem, and convert in reverse when
189 writing to the filesystem. The variable can be set to
190 'input', in which case the conversion happens only while
191 reading from the filesystem but files are written out with
Matthew Ogilvieff686682009-11-14 11:35:00 -0700192 `LF` at the end of lines. A file is considered
193 "text" (i.e. be subjected to the autocrlf mechanism) based on
194 the file's `crlf` attribute, or if `crlf` is unspecified,
195 based on the file's contents. See linkgit:gitattributes[5].
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200196
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100197core.safecrlf::
198 If true, makes git check if converting `CRLF` as controlled by
199 `core.autocrlf` is reversible. Git will verify if a command
200 modifies a file in the work tree either directly or indirectly.
201 For example, committing a file followed by checking out the
202 same file should yield the original file in the work tree. If
203 this is not the case for the current setting of
204 `core.autocrlf`, git will reject the file. The variable can
205 be set to "warn", in which case git will only warn about an
206 irreversible conversion but continue the operation.
207+
208CRLF conversion bears a slight chance of corrupting data.
209autocrlf=true will convert CRLF to LF during commit and LF to
210CRLF during checkout. A file that contains a mixture of LF and
211CRLF before the commit cannot be recreated by git. For text
212files this is the right thing to do: it corrects line endings
213such that we have only LF line endings in the repository.
214But for binary files that are accidentally classified as text the
215conversion can corrupt data.
216+
217If you recognize such corruption early you can easily fix it by
218setting the conversion type explicitly in .gitattributes. Right
219after committing you still have the original file in your work
220tree and this file is not yet corrupted. You can explicitly tell
221git that this file is binary and git will handle the file
222appropriately.
223+
224Unfortunately, the desired effect of cleaning up text files with
225mixed line endings and the undesired effect of corrupting binary
226files cannot be distinguished. In both cases CRLFs are removed
227in an irreversible way. For text files this is the right thing
228to do because CRLFs are line endings, while for binary files
229converting CRLFs corrupts data.
230+
231Note, this safety check does not mean that a checkout will generate a
232file identical to the original file for a different setting of
233`core.autocrlf`, but only for the current one. For example, a text
234file with `LF` would be accepted with `core.autocrlf=input` and could
235later be checked out with `core.autocrlf=true`, in which case the
236resulting file would contain `CRLF`, although the original file
237contained `LF`. However, in both work trees the line endings would be
238consistent, that is either all `LF` or all `CRLF`, but never mixed. A
239file with mixed line endings would be reported by the `core.safecrlf`
240mechanism.
241
Johannes Sixt78a8d642007-03-02 22:11:30 +0100242core.symlinks::
243 If false, symbolic links are checked out as small plain files that
Dan McGee5162e692007-12-29 00:20:38 -0600244 contain the link text. linkgit:git-update-index[1] and
245 linkgit:git-add[1] will not change the recorded type to regular
Johannes Sixt78a8d642007-03-02 22:11:30 +0100246 file. Useful on filesystems like FAT that do not support
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700247 symbolic links.
248+
249The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
250will probe and set core.symlinks false if appropriate when the repository
251is created.
Johannes Sixt78a8d642007-03-02 22:11:30 +0100252
Petr Baudis1ab661d2006-04-25 00:59:33 +0200253core.gitProxy::
254 A "proxy command" to execute (as 'command host port') instead
255 of establishing direct connection to the remote server when
256 using the git protocol for fetching. If the variable value is
257 in the "COMMAND for DOMAIN" format, the command is applied only
258 on hostnames ending with the specified domain string. This variable
259 may be set multiple times and is matched in the given order;
260 the first match wins.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100261+
262Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
263(which always applies universally, without the special "for"
264handling).
Emil Sit642d0842009-03-17 13:31:42 -0400265+
266The special string `none` can be used as the proxy command to
267specify that no proxy be used for a given domain pattern.
268This is useful for excluding servers inside a firewall from
269proxy use, while defaulting to a common proxy for external domains.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200270
271core.ignoreStat::
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200272 If true, commands which modify both the working tree and the index
273 will mark the updated paths with the "assume unchanged" bit in the
274 index. These marked files are then assumed to stay unchanged in the
275 working copy, until you mark them otherwise manually - Git will not
276 detect the file changes by lstat() calls. This is useful on systems
277 where those are very slow, such as Microsoft Windows.
278 See linkgit:git-update-index[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200279 False by default.
280
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700281core.preferSymlinkRefs::
282 Instead of the default "symref" format for HEAD
283 and other symbolic reference files, use symbolic links.
284 This is sometimes needed to work with old scripts that
285 expect HEAD to be a symbolic link.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200286
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500287core.bare::
288 If true this repository is assumed to be 'bare' and has no
289 working directory associated with it. If this is the case a
290 number of commands that require a working directory will be
Dan McGee5162e692007-12-29 00:20:38 -0600291 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500292+
Dan McGee5162e692007-12-29 00:20:38 -0600293This setting is automatically guessed by linkgit:git-clone[1] or
294linkgit:git-init[1] when the repository was created. By default a
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500295repository that ends in "/.git" is assumed to be not bare (bare =
296false), while all other repositories are assumed to be bare (bare
297= true).
298
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200299core.worktree::
Nguyễn Thái Ngọc Duyf5e025a2009-12-29 14:48:41 +0700300 Set the path to the root of the work tree.
Ralf Wildenhues06ada152007-10-09 23:00:03 +0200301 This can be overridden by the GIT_WORK_TREE environment
Liu Yubao302cc112008-04-29 04:09:20 +0800302 variable and the '--work-tree' command line option. It can be
Nguyễn Thái Ngọc Duyf5e025a2009-12-29 14:48:41 +0700303 an absolute path or a relative path to the .git directory,
304 either specified by --git-dir or GIT_DIR, or automatically
305 discovered.
306 If --git-dir or GIT_DIR are specified but none of
Liu Yubao302cc112008-04-29 04:09:20 +0800307 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Nguyễn Thái Ngọc Duyf5e025a2009-12-29 14:48:41 +0700308 the current working directory is regarded as the root of the
309 work tree.
310+
311Note that this variable is honored even when set in a configuration
312file in a ".git" subdirectory of a directory, and its value differs
313from the latter directory (e.g. "/path/to/.git/config" has
314core.worktree set to "/different/path"), which is most likely a
315misconfiguration. Running git commands in "/path/to" directory will
316still use "/different/path" as the root of the work tree and can cause
317great confusion to the users.
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200318
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400319core.logAllRefUpdates::
Lukas Sandström14cd5602007-08-19 23:38:57 +0200320 Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano4057deb2006-10-08 01:35:18 -0700321 "$GIT_DIR/logs/<ref>", by appending the new and old
322 SHA1, the date/time and the reason of the update, but
323 only when the file exists. If this configuration
324 variable is set to true, missing "$GIT_DIR/logs/<ref>"
325 file is automatically created for branch heads.
Junio C Hamanoa862f972006-12-30 22:39:24 -0800326+
327This information can be used to determine what commit
328was the tip of a branch "2 days ago".
329+
330This value is true by default in a repository that has
331a working directory associated with it, and false by
332default in a bare repository.
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400333
Petr Baudis1ab661d2006-04-25 00:59:33 +0200334core.repositoryFormatVersion::
335 Internal variable identifying the repository format and layout
336 version.
337
338core.sharedRepository::
Jonas Fonsecad5dc6a72006-08-09 02:26:23 +0200339 When 'group' (or 'true'), the repository is made shareable between
340 several users in a group (making sure all the files and objects are
341 group-writable). When 'all' (or 'world' or 'everybody'), the
342 repository will be readable by all users, additionally to being
343 group-shareable. When 'umask' (or 'false'), git will use permissions
Heikki Orsila06cbe852008-04-16 11:34:24 +0300344 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
345 files in the repository will have this mode value. '0xxx' will override
Johan Herland098082f2009-04-14 15:15:42 +0200346 user's umask value (whereas the other options will only override
347 requested parts of the user's umask value). Examples: '0660' will make
348 the repo read/write-able for the owner and group, but inaccessible to
349 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Heikki Orsila06cbe852008-04-16 11:34:24 +0300350 repository that is group-readable but not group-writable.
351 See linkgit:git-init[1]. False by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200352
353core.warnAmbiguousRefs::
354 If true, git will warn you if the ref name you passed it is ambiguous
355 and might match multiple refs in the .git/refs/ tree. True by default.
356
Joachim Berdal Haga3d3e95a2006-07-06 22:35:54 +0200357core.compression::
Dana How960ccca2007-05-09 13:56:50 -0700358 An integer -1..9, indicating a default compression level.
359 -1 is the zlib default. 0 means no compression,
360 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Brian Downingdec92302007-11-19 10:58:51 -0600361 If set, this provides a default to other compression variables,
362 such as 'core.loosecompression' and 'pack.compression'.
Dana How960ccca2007-05-09 13:56:50 -0700363
364core.loosecompression::
Joachim B Haga12f6c302006-07-03 22:11:47 +0200365 An integer -1..9, indicating the compression level for objects that
Dana How960ccca2007-05-09 13:56:50 -0700366 are not in a pack file. -1 is the zlib default. 0 means no
Joachim B Haga12f6c302006-07-03 22:11:47 +0200367 compression, and 1..9 are various speed/size tradeoffs, 9 being
Dana How960ccca2007-05-09 13:56:50 -0700368 slowest. If not set, defaults to core.compression. If that is
Brian Downingde1b2462007-11-19 10:58:50 -0600369 not set, defaults to 1 (best speed).
Joachim B Haga12f6c302006-07-03 22:11:47 +0200370
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500371core.packedGitWindowSize::
372 Number of bytes of a pack file to map into memory in a
373 single mapping operation. Larger window sizes may allow
374 your system to process a smaller number of large pack files
375 more quickly. Smaller window sizes will negatively affect
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500376 performance due to increased calls to the operating system's
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500377 memory manager, but may improve performance when accessing
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500378 a large number of large pack files.
379+
380Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
381MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
382be reasonable for all users/operating systems. You probably do
383not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500384+
385Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500386
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500387core.packedGitLimit::
388 Maximum number of bytes to map simultaneously into memory
389 from pack files. If Git needs to access more than this many
390 bytes at once to complete an operation it will unmap existing
391 regions to reclaim virtual address space within the process.
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500392+
393Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
394This should be reasonable for all users/operating systems, except on
395the largest projects. You probably do not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500396+
397Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500398
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400399core.deltaBaseCacheLimit::
400 Maximum number of bytes to reserve for caching base objects
401 that multiple deltafied objects reference. By storing the
402 entire decompressed base objects in a cache Git is able
403 to avoid unpacking and decompressing frequently used base
404 objects multiple times.
405+
406Default is 16 MiB on all platforms. This should be reasonable
407for all users/operating systems, except on the largest projects.
408You probably do not need to adjust this value.
409+
410Common unit suffixes of 'k', 'm', or 'g' are supported.
411
Michael Hendrickse8964a52007-07-02 10:48:34 -0600412core.excludesfile::
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100413 In addition to '.gitignore' (per-directory) and
414 '.git/info/exclude', git looks into this file for patterns
Junio C Hamano0f7fb212009-11-21 00:37:26 -0800415 of files which are not meant to be tracked. "{tilde}/" is expanded
416 to the value of `$HOME` and "{tilde}user/" to the specified user's
Matthieu Moydf2a79f2009-11-19 16:21:15 +0100417 home directory. See linkgit:gitignore[5].
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100418
Adam Robenef0c2ab2007-07-19 22:09:35 -0700419core.editor::
420 Commands such as `commit` and `tag` that lets you edit
Brian Hetro02783072007-08-23 20:44:13 -0400421 messages by launching an editor uses the value of this
Adam Robenef0c2ab2007-07-19 22:09:35 -0700422 variable when it is set, and the environment variable
Jonathan Niederb4479f02009-10-30 20:42:34 -0500423 `GIT_EDITOR` is not set. See linkgit:git-var[1].
Adam Robenef0c2ab2007-07-19 22:09:35 -0700424
Brian Gernhardt54adf372007-07-03 14:18:11 -0400425core.pager::
Jonathan Niederab54cd62008-08-24 00:28:32 -0500426 The command that git will use to paginate output. Can
427 be overridden with the `GIT_PAGER` environment
428 variable. Note that git sets the `LESS` environment
429 variable to `FRSX` if it is unset when it runs the
430 pager. One can change these settings by setting the
Chris Freyfee75452008-09-24 19:21:28 -0400431 `LESS` variable to some other value. Alternately,
432 these settings can be overridden on a project or
433 global basis by setting the `core.pager` option.
434 Setting `core.pager` has no affect on the `LESS`
435 environment variable behaviour above, so if you want
436 to override git's default settings this way, you need
437 to be explicit. For example, to disable the S option
438 in a backward compatible manner, set `core.pager`
Chris Johnsendcb11262009-03-15 06:30:52 -0500439 to `less -+$LESS -FRX`. This will be passed to the
Chris Freyfee75452008-09-24 19:21:28 -0400440 shell by git, which will translate the final command to
Chris Johnsendcb11262009-03-15 06:30:52 -0500441 `LESS=FRSX less -+FRSX -FRX`.
Brian Gernhardt54adf372007-07-03 14:18:11 -0400442
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800443core.whitespace::
444 A comma separated list of common whitespace problems to
Jonathan Niederba020ef2008-07-03 00:41:41 -0500445 notice. 'git-diff' will use `color.diff.whitespace` to
446 highlight them, and 'git-apply --whitespace=error' will
Junio C Hamanoc921cc92008-07-25 00:34:47 -0700447 consider them as errors. You can prefix `-` to disable
448 any of them (e.g. `-trailing-space`):
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800449+
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700450* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800451 as an error (enabled by default).
452* `space-before-tab` treats a space character that appears immediately
453 before a tab character in the initial indent part of the line as an
454 error (enabled by default).
455* `indent-with-non-tab` treats a line that is indented with 8 or more
J. Bruce Fields127f72e2007-12-16 11:31:42 -0500456 space characters as an error (not enabled by default).
Junio C Hamano77b15bb2009-09-03 16:02:32 -0700457* `blank-at-eof` treats blank lines added at the end of file as an error
458 (enabled by default).
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700459* `trailing-space` is a short-hand to cover both `blank-at-eol` and
460 `blank-at-eof`.
Junio C Hamanob2979ff2008-01-15 00:59:05 -0800461* `cr-at-eol` treats a carriage-return at the end of line as
462 part of the line terminator, i.e. with it, `trailing-space`
463 does not trigger if the character before such a carriage-return
464 is not a whitespace (not enabled by default).
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800465
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700466core.fsyncobjectfiles::
467 This boolean will enable 'fsync()' when writing object files.
468+
469This is a total waste of time and effort on a filesystem that orders
470data writes properly, but can be useful for filesystems that do not use
471journalling (traditional UNIX filesystems) or that only journal metadata
472and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
473
Linus Torvalds671c9b72008-11-13 16:36:30 -0800474core.preloadindex::
475 Enable parallel index preload for operations like 'git diff'
476+
477This can speed up operations like 'git diff' and 'git status' especially
478on filesystems like NFS that have weak caching semantics and thus
479relatively high IO latencies. With this set to 'true', git will do the
480index comparison to the filesystem data in parallel, allowing
481overlapping IO's.
482
Johannes Schindelin348df162009-04-28 00:32:25 +0200483core.createObject::
484 You can set this to 'link', in which case a hardlink followed by
485 a delete of the source are used to make sure that object creation
486 will not overwrite existing objects.
487+
488On some file system/operating system combinations, this is unreliable.
489Set this config setting to 'rename' there; However, This will remove the
490check that makes sure that existing object files will not get overwritten.
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200491
Johannes Schindelina97a7462009-10-09 12:21:57 +0200492core.notesRef::
493 When showing commit messages, also show notes which are stored in
494 the given ref. This ref is expected to contain files named
495 after the full SHA-1 of the commit they annotate.
496+
497If such a file exists in the given ref, the referenced blob is read, and
498appended to the commit message, separated by a "Notes:" line. If the
499given ref itself does not exist, it is not an error, but means that no
500notes should be printed.
501+
502This setting defaults to "refs/notes/commits", and can be overridden by
503the `GIT_NOTES_REF` environment variable.
504
Stephen Boyd13bd2132009-05-30 22:08:02 -0700505add.ignore-errors::
506 Tells 'git-add' to continue adding files when some files cannot be
507 added due to indexing errors. Equivalent to the '--ignore-errors'
508 option of linkgit:git-add[1].
509
Petr Baudis4514ad42006-06-07 20:43:50 +0200510alias.*::
Dan McGee5162e692007-12-29 00:20:38 -0600511 Command aliases for the linkgit:git[1] command wrapper - e.g.
Petr Baudis4514ad42006-06-07 20:43:50 +0200512 after defining "alias.last = cat-file commit HEAD", the invocation
513 "git last" is equivalent to "git cat-file commit HEAD". To avoid
Petr Baudis99b41c82006-06-07 17:25:21 -0700514 confusion and troubles with script usage, aliases that
515 hide existing git commands are ignored. Arguments are split by
516 spaces, the usual shell quoting and escaping is supported.
517 quote pair and a backslash can be used to quote them.
Junio C Hamanof368f5a2007-09-01 04:01:54 -0700518+
519If the alias expansion is prefixed with an exclamation point,
520it will be treated as a shell command. For example, defining
521"alias.new = !gitk --all --not ORIG_HEAD", the invocation
522"git new" is equivalent to running the shell command
Sitaram Chamarty595b8db2009-07-01 21:30:31 +0530523"gitk --all --not ORIG_HEAD". Note that shell commands will be
524executed from the top-level directory of a repository, which may
525not necessarily be the current directory.
Theodore Ts'odfd42a32007-02-10 19:33:58 -0500526
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200527apply.ignorewhitespace::
528 When set to 'change', tells 'git-apply' to ignore changes in
529 whitespace, in the same way as the '--ignore-space-change'
530 option.
531 When set to one of: no, none, never, false tells 'git-apply' to
532 respect all whitespace differences.
533 See linkgit:git-apply[1].
534
Petr Baudis1ab661d2006-04-25 00:59:33 +0200535apply.whitespace::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500536 Tells 'git-apply' how to handle whitespaces, in the same way
Dan McGee5162e692007-12-29 00:20:38 -0600537 as the '--whitespace' option. See linkgit:git-apply[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200538
Paolo Bonzini99023872007-05-23 07:07:54 +0200539branch.autosetupmerge::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500540 Tells 'git-branch' and 'git-checkout' to setup new branches
Jay Soffian572fc812008-02-19 11:24:38 -0500541 so that linkgit:git-pull[1] will appropriately merge from the
542 starting point branch. Note that even if this option is not set,
Paolo Bonzini99023872007-05-23 07:07:54 +0200543 this behavior can be chosen per-branch using the `--track`
Jay Soffian572fc812008-02-19 11:24:38 -0500544 and `--no-track` options. The valid settings are: `false` -- no
545 automatic setup is done; `true` -- automatic setup is done when the
546 starting point is a remote branch; `always` -- automatic setup is
547 done when the starting point is either a local branch or remote
548 branch. This option defaults to true.
Paolo Bonzini99023872007-05-23 07:07:54 +0200549
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700550branch.autosetuprebase::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500551 When a new branch is created with 'git-branch' or 'git-checkout'
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700552 that tracks another branch, this variable tells git to set
553 up pull to rebase instead of merge (see "branch.<name>.rebase").
554 When `never`, rebase is never automatically set to true.
555 When `local`, rebase is set to true for tracked branches of
556 other local branches.
557 When `remote`, rebase is set to true for tracked branches of
558 remote branches.
559 When `always`, rebase will be set to true for all tracking
560 branches.
561 See "branch.autosetupmerge" for details on how to set up a
562 branch to track another branch.
563 This option defaults to never.
564
Santi Béjar648ad182006-09-23 12:05:43 +0200565branch.<name>.remote::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200566 When in branch <name>, it tells 'git-fetch' and 'git-push' which
567 remote to fetch from/push to. It defaults to `origin` if no remote is
568 configured. `origin` is also used if you are not on any branch.
Santi Béjar648ad182006-09-23 12:05:43 +0200569
Santi Béjar53728062006-09-23 22:53:04 +0200570branch.<name>.merge::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200571 Defines, together with branch.<name>.remote, the upstream branch
572 for the given branch. It tells 'git-fetch'/'git-pull' which
Santi Béjar5c9c9902009-03-30 12:11:42 +0200573 branch to merge and can also affect 'git-push' (see push.default).
Jonathan Niederba020ef2008-07-03 00:41:41 -0500574 When in branch <name>, it tells 'git-fetch' the default
Daniel Barkalowb888d612007-09-10 23:03:25 -0400575 refspec to be marked for merging in FETCH_HEAD. The value is
576 handled like the remote part of a refspec, and must match a
577 ref which is fetched from the remote given by
578 "branch.<name>.remote".
Jonathan Niederba020ef2008-07-03 00:41:41 -0500579 The merge information is used by 'git-pull' (which at first calls
580 'git-fetch') to lookup the default branch for merging. Without
581 this option, 'git-pull' defaults to merge the first refspec fetched.
Josef Weidendorfer62b339a2006-12-09 02:28:26 +0100582 Specify multiple values to get an octopus merge.
Jonathan Niederba020ef2008-07-03 00:41:41 -0500583 If you wish to setup 'git-pull' so that it merges into <name> from
Paolo Bonzini9debc322007-03-15 09:23:20 +0100584 another branch in the local repository, you can point
585 branch.<name>.merge to the desired branch, and use the special setting
586 `.` (a period) for branch.<name>.remote.
Santi Béjar53728062006-09-23 22:53:04 +0200587
Lars Hjemliaec7b362007-09-24 00:51:43 +0200588branch.<name>.mergeoptions::
589 Sets default options for merging into branch <name>. The syntax and
Jonathan Nieder25dcc0d2009-10-09 13:51:14 -0500590 supported options are the same as those of linkgit:git-merge[1], but
Lars Hjemliaec7b362007-09-24 00:51:43 +0200591 option values containing whitespace characters are currently not
592 supported.
593
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000594branch.<name>.rebase::
595 When true, rebase the branch <name> on top of the fetched branch,
Dustin Sallings15ddb6f2008-05-08 11:28:07 -0700596 instead of merging the default branch from the default remote when
597 "git pull" is run.
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000598 *NOTE*: this is a possibly dangerous operation; do *not* use
Dan McGee5162e692007-12-29 00:20:38 -0600599 it unless you understand the implications (see linkgit:git-rebase[1]
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000600 for details).
601
Christian Couder1658c612008-03-14 05:56:53 +0100602browser.<tool>.cmd::
603 Specify the command to invoke the specified browser. The
604 specified command is evaluated in shell with the URLs passed
605 as arguments. (See linkgit:git-web--browse[1].)
606
Christian Couder584627b2008-01-29 07:08:22 +0100607browser.<tool>.path::
608 Override the path for the given tool that may be used to
Christian Couderab989ad2008-01-29 07:08:44 +0100609 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
610 working repository in gitweb (see linkgit:git-instaweb[1]).
Christian Couder584627b2008-01-29 07:08:22 +0100611
Josh Triplett21225912007-04-23 17:18:16 -0700612clean.requireForce::
Junio C Hamano562ca192007-11-01 17:32:04 -0700613 A boolean to make git-clean do nothing unless given -f
614 or -n. Defaults to true.
Josh Triplett21225912007-04-23 17:18:16 -0700615
Brian Gernhardtf3673982007-01-03 10:36:29 -0500616color.branch::
617 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600618 linkgit:git-branch[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800619 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Brian Gernhardtf3673982007-01-03 10:36:29 -0500620 only when the output is to a terminal. Defaults to false.
621
622color.branch.<slot>::
623 Use customized color for branch coloration. `<slot>` is one of
624 `current` (the current branch), `local` (a local branch),
625 `remote` (a tracking branch in refs/remotes/), `plain` (other
Mark Wooding4f193f22007-01-28 15:17:36 +0000626 refs).
627+
628The value for these configuration variables is a list of colors (at most
629two) and attributes (at most one), separated by spaces. The colors
630accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
631`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
632`blink` and `reverse`. The first color given is the foreground; the
633second is the background. The position of the attribute, if any,
634doesn't matter.
Brian Gernhardtf3673982007-01-03 10:36:29 -0500635
Andy Parkinsa159ca02006-12-13 09:13:28 +0000636color.diff::
Junio C Hamanocec99d82007-12-05 17:05:17 -0800637 When set to `always`, always use colors in patch.
638 When false (or `never`), never. When set to `true` or `auto`, use
639 colors only when the output is to the terminal. Defaults to false.
Junio C Hamanob5376642006-07-07 05:28:05 -0700640
Andy Parkinsa159ca02006-12-13 09:13:28 +0000641color.diff.<slot>::
Mark Wooding4f193f22007-01-28 15:17:36 +0000642 Use customized color for diff colorization. `<slot>` specifies
643 which part of the patch to use the specified color, and is one
644 of `plain` (context text), `meta` (metainformation), `frag`
Bert Wesarg89cb73a2009-11-27 07:55:18 +0100645 (hunk header), 'func' (function in hunk header), `old` (removed lines),
646 `new` (added lines), `commit` (commit headers), or `whitespace`
647 (highlighting whitespace errors). The values of these variables may be
648 specified as in color.branch.<slot>.
Junio C Hamanob5376642006-07-07 05:28:05 -0700649
René Scharfe7e8f59d2009-03-07 13:32:32 +0100650color.grep::
651 When set to `always`, always highlight matches. When `false` (or
652 `never`), never. When set to `true` or `auto`, use color only
653 when the output is written to the terminal. Defaults to `false`.
654
René Scharfea94982e2009-03-07 13:34:46 +0100655color.grep.external::
656 The string value of this variable is passed to an external 'grep'
657 command as a command line option if match highlighting is turned
658 on. If set to an empty string, no option is passed at all,
659 turning off coloring for external 'grep' calls; this is the default.
660 For GNU grep, set it to `--color=always` to highlight matches even
661 when a pager is used.
662
René Scharfe7e8f59d2009-03-07 13:32:32 +0100663color.grep.match::
664 Use customized color for matches. The value of this variable
René Scharfea94982e2009-03-07 13:34:46 +0100665 may be specified as in color.branch.<slot>. It is passed using
666 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
667 calling an external 'grep'.
René Scharfe7e8f59d2009-03-07 13:32:32 +0100668
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800669color.interactive::
Jeff King47ee06f2008-01-05 04:57:44 -0500670 When set to `always`, always use colors for interactive prompts
Jonathan Nieder467c0192008-07-03 00:28:15 -0500671 and displays (such as those used by "git-add --interactive").
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800672 When false (or `never`), never. When set to `true` or `auto`, use
673 colors only when the output is to the terminal. Defaults to false.
674
675color.interactive.<slot>::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500676 Use customized color for 'git-add --interactive'
Thomas Rasta3019732009-02-05 09:28:27 +0100677 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
678 four distinct types of normal output from interactive
Ori Avtalion57f6ec02009-08-07 17:24:21 +0300679 commands. The values of these variables may be specified as
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800680 in color.branch.<slot>.
681
Junio C Hamano1d770432006-12-13 12:11:03 -0800682color.pager::
683 A boolean to enable/disable colored output when the pager is in
684 use (default is true).
685
Markus Heidelbergab07ba22009-04-22 23:41:25 +0200686color.showbranch::
687 A boolean to enable/disable color in the output of
688 linkgit:git-show-branch[1]. May be set to `always`,
689 `false` (or `never`) or `auto` (or `true`), in which case colors are used
690 only when the output is to a terminal. Defaults to false.
691
Junio C Hamano1d770432006-12-13 12:11:03 -0800692color.status::
693 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600694 linkgit:git-status[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800695 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamano1d770432006-12-13 12:11:03 -0800696 only when the output is to a terminal. Defaults to false.
697
698color.status.<slot>::
699 Use customized color for status colorization. `<slot>` is
700 one of `header` (the header text of the status message),
Shawn O. Pearce82dca842006-12-15 21:53:13 -0500701 `added` or `updated` (files which are added but not committed),
702 `changed` (files which are changed but not added in the index),
Chris Parsons950ce2e2008-05-22 08:50:02 -0400703 `untracked` (files which are not tracked by git), or
704 `nobranch` (the color the 'no branch' warning is shown in, defaulting
705 to red). The values of these variables may be specified as in
706 color.branch.<slot>.
Junio C Hamano1d770432006-12-13 12:11:03 -0800707
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100708color.ui::
709 When set to `always`, always use colors in all git commands which
710 are capable of colored output. When false (or `never`), never. When
711 set to `true` or `auto`, use colors only when the output is to the
712 terminal. When more specific variables of color.* are set, they always
713 take precedence over this setting. Defaults to false.
714
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500715commit.template::
716 Specify a file to use as the template for new commit messages.
Junio C Hamano0f7fb212009-11-21 00:37:26 -0800717 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
Matthieu Moydf2a79f2009-11-19 16:21:15 +0100718 specified user's home directory.
Matt McCutchenb0f34c32008-11-26 03:26:50 -0500719
Junio C Hamanoaecbf912007-08-31 13:13:42 -0700720diff.autorefreshindex::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500721 When using 'git-diff' to compare with work tree
Junio C Hamanoaecbf912007-08-31 13:13:42 -0700722 files, do not consider stat-only change as changed.
723 Instead, silently run `git update-index --refresh` to
724 update the cached stat information for paths whose
725 contents in the work tree match the contents in the
726 index. This option defaults to true. Note that this
Jonathan Niederba020ef2008-07-03 00:41:41 -0500727 affects only 'git-diff' Porcelain, and not lower level
Jonathan Nieder5833d732008-07-03 00:59:09 -0500728 'diff' commands, such as 'git-diff-files'.
Junio C Hamanoaecbf912007-08-31 13:13:42 -0700729
Johannes Schindelin77680ca2007-12-17 12:21:22 +0000730diff.external::
731 If this config variable is set, diff generation is not
732 performed using the internal diff machinery, but using the
Anders Melchiorsen6bb9e512008-07-27 13:12:15 +0200733 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
734 environment variable. The command is called with parameters
735 as described under "git Diffs" in linkgit:git[1]. Note: if
736 you want to use an external diff program only on a subset of
737 your files, you might want to use linkgit:gitattributes[5] instead.
Johannes Schindelin77680ca2007-12-17 12:21:22 +0000738
Junio C Hamanoa5a818e2008-08-18 20:08:09 -0700739diff.mnemonicprefix::
740 If set, 'git-diff' uses a prefix pair that is different from the
741 standard "a/" and "b/" depending on what is being compared. When
742 this configuration is in effect, reverse diff output also swaps
743 the order of the prefixes:
744'git-diff';;
745 compares the (i)ndex and the (w)ork tree;
746'git-diff HEAD';;
747 compares a (c)ommit and the (w)ork tree;
748'git diff --cached';;
749 compares a (c)ommit and the (i)ndex;
750'git-diff HEAD:file1 file2';;
751 compares an (o)bject and a (w)ork tree entity;
752'git diff --no-index a b';;
753 compares two non-git things (1) and (2).
754
Petr Baudis1ab661d2006-04-25 00:59:33 +0200755diff.renameLimit::
756 The number of files to consider when performing the copy/rename
Jonathan Nieder0979c102008-07-03 00:37:18 -0500757 detection; equivalent to the 'git-diff' option '-l'.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200758
Eric Wongb68ea122006-07-07 04:01:23 -0700759diff.renames::
760 Tells git to detect renames. If set to any boolean value, it
761 will enable basic rename detection. If set to "copies" or
762 "copy", it will detect copies, as well.
763
Johannes Schindelin950db872009-01-20 22:08:33 +0100764diff.suppressBlankEmpty::
Richard Hartmann5fdb7092008-12-21 23:28:25 +0100765 A boolean to inhibit the standard behavior of printing a space
766 before each empty output line. Defaults to false.
767
David Aguilarafcbc8e2009-04-07 01:21:20 -0700768diff.tool::
769 Controls which diff tool is used. `diff.tool` overrides
770 `merge.tool` when used by linkgit:git-difftool[1] and has
771 the same valid values as `merge.tool` minus "tortoisemerge"
772 and plus "kompare".
773
774difftool.<tool>.path::
775 Override the path for the given tool. This is useful in case
776 your tool is not in the PATH.
777
778difftool.<tool>.cmd::
779 Specify the command to invoke the specified diff tool.
780 The specified command is evaluated in shell with the following
781 variables available: 'LOCAL' is set to the name of the temporary
782 file containing the contents of the diff pre-image and 'REMOTE'
783 is set to the name of the temporary file containing the contents
784 of the diff post-image.
785
David Aguilara9043922009-04-07 01:21:22 -0700786difftool.prompt::
787 Prompt before each invocation of the diff tool.
788
Boyd Stephen Smith Jrae3b9702009-01-20 22:59:54 -0600789diff.wordRegex::
Boyd Stephen Smith Jr98a4d872009-01-20 21:46:57 -0600790 A POSIX Extended Regular Expression used to determine what is a "word"
791 when performing word-by-word difference calculations. Character
792 sequences that match the regular expression are "words", all other
793 characters are *ignorable* whitespace.
794
Junio C Hamanoaf7cf262007-01-24 16:47:24 -0800795fetch.unpackLimit::
796 If the number of objects fetched over the git native
797 transfer is below this
798 limit, then the objects will be unpacked into loose object
799 files. However if the number of received objects equals or
800 exceeds this limit then the received pack will be stored as
801 a pack, after adding any missing delta bases. Storing the
802 pack from a push can make the push operation complete faster,
Michele Ballabio80cd9cf2008-01-11 22:11:13 +0100803 especially on slow filesystems. If not set, the value of
804 `transfer.unpackLimit` is used instead.
Junio C Hamanoaf7cf262007-01-24 16:47:24 -0800805
Stephen Boyd48d34482009-04-23 02:37:56 -0700806format.attach::
807 Enable multipart/mixed attachments as the default for
808 'format-patch'. The value can also be a double quoted string
809 which will enable attachments as the default and set the
810 value as the boundary. See the --attach option in
811 linkgit:git-format-patch[1].
812
Brian Gernhardt49604a42007-11-03 23:38:24 -0400813format.numbered::
Brian Gernhardta567fdc2008-10-02 16:55:39 -0400814 A boolean which can enable or disable sequence numbers in patch
815 subjects. It defaults to "auto" which enables it only if there
816 is more than one patch. It can be enabled or disabled for all
817 messages by setting it to "true" or "false". See --numbered
818 option in linkgit:git-format-patch[1].
Brian Gernhardt49604a42007-11-03 23:38:24 -0400819
Petr Baudis1ab661d2006-04-25 00:59:33 +0200820format.headers::
821 Additional email headers to include in a patch to be submitted
Dan McGee5162e692007-12-29 00:20:38 -0600822 by mail. See linkgit:git-format-patch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200823
Stephen Boyd48d34482009-04-23 02:37:56 -0700824format.cc::
825 Additional "Cc:" headers to include in a patch to be submitted
826 by mail. See the --cc option in linkgit:git-format-patch[1].
827
828format.subjectprefix::
829 The default for format-patch is to output files with the '[PATCH]'
830 subject prefix. Use this variable to change that prefix.
831
Johannes Schindelin78cb59c2007-03-04 00:17:23 +0100832format.suffix::
833 The default for format-patch is to output files with the suffix
834 `.patch`. Use this variable to change that suffix (make sure to
835 include the dot if you want it).
836
Denis Cheng94c22a52008-03-02 17:05:53 +0800837format.pretty::
838 The default pretty format for log/show/whatchanged command,
839 See linkgit:git-log[1], linkgit:git-show[1],
840 linkgit:git-whatchanged[1].
841
Thomas Rast30984ed2009-02-19 22:26:33 +0100842format.thread::
843 The default threading style for 'git-format-patch'. Can be
Stephen Boydfd1ff302009-04-23 02:37:57 -0700844 either a boolean value, `shallow` or `deep`. `shallow`
Thomas Rast30984ed2009-02-19 22:26:33 +0100845 threading makes every mail a reply to the head of the series,
846 where the head is chosen from the cover letter, the
847 `\--in-reply-to`, and the first patch mail, in this order.
Stephen Boydfd1ff302009-04-23 02:37:57 -0700848 `deep` threading makes every mail a reply to the previous one.
Thomas Rast30984ed2009-02-19 22:26:33 +0100849 A true boolean value is the same as `shallow`, and a false
850 value disables threading.
851
Heiko Voigt1d1876e2009-04-01 19:51:54 +0200852format.signoff::
853 A boolean value which lets you enable the `-s/--signoff` option of
854 format-patch by default. *Note:* Adding the Signed-off-by: line to a
855 patch should be a conscious act and means that you certify you have
856 the rights to submit this work under the same open source license.
857 Please see the 'SubmittingPatches' document for further discussion.
858
Theodore Tso0d7566a2007-05-09 15:48:39 -0400859gc.aggressiveWindow::
860 The window size parameter used in the delta compression
Jonathan Nieder467c0192008-07-03 00:28:15 -0500861 algorithm used by 'git-gc --aggressive'. This defaults
Theodore Tso0d7566a2007-05-09 15:48:39 -0400862 to 10.
863
Junio C Hamanoe9831e82007-09-17 00:39:52 -0700864gc.auto::
865 When there are approximately more than this many loose
866 objects in the repository, `git gc --auto` will pack them.
867 Some Porcelain commands use this command to perform a
Michele Ballabio80cd9cf2008-01-11 22:11:13 +0100868 light-weight garbage collection from time to time. The
869 default value is 6700. Setting this to 0 disables it.
Junio C Hamanoe9831e82007-09-17 00:39:52 -0700870
Junio C Hamano17815502007-09-17 00:55:13 -0700871gc.autopacklimit::
872 When there are more than this many packs that are not
873 marked with `*.keep` file in the repository, `git gc
Michele Ballabio80cd9cf2008-01-11 22:11:13 +0100874 --auto` consolidates them into one larger pack. The
Junio C Hamano97063972008-03-23 00:04:48 -0700875 default value is 50. Setting this to 0 disables it.
Junio C Hamano17815502007-09-17 00:55:13 -0700876
Johannes Schindelinc2120e52007-02-13 14:01:42 +0100877gc.packrefs::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500878 'git-gc' does not run `git pack-refs` in a bare repository by
Johannes Schindelinc2120e52007-02-13 14:01:42 +0100879 default so that older dumb-transport clients can still fetch
Jonathan Niederba020ef2008-07-03 00:41:41 -0500880 from the repository. Setting this to `true` lets 'git-gc'
Jonathan Nieder7a7d4ef2008-07-03 00:20:21 -0500881 to run `git pack-refs`. Setting this to `false` tells
Jonathan Niederba020ef2008-07-03 00:41:41 -0500882 'git-gc' never to run `git pack-refs`. The default setting is
Johannes Schindelinc2120e52007-02-13 14:01:42 +0100883 `notbare`. Enable it only when you know you do not have to
884 support such clients. The default setting will change to `true`
885 at some stage, and setting this to `false` will continue to
Jonathan Niederba020ef2008-07-03 00:41:41 -0500886 prevent `git pack-refs` from being run from 'git-gc'.
Johannes Schindelinc2120e52007-02-13 14:01:42 +0100887
Johannes Schindelin25ee9732008-03-12 21:55:47 +0100888gc.pruneexpire::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500889 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
Nicolas Pitre8e8daf32008-12-30 14:45:11 -0500890 Override the grace period with this config variable. The value
891 "now" may be used to disable this grace period and always prune
892 unreachable objects immediately.
Johannes Schindelin25ee9732008-03-12 21:55:47 +0100893
Junio C Hamano4aec56d2006-12-27 01:47:57 -0800894gc.reflogexpire::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500895 'git-reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -0800896 this time; defaults to 90 days.
897
898gc.reflogexpireunreachable::
Jonathan Niederba020ef2008-07-03 00:41:41 -0500899 'git-reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -0800900 this time and are not reachable from the current tip;
901 defaults to 30 days.
902
Junio C Hamano48c32422006-12-27 01:24:05 -0800903gc.rerereresolved::
904 Records of conflicted merge you resolved earlier are
Jonathan Niederba020ef2008-07-03 00:41:41 -0500905 kept for this many days when 'git-rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -0600906 The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -0800907
908gc.rerereunresolved::
909 Records of conflicted merge you have not resolved are
Jonathan Niederba020ef2008-07-03 00:41:41 -0500910 kept for this many days when 'git-rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -0600911 The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -0800912
Fabian Emmes280514e2009-01-02 16:40:13 +0100913gitcvs.commitmsgannotation::
914 Append this string to each commit message. Set to empty string
915 to disable this feature. Defaults to "via git-CVS emulator".
916
Petr Baudis1ab661d2006-04-25 00:59:33 +0200917gitcvs.enabled::
Brian Hetrodb218722007-08-23 20:40:08 -0400918 Whether the CVS server interface is enabled for this repository.
Dan McGee5162e692007-12-29 00:20:38 -0600919 See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200920
921gitcvs.logfile::
Brian Hetrodb218722007-08-23 20:40:08 -0400922 Path to a log file where the CVS server interface well... logs
Dan McGee5162e692007-12-29 00:20:38 -0600923 various stuff. See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200924
Teemu Likonen1707adb2008-08-29 10:29:42 +0300925gitcvs.usecrlfattr::
Matthew Ogilvie8a06a632008-05-14 22:35:47 -0600926 If true, the server will look up the `crlf` attribute for
927 files to determine the '-k' modes to use. If `crlf` is set,
928 the '-k' mode will be left blank, so cvs clients will
929 treat it as text. If `crlf` is explicitly unset, the file
Mike Ralphson1168d402008-08-05 17:12:05 +0100930 will be set with '-kb' mode, which suppresses any newline munging
Matthew Ogilvie8a06a632008-05-14 22:35:47 -0600931 the client might otherwise do. If `crlf` is not specified,
Eric Hanchrowea449612008-07-08 13:02:11 -0700932 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Matthew Ogilvie8a06a632008-05-14 22:35:47 -0600933
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +0200934gitcvs.allbinary::
Matthew Ogilvie90948a42008-05-14 22:35:48 -0600935 This is used if 'gitcvs.usecrlfattr' does not resolve
936 the correct '-kb' mode to use. If true, all
937 unresolved files are sent to the client in
938 mode '-kb'. This causes the client to treat them
939 as binary files, which suppresses any newline munging it
940 otherwise might do. Alternatively, if it is set to "guess",
941 then the contents of the file are examined to decide if
942 it is binary, similar to 'core.autocrlf'.
Junio C Hamanoabbf5942007-04-17 22:17:46 -0700943
Frank Lichtenheld04752862007-04-13 18:13:42 +0200944gitcvs.dbname::
945 Database used by git-cvsserver to cache revision information
946 derived from the git repository. The exact meaning depends on the
947 used database driver, for SQLite (which is the default driver) this
948 is a filename. Supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -0600949 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Frank Lichtenheld04752862007-04-13 18:13:42 +0200950 Default: '%Ggitcvs.%m.sqlite'
951
952gitcvs.dbdriver::
953 Used Perl DBI driver. You can specify any available driver
954 for this here, but it might not work. git-cvsserver is tested
955 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
956 reported *not* to work with 'DBD::mysql'. Experimental feature.
957 May not contain double colons (`:`). Default: 'SQLite'.
Dan McGee5162e692007-12-29 00:20:38 -0600958 See linkgit:git-cvsserver[1].
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +0200959
Frank Lichtenheld04752862007-04-13 18:13:42 +0200960gitcvs.dbuser, gitcvs.dbpass::
961 Database user and password. Only useful if setting 'gitcvs.dbdriver',
962 since SQLite has no concept of database users and/or passwords.
963 'gitcvs.dbuser' supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -0600964 linkgit:git-cvsserver[1] for details).
Frank Lichtenheld04752862007-04-13 18:13:42 +0200965
Josh Elsasser6aeeffd2008-03-27 14:02:14 -0700966gitcvs.dbTableNamePrefix::
967 Database table name prefix. Prepended to the names of any
968 database tables used, allowing a single database to be used
969 for several repositories. Supports variable substitution (see
970 linkgit:git-cvsserver[1] for details). Any non-alphabetic
971 characters will be replaced with underscores.
972
Matthew Ogilvie8a06a632008-05-14 22:35:47 -0600973All gitcvs variables except for 'gitcvs.usecrlfattr' and
974'gitcvs.allbinary' can also be specified as
975'gitcvs.<access_method>.<varname>' (where 'access_method'
Brian Hetro02783072007-08-23 20:44:13 -0400976is one of "ext" and "pserver") to make them apply only for the given
977access method.
Frank Lichtenheld04752862007-04-13 18:13:42 +0200978
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +0200979gui.commitmsgwidth::
980 Defines how wide the commit message window is in the
981 linkgit:git-gui[1]. "75" is the default.
982
983gui.diffcontext::
984 Specifies how many context lines should be used in calls to diff
985 made by the linkgit:git-gui[1]. The default is "5".
986
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +0300987gui.encoding::
988 Specifies the default encoding to use for displaying of
989 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
990 It can be overridden by setting the 'encoding' attribute
991 for relevant files (see linkgit:gitattributes[5]).
992 If this option is not set, the tools default to the
993 locale encoding.
994
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +0200995gui.matchtrackingbranch::
996 Determines if new branches created with linkgit:git-gui[1] should
997 default to tracking remote branches with matching names or
998 not. Default: "false".
999
1000gui.newbranchtemplate::
1001 Is used as suggested name when creating new branches using the
1002 linkgit:git-gui[1].
1003
1004gui.pruneduringfetch::
1005 "true" if linkgit:git-gui[1] should prune tracking branches when
1006 performing a fetch. The default value is "false".
1007
1008gui.trustmtime::
1009 Determines if linkgit:git-gui[1] should trust the file modification
1010 timestamp or not. By default the timestamps are not trusted.
1011
1012gui.spellingdictionary::
1013 Specifies the dictionary used for spell checking commit messages in
1014 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1015 off.
1016
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001017gui.fastcopyblame::
1018 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
1019 location detection. It makes blame significantly faster on huge
1020 repositories at the expense of less thorough copy detection.
1021
1022gui.copyblamethreshold::
Ralf Wildenhues76bac892008-11-27 08:32:01 +01001023 Specifies the threshold to use in 'git gui blame' original location
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001024 detection, measured in alphanumeric characters. See the
1025 linkgit:git-blame[1] manual for more information on copy detection.
1026
1027gui.blamehistoryctx::
1028 Specifies the radius of history context in days to show in
1029 linkgit:gitk[1] for the selected commit, when the `Show History
1030 Context` menu item is invoked from 'git gui blame'. If this
1031 variable is set to zero, the whole history is shown.
1032
Alexander Gavrilov390c3482008-12-14 22:44:32 +03001033guitool.<name>.cmd::
1034 Specifies the shell command line to execute when the corresponding item
1035 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1036 mandatory for every tool. The command is executed from the root of
1037 the working directory, and in the environment it receives the name of
1038 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1039 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1040 the head is detached, 'CUR_BRANCH' is empty).
1041
1042guitool.<name>.needsfile::
1043 Run the tool only if a diff is selected in the GUI. It guarantees
1044 that 'FILENAME' is not empty.
1045
1046guitool.<name>.noconsole::
1047 Run the command silently, without creating a window to display its
1048 output.
1049
1050guitool.<name>.norescan::
1051 Don't rescan the working directory for changes after the tool
1052 finishes execution.
1053
1054guitool.<name>.confirm::
1055 Show a confirmation dialog before actually running the tool.
1056
1057guitool.<name>.argprompt::
1058 Request a string argument from the user, and pass it to the tool
1059 through the 'ARGS' environment variable. Since requesting an
1060 argument implies confirmation, the 'confirm' option has no effect
1061 if this is enabled. If the option is set to 'true', 'yes', or '1',
1062 the dialog uses a built-in generic prompt; otherwise the exact
1063 value of the variable is used.
1064
1065guitool.<name>.revprompt::
1066 Request a single valid revision from the user, and set the
1067 'REVISION' environment variable. In other aspects this option
1068 is similar to 'argprompt', and can be used together with it.
1069
1070guitool.<name>.revunmerged::
1071 Show only unmerged branches in the 'revprompt' subdialog.
1072 This is useful for tools similar to merge or rebase, but not
1073 for things like checkout or reset.
1074
1075guitool.<name>.title::
1076 Specifies the title to use for the prompt dialog. The default
1077 is the tool name.
1078
1079guitool.<name>.prompt::
1080 Specifies the general prompt string to display at the top of
1081 the dialog, before subsections for 'argprompt' and 'revprompt'.
1082 The default value includes the actual command.
1083
Christian Couder983a9ee2008-01-08 04:55:14 +01001084help.browser::
1085 Specify the browser that will be used to display help in the
1086 'web' format. See linkgit:git-help[1].
1087
1088help.format::
1089 Override the default help format used by linkgit:git-help[1].
1090 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1091 the default. 'web' and 'html' are the same.
1092
Alex Riesenf0e90712008-08-31 15:54:58 +02001093help.autocorrect::
1094 Automatically correct and execute mistyped commands after
1095 waiting for the given number of deciseconds (0.1 sec). If more
1096 than one command can be deduced from the entered text, nothing
1097 will be executed. If the value of this option is negative,
1098 the corrected command will be executed immediately. If the
1099 value is 0 - the command will be just shown but not executed.
1100 This is the default.
1101
Sam Vilain9c5665a2007-11-23 13:07:00 +13001102http.proxy::
1103 Override the HTTP proxy, normally configured using the 'http_proxy'
Dan McGee5162e692007-12-29 00:20:38 -06001104 environment variable (see linkgit:curl[1]). This can be overridden
Sam Vilain14c98212007-12-04 10:48:54 +13001105 on a per-remote basis; see remote.<name>.proxy
Sam Vilain9c5665a2007-11-23 13:07:00 +13001106
Petr Baudis1ab661d2006-04-25 00:59:33 +02001107http.sslVerify::
1108 Whether to verify the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001109 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001110 variable.
1111
1112http.sslCert::
1113 File containing the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001114 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001115 variable.
1116
1117http.sslKey::
1118 File containing the SSL private key when fetching or pushing
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001119 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001120 variable.
1121
Mark Lodato754ae192009-05-27 23:16:03 -04001122http.sslCertPasswordProtected::
1123 Enable git's password prompt for the SSL certificate. Otherwise
1124 OpenSSL will prompt the user, possibly many times, if the
1125 certificate or private key is encrypted. Can be overridden by the
1126 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1127
Petr Baudis1ab661d2006-04-25 00:59:33 +02001128http.sslCAInfo::
1129 File containing the certificates to verify the peer with when
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001130 fetching or pushing over HTTPS. Can be overridden by the
Petr Baudis1ab661d2006-04-25 00:59:33 +02001131 'GIT_SSL_CAINFO' environment variable.
1132
1133http.sslCAPath::
1134 Path containing files with the CA certificates to verify the peer
Francis Daly37425062006-06-07 13:56:45 +01001135 with when fetching or pushing over HTTPS. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001136 by the 'GIT_SSL_CAPATH' environment variable.
1137
1138http.maxRequests::
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001139 How many HTTP requests to launch in parallel. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001140 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1141
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -07001142http.postBuffer::
1143 Maximum size in bytes of the buffer used by smart HTTP
1144 transports when POSTing data to the remote system.
1145 For requests larger than this buffer size, HTTP/1.1 and
1146 Transfer-Encoding: chunked is used to avoid creating a
1147 massive pack file locally. Default is 1 MiB, which is
1148 sufficient for most requests.
1149
Petr Baudis1ab661d2006-04-25 00:59:33 +02001150http.lowSpeedLimit, http.lowSpeedTime::
1151 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1152 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001153 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Petr Baudis1ab661d2006-04-25 00:59:33 +02001154 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1155
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001156http.noEPSV::
1157 A boolean which disables using of EPSV ftp command by curl.
Frank Lichtenheldbefc9c42007-04-13 18:02:33 +02001158 This can helpful with some "poor" ftp servers which don't
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001159 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1160 environment variable. Default is false (curl will use EPSV).
1161
Petr Baudis1ab661d2006-04-25 00:59:33 +02001162i18n.commitEncoding::
1163 Character encoding the commit messages are stored in; git itself
1164 does not care per se, but this information is necessary e.g. when
1165 importing commits from emails or in the gitk graphical history
1166 browser (and possibly at other places in the future or in other
Dan McGee5162e692007-12-29 00:20:38 -06001167 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Petr Baudis1ab661d2006-04-25 00:59:33 +02001168
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001169i18n.logOutputEncoding::
1170 Character encoding the commit messages are converted to when
Jonathan Niederba020ef2008-07-03 00:41:41 -05001171 running 'git-log' and friends.
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001172
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001173imap::
1174 The configuration variables in the 'imap' section are described
1175 in linkgit:git-imap-send[1].
1176
Christian Couder983a9ee2008-01-08 04:55:14 +01001177instaweb.browser::
1178 Specify the program that will be used to browse your working
1179 repository in gitweb. See linkgit:git-instaweb[1].
1180
1181instaweb.httpd::
1182 The HTTP daemon command-line to start gitweb on your working
1183 repository. See linkgit:git-instaweb[1].
1184
1185instaweb.local::
1186 If true the web server started by linkgit:git-instaweb[1] will
1187 be bound to the local IP (127.0.0.1).
1188
1189instaweb.modulepath::
1190 The module path for an apache httpd used by linkgit:git-instaweb[1].
1191
1192instaweb.port::
1193 The port number to bind the gitweb httpd to. See
1194 linkgit:git-instaweb[1].
1195
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001196interactive.singlekey::
Ori Avtalion57f6ec02009-08-07 17:24:21 +03001197 In interactive commands, allow the user to provide one-letter
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001198 input with a single key (i.e., without hitting enter).
1199 Currently this is used only by the `\--patch` mode of
1200 linkgit:git-add[1]. Note that this setting is silently
1201 ignored if portable keystroke input is not available.
1202
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001203log.date::
1204 Set default date-time mode for the log command. Setting log.date
Jonathan Nieder0979c102008-07-03 00:37:18 -05001205 value is similar to using 'git-log'\'s --date option. The value is one of the
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001206 following alternatives: {relative,local,default,iso,rfc,short}.
1207 See linkgit:git-log[1].
1208
Peter Baumann0f03ca92006-11-23 10:36:33 +01001209log.showroot::
1210 If true, the initial commit will be shown as a big creation event.
1211 This is equivalent to a diff against an empty tree.
Dan McGee5162e692007-12-29 00:20:38 -06001212 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Peter Baumann0f03ca92006-11-23 10:36:33 +01001213 normally hide the root commit will now show it. True by default.
1214
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001215mailmap.file::
1216 The location of an augmenting mailmap file. The default
1217 mailmap, located in the root of the repository, is loaded
1218 first, then the mailmap file pointed to by this variable.
1219 The location of the mailmap file may be in a repository
1220 subdirectory, or somewhere outside of the repository itself.
1221 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1222
Christian Couderb5578f32008-03-07 08:46:55 +01001223man.viewer::
Christian Couderb8322ea2008-03-13 06:48:46 +01001224 Specify the programs that may be used to display help in the
Christian Couderb5578f32008-03-07 08:46:55 +01001225 'man' format. See linkgit:git-help[1].
1226
Christian Couder0bb64002008-04-25 08:25:35 +02001227man.<tool>.cmd::
1228 Specify the command to invoke the specified man viewer. The
1229 specified command is evaluated in shell with the man page
1230 passed as argument. (See linkgit:git-help[1].)
1231
Christian Couder7e8114c2008-04-25 08:24:41 +02001232man.<tool>.path::
1233 Override the path for the given tool that may be used to
1234 display help in the 'man' format. See linkgit:git-help[1].
1235
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001236include::merge-config.txt[]
Junio C Hamanob5412482008-08-29 10:49:56 -07001237
Johannes Schindelin77680ca2007-12-17 12:21:22 +00001238mergetool.<tool>.path::
1239 Override the path for the given tool. This is useful in case
1240 your tool is not in the PATH.
1241
Charles Bailey964473a2008-02-21 23:31:12 +00001242mergetool.<tool>.cmd::
1243 Specify the command to invoke the specified merge tool. The
1244 specified command is evaluated in shell with the following
1245 variables available: 'BASE' is the name of a temporary file
1246 containing the common base of the files to be merged, if available;
1247 'LOCAL' is the name of a temporary file containing the contents of
1248 the file on the current branch; 'REMOTE' is the name of a temporary
1249 file containing the contents of the file from the branch being
1250 merged; 'MERGED' contains the name of the file to which the merge
1251 tool should write the results of a successful merge.
1252
1253mergetool.<tool>.trustExitCode::
1254 For a custom merge command, specify whether the exit code of
1255 the merge command can be used to determine whether the merge was
1256 successful. If this is not set to true then the merge target file
1257 timestamp is checked and the merge assumed to have been successful
1258 if the file has been updated, otherwise the user is prompted to
1259 indicate the success of the merge.
1260
Charles Bailey44c36d12008-02-21 23:30:02 +00001261mergetool.keepBackup::
1262 After performing a merge, the original file with conflict markers
1263 can be saved as a file with a `.orig` extension. If this variable
1264 is set to `false` then this file is not preserved. Defaults to
1265 `true` (i.e. keep the backup files).
1266
Charles Bailey162eba82008-12-12 21:48:41 +00001267mergetool.keepTemporaries::
1268 When invoking a custom merge tool, git uses a set of temporary
1269 files to pass to the tool. If the tool returns an error and this
1270 variable is set to `true`, then these temporary files will be
1271 preserved, otherwise they will be removed after the tool has
1272 exited. Defaults to `false`.
1273
Charles Bailey682b4512008-11-13 12:41:14 +00001274mergetool.prompt::
1275 Prompt before each invocation of the merge resolution program.
1276
Jeff King4812a932006-07-23 01:50:30 -04001277pack.window::
Dan McGee5162e692007-12-29 00:20:38 -06001278 The size of the window used by linkgit:git-pack-objects[1] when no
Jeff King4812a932006-07-23 01:50:30 -04001279 window size is given on the command line. Defaults to 10.
1280
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001281pack.depth::
Dan McGee5162e692007-12-29 00:20:38 -06001282 The maximum delta depth used by linkgit:git-pack-objects[1] when no
Theodore Ts'o618e6132007-05-08 09:28:26 -04001283 maximum depth is given on the command line. Defaults to 50.
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001284
Brian Downinge93b15c2007-07-12 07:55:52 -05001285pack.windowMemory::
Dan McGee5162e692007-12-29 00:20:38 -06001286 The window memory size limit used by linkgit:git-pack-objects[1]
Brian Downinge93b15c2007-07-12 07:55:52 -05001287 when no limit is given on the command line. The value can be
1288 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1289 limit.
1290
Dana How960ccca2007-05-09 13:56:50 -07001291pack.compression::
1292 An integer -1..9, indicating the compression level for objects
1293 in a pack file. -1 is the zlib default. 0 means no
1294 compression, and 1..9 are various speed/size tradeoffs, 9 being
1295 slowest. If not set, defaults to core.compression. If that is
Brian Downingdec92302007-11-19 10:58:51 -06001296 not set, defaults to -1, the zlib default, which is "a default
1297 compromise between speed and compression (currently equivalent
1298 to level 6)."
Dana How960ccca2007-05-09 13:56:50 -07001299
Martin Koegler074b2ee2007-05-28 23:20:58 +02001300pack.deltaCacheSize::
Brian Hetro02783072007-08-23 20:44:13 -04001301 The maximum memory in bytes used for caching deltas in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001302 linkgit:git-pack-objects[1] before writing them out to a pack.
1303 This cache is used to speed up the writing object phase by not
1304 having to recompute the final delta result once the best match
1305 for all objects is found. Repacking large repositories on machines
1306 which are tight with memory might be badly impacted by this though,
1307 especially if this cache pushes the system into swapping.
1308 A value of 0 means no limit. The smallest size of 1 byte may be
1309 used to virtually disable this cache. Defaults to 256 MiB.
Martin Koegler074b2ee2007-05-28 23:20:58 +02001310
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001311pack.deltaCacheLimit::
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001312 The maximum size of a delta, that is cached in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001313 linkgit:git-pack-objects[1]. This cache is used to speed up the
1314 writing object phase by not having to recompute the final delta
1315 result once the best match for all objects is found. Defaults to 1000.
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001316
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001317pack.threads::
1318 Specifies the number of threads to spawn when searching for best
Dan McGee5162e692007-12-29 00:20:38 -06001319 delta matches. This requires that linkgit:git-pack-objects[1]
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001320 be compiled with pthreads otherwise this option is ignored with a
1321 warning. This is meant to reduce packing time on multiprocessor
1322 machines. The required amount of memory for the delta search window
1323 is however multiplied by the number of threads.
Andreas Ericsson833e3df2008-02-22 20:11:56 -06001324 Specifying 0 will cause git to auto-detect the number of CPU's
1325 and set the number of threads accordingly.
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001326
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001327pack.indexVersion::
1328 Specify the default pack index version. Valid values are 1 for
1329 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1330 the new pack index with capabilities for packs larger than 4 GB
1331 as well as proper protection against the repacking of corrupted
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001332 packs. Version 2 is the default. Note that version 2 is enforced
1333 and this config option ignored whenever the corresponding pack is
1334 larger than 2 GB.
1335+
1336If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1337cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1338that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1339other side may give you a repository that cannot be accessed with your
1340older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1341you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1342the `{asterisk}.idx` file.
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001343
Junio C Hamanodbdbfec2008-03-12 23:11:15 -07001344pack.packSizeLimit::
Johannes Schindelin2b84b5a2008-02-05 14:25:04 +00001345 The default maximum size of a pack. This setting only affects
1346 packing to a file, i.e. the git:// protocol is unaffected. It
1347 can be overridden by the `\--max-pack-size` option of
1348 linkgit:git-repack[1].
1349
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001350pager.<cmd>::
Jonathan Nieder32818082008-08-24 00:38:06 -05001351 Allows turning on or off pagination of the output of a
1352 particular git subcommand when writing to a tty. If
1353 `\--paginate` or `\--no-pager` is specified on the command line,
1354 it takes precedence over this option. To disable pagination for
Chris Johnsendcb11262009-03-15 06:30:52 -05001355 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001356
Petr Baudis1ab661d2006-04-25 00:59:33 +02001357pull.octopus::
1358 The default merge strategy to use when pulling multiple branches
1359 at once.
1360
1361pull.twohead::
1362 The default merge strategy to use when pulling a single branch.
1363
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001364push.default::
1365 Defines the action git push should take if no refspec is given
1366 on the command line, no refspec is configured in the remote, and
1367 no refspec is implied by any of the options given on the command
Santi Béjar01eadaf2009-03-30 12:11:41 +02001368 line. Possible values are:
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001369+
1370* `nothing` do not push anything.
Santi Béjar01eadaf2009-03-30 12:11:41 +02001371* `matching` push all matching branches.
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001372 All branches having the same name in both ends are considered to be
Santi Béjar01eadaf2009-03-30 12:11:41 +02001373 matching. This is the default.
Santi Béjare892dc72009-04-07 01:24:30 +02001374* `tracking` push the current branch to its upstream branch.
Santi Béjar01eadaf2009-03-30 12:11:41 +02001375* `current` push the current branch to a branch of the same name.
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001376
Tor Arne Vestbøa9c38212009-03-01 23:11:38 +01001377rebase.stat::
1378 Whether to show a diffstat of what changed upstream since the last
1379 rebase. False by default.
1380
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001381receive.autogc::
1382 By default, git-receive-pack will run "git-gc --auto" after
1383 receiving data from git-push and updating refs. You can stop
1384 it by setting this variable to false.
1385
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001386receive.fsckObjects::
1387 If it is set to true, git-receive-pack will check all received
1388 objects. It will abort in the case of a malformed object or a
1389 broken link. The result of an abort are only dangling objects.
1390 Defaults to false.
1391
1392receive.unpackLimit::
1393 If the number of objects received in a push is below this
1394 limit then the objects will be unpacked into loose object
1395 files. However if the number of received objects equals or
1396 exceeds this limit then the received pack will be stored as
1397 a pack, after adding any missing delta bases. Storing the
1398 pack from a push can make the push operation complete faster,
1399 especially on slow filesystems. If not set, the value of
1400 `transfer.unpackLimit` is used instead.
1401
Junio C Hamano42fc11c2008-11-26 11:11:18 -08001402receive.denyDeletes::
1403 If set to true, git-receive-pack will deny a ref update that deletes
1404 the ref. Use this to prevent such a ref deletion via a push.
1405
1406receive.denyCurrentBranch::
1407 If set to true or "refuse", receive-pack will deny a ref update
1408 to the currently checked out branch of a non-bare repository.
1409 Such a push is potentially dangerous because it brings the HEAD
1410 out of sync with the index and working tree. If set to "warn",
1411 print a warning of such a push to stderr, but allow the push to
1412 proceed. If set to false or "ignore", allow such pushes with no
1413 message. Defaults to "warn".
1414
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001415receive.denyNonFastForwards::
1416 If set to true, git-receive-pack will deny a ref update which is
Felipe Contrerasa75d7b52009-10-24 11:31:32 +03001417 not a fast-forward. Use this to prevent such an update via a push,
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001418 even if that push is forced. This configuration variable is
1419 set when initializing a shared repository.
1420
Junio C Hamano77e3efb2009-10-20 14:56:40 -07001421receive.updateserverinfo::
1422 If set to true, git-receive-pack will run git-update-server-info
1423 after receiving data from git-push and updating refs.
1424
Santi Béjar0cc6d342006-10-23 18:42:14 +02001425remote.<name>.url::
Dan McGee5162e692007-12-29 00:20:38 -06001426 The URL of a remote repository. See linkgit:git-fetch[1] or
1427 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001428
Michael J Gruber20346232009-06-09 18:01:34 +02001429remote.<name>.pushurl::
1430 The push URL of a remote repository. See linkgit:git-push[1].
1431
Sam Vilain14c98212007-12-04 10:48:54 +13001432remote.<name>.proxy::
1433 For remotes that require curl (http, https and ftp), the URL to
1434 the proxy to use for that remote. Set to the empty string to
1435 disable proxying for that remote.
1436
Santi Béjar0cc6d342006-10-23 18:42:14 +02001437remote.<name>.fetch::
Dan McGee5162e692007-12-29 00:20:38 -06001438 The default set of "refspec" for linkgit:git-fetch[1]. See
1439 linkgit:git-fetch[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001440
1441remote.<name>.push::
Dan McGee5162e692007-12-29 00:20:38 -06001442 The default set of "refspec" for linkgit:git-push[1]. See
1443 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02001444
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02001445remote.<name>.mirror::
1446 If true, pushing to this remote will automatically behave
1447 as if the `\--mirror` option was given on the command line.
1448
Theodore Ts'o19182782007-02-20 15:13:43 -05001449remote.<name>.skipDefaultUpdate::
1450 If true, this remote will be skipped by default when updating
Björn Gustavsson7cc91a22009-11-09 21:11:06 +01001451 using linkgit:git-fetch[1] or the `update` subcommand of
1452 linkgit:git-remote[1].
1453
1454remote.<name>.skipFetchAll::
1455 If true, this remote will be skipped by default when updating
1456 using linkgit:git-fetch[1] or the `update` subcommand of
1457 linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001458
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001459remote.<name>.receivepack::
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001460 The default program to execute on the remote side when pushing. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001461 option \--receive-pack of linkgit:git-push[1].
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01001462
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001463remote.<name>.uploadpack::
1464 The default program to execute on the remote side when fetching. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001465 option \--upload-pack of linkgit:git-fetch-pack[1].
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01001466
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301467remote.<name>.tagopt::
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01001468 Setting this value to \--no-tags disables automatic tag following when
1469 fetching from remote <name>
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05301470
Theodore Ts'o19182782007-02-20 15:13:43 -05001471remotes.<group>::
1472 The list of remotes which are fetched by "git remote update
Dan McGee5162e692007-12-29 00:20:38 -06001473 <group>". See linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05001474
Junio C Hamanob6945f52006-10-13 21:28:58 -07001475repack.usedeltabaseoffset::
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04001476 By default, linkgit:git-repack[1] creates packs that use
1477 delta-base offset. If you need to share your repository with
1478 git older than version 1.4.4, either directly or via a dumb
1479 protocol such as http, then you need to set this option to
1480 "false" and repack. Access from old git versions over the
1481 native protocol are unaffected by this option.
Junio C Hamanob6945f52006-10-13 21:28:58 -07001482
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001483rerere.autoupdate::
1484 When set to true, `git-rerere` updates the index with the
1485 resulting contents after it cleanly resolves conflicts using
1486 previously recorded resolution. Defaults to false.
1487
1488rerere.enabled::
1489 Activate recording of resolved conflicts, so that identical
1490 conflict hunks can be resolved automatically, should they
1491 be encountered again. linkgit:git-rerere[1] command is by
1492 default enabled if you create `rr-cache` directory under
1493 `$GIT_DIR`, but can be disabled by setting this option to false.
1494
Yann Dirson65180c62009-07-22 23:39:30 +02001495sendemail.identity::
1496 A configuration identity. When given, causes values in the
1497 'sendemail.<identity>' subsection to take precedence over
1498 values in the 'sendemail' section. The default identity is
1499 the value of 'sendemail.identity'.
1500
1501sendemail.smtpencryption::
1502 See linkgit:git-send-email[1] for description. Note that this
1503 setting is not subject to the 'identity' mechanism.
1504
1505sendemail.smtpssl::
1506 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1507
1508sendemail.<identity>.*::
1509 Identity-specific versions of the 'sendemail.*' parameters
1510 found below, taking precedence over those when the this
1511 identity is selected, through command-line or
1512 'sendemail.identity'.
1513
1514sendemail.aliasesfile::
1515sendemail.aliasfiletype::
1516sendemail.bcc::
1517sendemail.cc::
1518sendemail.cccmd::
1519sendemail.chainreplyto::
1520sendemail.confirm::
1521sendemail.envelopesender::
1522sendemail.from::
1523sendemail.multiedit::
1524sendemail.signedoffbycc::
1525sendemail.smtppass::
1526sendemail.suppresscc::
1527sendemail.suppressfrom::
1528sendemail.to::
1529sendemail.smtpserver::
1530sendemail.smtpserverport::
1531sendemail.smtpuser::
1532sendemail.thread::
1533sendemail.validate::
1534 See linkgit:git-send-email[1] for description.
1535
1536sendemail.signedoffcc::
1537 Deprecated alias for 'sendemail.signedoffbycc'.
1538
Petr Baudis1ab661d2006-04-25 00:59:33 +02001539showbranch.default::
Dan McGee5162e692007-12-29 00:20:38 -06001540 The default set of branches for linkgit:git-show-branch[1].
1541 See linkgit:git-show-branch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001542
Jeff King46f721c2007-12-07 16:26:07 -05001543status.relativePaths::
Dan McGee5162e692007-12-29 00:20:38 -06001544 By default, linkgit:git-status[1] shows paths relative to the
Jeff King46f721c2007-12-07 16:26:07 -05001545 current directory. Setting this variable to `false` shows paths
1546 relative to the repository root (this was the default for git
1547 prior to v1.5.4).
1548
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02001549status.showUntrackedFiles::
1550 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1551 files which are not currently tracked by Git. Directories which
1552 contain only untracked files, are shown with the directory name
1553 only. Showing untracked files means that Git needs to lstat() all
1554 all the files in the whole repository, which might be slow on some
1555 systems. So, this variable controls how the commands displays
1556 the untracked files. Possible values are:
1557+
1558--
1559 - 'no' - Show no untracked files
1560 - 'normal' - Shows untracked files and directories
1561 - 'all' - Shows also individual files in untracked directories.
1562--
1563+
1564If this variable is not specified, it defaults to 'normal'.
1565This variable can be overridden with the -u|--untracked-files option
1566of linkgit:git-status[1] and linkgit:git-commit[1].
1567
Willy Tarreauce1a79b2006-07-20 11:30:44 +02001568tar.umask::
René Scharfe687157c2007-08-21 20:01:16 +02001569 This variable can be used to restrict the permission bits of
1570 tar archive entries. The default is 0002, which turns off the
1571 world write bit. The special value "user" indicates that the
1572 archiving user's umask will be used instead. See umask(2) and
Dan McGee5162e692007-12-29 00:20:38 -06001573 linkgit:git-archive[1].
Willy Tarreauce1a79b2006-07-20 11:30:44 +02001574
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001575transfer.unpackLimit::
1576 When `fetch.unpackLimit` or `receive.unpackLimit` are
1577 not set, the value of this variable is used instead.
1578 The default value is 100.
1579
Daniel Barkalow55029ae2008-02-20 13:43:53 -05001580url.<base>.insteadOf::
1581 Any URL that starts with this value will be rewritten to
1582 start, instead, with <base>. In cases where some site serves a
1583 large number of repositories, and serves them with multiple
1584 access methods, and some users need to use different access
1585 methods, this feature allows people to specify any of the
1586 equivalent URLs and have git automatically rewrite the URL to
1587 the best alternative for the particular user, even for a
Junio C Hamano844112c2008-02-24 22:25:04 -08001588 never-before-seen repository on the site. When more than one
1589 insteadOf strings match a given URL, the longest match is used.
Daniel Barkalow55029ae2008-02-20 13:43:53 -05001590
Josh Triplett1c2eafb2009-09-07 01:56:33 -07001591url.<base>.pushInsteadOf::
1592 Any URL that starts with this value will not be pushed to;
1593 instead, it will be rewritten to start with <base>, and the
1594 resulting URL will be pushed to. In cases where some site serves
1595 a large number of repositories, and serves them with multiple
1596 access methods, some of which do not allow push, this feature
1597 allows people to specify a pull-only URL and have git
1598 automatically use an appropriate URL to push, even for a
1599 never-before-seen repository on the site. When more than one
1600 pushInsteadOf strings match a given URL, the longest match is
1601 used. If a remote has an explicit pushurl, git will ignore this
1602 setting for that remote.
1603
Petr Baudis1ab661d2006-04-25 00:59:33 +02001604user.email::
1605 Your email address to be recorded in any newly created commits.
Josh Triplett28a94f82007-04-28 18:40:28 -07001606 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Dan McGee5162e692007-12-29 00:20:38 -06001607 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001608
1609user.name::
1610 Your full name to be recorded in any newly created commits.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001611 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Dan McGee5162e692007-12-29 00:20:38 -06001612 environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001613
Andy Parkinsd67778e2007-01-26 14:13:46 +00001614user.signingkey::
Dan McGee5162e692007-12-29 00:20:38 -06001615 If linkgit:git-tag[1] is not selecting the key you want it to
Andy Parkinsd67778e2007-01-26 14:13:46 +00001616 automatically when creating a signed tag, you can override the
1617 default selection with this variable. This option is passed
1618 unchanged to gpg's --local-user parameter, so you may specify a key
1619 using any method that gpg supports.
1620
Christian Couder983a9ee2008-01-08 04:55:14 +01001621web.browser::
1622 Specify a web browser that may be used by some commands.
1623 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1624 may use it.