]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/config.txt
Merge branch 'ef/help-cmd-prefix'
[thirdparty/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
773002a7 5the git command's behavior. The `.git/config` file in each repository
66e35fcb
SB
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
773002a7 8fallback values for the `.git/config` file. The file `/etc/gitconfig`
66e35fcb 9can be used to store a system-wide default configuration.
5ea5621f 10
b7ee2266
SB
11The 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
1ab661dd
PB
14dot-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
e136f33b
JN
18Syntax
19~~~~~~
20
1ab661dd 21The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
22ignored. 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
dcb11263 28characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
29must belong to some section, which means that there must be a section
30header before the first setting of a variable.
e136f33b
JN
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
773002a7 34in the section header, like in the example below:
e136f33b
JN
35
36--------
37 [section "subsection"]
38
39--------
40
b7ee2266
SB
41Subsection 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
e136f33b
JN
44lines. 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
773002a7
SB
48There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
e136f33b 51
2ceb639f
NS
52All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
e136f33b
JN
54'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
dcb11263 57characters and `-` are allowed. There can be more than one value
e136f33b
JN
58for 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,
0cbcf7ad 650/1, true/false or on/off. Case is not significant in boolean values, when
e136f33b 66converting value to the canonical form using '--bool' type specifier;
0b444cdb 67'git config' will ensure that the output is "true" or "false".
e136f33b
JN
68
69String values may be entirely or partially enclosed in double quotes.
773002a7
SB
70You 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
dcb11263 74be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 75
dcb11263
CJ
76The 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
e136f33b
JN
79char sequences are valid.
80
773002a7 81Variable values ending in a `\` are continued on the next line in the
e136f33b
JN
82customary UNIX fashion.
83
773002a7 84Some variables may require a special value format.
1ab661dd
PB
85
86Example
87~~~~~~~
88
89 # Core variables
90 [core]
91 ; Don't trust file modes
92 filemode = false
93
94 # Our diff algorithm
95 [diff]
6bb9e51b 96 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
97 renames = true
98
910c00c8
AK
99 [branch "devel"]
100 remote = origin
101 merge = refs/heads/devel
102
e136f33b
JN
103 # Proxy settings
104 [core]
29093c28 105 gitProxy="ssh" for "kernel.org"
e136f33b 106 gitProxy=default-proxy ; for the rest
910c00c8 107
1ab661dd
PB
108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
114porcelain configuration variables in the respective porcelain documentation.
115
75194438
JK
116advice.*::
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.
edf563fb
JK
125 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.
4c371f91
MM
129 commitBeforeMerge::
130 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 131 merge to avoid overwriting local changes.
4c371f91 132 Default: true.
d38a30df
MM
133 resolveConflict::
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
136 Default: true.
b706fcfe
JK
137 implicitIdentity::
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
13be3e31
JH
141
142 detachedHead::
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
75194438
JK
146--
147
1ab661dd
PB
148core.fileMode::
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
7b357240
MO
151 See linkgit:git-update-index[1].
152+
153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154will probe and set core.fileMode false if appropriate when the
155repository is created.
1ab661dd 156
adbc0b6b
DP
157core.ignoreCygwinFSTricks::
158 This option is only used by Cygwin implementation of Git. If false,
159 the Cygwin stat() and lstat() functions are used. This may be useful
160 if your repository consists of a few separate directories joined in
161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162 whenever it is possible and falls back to Cygwin functions only to
163 handle symbol links. The native mode is more than twice faster than
7faee6b8
ML
164 normal Cygwin l/stat() functions. True by default, unless core.filemode
165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166 POSIX emulation is required to support core.filemode.
adbc0b6b 167
7b357240
MO
168core.ignorecase::
169 If true, this option enables various workarounds to enable
170 git to work better on filesystems that are not case sensitive,
171 like FAT. For example, if a directory listing finds
172 "makefile" when git expects "Makefile", git will assume
173 it is really the same file, and continue to remember it as
174 "Makefile".
175+
176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177will probe and set core.ignorecase true if appropriate when the repository
178is created.
179
1ce4790b
AR
180core.trustctime::
181 If false, the ctime differences between the index and the
182 working copy are ignored; useful when the inode change time
183 is regularly modified by something outside Git (file system
184 crawlers and some backup systems).
185 See linkgit:git-update-index[1]. True by default.
186
9378c161 187core.quotepath::
5833d730
JN
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
9378c161
JH
190 "unusual" characters in the pathname by enclosing the
191 pathname in a double-quote pair and with backslashes the
192 same way strings in C source code are quoted. If this
193 variable is set to false, the bytes higher than 0x80 are
194 not quoted but output as verbatim. Note that double
195 quote, backslash and control characters are always
196 quoted without `-z` regardless of the setting of this
197 variable.
198
942e7747
EB
199core.eol::
200 Sets the line ending type to use in the working directory for
201 files that have the `text` property set. Alternatives are
202 'lf', 'crlf' and 'native', which uses the platform's native
203 line ending. The default value is `native`. See
204 linkgit:gitattributes[5] for more information on end-of-line
205 conversion.
5cb71f82 206
21e5ad50 207core.safecrlf::
fd6cce9e
EB
208 If true, makes git check if converting `CRLF` is reversible when
209 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
210 modifies a file in the work tree either directly or indirectly.
211 For example, committing a file followed by checking out the
212 same file should yield the original file in the work tree. If
213 this is not the case for the current setting of
214 `core.autocrlf`, git will reject the file. The variable can
215 be set to "warn", in which case git will only warn about an
216 irreversible conversion but continue the operation.
217+
218CRLF conversion bears a slight chance of corrupting data.
942e7747 219When it is enabled, git will convert CRLF to LF during commit and LF to
21e5ad50
SP
220CRLF during checkout. A file that contains a mixture of LF and
221CRLF before the commit cannot be recreated by git. For text
222files this is the right thing to do: it corrects line endings
223such that we have only LF line endings in the repository.
224But for binary files that are accidentally classified as text the
225conversion can corrupt data.
226+
227If you recognize such corruption early you can easily fix it by
228setting the conversion type explicitly in .gitattributes. Right
229after committing you still have the original file in your work
230tree and this file is not yet corrupted. You can explicitly tell
231git that this file is binary and git will handle the file
232appropriately.
233+
234Unfortunately, the desired effect of cleaning up text files with
235mixed line endings and the undesired effect of corrupting binary
236files cannot be distinguished. In both cases CRLFs are removed
237in an irreversible way. For text files this is the right thing
238to do because CRLFs are line endings, while for binary files
239converting CRLFs corrupts data.
240+
241Note, this safety check does not mean that a checkout will generate a
242file identical to the original file for a different setting of
942e7747
EB
243`core.eol` and `core.autocrlf`, but only for the current one. For
244example, a text file with `LF` would be accepted with `core.eol=lf`
245and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
246resulting file would contain `CRLF`, although the original file
247contained `LF`. However, in both work trees the line endings would be
248consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249file with mixed line endings would be reported by the `core.safecrlf`
250mechanism.
251
942e7747
EB
252core.autocrlf::
253 Setting this variable to "true" is almost the same as setting
254 the `text` attribute to "auto" on all files except that text
255 files are not guaranteed to be normalized: files that contain
256 `CRLF` in the repository will not be touched. Use this
257 setting if you want to have `CRLF` line endings in your
258 working directory even though the repository does not have
259 normalized line endings. This variable can be set to 'input',
260 in which case no output conversion is performed.
261
78a8d641
JS
262core.symlinks::
263 If false, symbolic links are checked out as small plain files that
5162e697
DM
264 contain the link text. linkgit:git-update-index[1] and
265 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 266 file. Useful on filesystems like FAT that do not support
7b357240
MO
267 symbolic links.
268+
269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270will probe and set core.symlinks false if appropriate when the repository
271is created.
78a8d641 272
1ab661dd
PB
273core.gitProxy::
274 A "proxy command" to execute (as 'command host port') instead
275 of establishing direct connection to the remote server when
276 using the git protocol for fetching. If the variable value is
277 in the "COMMAND for DOMAIN" format, the command is applied only
278 on hostnames ending with the specified domain string. This variable
279 may be set multiple times and is matched in the given order;
280 the first match wins.
b8936cf0
FD
281+
282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283(which always applies universally, without the special "for"
284handling).
642d0844
ES
285+
286The special string `none` can be used as the proxy command to
287specify that no proxy be used for a given domain pattern.
288This is useful for excluding servers inside a firewall from
289proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
290
291core.ignoreStat::
b7f685a7
MSO
292 If true, commands which modify both the working tree and the index
293 will mark the updated paths with the "assume unchanged" bit in the
294 index. These marked files are then assumed to stay unchanged in the
295 working copy, until you mark them otherwise manually - Git will not
296 detect the file changes by lstat() calls. This is useful on systems
297 where those are very slow, such as Microsoft Windows.
298 See linkgit:git-update-index[1].
1ab661dd
PB
299 False by default.
300
9f0bb90d
JH
301core.preferSymlinkRefs::
302 Instead of the default "symref" format for HEAD
303 and other symbolic reference files, use symbolic links.
304 This is sometimes needed to work with old scripts that
305 expect HEAD to be a symbolic link.
1ab661dd 306
e4a15f40
SP
307core.bare::
308 If true this repository is assumed to be 'bare' and has no
309 working directory associated with it. If this is the case a
310 number of commands that require a working directory will be
5162e697 311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 312+
5162e697
DM
313This setting is automatically guessed by linkgit:git-clone[1] or
314linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
315repository that ends in "/.git" is assumed to be not bare (bare =
316false), while all other repositories are assumed to be bare (bare
317= true).
318
892c41b9 319core.worktree::
f5e025a9 320 Set the path to the root of the work tree.
06ada152 321 This can be overridden by the GIT_WORK_TREE environment
302cc11a 322 variable and the '--work-tree' command line option. It can be
f5e025a9
NTND
323 an absolute path or a relative path to the .git directory,
324 either specified by --git-dir or GIT_DIR, or automatically
325 discovered.
326 If --git-dir or GIT_DIR are specified but none of
302cc11a 327 --work-tree, GIT_WORK_TREE and core.worktree is specified,
f5e025a9
NTND
328 the current working directory is regarded as the root of the
329 work tree.
330+
331Note that this variable is honored even when set in a configuration
332file in a ".git" subdirectory of a directory, and its value differs
333from the latter directory (e.g. "/path/to/.git/config" has
334core.worktree set to "/different/path"), which is most likely a
335misconfiguration. Running git commands in "/path/to" directory will
336still use "/different/path" as the root of the work tree and can cause
337great confusion to the users.
892c41b9 338
6de08ae6 339core.logAllRefUpdates::
14cd5607 340 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
341 "$GIT_DIR/logs/<ref>", by appending the new and old
342 SHA1, the date/time and the reason of the update, but
343 only when the file exists. If this configuration
344 variable is set to true, missing "$GIT_DIR/logs/<ref>"
345 file is automatically created for branch heads.
a862f97e
JH
346+
347This information can be used to determine what commit
348was the tip of a branch "2 days ago".
349+
350This value is true by default in a repository that has
351a working directory associated with it, and false by
352default in a bare repository.
6de08ae6 353
1ab661dd
PB
354core.repositoryFormatVersion::
355 Internal variable identifying the repository format and layout
356 version.
357
358core.sharedRepository::
d5dc6a76
JF
359 When 'group' (or 'true'), the repository is made shareable between
360 several users in a group (making sure all the files and objects are
361 group-writable). When 'all' (or 'world' or 'everybody'), the
362 repository will be readable by all users, additionally to being
363 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
364 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
365 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
366 user's umask value (whereas the other options will only override
367 requested parts of the user's umask value). Examples: '0660' will make
368 the repo read/write-able for the owner and group, but inaccessible to
369 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
370 repository that is group-readable but not group-writable.
371 See linkgit:git-init[1]. False by default.
1ab661dd
PB
372
373core.warnAmbiguousRefs::
374 If true, git will warn you if the ref name you passed it is ambiguous
375 and might match multiple refs in the .git/refs/ tree. True by default.
376
72a5b561
JH
377core.abbrevguard::
378 Even though git makes sure that it uses enough hexdigits to show
379 an abbreviated object name unambiguously, as more objects are
380 added to the repository over time, a short name that used to be
381 unique will stop being unique. Git uses this many extra hexdigits
382 that are more than necessary to make the object name currently
383 unique, in the hope that its output will stay unique a bit longer.
384 Defaults to 0.
385
3d3e95af 386core.compression::
960ccca6
DH
387 An integer -1..9, indicating a default compression level.
388 -1 is the zlib default. 0 means no compression,
389 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
390 If set, this provides a default to other compression variables,
391 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
392
393core.loosecompression::
12f6c308 394 An integer -1..9, indicating the compression level for objects that
960ccca6 395 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 396 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 397 slowest. If not set, defaults to core.compression. If that is
de1b2460 398 not set, defaults to 1 (best speed).
12f6c308 399
60bb8b14
SP
400core.packedGitWindowSize::
401 Number of bytes of a pack file to map into memory in a
402 single mapping operation. Larger window sizes may allow
403 your system to process a smaller number of large pack files
404 more quickly. Smaller window sizes will negatively affect
eb92242f 405 performance due to increased calls to the operating system's
60bb8b14 406 memory manager, but may improve performance when accessing
22bac0ea
SP
407 a large number of large pack files.
408+
409Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
410MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
411be reasonable for all users/operating systems. You probably do
412not need to adjust this value.
eb92242f
SP
413+
414Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 415
77ccc5bb
SP
416core.packedGitLimit::
417 Maximum number of bytes to map simultaneously into memory
418 from pack files. If Git needs to access more than this many
419 bytes at once to complete an operation it will unmap existing
420 regions to reclaim virtual address space within the process.
22bac0ea
SP
421+
422Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
423This should be reasonable for all users/operating systems, except on
424the largest projects. You probably do not need to adjust this value.
eb92242f
SP
425+
426Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 427
18bdec11
SP
428core.deltaBaseCacheLimit::
429 Maximum number of bytes to reserve for caching base objects
6b677a28 430 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
431 entire decompressed base objects in a cache Git is able
432 to avoid unpacking and decompressing frequently used base
433 objects multiple times.
434+
435Default is 16 MiB on all platforms. This should be reasonable
436for all users/operating systems, except on the largest projects.
437You probably do not need to adjust this value.
438+
439Common unit suffixes of 'k', 'm', or 'g' are supported.
440
5eef828b
SP
441core.bigFileThreshold::
442 Files larger than this size are stored deflated, without
443 attempting delta compression. Storing large files without
444 delta compression avoids excessive memory usage, at the
445 slight expense of increased disk usage.
446+
447Default is 512 MiB on all platforms. This should be reasonable
448for most projects as source code and other text files can still
449be delta compressed, but larger binary media files won't be.
450+
451Common unit suffixes of 'k', 'm', or 'g' are supported.
452+
453Currently only linkgit:git-fast-import[1] honors this setting.
454
e8964a5b 455core.excludesfile::
0ba956d3
JS
456 In addition to '.gitignore' (per-directory) and
457 '.git/info/exclude', git looks into this file for patterns
0f7fb21a
JH
458 of files which are not meant to be tracked. "{tilde}/" is expanded
459 to the value of `$HOME` and "{tilde}user/" to the specified user's
df2a79f4 460 home directory. See linkgit:gitignore[5].
0ba956d3 461
d3e7da89
AK
462core.askpass::
463 Some commands (e.g. svn and http interfaces) that interactively
464 ask for a password can be told to use an external program given
453842c9
KF
465 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
466 environment variable. If not set, fall back to the value of the
467 'SSH_ASKPASS' environment variable or, failing that, a simple password
468 prompt. The external program shall be given a suitable prompt as
469 command line argument and write the password on its STDOUT.
d3e7da89 470
6df42ab9
PO
471core.attributesfile::
472 In addition to '.gitattributes' (per-directory) and
473 '.git/info/attributes', git looks into this file for attributes
474 (see linkgit:gitattributes[5]). Path expansions are made the same
475 way as for `core.excludesfile`.
476
ef0c2abf
AR
477core.editor::
478 Commands such as `commit` and `tag` that lets you edit
02783075 479 messages by launching an editor uses the value of this
ef0c2abf 480 variable when it is set, and the environment variable
b4479f07 481 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 482
54adf370 483core.pager::
ab54cd6c
JN
484 The command that git will use to paginate output. Can
485 be overridden with the `GIT_PAGER` environment
486 variable. Note that git sets the `LESS` environment
487 variable to `FRSX` if it is unset when it runs the
488 pager. One can change these settings by setting the
fee75457
CF
489 `LESS` variable to some other value. Alternately,
490 these settings can be overridden on a project or
491 global basis by setting the `core.pager` option.
492 Setting `core.pager` has no affect on the `LESS`
493 environment variable behaviour above, so if you want
494 to override git's default settings this way, you need
495 to be explicit. For example, to disable the S option
496 in a backward compatible manner, set `core.pager`
dcb11263 497 to `less -+$LESS -FRX`. This will be passed to the
fee75457 498 shell by git, which will translate the final command to
dcb11263 499 `LESS=FRSX less -+FRSX -FRX`.
54adf370 500
91af7ae5
JH
501core.whitespace::
502 A comma separated list of common whitespace problems to
0b444cdb
TR
503 notice. 'git diff' will use `color.diff.whitespace` to
504 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
505 consider them as errors. You can prefix `-` to disable
506 any of them (e.g. `-trailing-space`):
91af7ae5 507+
aeb84b05 508* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
509 as an error (enabled by default).
510* `space-before-tab` treats a space character that appears immediately
511 before a tab character in the initial indent part of the line as an
512 error (enabled by default).
513* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 514 space characters as an error (not enabled by default).
3e3ec2ab
CW
515* `tab-in-indent` treats a tab character in the initial indent part of
516 the line as an error (not enabled by default).
77b15bbd
JH
517* `blank-at-eof` treats blank lines added at the end of file as an error
518 (enabled by default).
aeb84b05
JH
519* `trailing-space` is a short-hand to cover both `blank-at-eol` and
520 `blank-at-eof`.
b2979ff5
JH
521* `cr-at-eol` treats a carriage-return at the end of line as
522 part of the line terminator, i.e. with it, `trailing-space`
523 does not trigger if the character before such a carriage-return
524 is not a whitespace (not enabled by default).
91af7ae5 525
aafe9fba
LT
526core.fsyncobjectfiles::
527 This boolean will enable 'fsync()' when writing object files.
528+
529This is a total waste of time and effort on a filesystem that orders
530data writes properly, but can be useful for filesystems that do not use
531journalling (traditional UNIX filesystems) or that only journal metadata
532and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
533
671c9b7e
LT
534core.preloadindex::
535 Enable parallel index preload for operations like 'git diff'
536+
537This can speed up operations like 'git diff' and 'git status' especially
538on filesystems like NFS that have weak caching semantics and thus
539relatively high IO latencies. With this set to 'true', git will do the
540index comparison to the filesystem data in parallel, allowing
541overlapping IO's.
542
348df166
JS
543core.createObject::
544 You can set this to 'link', in which case a hardlink followed by
545 a delete of the source are used to make sure that object creation
546 will not overwrite existing objects.
547+
548On some file system/operating system combinations, this is unreliable.
549Set this config setting to 'rename' there; However, This will remove the
550check that makes sure that existing object files will not get overwritten.
be66a6c4 551
a97a7468
JS
552core.notesRef::
553 When showing commit messages, also show notes which are stored in
9eb3f816
JN
554 the given ref. The ref must be fully qualified. If the given
555 ref does not exist, it is not an error but means that no
556 notes should be printed.
a97a7468 557+
9eb3f816
JN
558This setting defaults to "refs/notes/commits", and it can be overridden by
559the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
a97a7468 560
08aefc9e
NTND
561core.sparseCheckout::
562 Enable "sparse checkout" feature. See section "Sparse checkout" in
563 linkgit:git-read-tree[1] for more information.
564
13bd2134 565add.ignore-errors::
6b3020a2 566add.ignoreErrors::
0b444cdb 567 Tells 'git add' to continue adding files when some files cannot be
13bd2134 568 added due to indexing errors. Equivalent to the '--ignore-errors'
6b3020a2
JN
569 option of linkgit:git-add[1]. Older versions of git accept only
570 `add.ignore-errors`, which does not follow the usual naming
571 convention for configuration variables. Newer versions of git
572 honor `add.ignoreErrors` as well.
13bd2134 573
4514ad4f 574alias.*::
5162e697 575 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
576 after defining "alias.last = cat-file commit HEAD", the invocation
577 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
578 confusion and troubles with script usage, aliases that
579 hide existing git commands are ignored. Arguments are split by
580 spaces, the usual shell quoting and escaping is supported.
581 quote pair and a backslash can be used to quote them.
f368f5a6
JH
582+
583If the alias expansion is prefixed with an exclamation point,
584it will be treated as a shell command. For example, defining
585"alias.new = !gitk --all --not ORIG_HEAD", the invocation
586"git new" is equivalent to running the shell command
595b8dbf
SC
587"gitk --all --not ORIG_HEAD". Note that shell commands will be
588executed from the top-level directory of a repository, which may
589not necessarily be the current directory.
dfd42a3c 590
e80d4cbe
SH
591am.keepcr::
592 If true, git-am will call git-mailsplit for patches in mbox format
593 with parameter '--keep-cr'. In this case git-mailsplit will
6b677a28 594 not remove `\r` from lines ending with `\r\n`. Can be overridden
e80d4cbe
SH
595 by giving '--no-keep-cr' from the command line.
596 See linkgit:git-am[1], linkgit:git-mailsplit[1].
597
86c91f91 598apply.ignorewhitespace::
0b444cdb 599 When set to 'change', tells 'git apply' to ignore changes in
86c91f91
GB
600 whitespace, in the same way as the '--ignore-space-change'
601 option.
0b444cdb 602 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
603 respect all whitespace differences.
604 See linkgit:git-apply[1].
605
1ab661dd 606apply.whitespace::
0b444cdb 607 Tells 'git apply' how to handle whitespaces, in the same way
5162e697 608 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 609
9902387d 610branch.autosetupmerge::
add0951a 611 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
612 so that linkgit:git-pull[1] will appropriately merge from the
613 starting point branch. Note that even if this option is not set,
9902387d 614 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
615 and `--no-track` options. The valid settings are: `false` -- no
616 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
617 starting point is a remote-tracking branch; `always` --
618 automatic setup is done when the starting point is either a
619 local branch or remote-tracking
572fc81d 620 branch. This option defaults to true.
9902387d 621
c998ae9b 622branch.autosetuprebase::
0b444cdb 623 When a new branch is created with 'git branch' or 'git checkout'
c998ae9b
DS
624 that tracks another branch, this variable tells git to set
625 up pull to rebase instead of merge (see "branch.<name>.rebase").
626 When `never`, rebase is never automatically set to true.
627 When `local`, rebase is set to true for tracked branches of
628 other local branches.
629 When `remote`, rebase is set to true for tracked branches of
29b9a66f 630 remote-tracking branches.
c998ae9b
DS
631 When `always`, rebase will be set to true for all tracking
632 branches.
633 See "branch.autosetupmerge" for details on how to set up a
634 branch to track another branch.
635 This option defaults to never.
636
648ad18f 637branch.<name>.remote::
0b444cdb 638 When in branch <name>, it tells 'git fetch' and 'git push' which
76d3cc50
SB
639 remote to fetch from/push to. It defaults to `origin` if no remote is
640 configured. `origin` is also used if you are not on any branch.
648ad18f 641
5372806a 642branch.<name>.merge::
76d3cc50 643 Defines, together with branch.<name>.remote, the upstream branch
0b444cdb
TR
644 for the given branch. It tells 'git fetch'/'git pull' which
645 branch to merge and can also affect 'git push' (see push.default).
646 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
647 refspec to be marked for merging in FETCH_HEAD. The value is
648 handled like the remote part of a refspec, and must match a
649 ref which is fetched from the remote given by
650 "branch.<name>.remote".
0b444cdb
TR
651 The merge information is used by 'git pull' (which at first calls
652 'git fetch') to lookup the default branch for merging. Without
653 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 654 Specify multiple values to get an octopus merge.
0b444cdb 655 If you wish to setup 'git pull' so that it merges into <name> from
9debc324
PB
656 another branch in the local repository, you can point
657 branch.<name>.merge to the desired branch, and use the special setting
658 `.` (a period) for branch.<name>.remote.
5372806a 659
aec7b362
LH
660branch.<name>.mergeoptions::
661 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 662 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
663 option values containing whitespace characters are currently not
664 supported.
665
cd67e4d4
JS
666branch.<name>.rebase::
667 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
668 instead of merging the default branch from the default remote when
669 "git pull" is run.
cd67e4d4 670 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 671 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
672 for details).
673
1658c614
CC
674browser.<tool>.cmd::
675 Specify the command to invoke the specified browser. The
676 specified command is evaluated in shell with the URLs passed
677 as arguments. (See linkgit:git-web--browse[1].)
678
584627b4
CC
679browser.<tool>.path::
680 Override the path for the given tool that may be used to
ab989adf
CC
681 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
682 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 683
2122591b 684clean.requireForce::
562ca192
JH
685 A boolean to make git-clean do nothing unless given -f
686 or -n. Defaults to true.
2122591b 687
f3673988
BG
688color.branch::
689 A boolean to enable/disable color in the output of
5162e697 690 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 691 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
692 only when the output is to a terminal. Defaults to false.
693
694color.branch.<slot>::
695 Use customized color for branch coloration. `<slot>` is one of
696 `current` (the current branch), `local` (a local branch),
8b3f3f84 697 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
698 refs).
699+
700The value for these configuration variables is a list of colors (at most
701two) and attributes (at most one), separated by spaces. The colors
702accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
703`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
704`blink` and `reverse`. The first color given is the foreground; the
705second is the background. The position of the attribute, if any,
706doesn't matter.
f3673988 707
a159ca0c 708color.diff::
cec99d8c
JH
709 When set to `always`, always use colors in patch.
710 When false (or `never`), never. When set to `true` or `auto`, use
711 colors only when the output is to the terminal. Defaults to false.
b5376648 712
a159ca0c 713color.diff.<slot>::
4f193f20
MW
714 Use customized color for diff colorization. `<slot>` specifies
715 which part of the patch to use the specified color, and is one
716 of `plain` (context text), `meta` (metainformation), `frag`
89cb73a1
BW
717 (hunk header), 'func' (function in hunk header), `old` (removed lines),
718 `new` (added lines), `commit` (commit headers), or `whitespace`
719 (highlighting whitespace errors). The values of these variables may be
720 specified as in color.branch.<slot>.
b5376648 721
5e11bee6
NR
722color.decorate.<slot>::
723 Use customized color for 'git log --decorate' output. `<slot>` is one
724 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
0e615b25 725 branches, remote-tracking branches, tags, stash and HEAD, respectively.
5e11bee6 726
7e8f59d5
RS
727color.grep::
728 When set to `always`, always highlight matches. When `false` (or
729 `never`), never. When set to `true` or `auto`, use color only
730 when the output is written to the terminal. Defaults to `false`.
731
55f638bd
ML
732color.grep.<slot>::
733 Use customized color for grep colorization. `<slot>` specifies which
734 part of the line to use the specified color, and is one of
735+
736--
00588bb5
ML
737`context`;;
738 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
739`filename`;;
740 filename prefix (when not using `-h`)
00588bb5
ML
741`function`;;
742 function name lines (when using `-p`)
55f638bd
ML
743`linenumber`;;
744 line number prefix (when using `-n`)
745`match`;;
746 matching text
00588bb5
ML
747`selected`;;
748 non-matching text in selected lines
55f638bd
ML
749`separator`;;
750 separators between fields on a line (`:`, `-`, and `=`)
751 and between hunks (`--`)
752--
753+
754The values of these variables may be specified as in color.branch.<slot>.
7e8f59d5 755
b4c61ed6 756color.interactive::
47ee06f1 757 When set to `always`, always use colors for interactive prompts
467c0197 758 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
759 When false (or `never`), never. When set to `true` or `auto`, use
760 colors only when the output is to the terminal. Defaults to false.
761
762color.interactive.<slot>::
0b444cdb 763 Use customized color for 'git add --interactive'
a3019736
TR
764 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
765 four distinct types of normal output from interactive
57f6ec02 766 commands. The values of these variables may be specified as
b4c61ed6
JH
767 in color.branch.<slot>.
768
1d77043b
JH
769color.pager::
770 A boolean to enable/disable colored output when the pager is in
771 use (default is true).
772
ab07ba2a
MH
773color.showbranch::
774 A boolean to enable/disable color in the output of
775 linkgit:git-show-branch[1]. May be set to `always`,
776 `false` (or `never`) or `auto` (or `true`), in which case colors are used
777 only when the output is to a terminal. Defaults to false.
778
1d77043b
JH
779color.status::
780 A boolean to enable/disable color in the output of
5162e697 781 linkgit:git-status[1]. May be set to `always`,
cec99d8c 782 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
783 only when the output is to a terminal. Defaults to false.
784
785color.status.<slot>::
786 Use customized color for status colorization. `<slot>` is
787 one of `header` (the header text of the status message),
82dca848
SP
788 `added` or `updated` (files which are added but not committed),
789 `changed` (files which are changed but not added in the index),
950ce2e2
CP
790 `untracked` (files which are not tracked by git), or
791 `nobranch` (the color the 'no branch' warning is shown in, defaulting
792 to red). The values of these variables may be specified as in
793 color.branch.<slot>.
1d77043b 794
6b2f2d98
MK
795color.ui::
796 When set to `always`, always use colors in all git commands which
797 are capable of colored output. When false (or `never`), never. When
798 set to `true` or `auto`, use colors only when the output is to the
799 terminal. When more specific variables of color.* are set, they always
800 take precedence over this setting. Defaults to false.
801
88955ed2 802commit.status::
bed575e4
JHI
803 A boolean to enable/disable inclusion of status information in the
804 commit message template when using an editor to prepare the commit
805 message. Defaults to true.
806
b0f34c3d
MM
807commit.template::
808 Specify a file to use as the template for new commit messages.
0f7fb21a 809 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
df2a79f4 810 specified user's home directory.
b0f34c3d 811
aecbf914 812diff.autorefreshindex::
0b444cdb 813 When using 'git diff' to compare with work tree
aecbf914
JH
814 files, do not consider stat-only change as changed.
815 Instead, silently run `git update-index --refresh` to
816 update the cached stat information for paths whose
817 contents in the work tree match the contents in the
818 index. This option defaults to true. Note that this
0b444cdb 819 affects only 'git diff' Porcelain, and not lower level
add0951a 820 'diff' commands such as 'git diff-files'.
aecbf914 821
77680caa
JS
822diff.external::
823 If this config variable is set, diff generation is not
824 performed using the internal diff machinery, but using the
6bb9e51b
AM
825 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
826 environment variable. The command is called with parameters
827 as described under "git Diffs" in linkgit:git[1]. Note: if
828 you want to use an external diff program only on a subset of
829 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 830
a5a818ee 831diff.mnemonicprefix::
0b444cdb 832 If set, 'git diff' uses a prefix pair that is different from the
a5a818ee
JH
833 standard "a/" and "b/" depending on what is being compared. When
834 this configuration is in effect, reverse diff output also swaps
835 the order of the prefixes:
ca768288 836`git diff`;;
a5a818ee 837 compares the (i)ndex and the (w)ork tree;
ca768288 838`git diff HEAD`;;
a5a818ee 839 compares a (c)ommit and the (w)ork tree;
ca768288 840`git diff --cached`;;
a5a818ee 841 compares a (c)ommit and the (i)ndex;
ca768288 842`git diff HEAD:file1 file2`;;
a5a818ee 843 compares an (o)bject and a (w)ork tree entity;
ca768288 844`git diff --no-index a b`;;
a5a818ee
JH
845 compares two non-git things (1) and (2).
846
9904fadf
ML
847diff.noprefix::
848 If set, 'git diff' does not show any source or destination prefix.
849
1ab661dd
PB
850diff.renameLimit::
851 The number of files to consider when performing the copy/rename
0b444cdb 852 detection; equivalent to the 'git diff' option '-l'.
1ab661dd 853
b68ea12e
EW
854diff.renames::
855 Tells git to detect renames. If set to any boolean value, it
856 will enable basic rename detection. If set to "copies" or
857 "copy", it will detect copies, as well.
858
be4f2b40
JS
859diff.ignoreSubmodules::
860 Sets the default value of --ignore-submodules. Note that this
861 affects only 'git diff' Porcelain, and not lower level 'diff'
62ed0096
JL
862 commands such as 'git diff-files'. 'git checkout' also honors
863 this setting when reporting uncommitted changes.
be4f2b40 864
950db879 865diff.suppressBlankEmpty::
5fdb7098
RH
866 A boolean to inhibit the standard behavior of printing a space
867 before each empty output line. Defaults to false.
868
afcbc8e7
DA
869diff.tool::
870 Controls which diff tool is used. `diff.tool` overrides
871 `merge.tool` when used by linkgit:git-difftool[1] and has
872 the same valid values as `merge.tool` minus "tortoisemerge"
873 and plus "kompare".
874
875difftool.<tool>.path::
876 Override the path for the given tool. This is useful in case
877 your tool is not in the PATH.
878
879difftool.<tool>.cmd::
880 Specify the command to invoke the specified diff tool.
881 The specified command is evaluated in shell with the following
882 variables available: 'LOCAL' is set to the name of the temporary
883 file containing the contents of the diff pre-image and 'REMOTE'
884 is set to the name of the temporary file containing the contents
885 of the diff post-image.
886
a904392e
DA
887difftool.prompt::
888 Prompt before each invocation of the diff tool.
889
ae3b970a 890diff.wordRegex::
98a4d87b
BSSJ
891 A POSIX Extended Regular Expression used to determine what is a "word"
892 when performing word-by-word difference calculations. Character
893 sequences that match the regular expression are "words", all other
894 characters are *ignorable* whitespace.
895
af7cf268
JH
896fetch.unpackLimit::
897 If the number of objects fetched over the git native
898 transfer is below this
899 limit, then the objects will be unpacked into loose object
900 files. However if the number of received objects equals or
901 exceeds this limit then the received pack will be stored as
902 a pack, after adding any missing delta bases. Storing the
903 pack from a push can make the push operation complete faster,
80cd9cf9
MB
904 especially on slow filesystems. If not set, the value of
905 `transfer.unpackLimit` is used instead.
af7cf268 906
48d3448d
SB
907format.attach::
908 Enable multipart/mixed attachments as the default for
909 'format-patch'. The value can also be a double quoted string
910 which will enable attachments as the default and set the
911 value as the boundary. See the --attach option in
912 linkgit:git-format-patch[1].
913
49604a4d 914format.numbered::
a567fdcb
BG
915 A boolean which can enable or disable sequence numbers in patch
916 subjects. It defaults to "auto" which enables it only if there
917 is more than one patch. It can be enabled or disabled for all
918 messages by setting it to "true" or "false". See --numbered
919 option in linkgit:git-format-patch[1].
49604a4d 920
1ab661dd
PB
921format.headers::
922 Additional email headers to include in a patch to be submitted
5162e697 923 by mail. See linkgit:git-format-patch[1].
1ab661dd 924
312a30eb 925format.to::
48d3448d 926format.cc::
312a30eb
MV
927 Additional recipients to include in a patch to be submitted
928 by mail. See the --to and --cc options in
929 linkgit:git-format-patch[1].
48d3448d
SB
930
931format.subjectprefix::
932 The default for format-patch is to output files with the '[PATCH]'
933 subject prefix. Use this variable to change that prefix.
934
6622d9c7
SB
935format.signature::
936 The default for format-patch is to output a signature containing
937 the git version number. Use this variable to change that default.
938 Set this variable to the empty string ("") to suppress
939 signature generation.
940
78cb59c8
JS
941format.suffix::
942 The default for format-patch is to output files with the suffix
943 `.patch`. Use this variable to change that suffix (make sure to
944 include the dot if you want it).
1ab661dd 945
94c22a5e
CR
946format.pretty::
947 The default pretty format for log/show/whatchanged command,
948 See linkgit:git-log[1], linkgit:git-show[1],
949 linkgit:git-whatchanged[1].
950
30984ed2 951format.thread::
0b444cdb 952 The default threading style for 'git format-patch'. Can be
578b62bf
JN
953 a boolean value, or `shallow` or `deep`. `shallow` threading
954 makes every mail a reply to the head of the series,
30984ed2
TR
955 where the head is chosen from the cover letter, the
956 `\--in-reply-to`, and the first patch mail, in this order.
fd1ff306 957 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
958 A true boolean value is the same as `shallow`, and a false
959 value disables threading.
960
1d1876e9
HV
961format.signoff::
962 A boolean value which lets you enable the `-s/--signoff` option of
963 format-patch by default. *Note:* Adding the Signed-off-by: line to a
964 patch should be a conscious act and means that you certify you have
965 the rights to submit this work under the same open source license.
966 Please see the 'SubmittingPatches' document for further discussion.
967
0d7566a5
TT
968gc.aggressiveWindow::
969 The window size parameter used in the delta compression
0b444cdb 970 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 971 to 250.
0d7566a5 972
e9831e83
JH
973gc.auto::
974 When there are approximately more than this many loose
975 objects in the repository, `git gc --auto` will pack them.
976 Some Porcelain commands use this command to perform a
80cd9cf9
MB
977 light-weight garbage collection from time to time. The
978 default value is 6700. Setting this to 0 disables it.
e9831e83 979
17815501
JH
980gc.autopacklimit::
981 When there are more than this many packs that are not
982 marked with `*.keep` file in the repository, `git gc
80cd9cf9 983 --auto` consolidates them into one larger pack. The
97063974 984 default value is 50. Setting this to 0 disables it.
17815501 985
c2120e5e 986gc.packrefs::
efc266e8
JN
987 Running `git pack-refs` in a repository renders it
988 unclonable by Git versions prior to 1.5.1.2 over dumb
989 transports such as HTTP. This variable determines whether
add0951a 990 'git gc' runs `git pack-refs`. This can be set to `nobare`
efc266e8
JN
991 to enable it within all non-bare repos or it can be set to a
992 boolean value. The default is `true`.
c2120e5e 993
25ee9731 994gc.pruneexpire::
0b444cdb 995 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
996 Override the grace period with this config variable. The value
997 "now" may be used to disable this grace period and always prune
998 unreachable objects immediately.
25ee9731 999
4aec56d1 1000gc.reflogexpire::
eb523a8d 1001gc.<pattern>.reflogexpire::
0b444cdb 1002 'git reflog expire' removes reflog entries older than
eb523a8d
JH
1003 this time; defaults to 90 days. With "<pattern>" (e.g.
1004 "refs/stash") in the middle the setting applies only to
1005 the refs that match the <pattern>.
4aec56d1
JH
1006
1007gc.reflogexpireunreachable::
eb523a8d 1008gc.<ref>.reflogexpireunreachable::
0b444cdb 1009 'git reflog expire' removes reflog entries older than
4aec56d1 1010 this time and are not reachable from the current tip;
eb523a8d
JH
1011 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1012 in the middle, the setting applies only to the refs that
1013 match the <pattern>.
4aec56d1 1014
48c32424
JH
1015gc.rerereresolved::
1016 Records of conflicted merge you resolved earlier are
0b444cdb 1017 kept for this many days when 'git rerere gc' is run.
5162e697 1018 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
1019
1020gc.rerereunresolved::
1021 Records of conflicted merge you have not resolved are
0b444cdb 1022 kept for this many days when 'git rerere gc' is run.
5162e697 1023 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1024
280514e1
FE
1025gitcvs.commitmsgannotation::
1026 Append this string to each commit message. Set to empty string
1027 to disable this feature. Defaults to "via git-CVS emulator".
1028
1ab661dd 1029gitcvs.enabled::
db218723 1030 Whether the CVS server interface is enabled for this repository.
5162e697 1031 See linkgit:git-cvsserver[1].
1ab661dd
PB
1032
1033gitcvs.logfile::
db218723 1034 Path to a log file where the CVS server interface well... logs
5162e697 1035 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1036
1707adb7 1037gitcvs.usecrlfattr::
5ec3e670
EB
1038 If true, the server will look up the end-of-line conversion
1039 attributes for files to determine the '-k' modes to use. If
1040 the attributes force git to treat a file as text,
6b677a28 1041 the '-k' mode will be left blank so CVS clients will
5ec3e670 1042 treat it as text. If they suppress text conversion, the file
1168d402 1043 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670
EB
1044 the client might otherwise do. If the attributes do not allow
1045 the file type to be determined, then 'gitcvs.allbinary' is
1046 used. See linkgit:gitattributes[5].
8a06a632 1047
eabb0bfd 1048gitcvs.allbinary::
90948a42
MO
1049 This is used if 'gitcvs.usecrlfattr' does not resolve
1050 the correct '-kb' mode to use. If true, all
1051 unresolved files are sent to the client in
1052 mode '-kb'. This causes the client to treat them
1053 as binary files, which suppresses any newline munging it
1054 otherwise might do. Alternatively, if it is set to "guess",
1055 then the contents of the file are examined to decide if
1056 it is binary, similar to 'core.autocrlf'.
abbf5947 1057
04752868
FL
1058gitcvs.dbname::
1059 Database used by git-cvsserver to cache revision information
1060 derived from the git repository. The exact meaning depends on the
1061 used database driver, for SQLite (which is the default driver) this
1062 is a filename. Supports variable substitution (see
5162e697 1063 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1064 Default: '%Ggitcvs.%m.sqlite'
1065
1066gitcvs.dbdriver::
1067 Used Perl DBI driver. You can specify any available driver
1068 for this here, but it might not work. git-cvsserver is tested
1069 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1070 reported *not* to work with 'DBD::mysql'. Experimental feature.
1071 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1072 See linkgit:git-cvsserver[1].
eabb0bfd 1073
04752868
FL
1074gitcvs.dbuser, gitcvs.dbpass::
1075 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1076 since SQLite has no concept of database users and/or passwords.
1077 'gitcvs.dbuser' supports variable substitution (see
5162e697 1078 linkgit:git-cvsserver[1] for details).
04752868 1079
6aeeffd1
JE
1080gitcvs.dbTableNamePrefix::
1081 Database table name prefix. Prepended to the names of any
1082 database tables used, allowing a single database to be used
1083 for several repositories. Supports variable substitution (see
1084 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1085 characters will be replaced with underscores.
1086
8a06a632
MO
1087All gitcvs variables except for 'gitcvs.usecrlfattr' and
1088'gitcvs.allbinary' can also be specified as
1089'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1090is one of "ext" and "pserver") to make them apply only for the given
1091access method.
04752868 1092
d84ae0db
GH
1093gui.commitmsgwidth::
1094 Defines how wide the commit message window is in the
1095 linkgit:git-gui[1]. "75" is the default.
1096
1097gui.diffcontext::
1098 Specifies how many context lines should be used in calls to diff
1099 made by the linkgit:git-gui[1]. The default is "5".
1100
a2df1fb2
AG
1101gui.encoding::
1102 Specifies the default encoding to use for displaying of
1103 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1104 It can be overridden by setting the 'encoding' attribute
1105 for relevant files (see linkgit:gitattributes[5]).
1106 If this option is not set, the tools default to the
1107 locale encoding.
1108
d84ae0db
GH
1109gui.matchtrackingbranch::
1110 Determines if new branches created with linkgit:git-gui[1] should
1111 default to tracking remote branches with matching names or
1112 not. Default: "false".
1113
1114gui.newbranchtemplate::
1115 Is used as suggested name when creating new branches using the
1116 linkgit:git-gui[1].
1117
1118gui.pruneduringfetch::
8b3f3f84 1119 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1120 performing a fetch. The default value is "false".
1121
1122gui.trustmtime::
1123 Determines if linkgit:git-gui[1] should trust the file modification
1124 timestamp or not. By default the timestamps are not trusted.
1125
1126gui.spellingdictionary::
1127 Specifies the dictionary used for spell checking commit messages in
1128 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1129 off.
1130
a2df1fb2 1131gui.fastcopyblame::
ca768288 1132 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1133 location detection. It makes blame significantly faster on huge
1134 repositories at the expense of less thorough copy detection.
1135
1136gui.copyblamethreshold::
76bac890 1137 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1138 detection, measured in alphanumeric characters. See the
1139 linkgit:git-blame[1] manual for more information on copy detection.
1140
1141gui.blamehistoryctx::
1142 Specifies the radius of history context in days to show in
1143 linkgit:gitk[1] for the selected commit, when the `Show History
1144 Context` menu item is invoked from 'git gui blame'. If this
1145 variable is set to zero, the whole history is shown.
1146
390c3480
AG
1147guitool.<name>.cmd::
1148 Specifies the shell command line to execute when the corresponding item
1149 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1150 mandatory for every tool. The command is executed from the root of
1151 the working directory, and in the environment it receives the name of
1152 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1153 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1154 the head is detached, 'CUR_BRANCH' is empty).
1155
1156guitool.<name>.needsfile::
1157 Run the tool only if a diff is selected in the GUI. It guarantees
1158 that 'FILENAME' is not empty.
1159
1160guitool.<name>.noconsole::
1161 Run the command silently, without creating a window to display its
1162 output.
1163
1164guitool.<name>.norescan::
1165 Don't rescan the working directory for changes after the tool
1166 finishes execution.
1167
1168guitool.<name>.confirm::
1169 Show a confirmation dialog before actually running the tool.
1170
1171guitool.<name>.argprompt::
1172 Request a string argument from the user, and pass it to the tool
1173 through the 'ARGS' environment variable. Since requesting an
1174 argument implies confirmation, the 'confirm' option has no effect
1175 if this is enabled. If the option is set to 'true', 'yes', or '1',
1176 the dialog uses a built-in generic prompt; otherwise the exact
1177 value of the variable is used.
1178
1179guitool.<name>.revprompt::
1180 Request a single valid revision from the user, and set the
1181 'REVISION' environment variable. In other aspects this option
1182 is similar to 'argprompt', and can be used together with it.
1183
1184guitool.<name>.revunmerged::
1185 Show only unmerged branches in the 'revprompt' subdialog.
1186 This is useful for tools similar to merge or rebase, but not
1187 for things like checkout or reset.
1188
1189guitool.<name>.title::
1190 Specifies the title to use for the prompt dialog. The default
1191 is the tool name.
1192
1193guitool.<name>.prompt::
1194 Specifies the general prompt string to display at the top of
1195 the dialog, before subsections for 'argprompt' and 'revprompt'.
1196 The default value includes the actual command.
1197
983a9eeb
CC
1198help.browser::
1199 Specify the browser that will be used to display help in the
1200 'web' format. See linkgit:git-help[1].
1201
1202help.format::
1203 Override the default help format used by linkgit:git-help[1].
1204 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1205 the default. 'web' and 'html' are the same.
1206
f0e90716
AR
1207help.autocorrect::
1208 Automatically correct and execute mistyped commands after
1209 waiting for the given number of deciseconds (0.1 sec). If more
1210 than one command can be deduced from the entered text, nothing
1211 will be executed. If the value of this option is negative,
1212 the corrected command will be executed immediately. If the
1213 value is 0 - the command will be just shown but not executed.
1214 This is the default.
1215
9c5665aa
SV
1216http.proxy::
1217 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 1218 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 1219 on a per-remote basis; see remote.<name>.proxy
9c5665aa 1220
1ab661dd
PB
1221http.sslVerify::
1222 Whether to verify the SSL certificate when fetching or pushing
37425065 1223 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1224 variable.
1225
1226http.sslCert::
1227 File containing the SSL certificate when fetching or pushing
37425065 1228 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1229 variable.
1230
1231http.sslKey::
1232 File containing the SSL private key when fetching or pushing
abda1ef5 1233 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1234 variable.
1235
754ae192
ML
1236http.sslCertPasswordProtected::
1237 Enable git's password prompt for the SSL certificate. Otherwise
1238 OpenSSL will prompt the user, possibly many times, if the
1239 certificate or private key is encrypted. Can be overridden by the
1240 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1241
1ab661dd
PB
1242http.sslCAInfo::
1243 File containing the certificates to verify the peer with when
abda1ef5 1244 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1245 'GIT_SSL_CAINFO' environment variable.
1246
1247http.sslCAPath::
1248 Path containing files with the CA certificates to verify the peer
37425065 1249 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1250 by the 'GIT_SSL_CAPATH' environment variable.
1251
1252http.maxRequests::
abda1ef5 1253 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1254 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1255
ad75ebe5
TRC
1256http.minSessions::
1257 The number of curl sessions (counted across slots) to be kept across
1258 requests. They will not be ended with curl_easy_cleanup() until
1259 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1260 value will be capped at 1. Defaults to 1.
1261
de1a2fdd
SP
1262http.postBuffer::
1263 Maximum size in bytes of the buffer used by smart HTTP
1264 transports when POSTing data to the remote system.
1265 For requests larger than this buffer size, HTTP/1.1 and
1266 Transfer-Encoding: chunked is used to avoid creating a
1267 massive pack file locally. Default is 1 MiB, which is
1268 sufficient for most requests.
1269
1ab661dd
PB
1270http.lowSpeedLimit, http.lowSpeedTime::
1271 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1272 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1273 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1274 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1275
3ea099d4
SK
1276http.noEPSV::
1277 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1278 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1279 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1280 environment variable. Default is false (curl will use EPSV).
1281
b1d1058c
SO
1282http.useragent::
1283 The HTTP USER_AGENT string presented to an HTTP server. The default
1284 value represents the version of the client git such as git/1.7.1.
1285 This option allows you to override this value to a more common value
1286 such as Mozilla/4.0. This may be necessary, for instance, if
1287 connecting through a firewall that restricts HTTP connections to a set
1288 of common USER_AGENT strings (but not including those like git/1.7.1).
1289 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1290
1ab661dd
PB
1291i18n.commitEncoding::
1292 Character encoding the commit messages are stored in; git itself
1293 does not care per se, but this information is necessary e.g. when
1294 importing commits from emails or in the gitk graphical history
1295 browser (and possibly at other places in the future or in other
5162e697 1296 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1297
d2c11a38
JH
1298i18n.logOutputEncoding::
1299 Character encoding the commit messages are converted to when
0b444cdb 1300 running 'git log' and friends.
d2c11a38 1301
b0f34c3d
MM
1302imap::
1303 The configuration variables in the 'imap' section are described
1304 in linkgit:git-imap-send[1].
1305
d8a8488d
SD
1306init.templatedir::
1307 Specify the directory from which templates will be copied.
1308 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1309
983a9eeb
CC
1310instaweb.browser::
1311 Specify the program that will be used to browse your working
1312 repository in gitweb. See linkgit:git-instaweb[1].
1313
1314instaweb.httpd::
1315 The HTTP daemon command-line to start gitweb on your working
1316 repository. See linkgit:git-instaweb[1].
1317
1318instaweb.local::
1319 If true the web server started by linkgit:git-instaweb[1] will
1320 be bound to the local IP (127.0.0.1).
1321
1322instaweb.modulepath::
6b677a28
VS
1323 The default module path for linkgit:git-instaweb[1] to use
1324 instead of /usr/lib/apache2/modules. Only used if httpd
1325 is Apache.
983a9eeb
CC
1326
1327instaweb.port::
1328 The port number to bind the gitweb httpd to. See
1329 linkgit:git-instaweb[1].
1330
ca6ac7f1 1331interactive.singlekey::
57f6ec02 1332 In interactive commands, allow the user to provide one-letter
ca6ac7f1
TR
1333 input with a single key (i.e., without hitting enter).
1334 Currently this is used only by the `\--patch` mode of
1335 linkgit:git-add[1]. Note that this setting is silently
1336 ignored if portable keystroke input is not available.
1337
dd0ffd5b 1338log.date::
e860795d
JN
1339 Set the default date-time mode for the 'log' command.
1340 Setting a value for log.date is similar to using 'git log''s
1341 `\--date` option. Possible values are `relative`, `local`,
1342 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1343 for details.
dd0ffd5b 1344
eb734454
SD
1345log.decorate::
1346 Print out the ref names of any commits that are shown by the log
1347 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1348 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1349 specified, the full ref name (including prefix) will be printed.
1350 This is the same as the log commands '--decorate' option.
1351
0f03ca94
PB
1352log.showroot::
1353 If true, the initial commit will be shown as a big creation event.
1354 This is equivalent to a diff against an empty tree.
5162e697 1355 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1356 normally hide the root commit will now show it. True by default.
1357
d551a488
MSO
1358mailmap.file::
1359 The location of an augmenting mailmap file. The default
1360 mailmap, located in the root of the repository, is loaded
1361 first, then the mailmap file pointed to by this variable.
1362 The location of the mailmap file may be in a repository
1363 subdirectory, or somewhere outside of the repository itself.
1364 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1365
b5578f33 1366man.viewer::
b8322ea8 1367 Specify the programs that may be used to display help in the
b5578f33
CC
1368 'man' format. See linkgit:git-help[1].
1369
0bb64009
CC
1370man.<tool>.cmd::
1371 Specify the command to invoke the specified man viewer. The
1372 specified command is evaluated in shell with the man page
1373 passed as argument. (See linkgit:git-help[1].)
1374
7e8114c0
CC
1375man.<tool>.path::
1376 Override the path for the given tool that may be used to
1377 display help in the 'man' format. See linkgit:git-help[1].
1378
b0f34c3d 1379include::merge-config.txt[]
b5412484 1380
77680caa
JS
1381mergetool.<tool>.path::
1382 Override the path for the given tool. This is useful in case
1383 your tool is not in the PATH.
1384
964473a0
CB
1385mergetool.<tool>.cmd::
1386 Specify the command to invoke the specified merge tool. The
1387 specified command is evaluated in shell with the following
1388 variables available: 'BASE' is the name of a temporary file
1389 containing the common base of the files to be merged, if available;
1390 'LOCAL' is the name of a temporary file containing the contents of
1391 the file on the current branch; 'REMOTE' is the name of a temporary
1392 file containing the contents of the file from the branch being
1393 merged; 'MERGED' contains the name of the file to which the merge
1394 tool should write the results of a successful merge.
1395
1396mergetool.<tool>.trustExitCode::
1397 For a custom merge command, specify whether the exit code of
1398 the merge command can be used to determine whether the merge was
1399 successful. If this is not set to true then the merge target file
1400 timestamp is checked and the merge assumed to have been successful
1401 if the file has been updated, otherwise the user is prompted to
1402 indicate the success of the merge.
1403
44c36d1c
CB
1404mergetool.keepBackup::
1405 After performing a merge, the original file with conflict markers
1406 can be saved as a file with a `.orig` extension. If this variable
1407 is set to `false` then this file is not preserved. Defaults to
1408 `true` (i.e. keep the backup files).
1409
162eba8b
CB
1410mergetool.keepTemporaries::
1411 When invoking a custom merge tool, git uses a set of temporary
1412 files to pass to the tool. If the tool returns an error and this
1413 variable is set to `true`, then these temporary files will be
1414 preserved, otherwise they will be removed after the tool has
1415 exited. Defaults to `false`.
1416
682b451f
CB
1417mergetool.prompt::
1418 Prompt before each invocation of the merge resolution program.
1419
894a9d33
TR
1420notes.displayRef::
1421 The (fully qualified) refname from which to show notes when
1422 showing commit messages. The value of this variable can be set
1423 to a glob, in which case notes from all matching refs will be
1424 shown. You may also specify this configuration variable
1425 several times. A warning will be issued for refs that do not
1426 exist, but a glob that does not match any refs is silently
1427 ignored.
1428+
1429This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1430environment variable, which must be a colon separated list of refs or
1431globs.
1432+
1433The effective value of "core.notesRef" (possibly overridden by
1434GIT_NOTES_REF) is also implicitly added to the list of refs to be
1435displayed.
1436
6956f858
TR
1437notes.rewrite.<command>::
1438 When rewriting commits with <command> (currently `amend` or
1439 `rebase`) and this variable is set to `true`, git
1440 automatically copies your notes from the original to the
1441 rewritten commit. Defaults to `true`, but see
1442 "notes.rewriteRef" below.
6956f858
TR
1443
1444notes.rewriteMode::
1445 When copying notes during a rewrite (see the
1446 "notes.rewrite.<command>" option), determines what to do if
1447 the target commit already has a note. Must be one of
1448 `overwrite`, `concatenate`, or `ignore`. Defaults to
1449 `concatenate`.
1450+
1451This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1452environment variable.
1453
1454notes.rewriteRef::
1455 When copying notes during a rewrite, specifies the (fully
1456 qualified) ref whose notes should be copied. The ref may be a
1457 glob, in which case notes in all matching refs will be copied.
1458 You may also specify this configuration several times.
1459+
1460Does not have a default value; you must configure this variable to
1461enable note rewriting.
cfb88e9a
LAS
1462+
1463This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1464environment variable, which must be a colon separated list of refs or
1465globs.
6956f858 1466
4812a93a 1467pack.window::
5162e697 1468 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1469 window size is given on the command line. Defaults to 10.
1470
842aaf93 1471pack.depth::
5162e697 1472 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1473 maximum depth is given on the command line. Defaults to 50.
842aaf93 1474
e93b15cd 1475pack.windowMemory::
5162e697 1476 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1477 when no limit is given on the command line. The value can be
1478 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1479 limit.
1480
960ccca6
DH
1481pack.compression::
1482 An integer -1..9, indicating the compression level for objects
1483 in a pack file. -1 is the zlib default. 0 means no
1484 compression, and 1..9 are various speed/size tradeoffs, 9 being
1485 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1486 not set, defaults to -1, the zlib default, which is "a default
1487 compromise between speed and compression (currently equivalent
1488 to level 6)."
89d71f75
JK
1489+
1490Note that changing the compression level will not automatically recompress
1491all existing objects. You can force recompression by passing the -F option
1492to linkgit:git-repack[1].
960ccca6 1493
074b2eea 1494pack.deltaCacheSize::
02783075 1495 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
1496 linkgit:git-pack-objects[1] before writing them out to a pack.
1497 This cache is used to speed up the writing object phase by not
1498 having to recompute the final delta result once the best match
1499 for all objects is found. Repacking large repositories on machines
1500 which are tight with memory might be badly impacted by this though,
1501 especially if this cache pushes the system into swapping.
1502 A value of 0 means no limit. The smallest size of 1 byte may be
1503 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 1504
e3dfddb3 1505pack.deltaCacheLimit::
693b86ff 1506 The maximum size of a delta, that is cached in
5749b0b2
NP
1507 linkgit:git-pack-objects[1]. This cache is used to speed up the
1508 writing object phase by not having to recompute the final delta
1509 result once the best match for all objects is found. Defaults to 1000.
e3dfddb3 1510
693b86ff
NP
1511pack.threads::
1512 Specifies the number of threads to spawn when searching for best
5162e697 1513 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1514 be compiled with pthreads otherwise this option is ignored with a
1515 warning. This is meant to reduce packing time on multiprocessor
1516 machines. The required amount of memory for the delta search window
1517 is however multiplied by the number of threads.
833e3df1
AE
1518 Specifying 0 will cause git to auto-detect the number of CPU's
1519 and set the number of threads accordingly.
693b86ff 1520
4d00bda2
NP
1521pack.indexVersion::
1522 Specify the default pack index version. Valid values are 1 for
1523 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1524 the new pack index with capabilities for packs larger than 4 GB
1525 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1526 packs. Version 2 is the default. Note that version 2 is enforced
1527 and this config option ignored whenever the corresponding pack is
1528 larger than 2 GB.
1529+
1530If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1531cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1532that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1533other side may give you a repository that cannot be accessed with your
1534older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1535you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1536the `{asterisk}.idx` file.
4d00bda2 1537
dbdbfec4 1538pack.packSizeLimit::
07cf0f24
NP
1539 The maximum size of a pack. This setting only affects
1540 packing to a file when repacking, i.e. the git:// protocol
1541 is unaffected. It can be overridden by the `\--max-pack-size`
1542 option of linkgit:git-repack[1]. The minimum size allowed is
1543 limited to 1 MiB. The default is unlimited.
1544 Common unit suffixes of 'k', 'm', or 'g' are
1545 supported.
2b84b5a8 1546
4370c2d6 1547pager.<cmd>::
9bad7233
JK
1548 If the value is boolean, turns on or off pagination of the
1549 output of a particular git subcommand when writing to a tty.
1550 Otherwise, turns on pagination for the subcommand using the
1551 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1552 or `\--no-pager` is specified on the command line, it takes
1553 precedence over this option. To disable pagination for all
1554 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1555
8028184e
WP
1556pretty.<name>::
1557 Alias for a --pretty= format string, as specified in
1558 linkgit:git-log[1]. Any aliases defined here can be used just
1559 as the built-in pretty formats could. For example,
1560 running `git config pretty.changelog "format:{asterisk} %H %s"`
1561 would cause the invocation `git log --pretty=changelog`
1562 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1563 Note that an alias with the same name as a built-in format
1564 will be silently ignored.
1565
1ab661dd
PB
1566pull.octopus::
1567 The default merge strategy to use when pulling multiple branches
1568 at once.
1569
1570pull.twohead::
1571 The default merge strategy to use when pulling a single branch.
1572
52153747
FAG
1573push.default::
1574 Defines the action git push should take if no refspec is given
1575 on the command line, no refspec is configured in the remote, and
1576 no refspec is implied by any of the options given on the command
01eadafc 1577 line. Possible values are:
52153747 1578+
9373bdc4
CF
1579* `nothing` - do not push anything.
1580* `matching` - push all matching branches.
52153747 1581 All branches having the same name in both ends are considered to be
01eadafc 1582 matching. This is the default.
9373bdc4
CF
1583* `tracking` - push the current branch to its upstream branch.
1584* `current` - push the current branch to a branch of the same name.
52153747 1585
a9c3821c
TAV
1586rebase.stat::
1587 Whether to show a diffstat of what changed upstream since the last
1588 rebase. False by default.
1589
dd1e5b31
HV
1590rebase.autosquash::
1591 If set to true enable '--autosquash' option by default.
1592
77e3efbf
JH
1593receive.autogc::
1594 By default, git-receive-pack will run "git-gc --auto" after
1595 receiving data from git-push and updating refs. You can stop
1596 it by setting this variable to false.
1597
b0f34c3d
MM
1598receive.fsckObjects::
1599 If it is set to true, git-receive-pack will check all received
1600 objects. It will abort in the case of a malformed object or a
1601 broken link. The result of an abort are only dangling objects.
1602 Defaults to false.
1603
1604receive.unpackLimit::
1605 If the number of objects received in a push is below this
1606 limit then the objects will be unpacked into loose object
1607 files. However if the number of received objects equals or
1608 exceeds this limit then the received pack will be stored as
1609 a pack, after adding any missing delta bases. Storing the
1610 pack from a push can make the push operation complete faster,
1611 especially on slow filesystems. If not set, the value of
1612 `transfer.unpackLimit` is used instead.
1613
42fc11c1
JH
1614receive.denyDeletes::
1615 If set to true, git-receive-pack will deny a ref update that deletes
1616 the ref. Use this to prevent such a ref deletion via a push.
1617
662c83ff
TR
1618receive.denyDeleteCurrent::
1619 If set to true, git-receive-pack will deny a ref update that
1620 deletes the currently checked out branch of a non-bare repository.
1621
42fc11c1 1622receive.denyCurrentBranch::
f3838ce1 1623 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
1624 to the currently checked out branch of a non-bare repository.
1625 Such a push is potentially dangerous because it brings the HEAD
1626 out of sync with the index and working tree. If set to "warn",
1627 print a warning of such a push to stderr, but allow the push to
1628 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 1629 message. Defaults to "refuse".
42fc11c1 1630
b0f34c3d
MM
1631receive.denyNonFastForwards::
1632 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 1633 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
1634 even if that push is forced. This configuration variable is
1635 set when initializing a shared repository.
1636
77e3efbf
JH
1637receive.updateserverinfo::
1638 If set to true, git-receive-pack will run git-update-server-info
1639 after receiving data from git-push and updating refs.
1640
0cc6d346 1641remote.<name>.url::
5162e697
DM
1642 The URL of a remote repository. See linkgit:git-fetch[1] or
1643 linkgit:git-push[1].
0cc6d346 1644
20346234
MG
1645remote.<name>.pushurl::
1646 The push URL of a remote repository. See linkgit:git-push[1].
1647
14c98218
SV
1648remote.<name>.proxy::
1649 For remotes that require curl (http, https and ftp), the URL to
1650 the proxy to use for that remote. Set to the empty string to
1651 disable proxying for that remote.
1652
0cc6d346 1653remote.<name>.fetch::
5162e697
DM
1654 The default set of "refspec" for linkgit:git-fetch[1]. See
1655 linkgit:git-fetch[1].
0cc6d346
SB
1656
1657remote.<name>.push::
5162e697
DM
1658 The default set of "refspec" for linkgit:git-push[1]. See
1659 linkgit:git-push[1].
0cc6d346 1660
84bb2dfd
PB
1661remote.<name>.mirror::
1662 If true, pushing to this remote will automatically behave
1663 as if the `\--mirror` option was given on the command line.
1664
1918278e
TT
1665remote.<name>.skipDefaultUpdate::
1666 If true, this remote will be skipped by default when updating
7cc91a2f
BG
1667 using linkgit:git-fetch[1] or the `update` subcommand of
1668 linkgit:git-remote[1].
1669
1670remote.<name>.skipFetchAll::
1671 If true, this remote will be skipped by default when updating
1672 using linkgit:git-fetch[1] or the `update` subcommand of
1673 linkgit:git-remote[1].
1918278e 1674
060aafc1 1675remote.<name>.receivepack::
5dee29ac 1676 The default program to execute on the remote side when pushing. See
79f43f3d 1677 option \--receive-pack of linkgit:git-push[1].
060aafc1 1678
5dee29ac
UKK
1679remote.<name>.uploadpack::
1680 The default program to execute on the remote side when fetching. See
79f43f3d 1681 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1682
047f636d 1683remote.<name>.tagopt::
79f43f3d 1684 Setting this value to \--no-tags disables automatic tag following when
944163a4
ST
1685 fetching from remote <name>. Setting it to \--tags will fetch every
1686 tag from remote <name>, even if they are not reachable from remote
ed368546
DJ
1687 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1688 override this setting. See options \--tags and \--no-tags of
1689 linkgit:git-fetch[1].
047f636d 1690
c578f51d
DB
1691remote.<name>.vcs::
1692 Setting this to a value <vcs> will cause git to interact with
1693 the remote with the git-remote-<vcs> helper.
1694
1918278e
TT
1695remotes.<group>::
1696 The list of remotes which are fetched by "git remote update
5162e697 1697 <group>". See linkgit:git-remote[1].
1918278e 1698
b6945f57 1699repack.usedeltabaseoffset::
22c79eab
NP
1700 By default, linkgit:git-repack[1] creates packs that use
1701 delta-base offset. If you need to share your repository with
1702 git older than version 1.4.4, either directly or via a dumb
1703 protocol such as http, then you need to set this option to
1704 "false" and repack. Access from old git versions over the
1705 native protocol are unaffected by this option.
b6945f57 1706
b0f34c3d
MM
1707rerere.autoupdate::
1708 When set to true, `git-rerere` updates the index with the
1709 resulting contents after it cleanly resolves conflicts using
1710 previously recorded resolution. Defaults to false.
1711
1712rerere.enabled::
1713 Activate recording of resolved conflicts, so that identical
1714 conflict hunks can be resolved automatically, should they
1715 be encountered again. linkgit:git-rerere[1] command is by
1716 default enabled if you create `rr-cache` directory under
1717 `$GIT_DIR`, but can be disabled by setting this option to false.
1718
65180c66
YD
1719sendemail.identity::
1720 A configuration identity. When given, causes values in the
1721 'sendemail.<identity>' subsection to take precedence over
1722 values in the 'sendemail' section. The default identity is
1723 the value of 'sendemail.identity'.
1724
1725sendemail.smtpencryption::
1726 See linkgit:git-send-email[1] for description. Note that this
1727 setting is not subject to the 'identity' mechanism.
1728
1729sendemail.smtpssl::
1730 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1731
1732sendemail.<identity>.*::
1733 Identity-specific versions of the 'sendemail.*' parameters
1734 found below, taking precedence over those when the this
1735 identity is selected, through command-line or
1736 'sendemail.identity'.
1737
1738sendemail.aliasesfile::
1739sendemail.aliasfiletype::
1740sendemail.bcc::
1741sendemail.cc::
1742sendemail.cccmd::
1743sendemail.chainreplyto::
1744sendemail.confirm::
1745sendemail.envelopesender::
1746sendemail.from::
1747sendemail.multiedit::
1748sendemail.signedoffbycc::
1749sendemail.smtppass::
1750sendemail.suppresscc::
1751sendemail.suppressfrom::
1752sendemail.to::
69cf7bfd 1753sendemail.smtpdomain::
65180c66
YD
1754sendemail.smtpserver::
1755sendemail.smtpserverport::
052fbea2 1756sendemail.smtpserveroption::
65180c66
YD
1757sendemail.smtpuser::
1758sendemail.thread::
1759sendemail.validate::
1760 See linkgit:git-send-email[1] for description.
1761
1762sendemail.signedoffcc::
1763 Deprecated alias for 'sendemail.signedoffbycc'.
1764
1ab661dd 1765showbranch.default::
5162e697
DM
1766 The default set of branches for linkgit:git-show-branch[1].
1767 See linkgit:git-show-branch[1].
1ab661dd 1768
46f721c8 1769status.relativePaths::
5162e697 1770 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1771 current directory. Setting this variable to `false` shows paths
1772 relative to the repository root (this was the default for git
1773 prior to v1.5.4).
1774
d6293d1f
MSO
1775status.showUntrackedFiles::
1776 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1777 files which are not currently tracked by Git. Directories which
1778 contain only untracked files, are shown with the directory name
1779 only. Showing untracked files means that Git needs to lstat() all
1780 all the files in the whole repository, which might be slow on some
1781 systems. So, this variable controls how the commands displays
1782 the untracked files. Possible values are:
1783+
1784--
9373bdc4
CF
1785* `no` - Show no untracked files.
1786* `normal` - Show untracked files and directories.
1787* `all` - Show also individual files in untracked directories.
d6293d1f
MSO
1788--
1789+
1790If this variable is not specified, it defaults to 'normal'.
1791This variable can be overridden with the -u|--untracked-files option
1792of linkgit:git-status[1] and linkgit:git-commit[1].
1793
4b2343fa
MG
1794status.submodulesummary::
1795 Defaults to false.
1796 If this is set to a non zero number or true (identical to -1 or an
1797 unlimited number), the submodule summary will be enabled and a
1798 summary of commits for modified submodules will be shown (see
1799 --summary-limit option of linkgit:git-submodule[1]).
1800
0ad0a61f
JN
1801submodule.<name>.path::
1802submodule.<name>.url::
1803submodule.<name>.update::
1804 The path within this project, URL, and the updating strategy
1805 for a submodule. These variables are initially populated
1806 by 'git submodule init'; edit them to override the
1807 URL and other values found in the `.gitmodules` file. See
1808 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1809
aee9c7d6
JL
1810submodule.<name>.ignore::
1811 Defines under what circumstances "git status" and the diff family show
1812 a submodule as modified. When set to "all", it will never be considered
1813 modified, "dirty" will ignore all changes to the submodules work tree and
1814 takes only differences between the HEAD of the submodule and the commit
1815 recorded in the superproject into account. "untracked" will additionally
1816 let submodules with modified tracked files in their work tree show up.
1817 Using "none" (the default when this option is not set) also shows
1818 submodules that have untracked files in their work tree as changed.
302ad7a9 1819 This setting overrides any setting made in .gitmodules for this submodule,
3776ea9d 1820 both settings can be overridden on the command line by using the
be4f2b40 1821 "--ignore-submodules" option.
aee9c7d6 1822
ce1a79b6 1823tar.umask::
687157c7
RS
1824 This variable can be used to restrict the permission bits of
1825 tar archive entries. The default is 0002, which turns off the
1826 world write bit. The special value "user" indicates that the
1827 archiving user's umask will be used instead. See umask(2) and
5162e697 1828 linkgit:git-archive[1].
ce1a79b6 1829
b0f34c3d
MM
1830transfer.unpackLimit::
1831 When `fetch.unpackLimit` or `receive.unpackLimit` are
1832 not set, the value of this variable is used instead.
1833 The default value is 100.
1834
55029ae4
DB
1835url.<base>.insteadOf::
1836 Any URL that starts with this value will be rewritten to
1837 start, instead, with <base>. In cases where some site serves a
1838 large number of repositories, and serves them with multiple
1839 access methods, and some users need to use different access
1840 methods, this feature allows people to specify any of the
1841 equivalent URLs and have git automatically rewrite the URL to
1842 the best alternative for the particular user, even for a
844112ca
JH
1843 never-before-seen repository on the site. When more than one
1844 insteadOf strings match a given URL, the longest match is used.
55029ae4 1845
1c2eafb8
JT
1846url.<base>.pushInsteadOf::
1847 Any URL that starts with this value will not be pushed to;
1848 instead, it will be rewritten to start with <base>, and the
1849 resulting URL will be pushed to. In cases where some site serves
1850 a large number of repositories, and serves them with multiple
1851 access methods, some of which do not allow push, this feature
1852 allows people to specify a pull-only URL and have git
1853 automatically use an appropriate URL to push, even for a
1854 never-before-seen repository on the site. When more than one
1855 pushInsteadOf strings match a given URL, the longest match is
1856 used. If a remote has an explicit pushurl, git will ignore this
1857 setting for that remote.
1858
1ab661dd
PB
1859user.email::
1860 Your email address to be recorded in any newly created commits.
28a94f88 1861 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1862 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1863
1864user.name::
1865 Your full name to be recorded in any newly created commits.
abda1ef5 1866 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1867 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1868
d67778ec 1869user.signingkey::
5162e697 1870 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1871 automatically when creating a signed tag, you can override the
1872 default selection with this variable. This option is passed
1873 unchanged to gpg's --local-user parameter, so you may specify a key
1874 using any method that gpg supports.
1875
983a9eeb
CC
1876web.browser::
1877 Specify a web browser that may be used by some commands.
1878 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1879 may use it.