configure.ac: rework/fix the NEEDS_RESOLV and NEEDS_LIBGEN tests
[git/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
JN
51
52All the other lines are recognized as setting variables, in the form
53'name = value'. If there is no equal sign on the line, the entire line
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
dcb11263 56characters and `-` are allowed. There can be more than one value
e136f33b
JN
57for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
0cbcf7ad 640/1, true/false or on/off. Case is not significant in boolean values, when
e136f33b 65converting value to the canonical form using '--bool' type specifier;
ba020ef5 66'git-config' will ensure that the output is "true" or "false".
e136f33b
JN
67
68String values may be entirely or partially enclosed in double quotes.
773002a7
SB
69You need to enclose variable values in double quotes if you want to
70preserve leading or trailing whitespace, or if the variable value contains
71comment characters (i.e. it contains '#' or ';').
72Double quote `"` and backslash `\` characters in variable values must
dcb11263 73be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 74
dcb11263
CJ
75The following escape sequences (beside `\"` and `\\`) are recognized:
76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77and `\b` for backspace (BS). No other char escape sequence, nor octal
e136f33b
JN
78char sequences are valid.
79
773002a7 80Variable values ending in a `\` are continued on the next line in the
e136f33b
JN
81customary UNIX fashion.
82
773002a7 83Some variables may require a special value format.
1ab661dd
PB
84
85Example
86~~~~~~~
87
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
92
93 # Our diff algorithm
94 [diff]
6bb9e51b 95 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
96 renames = true
97
910c00c8
AK
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
101
e136f33b
JN
102 # Proxy settings
103 [core]
29093c28 104 gitProxy="ssh" for "kernel.org"
e136f33b 105 gitProxy=default-proxy ; for the rest
910c00c8 106
1ab661dd
PB
107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116 If false, the executable bit differences between the index and
117 the working copy are ignored; useful on broken filesystems like FAT.
5162e697 118 See linkgit:git-update-index[1]. True by default.
1ab661dd 119
adbc0b6b
DP
120core.ignoreCygwinFSTricks::
121 This option is only used by Cygwin implementation of Git. If false,
122 the Cygwin stat() and lstat() functions are used. This may be useful
123 if your repository consists of a few separate directories joined in
124 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125 whenever it is possible and falls back to Cygwin functions only to
126 handle symbol links. The native mode is more than twice faster than
7faee6b8
ML
127 normal Cygwin l/stat() functions. True by default, unless core.filemode
128 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129 POSIX emulation is required to support core.filemode.
adbc0b6b 130
1ce4790b
AR
131core.trustctime::
132 If false, the ctime differences between the index and the
133 working copy are ignored; useful when the inode change time
134 is regularly modified by something outside Git (file system
135 crawlers and some backup systems).
136 See linkgit:git-update-index[1]. True by default.
137
9378c161 138core.quotepath::
5833d730
JN
139 The commands that output paths (e.g. 'ls-files',
140 'diff'), when not given the `-z` option, will quote
9378c161
JH
141 "unusual" characters in the pathname by enclosing the
142 pathname in a double-quote pair and with backslashes the
143 same way strings in C source code are quoted. If this
144 variable is set to false, the bytes higher than 0x80 are
145 not quoted but output as verbatim. Note that double
146 quote, backslash and control characters are always
147 quoted without `-z` regardless of the setting of this
148 variable.
149
5cb71f82
FL
150core.autocrlf::
151 If true, makes git convert `CRLF` at the end of lines in text files to
152 `LF` when reading from the filesystem, and convert in reverse when
153 writing to the filesystem. The variable can be set to
154 'input', in which case the conversion happens only while
155 reading from the filesystem but files are written out with
156 `LF` at the end of lines. Currently, which paths to consider
157 "text" (i.e. be subjected to the autocrlf mechanism) is
158 decided purely based on the contents.
159
21e5ad50
SP
160core.safecrlf::
161 If true, makes git check if converting `CRLF` as controlled by
162 `core.autocrlf` is reversible. Git will verify if a command
163 modifies a file in the work tree either directly or indirectly.
164 For example, committing a file followed by checking out the
165 same file should yield the original file in the work tree. If
166 this is not the case for the current setting of
167 `core.autocrlf`, git will reject the file. The variable can
168 be set to "warn", in which case git will only warn about an
169 irreversible conversion but continue the operation.
170+
171CRLF conversion bears a slight chance of corrupting data.
172autocrlf=true will convert CRLF to LF during commit and LF to
173CRLF during checkout. A file that contains a mixture of LF and
174CRLF before the commit cannot be recreated by git. For text
175files this is the right thing to do: it corrects line endings
176such that we have only LF line endings in the repository.
177But for binary files that are accidentally classified as text the
178conversion can corrupt data.
179+
180If you recognize such corruption early you can easily fix it by
181setting the conversion type explicitly in .gitattributes. Right
182after committing you still have the original file in your work
183tree and this file is not yet corrupted. You can explicitly tell
184git that this file is binary and git will handle the file
185appropriately.
186+
187Unfortunately, the desired effect of cleaning up text files with
188mixed line endings and the undesired effect of corrupting binary
189files cannot be distinguished. In both cases CRLFs are removed
190in an irreversible way. For text files this is the right thing
191to do because CRLFs are line endings, while for binary files
192converting CRLFs corrupts data.
193+
194Note, this safety check does not mean that a checkout will generate a
195file identical to the original file for a different setting of
196`core.autocrlf`, but only for the current one. For example, a text
197file with `LF` would be accepted with `core.autocrlf=input` and could
198later be checked out with `core.autocrlf=true`, in which case the
199resulting file would contain `CRLF`, although the original file
200contained `LF`. However, in both work trees the line endings would be
201consistent, that is either all `LF` or all `CRLF`, but never mixed. A
202file with mixed line endings would be reported by the `core.safecrlf`
203mechanism.
204
78a8d641
JS
205core.symlinks::
206 If false, symbolic links are checked out as small plain files that
5162e697
DM
207 contain the link text. linkgit:git-update-index[1] and
208 linkgit:git-add[1] will not change the recorded type to regular
78a8d641
JS
209 file. Useful on filesystems like FAT that do not support
210 symbolic links. True by default.
211
1ab661dd
PB
212core.gitProxy::
213 A "proxy command" to execute (as 'command host port') instead
214 of establishing direct connection to the remote server when
215 using the git protocol for fetching. If the variable value is
216 in the "COMMAND for DOMAIN" format, the command is applied only
217 on hostnames ending with the specified domain string. This variable
218 may be set multiple times and is matched in the given order;
219 the first match wins.
b8936cf0
FD
220+
221Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222(which always applies universally, without the special "for"
223handling).
642d0844
ES
224+
225The special string `none` can be used as the proxy command to
226specify that no proxy be used for a given domain pattern.
227This is useful for excluding servers inside a firewall from
228proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
229
230core.ignoreStat::
b7f685a7
MSO
231 If true, commands which modify both the working tree and the index
232 will mark the updated paths with the "assume unchanged" bit in the
233 index. These marked files are then assumed to stay unchanged in the
234 working copy, until you mark them otherwise manually - Git will not
235 detect the file changes by lstat() calls. This is useful on systems
236 where those are very slow, such as Microsoft Windows.
237 See linkgit:git-update-index[1].
1ab661dd
PB
238 False by default.
239
9f0bb90d
JH
240core.preferSymlinkRefs::
241 Instead of the default "symref" format for HEAD
242 and other symbolic reference files, use symbolic links.
243 This is sometimes needed to work with old scripts that
244 expect HEAD to be a symbolic link.
1ab661dd 245
e4a15f40
SP
246core.bare::
247 If true this repository is assumed to be 'bare' and has no
248 working directory associated with it. If this is the case a
249 number of commands that require a working directory will be
5162e697 250 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 251+
5162e697
DM
252This setting is automatically guessed by linkgit:git-clone[1] or
253linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
254repository that ends in "/.git" is assumed to be not bare (bare =
255false), while all other repositories are assumed to be bare (bare
256= true).
257
892c41b9
ML
258core.worktree::
259 Set the path to the working tree. The value will not be
260 used in combination with repositories found automatically in
261 a .git directory (i.e. $GIT_DIR is not set).
06ada152 262 This can be overridden by the GIT_WORK_TREE environment
302cc11a
LY
263 variable and the '--work-tree' command line option. It can be
264 a absolute path or relative path to the directory specified by
265 --git-dir or GIT_DIR.
266 Note: If --git-dir or GIT_DIR are specified but none of
267 --work-tree, GIT_WORK_TREE and core.worktree is specified,
268 the current working directory is regarded as the top directory
269 of your working tree.
892c41b9 270
6de08ae6 271core.logAllRefUpdates::
14cd5607 272 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
273 "$GIT_DIR/logs/<ref>", by appending the new and old
274 SHA1, the date/time and the reason of the update, but
275 only when the file exists. If this configuration
276 variable is set to true, missing "$GIT_DIR/logs/<ref>"
277 file is automatically created for branch heads.
a862f97e
JH
278+
279This information can be used to determine what commit
280was the tip of a branch "2 days ago".
281+
282This value is true by default in a repository that has
283a working directory associated with it, and false by
284default in a bare repository.
6de08ae6 285
1ab661dd
PB
286core.repositoryFormatVersion::
287 Internal variable identifying the repository format and layout
288 version.
289
290core.sharedRepository::
d5dc6a76
JF
291 When 'group' (or 'true'), the repository is made shareable between
292 several users in a group (making sure all the files and objects are
293 group-writable). When 'all' (or 'world' or 'everybody'), the
294 repository will be readable by all users, additionally to being
295 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
296 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
297 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
298 user's umask value (whereas the other options will only override
299 requested parts of the user's umask value). Examples: '0660' will make
300 the repo read/write-able for the owner and group, but inaccessible to
301 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
302 repository that is group-readable but not group-writable.
303 See linkgit:git-init[1]. False by default.
1ab661dd
PB
304
305core.warnAmbiguousRefs::
306 If true, git will warn you if the ref name you passed it is ambiguous
307 and might match multiple refs in the .git/refs/ tree. True by default.
308
3d3e95af 309core.compression::
960ccca6
DH
310 An integer -1..9, indicating a default compression level.
311 -1 is the zlib default. 0 means no compression,
312 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
313 If set, this provides a default to other compression variables,
314 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
315
316core.loosecompression::
12f6c308 317 An integer -1..9, indicating the compression level for objects that
960ccca6 318 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 319 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 320 slowest. If not set, defaults to core.compression. If that is
de1b2460 321 not set, defaults to 1 (best speed).
12f6c308 322
60bb8b14
SP
323core.packedGitWindowSize::
324 Number of bytes of a pack file to map into memory in a
325 single mapping operation. Larger window sizes may allow
326 your system to process a smaller number of large pack files
327 more quickly. Smaller window sizes will negatively affect
eb92242f 328 performance due to increased calls to the operating system's
60bb8b14 329 memory manager, but may improve performance when accessing
22bac0ea
SP
330 a large number of large pack files.
331+
332Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
333MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
334be reasonable for all users/operating systems. You probably do
335not need to adjust this value.
eb92242f
SP
336+
337Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 338
77ccc5bb
SP
339core.packedGitLimit::
340 Maximum number of bytes to map simultaneously into memory
341 from pack files. If Git needs to access more than this many
342 bytes at once to complete an operation it will unmap existing
343 regions to reclaim virtual address space within the process.
22bac0ea
SP
344+
345Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
346This should be reasonable for all users/operating systems, except on
347the largest projects. You probably do not need to adjust this value.
eb92242f
SP
348+
349Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 350
18bdec11
SP
351core.deltaBaseCacheLimit::
352 Maximum number of bytes to reserve for caching base objects
353 that multiple deltafied objects reference. By storing the
354 entire decompressed base objects in a cache Git is able
355 to avoid unpacking and decompressing frequently used base
356 objects multiple times.
357+
358Default is 16 MiB on all platforms. This should be reasonable
359for all users/operating systems, except on the largest projects.
360You probably do not need to adjust this value.
361+
362Common unit suffixes of 'k', 'm', or 'g' are supported.
363
e8964a5b 364core.excludesfile::
0ba956d3
JS
365 In addition to '.gitignore' (per-directory) and
366 '.git/info/exclude', git looks into this file for patterns
cedb8d5d 367 of files which are not meant to be tracked. See
5162e697 368 linkgit:gitignore[5].
0ba956d3 369
ef0c2abf
AR
370core.editor::
371 Commands such as `commit` and `tag` that lets you edit
02783075 372 messages by launching an editor uses the value of this
ef0c2abf
AR
373 variable when it is set, and the environment variable
374 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
375 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
376 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 377
54adf370 378core.pager::
ab54cd6c
JN
379 The command that git will use to paginate output. Can
380 be overridden with the `GIT_PAGER` environment
381 variable. Note that git sets the `LESS` environment
382 variable to `FRSX` if it is unset when it runs the
383 pager. One can change these settings by setting the
fee75457
CF
384 `LESS` variable to some other value. Alternately,
385 these settings can be overridden on a project or
386 global basis by setting the `core.pager` option.
387 Setting `core.pager` has no affect on the `LESS`
388 environment variable behaviour above, so if you want
389 to override git's default settings this way, you need
390 to be explicit. For example, to disable the S option
391 in a backward compatible manner, set `core.pager`
dcb11263 392 to `less -+$LESS -FRX`. This will be passed to the
fee75457 393 shell by git, which will translate the final command to
dcb11263 394 `LESS=FRSX less -+FRSX -FRX`.
54adf370 395
91af7ae5
JH
396core.whitespace::
397 A comma separated list of common whitespace problems to
ba020ef5
JN
398 notice. 'git-diff' will use `color.diff.whitespace` to
399 highlight them, and 'git-apply --whitespace=error' will
c921cc92
JH
400 consider them as errors. You can prefix `-` to disable
401 any of them (e.g. `-trailing-space`):
91af7ae5
JH
402+
403* `trailing-space` treats trailing whitespaces at the end of the line
404 as an error (enabled by default).
405* `space-before-tab` treats a space character that appears immediately
406 before a tab character in the initial indent part of the line as an
407 error (enabled by default).
408* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 409 space characters as an error (not enabled by default).
b2979ff5
JH
410* `cr-at-eol` treats a carriage-return at the end of line as
411 part of the line terminator, i.e. with it, `trailing-space`
412 does not trigger if the character before such a carriage-return
413 is not a whitespace (not enabled by default).
91af7ae5 414
aafe9fba
LT
415core.fsyncobjectfiles::
416 This boolean will enable 'fsync()' when writing object files.
417+
418This is a total waste of time and effort on a filesystem that orders
419data writes properly, but can be useful for filesystems that do not use
420journalling (traditional UNIX filesystems) or that only journal metadata
421and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
422
671c9b7e
LT
423core.preloadindex::
424 Enable parallel index preload for operations like 'git diff'
425+
426This can speed up operations like 'git diff' and 'git status' especially
427on filesystems like NFS that have weak caching semantics and thus
428relatively high IO latencies. With this set to 'true', git will do the
429index comparison to the filesystem data in parallel, allowing
430overlapping IO's.
431
348df166
JS
432core.createObject::
433 You can set this to 'link', in which case a hardlink followed by
434 a delete of the source are used to make sure that object creation
435 will not overwrite existing objects.
436+
437On some file system/operating system combinations, this is unreliable.
438Set this config setting to 'rename' there; However, This will remove the
439check that makes sure that existing object files will not get overwritten.
be66a6c4 440
13bd2134
SB
441add.ignore-errors::
442 Tells 'git-add' to continue adding files when some files cannot be
443 added due to indexing errors. Equivalent to the '--ignore-errors'
444 option of linkgit:git-add[1].
445
4514ad4f 446alias.*::
5162e697 447 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
448 after defining "alias.last = cat-file commit HEAD", the invocation
449 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
450 confusion and troubles with script usage, aliases that
451 hide existing git commands are ignored. Arguments are split by
452 spaces, the usual shell quoting and escaping is supported.
453 quote pair and a backslash can be used to quote them.
f368f5a6
JH
454+
455If the alias expansion is prefixed with an exclamation point,
456it will be treated as a shell command. For example, defining
457"alias.new = !gitk --all --not ORIG_HEAD", the invocation
458"git new" is equivalent to running the shell command
595b8dbf
SC
459"gitk --all --not ORIG_HEAD". Note that shell commands will be
460executed from the top-level directory of a repository, which may
461not necessarily be the current directory.
dfd42a3c 462
1ab661dd 463apply.whitespace::
ba020ef5 464 Tells 'git-apply' how to handle whitespaces, in the same way
5162e697 465 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 466
9902387d 467branch.autosetupmerge::
ba020ef5 468 Tells 'git-branch' and 'git-checkout' to setup new branches
572fc81d
JS
469 so that linkgit:git-pull[1] will appropriately merge from the
470 starting point branch. Note that even if this option is not set,
9902387d 471 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
472 and `--no-track` options. The valid settings are: `false` -- no
473 automatic setup is done; `true` -- automatic setup is done when the
474 starting point is a remote branch; `always` -- automatic setup is
475 done when the starting point is either a local branch or remote
476 branch. This option defaults to true.
9902387d 477
c998ae9b 478branch.autosetuprebase::
ba020ef5 479 When a new branch is created with 'git-branch' or 'git-checkout'
c998ae9b
DS
480 that tracks another branch, this variable tells git to set
481 up pull to rebase instead of merge (see "branch.<name>.rebase").
482 When `never`, rebase is never automatically set to true.
483 When `local`, rebase is set to true for tracked branches of
484 other local branches.
485 When `remote`, rebase is set to true for tracked branches of
486 remote branches.
487 When `always`, rebase will be set to true for all tracking
488 branches.
489 See "branch.autosetupmerge" for details on how to set up a
490 branch to track another branch.
491 This option defaults to never.
492
648ad18f 493branch.<name>.remote::
76d3cc50
SB
494 When in branch <name>, it tells 'git-fetch' and 'git-push' which
495 remote to fetch from/push to. It defaults to `origin` if no remote is
496 configured. `origin` is also used if you are not on any branch.
648ad18f 497
5372806a 498branch.<name>.merge::
76d3cc50
SB
499 Defines, together with branch.<name>.remote, the upstream branch
500 for the given branch. It tells 'git-fetch'/'git-pull' which
5c9c9903 501 branch to merge and can also affect 'git-push' (see push.default).
ba020ef5 502 When in branch <name>, it tells 'git-fetch' the default
b888d61c
DB
503 refspec to be marked for merging in FETCH_HEAD. The value is
504 handled like the remote part of a refspec, and must match a
505 ref which is fetched from the remote given by
506 "branch.<name>.remote".
ba020ef5
JN
507 The merge information is used by 'git-pull' (which at first calls
508 'git-fetch') to lookup the default branch for merging. Without
509 this option, 'git-pull' defaults to merge the first refspec fetched.
62b339a5 510 Specify multiple values to get an octopus merge.
ba020ef5 511 If you wish to setup 'git-pull' so that it merges into <name> from
9debc324
PB
512 another branch in the local repository, you can point
513 branch.<name>.merge to the desired branch, and use the special setting
514 `.` (a period) for branch.<name>.remote.
5372806a 515
aec7b362
LH
516branch.<name>.mergeoptions::
517 Sets default options for merging into branch <name>. The syntax and
5162e697 518 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
519 option values containing whitespace characters are currently not
520 supported.
521
cd67e4d4
JS
522branch.<name>.rebase::
523 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
524 instead of merging the default branch from the default remote when
525 "git pull" is run.
cd67e4d4 526 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 527 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
528 for details).
529
1658c614
CC
530browser.<tool>.cmd::
531 Specify the command to invoke the specified browser. The
532 specified command is evaluated in shell with the URLs passed
533 as arguments. (See linkgit:git-web--browse[1].)
534
584627b4
CC
535browser.<tool>.path::
536 Override the path for the given tool that may be used to
ab989adf
CC
537 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
538 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 539
2122591b 540clean.requireForce::
562ca192
JH
541 A boolean to make git-clean do nothing unless given -f
542 or -n. Defaults to true.
2122591b 543
f3673988
BG
544color.branch::
545 A boolean to enable/disable color in the output of
5162e697 546 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 547 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
548 only when the output is to a terminal. Defaults to false.
549
550color.branch.<slot>::
551 Use customized color for branch coloration. `<slot>` is one of
552 `current` (the current branch), `local` (a local branch),
553 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
554 refs).
555+
556The value for these configuration variables is a list of colors (at most
557two) and attributes (at most one), separated by spaces. The colors
558accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
559`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
560`blink` and `reverse`. The first color given is the foreground; the
561second is the background. The position of the attribute, if any,
562doesn't matter.
f3673988 563
a159ca0c 564color.diff::
cec99d8c
JH
565 When set to `always`, always use colors in patch.
566 When false (or `never`), never. When set to `true` or `auto`, use
567 colors only when the output is to the terminal. Defaults to false.
b5376648 568
a159ca0c 569color.diff.<slot>::
4f193f20
MW
570 Use customized color for diff colorization. `<slot>` specifies
571 which part of the patch to use the specified color, and is one
572 of `plain` (context text), `meta` (metainformation), `frag`
573 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
574 `commit` (commit headers), or `whitespace` (highlighting
575 whitespace errors). The values of these variables may be specified as
4f193f20 576 in color.branch.<slot>.
b5376648 577
7e8f59d5
RS
578color.grep::
579 When set to `always`, always highlight matches. When `false` (or
580 `never`), never. When set to `true` or `auto`, use color only
581 when the output is written to the terminal. Defaults to `false`.
582
a94982ef
RS
583color.grep.external::
584 The string value of this variable is passed to an external 'grep'
585 command as a command line option if match highlighting is turned
586 on. If set to an empty string, no option is passed at all,
587 turning off coloring for external 'grep' calls; this is the default.
588 For GNU grep, set it to `--color=always` to highlight matches even
589 when a pager is used.
590
7e8f59d5
RS
591color.grep.match::
592 Use customized color for matches. The value of this variable
a94982ef
RS
593 may be specified as in color.branch.<slot>. It is passed using
594 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
595 calling an external 'grep'.
7e8f59d5 596
b4c61ed6 597color.interactive::
47ee06f1 598 When set to `always`, always use colors for interactive prompts
467c0197 599 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
600 When false (or `never`), never. When set to `true` or `auto`, use
601 colors only when the output is to the terminal. Defaults to false.
602
603color.interactive.<slot>::
ba020ef5 604 Use customized color for 'git-add --interactive'
a3019736
TR
605 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
606 four distinct types of normal output from interactive
b4c61ed6
JH
607 programs. The values of these variables may be specified as
608 in color.branch.<slot>.
609
1d77043b
JH
610color.pager::
611 A boolean to enable/disable colored output when the pager is in
612 use (default is true).
613
ab07ba2a
MH
614color.showbranch::
615 A boolean to enable/disable color in the output of
616 linkgit:git-show-branch[1]. May be set to `always`,
617 `false` (or `never`) or `auto` (or `true`), in which case colors are used
618 only when the output is to a terminal. Defaults to false.
619
1d77043b
JH
620color.status::
621 A boolean to enable/disable color in the output of
5162e697 622 linkgit:git-status[1]. May be set to `always`,
cec99d8c 623 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
624 only when the output is to a terminal. Defaults to false.
625
626color.status.<slot>::
627 Use customized color for status colorization. `<slot>` is
628 one of `header` (the header text of the status message),
82dca848
SP
629 `added` or `updated` (files which are added but not committed),
630 `changed` (files which are changed but not added in the index),
950ce2e2
CP
631 `untracked` (files which are not tracked by git), or
632 `nobranch` (the color the 'no branch' warning is shown in, defaulting
633 to red). The values of these variables may be specified as in
634 color.branch.<slot>.
1d77043b 635
6b2f2d98
MK
636color.ui::
637 When set to `always`, always use colors in all git commands which
638 are capable of colored output. When false (or `never`), never. When
639 set to `true` or `auto`, use colors only when the output is to the
640 terminal. When more specific variables of color.* are set, they always
641 take precedence over this setting. Defaults to false.
642
b0f34c3d
MM
643commit.template::
644 Specify a file to use as the template for new commit messages.
645
aecbf914 646diff.autorefreshindex::
ba020ef5 647 When using 'git-diff' to compare with work tree
aecbf914
JH
648 files, do not consider stat-only change as changed.
649 Instead, silently run `git update-index --refresh` to
650 update the cached stat information for paths whose
651 contents in the work tree match the contents in the
652 index. This option defaults to true. Note that this
ba020ef5 653 affects only 'git-diff' Porcelain, and not lower level
5833d730 654 'diff' commands, such as 'git-diff-files'.
aecbf914 655
77680caa
JS
656diff.external::
657 If this config variable is set, diff generation is not
658 performed using the internal diff machinery, but using the
6bb9e51b
AM
659 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
660 environment variable. The command is called with parameters
661 as described under "git Diffs" in linkgit:git[1]. Note: if
662 you want to use an external diff program only on a subset of
663 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 664
a5a818ee
JH
665diff.mnemonicprefix::
666 If set, 'git-diff' uses a prefix pair that is different from the
667 standard "a/" and "b/" depending on what is being compared. When
668 this configuration is in effect, reverse diff output also swaps
669 the order of the prefixes:
670'git-diff';;
671 compares the (i)ndex and the (w)ork tree;
672'git-diff HEAD';;
673 compares a (c)ommit and the (w)ork tree;
674'git diff --cached';;
675 compares a (c)ommit and the (i)ndex;
676'git-diff HEAD:file1 file2';;
677 compares an (o)bject and a (w)ork tree entity;
678'git diff --no-index a b';;
679 compares two non-git things (1) and (2).
680
1ab661dd
PB
681diff.renameLimit::
682 The number of files to consider when performing the copy/rename
0979c106 683 detection; equivalent to the 'git-diff' option '-l'.
1ab661dd 684
b68ea12e
EW
685diff.renames::
686 Tells git to detect renames. If set to any boolean value, it
687 will enable basic rename detection. If set to "copies" or
688 "copy", it will detect copies, as well.
689
950db879 690diff.suppressBlankEmpty::
5fdb7098
RH
691 A boolean to inhibit the standard behavior of printing a space
692 before each empty output line. Defaults to false.
693
afcbc8e7
DA
694diff.tool::
695 Controls which diff tool is used. `diff.tool` overrides
696 `merge.tool` when used by linkgit:git-difftool[1] and has
697 the same valid values as `merge.tool` minus "tortoisemerge"
698 and plus "kompare".
699
700difftool.<tool>.path::
701 Override the path for the given tool. This is useful in case
702 your tool is not in the PATH.
703
704difftool.<tool>.cmd::
705 Specify the command to invoke the specified diff tool.
706 The specified command is evaluated in shell with the following
707 variables available: 'LOCAL' is set to the name of the temporary
708 file containing the contents of the diff pre-image and 'REMOTE'
709 is set to the name of the temporary file containing the contents
710 of the diff post-image.
711
a904392e
DA
712difftool.prompt::
713 Prompt before each invocation of the diff tool.
714
ae3b970a 715diff.wordRegex::
98a4d87b
BSSJ
716 A POSIX Extended Regular Expression used to determine what is a "word"
717 when performing word-by-word difference calculations. Character
718 sequences that match the regular expression are "words", all other
719 characters are *ignorable* whitespace.
720
af7cf268
JH
721fetch.unpackLimit::
722 If the number of objects fetched over the git native
723 transfer is below this
724 limit, then the objects will be unpacked into loose object
725 files. However if the number of received objects equals or
726 exceeds this limit then the received pack will be stored as
727 a pack, after adding any missing delta bases. Storing the
728 pack from a push can make the push operation complete faster,
80cd9cf9
MB
729 especially on slow filesystems. If not set, the value of
730 `transfer.unpackLimit` is used instead.
af7cf268 731
48d3448d
SB
732format.attach::
733 Enable multipart/mixed attachments as the default for
734 'format-patch'. The value can also be a double quoted string
735 which will enable attachments as the default and set the
736 value as the boundary. See the --attach option in
737 linkgit:git-format-patch[1].
738
49604a4d 739format.numbered::
a567fdcb
BG
740 A boolean which can enable or disable sequence numbers in patch
741 subjects. It defaults to "auto" which enables it only if there
742 is more than one patch. It can be enabled or disabled for all
743 messages by setting it to "true" or "false". See --numbered
744 option in linkgit:git-format-patch[1].
49604a4d 745
1ab661dd
PB
746format.headers::
747 Additional email headers to include in a patch to be submitted
5162e697 748 by mail. See linkgit:git-format-patch[1].
1ab661dd 749
48d3448d
SB
750format.cc::
751 Additional "Cc:" headers to include in a patch to be submitted
752 by mail. See the --cc option in linkgit:git-format-patch[1].
753
754format.subjectprefix::
755 The default for format-patch is to output files with the '[PATCH]'
756 subject prefix. Use this variable to change that prefix.
757
78cb59c8
JS
758format.suffix::
759 The default for format-patch is to output files with the suffix
760 `.patch`. Use this variable to change that suffix (make sure to
761 include the dot if you want it).
1ab661dd 762
94c22a5e
CR
763format.pretty::
764 The default pretty format for log/show/whatchanged command,
765 See linkgit:git-log[1], linkgit:git-show[1],
766 linkgit:git-whatchanged[1].
767
30984ed2
TR
768format.thread::
769 The default threading style for 'git-format-patch'. Can be
fd1ff306 770 either a boolean value, `shallow` or `deep`. `shallow`
30984ed2
TR
771 threading makes every mail a reply to the head of the series,
772 where the head is chosen from the cover letter, the
773 `\--in-reply-to`, and the first patch mail, in this order.
fd1ff306 774 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
775 A true boolean value is the same as `shallow`, and a false
776 value disables threading.
777
1d1876e9
HV
778format.signoff::
779 A boolean value which lets you enable the `-s/--signoff` option of
780 format-patch by default. *Note:* Adding the Signed-off-by: line to a
781 patch should be a conscious act and means that you certify you have
782 the rights to submit this work under the same open source license.
783 Please see the 'SubmittingPatches' document for further discussion.
784
0d7566a5
TT
785gc.aggressiveWindow::
786 The window size parameter used in the delta compression
467c0197 787 algorithm used by 'git-gc --aggressive'. This defaults
0d7566a5
TT
788 to 10.
789
e9831e83
JH
790gc.auto::
791 When there are approximately more than this many loose
792 objects in the repository, `git gc --auto` will pack them.
793 Some Porcelain commands use this command to perform a
80cd9cf9
MB
794 light-weight garbage collection from time to time. The
795 default value is 6700. Setting this to 0 disables it.
e9831e83 796
17815501
JH
797gc.autopacklimit::
798 When there are more than this many packs that are not
799 marked with `*.keep` file in the repository, `git gc
80cd9cf9 800 --auto` consolidates them into one larger pack. The
97063974 801 default value is 50. Setting this to 0 disables it.
17815501 802
c2120e5e 803gc.packrefs::
ba020ef5 804 'git-gc' does not run `git pack-refs` in a bare repository by
c2120e5e 805 default so that older dumb-transport clients can still fetch
ba020ef5 806 from the repository. Setting this to `true` lets 'git-gc'
7a7d4ef6 807 to run `git pack-refs`. Setting this to `false` tells
ba020ef5 808 'git-gc' never to run `git pack-refs`. The default setting is
c2120e5e
JS
809 `notbare`. Enable it only when you know you do not have to
810 support such clients. The default setting will change to `true`
811 at some stage, and setting this to `false` will continue to
ba020ef5 812 prevent `git pack-refs` from being run from 'git-gc'.
c2120e5e 813
25ee9731 814gc.pruneexpire::
5833d730 815 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
816 Override the grace period with this config variable. The value
817 "now" may be used to disable this grace period and always prune
818 unreachable objects immediately.
25ee9731 819
4aec56d1 820gc.reflogexpire::
ba020ef5 821 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
822 this time; defaults to 90 days.
823
824gc.reflogexpireunreachable::
ba020ef5 825 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
826 this time and are not reachable from the current tip;
827 defaults to 30 days.
828
48c32424
JH
829gc.rerereresolved::
830 Records of conflicted merge you resolved earlier are
ba020ef5 831 kept for this many days when 'git-rerere gc' is run.
5162e697 832 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
833
834gc.rerereunresolved::
835 Records of conflicted merge you have not resolved are
ba020ef5 836 kept for this many days when 'git-rerere gc' is run.
5162e697 837 The default is 15 days. See linkgit:git-rerere[1].
48c32424 838
280514e1
FE
839gitcvs.commitmsgannotation::
840 Append this string to each commit message. Set to empty string
841 to disable this feature. Defaults to "via git-CVS emulator".
842
1ab661dd 843gitcvs.enabled::
db218723 844 Whether the CVS server interface is enabled for this repository.
5162e697 845 See linkgit:git-cvsserver[1].
1ab661dd
PB
846
847gitcvs.logfile::
db218723 848 Path to a log file where the CVS server interface well... logs
5162e697 849 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 850
1707adb7 851gitcvs.usecrlfattr::
8a06a632
MO
852 If true, the server will look up the `crlf` attribute for
853 files to determine the '-k' modes to use. If `crlf` is set,
854 the '-k' mode will be left blank, so cvs clients will
855 treat it as text. If `crlf` is explicitly unset, the file
1168d402 856 will be set with '-kb' mode, which suppresses any newline munging
8a06a632 857 the client might otherwise do. If `crlf` is not specified,
ea449615 858 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
8a06a632 859
eabb0bfd 860gitcvs.allbinary::
90948a42
MO
861 This is used if 'gitcvs.usecrlfattr' does not resolve
862 the correct '-kb' mode to use. If true, all
863 unresolved files are sent to the client in
864 mode '-kb'. This causes the client to treat them
865 as binary files, which suppresses any newline munging it
866 otherwise might do. Alternatively, if it is set to "guess",
867 then the contents of the file are examined to decide if
868 it is binary, similar to 'core.autocrlf'.
abbf5947 869
04752868
FL
870gitcvs.dbname::
871 Database used by git-cvsserver to cache revision information
872 derived from the git repository. The exact meaning depends on the
873 used database driver, for SQLite (which is the default driver) this
874 is a filename. Supports variable substitution (see
5162e697 875 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
876 Default: '%Ggitcvs.%m.sqlite'
877
878gitcvs.dbdriver::
879 Used Perl DBI driver. You can specify any available driver
880 for this here, but it might not work. git-cvsserver is tested
881 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
882 reported *not* to work with 'DBD::mysql'. Experimental feature.
883 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 884 See linkgit:git-cvsserver[1].
eabb0bfd 885
04752868
FL
886gitcvs.dbuser, gitcvs.dbpass::
887 Database user and password. Only useful if setting 'gitcvs.dbdriver',
888 since SQLite has no concept of database users and/or passwords.
889 'gitcvs.dbuser' supports variable substitution (see
5162e697 890 linkgit:git-cvsserver[1] for details).
04752868 891
6aeeffd1
JE
892gitcvs.dbTableNamePrefix::
893 Database table name prefix. Prepended to the names of any
894 database tables used, allowing a single database to be used
895 for several repositories. Supports variable substitution (see
896 linkgit:git-cvsserver[1] for details). Any non-alphabetic
897 characters will be replaced with underscores.
898
8a06a632
MO
899All gitcvs variables except for 'gitcvs.usecrlfattr' and
900'gitcvs.allbinary' can also be specified as
901'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
902is one of "ext" and "pserver") to make them apply only for the given
903access method.
04752868 904
d84ae0db
GH
905gui.commitmsgwidth::
906 Defines how wide the commit message window is in the
907 linkgit:git-gui[1]. "75" is the default.
908
909gui.diffcontext::
910 Specifies how many context lines should be used in calls to diff
911 made by the linkgit:git-gui[1]. The default is "5".
912
a2df1fb2
AG
913gui.encoding::
914 Specifies the default encoding to use for displaying of
915 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
916 It can be overridden by setting the 'encoding' attribute
917 for relevant files (see linkgit:gitattributes[5]).
918 If this option is not set, the tools default to the
919 locale encoding.
920
d84ae0db
GH
921gui.matchtrackingbranch::
922 Determines if new branches created with linkgit:git-gui[1] should
923 default to tracking remote branches with matching names or
924 not. Default: "false".
925
926gui.newbranchtemplate::
927 Is used as suggested name when creating new branches using the
928 linkgit:git-gui[1].
929
930gui.pruneduringfetch::
931 "true" if linkgit:git-gui[1] should prune tracking branches when
932 performing a fetch. The default value is "false".
933
934gui.trustmtime::
935 Determines if linkgit:git-gui[1] should trust the file modification
936 timestamp or not. By default the timestamps are not trusted.
937
938gui.spellingdictionary::
939 Specifies the dictionary used for spell checking commit messages in
940 the linkgit:git-gui[1]. When set to "none" spell checking is turned
941 off.
942
a2df1fb2
AG
943gui.fastcopyblame::
944 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
945 location detection. It makes blame significantly faster on huge
946 repositories at the expense of less thorough copy detection.
947
948gui.copyblamethreshold::
76bac890 949 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
950 detection, measured in alphanumeric characters. See the
951 linkgit:git-blame[1] manual for more information on copy detection.
952
953gui.blamehistoryctx::
954 Specifies the radius of history context in days to show in
955 linkgit:gitk[1] for the selected commit, when the `Show History
956 Context` menu item is invoked from 'git gui blame'. If this
957 variable is set to zero, the whole history is shown.
958
390c3480
AG
959guitool.<name>.cmd::
960 Specifies the shell command line to execute when the corresponding item
961 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
962 mandatory for every tool. The command is executed from the root of
963 the working directory, and in the environment it receives the name of
964 the tool as 'GIT_GUITOOL', the name of the currently selected file as
965 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
966 the head is detached, 'CUR_BRANCH' is empty).
967
968guitool.<name>.needsfile::
969 Run the tool only if a diff is selected in the GUI. It guarantees
970 that 'FILENAME' is not empty.
971
972guitool.<name>.noconsole::
973 Run the command silently, without creating a window to display its
974 output.
975
976guitool.<name>.norescan::
977 Don't rescan the working directory for changes after the tool
978 finishes execution.
979
980guitool.<name>.confirm::
981 Show a confirmation dialog before actually running the tool.
982
983guitool.<name>.argprompt::
984 Request a string argument from the user, and pass it to the tool
985 through the 'ARGS' environment variable. Since requesting an
986 argument implies confirmation, the 'confirm' option has no effect
987 if this is enabled. If the option is set to 'true', 'yes', or '1',
988 the dialog uses a built-in generic prompt; otherwise the exact
989 value of the variable is used.
990
991guitool.<name>.revprompt::
992 Request a single valid revision from the user, and set the
993 'REVISION' environment variable. In other aspects this option
994 is similar to 'argprompt', and can be used together with it.
995
996guitool.<name>.revunmerged::
997 Show only unmerged branches in the 'revprompt' subdialog.
998 This is useful for tools similar to merge or rebase, but not
999 for things like checkout or reset.
1000
1001guitool.<name>.title::
1002 Specifies the title to use for the prompt dialog. The default
1003 is the tool name.
1004
1005guitool.<name>.prompt::
1006 Specifies the general prompt string to display at the top of
1007 the dialog, before subsections for 'argprompt' and 'revprompt'.
1008 The default value includes the actual command.
1009
983a9eeb
CC
1010help.browser::
1011 Specify the browser that will be used to display help in the
1012 'web' format. See linkgit:git-help[1].
1013
1014help.format::
1015 Override the default help format used by linkgit:git-help[1].
1016 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1017 the default. 'web' and 'html' are the same.
1018
f0e90716
AR
1019help.autocorrect::
1020 Automatically correct and execute mistyped commands after
1021 waiting for the given number of deciseconds (0.1 sec). If more
1022 than one command can be deduced from the entered text, nothing
1023 will be executed. If the value of this option is negative,
1024 the corrected command will be executed immediately. If the
1025 value is 0 - the command will be just shown but not executed.
1026 This is the default.
1027
9c5665aa
SV
1028http.proxy::
1029 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 1030 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 1031 on a per-remote basis; see remote.<name>.proxy
9c5665aa 1032
1ab661dd
PB
1033http.sslVerify::
1034 Whether to verify the SSL certificate when fetching or pushing
37425065 1035 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1036 variable.
1037
1038http.sslCert::
1039 File containing the SSL certificate when fetching or pushing
37425065 1040 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1041 variable.
1042
1043http.sslKey::
1044 File containing the SSL private key when fetching or pushing
abda1ef5 1045 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1046 variable.
1047
754ae192
ML
1048http.sslCertPasswordProtected::
1049 Enable git's password prompt for the SSL certificate. Otherwise
1050 OpenSSL will prompt the user, possibly many times, if the
1051 certificate or private key is encrypted. Can be overridden by the
1052 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1053
1ab661dd
PB
1054http.sslCAInfo::
1055 File containing the certificates to verify the peer with when
abda1ef5 1056 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1057 'GIT_SSL_CAINFO' environment variable.
1058
1059http.sslCAPath::
1060 Path containing files with the CA certificates to verify the peer
37425065 1061 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1062 by the 'GIT_SSL_CAPATH' environment variable.
1063
1064http.maxRequests::
abda1ef5 1065 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1066 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1067
1068http.lowSpeedLimit, http.lowSpeedTime::
1069 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1070 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1071 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1072 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1073
3ea099d4
SK
1074http.noEPSV::
1075 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1076 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1077 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1078 environment variable. Default is false (curl will use EPSV).
1079
1ab661dd
PB
1080i18n.commitEncoding::
1081 Character encoding the commit messages are stored in; git itself
1082 does not care per se, but this information is necessary e.g. when
1083 importing commits from emails or in the gitk graphical history
1084 browser (and possibly at other places in the future or in other
5162e697 1085 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1086
d2c11a38
JH
1087i18n.logOutputEncoding::
1088 Character encoding the commit messages are converted to when
ba020ef5 1089 running 'git-log' and friends.
d2c11a38 1090
b0f34c3d
MM
1091imap::
1092 The configuration variables in the 'imap' section are described
1093 in linkgit:git-imap-send[1].
1094
983a9eeb
CC
1095instaweb.browser::
1096 Specify the program that will be used to browse your working
1097 repository in gitweb. See linkgit:git-instaweb[1].
1098
1099instaweb.httpd::
1100 The HTTP daemon command-line to start gitweb on your working
1101 repository. See linkgit:git-instaweb[1].
1102
1103instaweb.local::
1104 If true the web server started by linkgit:git-instaweb[1] will
1105 be bound to the local IP (127.0.0.1).
1106
1107instaweb.modulepath::
1108 The module path for an apache httpd used by linkgit:git-instaweb[1].
1109
1110instaweb.port::
1111 The port number to bind the gitweb httpd to. See
1112 linkgit:git-instaweb[1].
1113
ca6ac7f1
TR
1114interactive.singlekey::
1115 In interactive programs, allow the user to provide one-letter
1116 input with a single key (i.e., without hitting enter).
1117 Currently this is used only by the `\--patch` mode of
1118 linkgit:git-add[1]. Note that this setting is silently
1119 ignored if portable keystroke input is not available.
1120
dd0ffd5b
HO
1121log.date::
1122 Set default date-time mode for the log command. Setting log.date
0979c106 1123 value is similar to using 'git-log'\'s --date option. The value is one of the
dd0ffd5b
HO
1124 following alternatives: {relative,local,default,iso,rfc,short}.
1125 See linkgit:git-log[1].
1126
0f03ca94
PB
1127log.showroot::
1128 If true, the initial commit will be shown as a big creation event.
1129 This is equivalent to a diff against an empty tree.
5162e697 1130 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1131 normally hide the root commit will now show it. True by default.
1132
d551a488
MSO
1133mailmap.file::
1134 The location of an augmenting mailmap file. The default
1135 mailmap, located in the root of the repository, is loaded
1136 first, then the mailmap file pointed to by this variable.
1137 The location of the mailmap file may be in a repository
1138 subdirectory, or somewhere outside of the repository itself.
1139 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1140
b5578f33 1141man.viewer::
b8322ea8 1142 Specify the programs that may be used to display help in the
b5578f33
CC
1143 'man' format. See linkgit:git-help[1].
1144
0bb64009
CC
1145man.<tool>.cmd::
1146 Specify the command to invoke the specified man viewer. The
1147 specified command is evaluated in shell with the man page
1148 passed as argument. (See linkgit:git-help[1].)
1149
7e8114c0
CC
1150man.<tool>.path::
1151 Override the path for the given tool that may be used to
1152 display help in the 'man' format. See linkgit:git-help[1].
1153
b0f34c3d 1154include::merge-config.txt[]
b5412484 1155
77680caa
JS
1156mergetool.<tool>.path::
1157 Override the path for the given tool. This is useful in case
1158 your tool is not in the PATH.
1159
964473a0
CB
1160mergetool.<tool>.cmd::
1161 Specify the command to invoke the specified merge tool. The
1162 specified command is evaluated in shell with the following
1163 variables available: 'BASE' is the name of a temporary file
1164 containing the common base of the files to be merged, if available;
1165 'LOCAL' is the name of a temporary file containing the contents of
1166 the file on the current branch; 'REMOTE' is the name of a temporary
1167 file containing the contents of the file from the branch being
1168 merged; 'MERGED' contains the name of the file to which the merge
1169 tool should write the results of a successful merge.
1170
1171mergetool.<tool>.trustExitCode::
1172 For a custom merge command, specify whether the exit code of
1173 the merge command can be used to determine whether the merge was
1174 successful. If this is not set to true then the merge target file
1175 timestamp is checked and the merge assumed to have been successful
1176 if the file has been updated, otherwise the user is prompted to
1177 indicate the success of the merge.
1178
44c36d1c
CB
1179mergetool.keepBackup::
1180 After performing a merge, the original file with conflict markers
1181 can be saved as a file with a `.orig` extension. If this variable
1182 is set to `false` then this file is not preserved. Defaults to
1183 `true` (i.e. keep the backup files).
1184
162eba8b
CB
1185mergetool.keepTemporaries::
1186 When invoking a custom merge tool, git uses a set of temporary
1187 files to pass to the tool. If the tool returns an error and this
1188 variable is set to `true`, then these temporary files will be
1189 preserved, otherwise they will be removed after the tool has
1190 exited. Defaults to `false`.
1191
682b451f
CB
1192mergetool.prompt::
1193 Prompt before each invocation of the merge resolution program.
1194
4812a93a 1195pack.window::
5162e697 1196 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1197 window size is given on the command line. Defaults to 10.
1198
842aaf93 1199pack.depth::
5162e697 1200 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1201 maximum depth is given on the command line. Defaults to 50.
842aaf93 1202
e93b15cd 1203pack.windowMemory::
5162e697 1204 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1205 when no limit is given on the command line. The value can be
1206 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1207 limit.
1208
960ccca6
DH
1209pack.compression::
1210 An integer -1..9, indicating the compression level for objects
1211 in a pack file. -1 is the zlib default. 0 means no
1212 compression, and 1..9 are various speed/size tradeoffs, 9 being
1213 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1214 not set, defaults to -1, the zlib default, which is "a default
1215 compromise between speed and compression (currently equivalent
1216 to level 6)."
960ccca6 1217
074b2eea 1218pack.deltaCacheSize::
02783075 1219 The maximum memory in bytes used for caching deltas in
5162e697 1220 linkgit:git-pack-objects[1].
074b2eea
MK
1221 A value of 0 means no limit. Defaults to 0.
1222
e3dfddb3 1223pack.deltaCacheLimit::
693b86ff 1224 The maximum size of a delta, that is cached in
5162e697 1225 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 1226
693b86ff
NP
1227pack.threads::
1228 Specifies the number of threads to spawn when searching for best
5162e697 1229 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1230 be compiled with pthreads otherwise this option is ignored with a
1231 warning. This is meant to reduce packing time on multiprocessor
1232 machines. The required amount of memory for the delta search window
1233 is however multiplied by the number of threads.
833e3df1
AE
1234 Specifying 0 will cause git to auto-detect the number of CPU's
1235 and set the number of threads accordingly.
693b86ff 1236
4d00bda2
NP
1237pack.indexVersion::
1238 Specify the default pack index version. Valid values are 1 for
1239 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1240 the new pack index with capabilities for packs larger than 4 GB
1241 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1242 packs. Version 2 is the default. Note that version 2 is enforced
1243 and this config option ignored whenever the corresponding pack is
1244 larger than 2 GB.
1245+
1246If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1247cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1248that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1249other side may give you a repository that cannot be accessed with your
1250older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1251you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1252the `{asterisk}.idx` file.
4d00bda2 1253
dbdbfec4 1254pack.packSizeLimit::
2b84b5a8
JS
1255 The default maximum size of a pack. This setting only affects
1256 packing to a file, i.e. the git:// protocol is unaffected. It
1257 can be overridden by the `\--max-pack-size` option of
1258 linkgit:git-repack[1].
1259
4370c2d6 1260pager.<cmd>::
32818085
JN
1261 Allows turning on or off pagination of the output of a
1262 particular git subcommand when writing to a tty. If
1263 `\--paginate` or `\--no-pager` is specified on the command line,
1264 it takes precedence over this option. To disable pagination for
dcb11263 1265 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1266
1ab661dd
PB
1267pull.octopus::
1268 The default merge strategy to use when pulling multiple branches
1269 at once.
1270
1271pull.twohead::
1272 The default merge strategy to use when pulling a single branch.
1273
52153747
FAG
1274push.default::
1275 Defines the action git push should take if no refspec is given
1276 on the command line, no refspec is configured in the remote, and
1277 no refspec is implied by any of the options given on the command
01eadafc 1278 line. Possible values are:
52153747
FAG
1279+
1280* `nothing` do not push anything.
01eadafc 1281* `matching` push all matching branches.
52153747 1282 All branches having the same name in both ends are considered to be
01eadafc 1283 matching. This is the default.
e892dc71 1284* `tracking` push the current branch to its upstream branch.
01eadafc 1285* `current` push the current branch to a branch of the same name.
52153747 1286
a9c3821c
TAV
1287rebase.stat::
1288 Whether to show a diffstat of what changed upstream since the last
1289 rebase. False by default.
1290
b0f34c3d
MM
1291receive.fsckObjects::
1292 If it is set to true, git-receive-pack will check all received
1293 objects. It will abort in the case of a malformed object or a
1294 broken link. The result of an abort are only dangling objects.
1295 Defaults to false.
1296
1297receive.unpackLimit::
1298 If the number of objects received in a push is below this
1299 limit then the objects will be unpacked into loose object
1300 files. However if the number of received objects equals or
1301 exceeds this limit then the received pack will be stored as
1302 a pack, after adding any missing delta bases. Storing the
1303 pack from a push can make the push operation complete faster,
1304 especially on slow filesystems. If not set, the value of
1305 `transfer.unpackLimit` is used instead.
1306
42fc11c1
JH
1307receive.denyDeletes::
1308 If set to true, git-receive-pack will deny a ref update that deletes
1309 the ref. Use this to prevent such a ref deletion via a push.
1310
1311receive.denyCurrentBranch::
1312 If set to true or "refuse", receive-pack will deny a ref update
1313 to the currently checked out branch of a non-bare repository.
1314 Such a push is potentially dangerous because it brings the HEAD
1315 out of sync with the index and working tree. If set to "warn",
1316 print a warning of such a push to stderr, but allow the push to
1317 proceed. If set to false or "ignore", allow such pushes with no
1318 message. Defaults to "warn".
1319
b0f34c3d
MM
1320receive.denyNonFastForwards::
1321 If set to true, git-receive-pack will deny a ref update which is
1322 not a fast forward. Use this to prevent such an update via a push,
1323 even if that push is forced. This configuration variable is
1324 set when initializing a shared repository.
1325
0cc6d346 1326remote.<name>.url::
5162e697
DM
1327 The URL of a remote repository. See linkgit:git-fetch[1] or
1328 linkgit:git-push[1].
0cc6d346 1329
20346234
MG
1330remote.<name>.pushurl::
1331 The push URL of a remote repository. See linkgit:git-push[1].
1332
14c98218
SV
1333remote.<name>.proxy::
1334 For remotes that require curl (http, https and ftp), the URL to
1335 the proxy to use for that remote. Set to the empty string to
1336 disable proxying for that remote.
1337
0cc6d346 1338remote.<name>.fetch::
5162e697
DM
1339 The default set of "refspec" for linkgit:git-fetch[1]. See
1340 linkgit:git-fetch[1].
0cc6d346
SB
1341
1342remote.<name>.push::
5162e697
DM
1343 The default set of "refspec" for linkgit:git-push[1]. See
1344 linkgit:git-push[1].
0cc6d346 1345
84bb2dfd
PB
1346remote.<name>.mirror::
1347 If true, pushing to this remote will automatically behave
1348 as if the `\--mirror` option was given on the command line.
1349
1918278e
TT
1350remote.<name>.skipDefaultUpdate::
1351 If true, this remote will be skipped by default when updating
5162e697 1352 using the update subcommand of linkgit:git-remote[1].
1918278e 1353
060aafc1 1354remote.<name>.receivepack::
5dee29ac 1355 The default program to execute on the remote side when pushing. See
79f43f3d 1356 option \--receive-pack of linkgit:git-push[1].
060aafc1 1357
5dee29ac
UKK
1358remote.<name>.uploadpack::
1359 The default program to execute on the remote side when fetching. See
79f43f3d 1360 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1361
047f636d 1362remote.<name>.tagopt::
79f43f3d
UKK
1363 Setting this value to \--no-tags disables automatic tag following when
1364 fetching from remote <name>
047f636d 1365
1918278e
TT
1366remotes.<group>::
1367 The list of remotes which are fetched by "git remote update
5162e697 1368 <group>". See linkgit:git-remote[1].
1918278e 1369
b6945f57 1370repack.usedeltabaseoffset::
22c79eab
NP
1371 By default, linkgit:git-repack[1] creates packs that use
1372 delta-base offset. If you need to share your repository with
1373 git older than version 1.4.4, either directly or via a dumb
1374 protocol such as http, then you need to set this option to
1375 "false" and repack. Access from old git versions over the
1376 native protocol are unaffected by this option.
b6945f57 1377
b0f34c3d
MM
1378rerere.autoupdate::
1379 When set to true, `git-rerere` updates the index with the
1380 resulting contents after it cleanly resolves conflicts using
1381 previously recorded resolution. Defaults to false.
1382
1383rerere.enabled::
1384 Activate recording of resolved conflicts, so that identical
1385 conflict hunks can be resolved automatically, should they
1386 be encountered again. linkgit:git-rerere[1] command is by
1387 default enabled if you create `rr-cache` directory under
1388 `$GIT_DIR`, but can be disabled by setting this option to false.
1389
1ab661dd 1390showbranch.default::
5162e697
DM
1391 The default set of branches for linkgit:git-show-branch[1].
1392 See linkgit:git-show-branch[1].
1ab661dd 1393
46f721c8 1394status.relativePaths::
5162e697 1395 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1396 current directory. Setting this variable to `false` shows paths
1397 relative to the repository root (this was the default for git
1398 prior to v1.5.4).
1399
d6293d1f
MSO
1400status.showUntrackedFiles::
1401 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1402 files which are not currently tracked by Git. Directories which
1403 contain only untracked files, are shown with the directory name
1404 only. Showing untracked files means that Git needs to lstat() all
1405 all the files in the whole repository, which might be slow on some
1406 systems. So, this variable controls how the commands displays
1407 the untracked files. Possible values are:
1408+
1409--
1410 - 'no' - Show no untracked files
1411 - 'normal' - Shows untracked files and directories
1412 - 'all' - Shows also individual files in untracked directories.
1413--
1414+
1415If this variable is not specified, it defaults to 'normal'.
1416This variable can be overridden with the -u|--untracked-files option
1417of linkgit:git-status[1] and linkgit:git-commit[1].
1418
ce1a79b6 1419tar.umask::
687157c7
RS
1420 This variable can be used to restrict the permission bits of
1421 tar archive entries. The default is 0002, which turns off the
1422 world write bit. The special value "user" indicates that the
1423 archiving user's umask will be used instead. See umask(2) and
5162e697 1424 linkgit:git-archive[1].
ce1a79b6 1425
b0f34c3d
MM
1426transfer.unpackLimit::
1427 When `fetch.unpackLimit` or `receive.unpackLimit` are
1428 not set, the value of this variable is used instead.
1429 The default value is 100.
1430
55029ae4
DB
1431url.<base>.insteadOf::
1432 Any URL that starts with this value will be rewritten to
1433 start, instead, with <base>. In cases where some site serves a
1434 large number of repositories, and serves them with multiple
1435 access methods, and some users need to use different access
1436 methods, this feature allows people to specify any of the
1437 equivalent URLs and have git automatically rewrite the URL to
1438 the best alternative for the particular user, even for a
844112ca
JH
1439 never-before-seen repository on the site. When more than one
1440 insteadOf strings match a given URL, the longest match is used.
55029ae4 1441
1ab661dd
PB
1442user.email::
1443 Your email address to be recorded in any newly created commits.
28a94f88 1444 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1445 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1446
1447user.name::
1448 Your full name to be recorded in any newly created commits.
abda1ef5 1449 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1450 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1451
d67778ec 1452user.signingkey::
5162e697 1453 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1454 automatically when creating a signed tag, you can override the
1455 default selection with this variable. This option is passed
1456 unchanged to gpg's --local-user parameter, so you may specify a key
1457 using any method that gpg supports.
1458
983a9eeb
CC
1459web.browser::
1460 Specify a web browser that may be used by some commands.
1461 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1462 may use it.