]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/config.txt
request-pull: really really disable pager
[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
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
4514ad4f 441alias.*::
5162e697 442 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
443 after defining "alias.last = cat-file commit HEAD", the invocation
444 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
445 confusion and troubles with script usage, aliases that
446 hide existing git commands are ignored. Arguments are split by
447 spaces, the usual shell quoting and escaping is supported.
448 quote pair and a backslash can be used to quote them.
f368f5a6
JH
449+
450If the alias expansion is prefixed with an exclamation point,
451it will be treated as a shell command. For example, defining
452"alias.new = !gitk --all --not ORIG_HEAD", the invocation
453"git new" is equivalent to running the shell command
454"gitk --all --not ORIG_HEAD".
dfd42a3c 455
1ab661dd 456apply.whitespace::
ba020ef5 457 Tells 'git-apply' how to handle whitespaces, in the same way
5162e697 458 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 459
9902387d 460branch.autosetupmerge::
ba020ef5 461 Tells 'git-branch' and 'git-checkout' to setup new branches
572fc81d
JS
462 so that linkgit:git-pull[1] will appropriately merge from the
463 starting point branch. Note that even if this option is not set,
9902387d 464 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
465 and `--no-track` options. The valid settings are: `false` -- no
466 automatic setup is done; `true` -- automatic setup is done when the
467 starting point is a remote branch; `always` -- automatic setup is
468 done when the starting point is either a local branch or remote
469 branch. This option defaults to true.
9902387d 470
c998ae9b 471branch.autosetuprebase::
ba020ef5 472 When a new branch is created with 'git-branch' or 'git-checkout'
c998ae9b
DS
473 that tracks another branch, this variable tells git to set
474 up pull to rebase instead of merge (see "branch.<name>.rebase").
475 When `never`, rebase is never automatically set to true.
476 When `local`, rebase is set to true for tracked branches of
477 other local branches.
478 When `remote`, rebase is set to true for tracked branches of
479 remote branches.
480 When `always`, rebase will be set to true for all tracking
481 branches.
482 See "branch.autosetupmerge" for details on how to set up a
483 branch to track another branch.
484 This option defaults to never.
485
648ad18f 486branch.<name>.remote::
76d3cc50
SB
487 When in branch <name>, it tells 'git-fetch' and 'git-push' which
488 remote to fetch from/push to. It defaults to `origin` if no remote is
489 configured. `origin` is also used if you are not on any branch.
648ad18f 490
5372806a 491branch.<name>.merge::
76d3cc50
SB
492 Defines, together with branch.<name>.remote, the upstream branch
493 for the given branch. It tells 'git-fetch'/'git-pull' which
5c9c9903 494 branch to merge and can also affect 'git-push' (see push.default).
ba020ef5 495 When in branch <name>, it tells 'git-fetch' the default
b888d61c
DB
496 refspec to be marked for merging in FETCH_HEAD. The value is
497 handled like the remote part of a refspec, and must match a
498 ref which is fetched from the remote given by
499 "branch.<name>.remote".
ba020ef5
JN
500 The merge information is used by 'git-pull' (which at first calls
501 'git-fetch') to lookup the default branch for merging. Without
502 this option, 'git-pull' defaults to merge the first refspec fetched.
62b339a5 503 Specify multiple values to get an octopus merge.
ba020ef5 504 If you wish to setup 'git-pull' so that it merges into <name> from
9debc324
PB
505 another branch in the local repository, you can point
506 branch.<name>.merge to the desired branch, and use the special setting
507 `.` (a period) for branch.<name>.remote.
5372806a 508
aec7b362
LH
509branch.<name>.mergeoptions::
510 Sets default options for merging into branch <name>. The syntax and
5162e697 511 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
512 option values containing whitespace characters are currently not
513 supported.
514
cd67e4d4
JS
515branch.<name>.rebase::
516 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
517 instead of merging the default branch from the default remote when
518 "git pull" is run.
cd67e4d4 519 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 520 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
521 for details).
522
1658c614
CC
523browser.<tool>.cmd::
524 Specify the command to invoke the specified browser. The
525 specified command is evaluated in shell with the URLs passed
526 as arguments. (See linkgit:git-web--browse[1].)
527
584627b4
CC
528browser.<tool>.path::
529 Override the path for the given tool that may be used to
ab989adf
CC
530 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
531 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 532
2122591b 533clean.requireForce::
562ca192
JH
534 A boolean to make git-clean do nothing unless given -f
535 or -n. Defaults to true.
2122591b 536
f3673988
BG
537color.branch::
538 A boolean to enable/disable color in the output of
5162e697 539 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 540 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
541 only when the output is to a terminal. Defaults to false.
542
543color.branch.<slot>::
544 Use customized color for branch coloration. `<slot>` is one of
545 `current` (the current branch), `local` (a local branch),
546 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
547 refs).
548+
549The value for these configuration variables is a list of colors (at most
550two) and attributes (at most one), separated by spaces. The colors
551accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
552`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
553`blink` and `reverse`. The first color given is the foreground; the
554second is the background. The position of the attribute, if any,
555doesn't matter.
f3673988 556
a159ca0c 557color.diff::
cec99d8c
JH
558 When set to `always`, always use colors in patch.
559 When false (or `never`), never. When set to `true` or `auto`, use
560 colors only when the output is to the terminal. Defaults to false.
b5376648 561
a159ca0c 562color.diff.<slot>::
4f193f20
MW
563 Use customized color for diff colorization. `<slot>` specifies
564 which part of the patch to use the specified color, and is one
565 of `plain` (context text), `meta` (metainformation), `frag`
566 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
567 `commit` (commit headers), or `whitespace` (highlighting
568 whitespace errors). The values of these variables may be specified as
4f193f20 569 in color.branch.<slot>.
b5376648 570
7e8f59d5
RS
571color.grep::
572 When set to `always`, always highlight matches. When `false` (or
573 `never`), never. When set to `true` or `auto`, use color only
574 when the output is written to the terminal. Defaults to `false`.
575
a94982ef
RS
576color.grep.external::
577 The string value of this variable is passed to an external 'grep'
578 command as a command line option if match highlighting is turned
579 on. If set to an empty string, no option is passed at all,
580 turning off coloring for external 'grep' calls; this is the default.
581 For GNU grep, set it to `--color=always` to highlight matches even
582 when a pager is used.
583
7e8f59d5
RS
584color.grep.match::
585 Use customized color for matches. The value of this variable
a94982ef
RS
586 may be specified as in color.branch.<slot>. It is passed using
587 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
588 calling an external 'grep'.
7e8f59d5 589
b4c61ed6 590color.interactive::
47ee06f1 591 When set to `always`, always use colors for interactive prompts
467c0197 592 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
593 When false (or `never`), never. When set to `true` or `auto`, use
594 colors only when the output is to the terminal. Defaults to false.
595
596color.interactive.<slot>::
ba020ef5 597 Use customized color for 'git-add --interactive'
a3019736
TR
598 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
599 four distinct types of normal output from interactive
b4c61ed6
JH
600 programs. The values of these variables may be specified as
601 in color.branch.<slot>.
602
1d77043b
JH
603color.pager::
604 A boolean to enable/disable colored output when the pager is in
605 use (default is true).
606
607color.status::
608 A boolean to enable/disable color in the output of
5162e697 609 linkgit:git-status[1]. May be set to `always`,
cec99d8c 610 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
611 only when the output is to a terminal. Defaults to false.
612
613color.status.<slot>::
614 Use customized color for status colorization. `<slot>` is
615 one of `header` (the header text of the status message),
82dca848
SP
616 `added` or `updated` (files which are added but not committed),
617 `changed` (files which are changed but not added in the index),
950ce2e2
CP
618 `untracked` (files which are not tracked by git), or
619 `nobranch` (the color the 'no branch' warning is shown in, defaulting
620 to red). The values of these variables may be specified as in
621 color.branch.<slot>.
1d77043b 622
6b2f2d98
MK
623color.ui::
624 When set to `always`, always use colors in all git commands which
625 are capable of colored output. When false (or `never`), never. When
626 set to `true` or `auto`, use colors only when the output is to the
627 terminal. When more specific variables of color.* are set, they always
628 take precedence over this setting. Defaults to false.
629
b0f34c3d
MM
630commit.template::
631 Specify a file to use as the template for new commit messages.
632
aecbf914 633diff.autorefreshindex::
ba020ef5 634 When using 'git-diff' to compare with work tree
aecbf914
JH
635 files, do not consider stat-only change as changed.
636 Instead, silently run `git update-index --refresh` to
637 update the cached stat information for paths whose
638 contents in the work tree match the contents in the
639 index. This option defaults to true. Note that this
ba020ef5 640 affects only 'git-diff' Porcelain, and not lower level
5833d730 641 'diff' commands, such as 'git-diff-files'.
aecbf914 642
77680caa
JS
643diff.external::
644 If this config variable is set, diff generation is not
645 performed using the internal diff machinery, but using the
6bb9e51b
AM
646 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
647 environment variable. The command is called with parameters
648 as described under "git Diffs" in linkgit:git[1]. Note: if
649 you want to use an external diff program only on a subset of
650 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 651
a5a818ee
JH
652diff.mnemonicprefix::
653 If set, 'git-diff' uses a prefix pair that is different from the
654 standard "a/" and "b/" depending on what is being compared. When
655 this configuration is in effect, reverse diff output also swaps
656 the order of the prefixes:
657'git-diff';;
658 compares the (i)ndex and the (w)ork tree;
659'git-diff HEAD';;
660 compares a (c)ommit and the (w)ork tree;
661'git diff --cached';;
662 compares a (c)ommit and the (i)ndex;
663'git-diff HEAD:file1 file2';;
664 compares an (o)bject and a (w)ork tree entity;
665'git diff --no-index a b';;
666 compares two non-git things (1) and (2).
667
1ab661dd
PB
668diff.renameLimit::
669 The number of files to consider when performing the copy/rename
0979c106 670 detection; equivalent to the 'git-diff' option '-l'.
1ab661dd 671
b68ea12e
EW
672diff.renames::
673 Tells git to detect renames. If set to any boolean value, it
674 will enable basic rename detection. If set to "copies" or
675 "copy", it will detect copies, as well.
676
950db879 677diff.suppressBlankEmpty::
5fdb7098
RH
678 A boolean to inhibit the standard behavior of printing a space
679 before each empty output line. Defaults to false.
680
afcbc8e7
DA
681diff.tool::
682 Controls which diff tool is used. `diff.tool` overrides
683 `merge.tool` when used by linkgit:git-difftool[1] and has
684 the same valid values as `merge.tool` minus "tortoisemerge"
685 and plus "kompare".
686
687difftool.<tool>.path::
688 Override the path for the given tool. This is useful in case
689 your tool is not in the PATH.
690
691difftool.<tool>.cmd::
692 Specify the command to invoke the specified diff tool.
693 The specified command is evaluated in shell with the following
694 variables available: 'LOCAL' is set to the name of the temporary
695 file containing the contents of the diff pre-image and 'REMOTE'
696 is set to the name of the temporary file containing the contents
697 of the diff post-image.
698
a904392e
DA
699difftool.prompt::
700 Prompt before each invocation of the diff tool.
701
ae3b970a 702diff.wordRegex::
98a4d87b
BSSJ
703 A POSIX Extended Regular Expression used to determine what is a "word"
704 when performing word-by-word difference calculations. Character
705 sequences that match the regular expression are "words", all other
706 characters are *ignorable* whitespace.
707
af7cf268
JH
708fetch.unpackLimit::
709 If the number of objects fetched over the git native
710 transfer is below this
711 limit, then the objects will be unpacked into loose object
712 files. However if the number of received objects equals or
713 exceeds this limit then the received pack will be stored as
714 a pack, after adding any missing delta bases. Storing the
715 pack from a push can make the push operation complete faster,
80cd9cf9
MB
716 especially on slow filesystems. If not set, the value of
717 `transfer.unpackLimit` is used instead.
af7cf268 718
48d3448d
SB
719format.attach::
720 Enable multipart/mixed attachments as the default for
721 'format-patch'. The value can also be a double quoted string
722 which will enable attachments as the default and set the
723 value as the boundary. See the --attach option in
724 linkgit:git-format-patch[1].
725
49604a4d 726format.numbered::
a567fdcb
BG
727 A boolean which can enable or disable sequence numbers in patch
728 subjects. It defaults to "auto" which enables it only if there
729 is more than one patch. It can be enabled or disabled for all
730 messages by setting it to "true" or "false". See --numbered
731 option in linkgit:git-format-patch[1].
49604a4d 732
1ab661dd
PB
733format.headers::
734 Additional email headers to include in a patch to be submitted
5162e697 735 by mail. See linkgit:git-format-patch[1].
1ab661dd 736
48d3448d
SB
737format.cc::
738 Additional "Cc:" headers to include in a patch to be submitted
739 by mail. See the --cc option in linkgit:git-format-patch[1].
740
741format.subjectprefix::
742 The default for format-patch is to output files with the '[PATCH]'
743 subject prefix. Use this variable to change that prefix.
744
78cb59c8
JS
745format.suffix::
746 The default for format-patch is to output files with the suffix
747 `.patch`. Use this variable to change that suffix (make sure to
748 include the dot if you want it).
1ab661dd 749
94c22a5e
CR
750format.pretty::
751 The default pretty format for log/show/whatchanged command,
752 See linkgit:git-log[1], linkgit:git-show[1],
753 linkgit:git-whatchanged[1].
754
30984ed2
TR
755format.thread::
756 The default threading style for 'git-format-patch'. Can be
fd1ff306 757 either a boolean value, `shallow` or `deep`. `shallow`
30984ed2
TR
758 threading makes every mail a reply to the head of the series,
759 where the head is chosen from the cover letter, the
760 `\--in-reply-to`, and the first patch mail, in this order.
fd1ff306 761 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
762 A true boolean value is the same as `shallow`, and a false
763 value disables threading.
764
1d1876e9
HV
765format.signoff::
766 A boolean value which lets you enable the `-s/--signoff` option of
767 format-patch by default. *Note:* Adding the Signed-off-by: line to a
768 patch should be a conscious act and means that you certify you have
769 the rights to submit this work under the same open source license.
770 Please see the 'SubmittingPatches' document for further discussion.
771
0d7566a5
TT
772gc.aggressiveWindow::
773 The window size parameter used in the delta compression
467c0197 774 algorithm used by 'git-gc --aggressive'. This defaults
0d7566a5
TT
775 to 10.
776
e9831e83
JH
777gc.auto::
778 When there are approximately more than this many loose
779 objects in the repository, `git gc --auto` will pack them.
780 Some Porcelain commands use this command to perform a
80cd9cf9
MB
781 light-weight garbage collection from time to time. The
782 default value is 6700. Setting this to 0 disables it.
e9831e83 783
17815501
JH
784gc.autopacklimit::
785 When there are more than this many packs that are not
786 marked with `*.keep` file in the repository, `git gc
80cd9cf9 787 --auto` consolidates them into one larger pack. The
97063974 788 default value is 50. Setting this to 0 disables it.
17815501 789
c2120e5e 790gc.packrefs::
ba020ef5 791 'git-gc' does not run `git pack-refs` in a bare repository by
c2120e5e 792 default so that older dumb-transport clients can still fetch
ba020ef5 793 from the repository. Setting this to `true` lets 'git-gc'
7a7d4ef6 794 to run `git pack-refs`. Setting this to `false` tells
ba020ef5 795 'git-gc' never to run `git pack-refs`. The default setting is
c2120e5e
JS
796 `notbare`. Enable it only when you know you do not have to
797 support such clients. The default setting will change to `true`
798 at some stage, and setting this to `false` will continue to
ba020ef5 799 prevent `git pack-refs` from being run from 'git-gc'.
c2120e5e 800
25ee9731 801gc.pruneexpire::
5833d730 802 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
803 Override the grace period with this config variable. The value
804 "now" may be used to disable this grace period and always prune
805 unreachable objects immediately.
25ee9731 806
4aec56d1 807gc.reflogexpire::
ba020ef5 808 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
809 this time; defaults to 90 days.
810
811gc.reflogexpireunreachable::
ba020ef5 812 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
813 this time and are not reachable from the current tip;
814 defaults to 30 days.
815
48c32424
JH
816gc.rerereresolved::
817 Records of conflicted merge you resolved earlier are
ba020ef5 818 kept for this many days when 'git-rerere gc' is run.
5162e697 819 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
820
821gc.rerereunresolved::
822 Records of conflicted merge you have not resolved are
ba020ef5 823 kept for this many days when 'git-rerere gc' is run.
5162e697 824 The default is 15 days. See linkgit:git-rerere[1].
48c32424 825
280514e1
FE
826gitcvs.commitmsgannotation::
827 Append this string to each commit message. Set to empty string
828 to disable this feature. Defaults to "via git-CVS emulator".
829
1ab661dd 830gitcvs.enabled::
db218723 831 Whether the CVS server interface is enabled for this repository.
5162e697 832 See linkgit:git-cvsserver[1].
1ab661dd
PB
833
834gitcvs.logfile::
db218723 835 Path to a log file where the CVS server interface well... logs
5162e697 836 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 837
1707adb7 838gitcvs.usecrlfattr::
8a06a632
MO
839 If true, the server will look up the `crlf` attribute for
840 files to determine the '-k' modes to use. If `crlf` is set,
841 the '-k' mode will be left blank, so cvs clients will
842 treat it as text. If `crlf` is explicitly unset, the file
1168d402 843 will be set with '-kb' mode, which suppresses any newline munging
8a06a632 844 the client might otherwise do. If `crlf` is not specified,
ea449615 845 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
8a06a632 846
eabb0bfd 847gitcvs.allbinary::
90948a42
MO
848 This is used if 'gitcvs.usecrlfattr' does not resolve
849 the correct '-kb' mode to use. If true, all
850 unresolved files are sent to the client in
851 mode '-kb'. This causes the client to treat them
852 as binary files, which suppresses any newline munging it
853 otherwise might do. Alternatively, if it is set to "guess",
854 then the contents of the file are examined to decide if
855 it is binary, similar to 'core.autocrlf'.
abbf5947 856
04752868
FL
857gitcvs.dbname::
858 Database used by git-cvsserver to cache revision information
859 derived from the git repository. The exact meaning depends on the
860 used database driver, for SQLite (which is the default driver) this
861 is a filename. Supports variable substitution (see
5162e697 862 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
863 Default: '%Ggitcvs.%m.sqlite'
864
865gitcvs.dbdriver::
866 Used Perl DBI driver. You can specify any available driver
867 for this here, but it might not work. git-cvsserver is tested
868 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
869 reported *not* to work with 'DBD::mysql'. Experimental feature.
870 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 871 See linkgit:git-cvsserver[1].
eabb0bfd 872
04752868
FL
873gitcvs.dbuser, gitcvs.dbpass::
874 Database user and password. Only useful if setting 'gitcvs.dbdriver',
875 since SQLite has no concept of database users and/or passwords.
876 'gitcvs.dbuser' supports variable substitution (see
5162e697 877 linkgit:git-cvsserver[1] for details).
04752868 878
6aeeffd1
JE
879gitcvs.dbTableNamePrefix::
880 Database table name prefix. Prepended to the names of any
881 database tables used, allowing a single database to be used
882 for several repositories. Supports variable substitution (see
883 linkgit:git-cvsserver[1] for details). Any non-alphabetic
884 characters will be replaced with underscores.
885
8a06a632
MO
886All gitcvs variables except for 'gitcvs.usecrlfattr' and
887'gitcvs.allbinary' can also be specified as
888'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
889is one of "ext" and "pserver") to make them apply only for the given
890access method.
04752868 891
d84ae0db
GH
892gui.commitmsgwidth::
893 Defines how wide the commit message window is in the
894 linkgit:git-gui[1]. "75" is the default.
895
896gui.diffcontext::
897 Specifies how many context lines should be used in calls to diff
898 made by the linkgit:git-gui[1]. The default is "5".
899
a2df1fb2
AG
900gui.encoding::
901 Specifies the default encoding to use for displaying of
902 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
903 It can be overridden by setting the 'encoding' attribute
904 for relevant files (see linkgit:gitattributes[5]).
905 If this option is not set, the tools default to the
906 locale encoding.
907
d84ae0db
GH
908gui.matchtrackingbranch::
909 Determines if new branches created with linkgit:git-gui[1] should
910 default to tracking remote branches with matching names or
911 not. Default: "false".
912
913gui.newbranchtemplate::
914 Is used as suggested name when creating new branches using the
915 linkgit:git-gui[1].
916
917gui.pruneduringfetch::
918 "true" if linkgit:git-gui[1] should prune tracking branches when
919 performing a fetch. The default value is "false".
920
921gui.trustmtime::
922 Determines if linkgit:git-gui[1] should trust the file modification
923 timestamp or not. By default the timestamps are not trusted.
924
925gui.spellingdictionary::
926 Specifies the dictionary used for spell checking commit messages in
927 the linkgit:git-gui[1]. When set to "none" spell checking is turned
928 off.
929
a2df1fb2
AG
930gui.fastcopyblame::
931 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
932 location detection. It makes blame significantly faster on huge
933 repositories at the expense of less thorough copy detection.
934
935gui.copyblamethreshold::
76bac890 936 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
937 detection, measured in alphanumeric characters. See the
938 linkgit:git-blame[1] manual for more information on copy detection.
939
940gui.blamehistoryctx::
941 Specifies the radius of history context in days to show in
942 linkgit:gitk[1] for the selected commit, when the `Show History
943 Context` menu item is invoked from 'git gui blame'. If this
944 variable is set to zero, the whole history is shown.
945
390c3480
AG
946guitool.<name>.cmd::
947 Specifies the shell command line to execute when the corresponding item
948 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
949 mandatory for every tool. The command is executed from the root of
950 the working directory, and in the environment it receives the name of
951 the tool as 'GIT_GUITOOL', the name of the currently selected file as
952 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
953 the head is detached, 'CUR_BRANCH' is empty).
954
955guitool.<name>.needsfile::
956 Run the tool only if a diff is selected in the GUI. It guarantees
957 that 'FILENAME' is not empty.
958
959guitool.<name>.noconsole::
960 Run the command silently, without creating a window to display its
961 output.
962
963guitool.<name>.norescan::
964 Don't rescan the working directory for changes after the tool
965 finishes execution.
966
967guitool.<name>.confirm::
968 Show a confirmation dialog before actually running the tool.
969
970guitool.<name>.argprompt::
971 Request a string argument from the user, and pass it to the tool
972 through the 'ARGS' environment variable. Since requesting an
973 argument implies confirmation, the 'confirm' option has no effect
974 if this is enabled. If the option is set to 'true', 'yes', or '1',
975 the dialog uses a built-in generic prompt; otherwise the exact
976 value of the variable is used.
977
978guitool.<name>.revprompt::
979 Request a single valid revision from the user, and set the
980 'REVISION' environment variable. In other aspects this option
981 is similar to 'argprompt', and can be used together with it.
982
983guitool.<name>.revunmerged::
984 Show only unmerged branches in the 'revprompt' subdialog.
985 This is useful for tools similar to merge or rebase, but not
986 for things like checkout or reset.
987
988guitool.<name>.title::
989 Specifies the title to use for the prompt dialog. The default
990 is the tool name.
991
992guitool.<name>.prompt::
993 Specifies the general prompt string to display at the top of
994 the dialog, before subsections for 'argprompt' and 'revprompt'.
995 The default value includes the actual command.
996
983a9eeb
CC
997help.browser::
998 Specify the browser that will be used to display help in the
999 'web' format. See linkgit:git-help[1].
1000
1001help.format::
1002 Override the default help format used by linkgit:git-help[1].
1003 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1004 the default. 'web' and 'html' are the same.
1005
f0e90716
AR
1006help.autocorrect::
1007 Automatically correct and execute mistyped commands after
1008 waiting for the given number of deciseconds (0.1 sec). If more
1009 than one command can be deduced from the entered text, nothing
1010 will be executed. If the value of this option is negative,
1011 the corrected command will be executed immediately. If the
1012 value is 0 - the command will be just shown but not executed.
1013 This is the default.
1014
9c5665aa
SV
1015http.proxy::
1016 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 1017 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 1018 on a per-remote basis; see remote.<name>.proxy
9c5665aa 1019
1ab661dd
PB
1020http.sslVerify::
1021 Whether to verify the SSL certificate when fetching or pushing
37425065 1022 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1023 variable.
1024
1025http.sslCert::
1026 File containing the SSL certificate when fetching or pushing
37425065 1027 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1028 variable.
1029
1030http.sslKey::
1031 File containing the SSL private key when fetching or pushing
abda1ef5 1032 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1033 variable.
1034
1035http.sslCAInfo::
1036 File containing the certificates to verify the peer with when
abda1ef5 1037 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1038 'GIT_SSL_CAINFO' environment variable.
1039
1040http.sslCAPath::
1041 Path containing files with the CA certificates to verify the peer
37425065 1042 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1043 by the 'GIT_SSL_CAPATH' environment variable.
1044
1045http.maxRequests::
abda1ef5 1046 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1047 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1048
1049http.lowSpeedLimit, http.lowSpeedTime::
1050 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1051 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1052 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1053 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1054
3ea099d4
SK
1055http.noEPSV::
1056 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1057 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1058 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1059 environment variable. Default is false (curl will use EPSV).
1060
1ab661dd
PB
1061i18n.commitEncoding::
1062 Character encoding the commit messages are stored in; git itself
1063 does not care per se, but this information is necessary e.g. when
1064 importing commits from emails or in the gitk graphical history
1065 browser (and possibly at other places in the future or in other
5162e697 1066 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1067
d2c11a38
JH
1068i18n.logOutputEncoding::
1069 Character encoding the commit messages are converted to when
ba020ef5 1070 running 'git-log' and friends.
d2c11a38 1071
b0f34c3d
MM
1072imap::
1073 The configuration variables in the 'imap' section are described
1074 in linkgit:git-imap-send[1].
1075
983a9eeb
CC
1076instaweb.browser::
1077 Specify the program that will be used to browse your working
1078 repository in gitweb. See linkgit:git-instaweb[1].
1079
1080instaweb.httpd::
1081 The HTTP daemon command-line to start gitweb on your working
1082 repository. See linkgit:git-instaweb[1].
1083
1084instaweb.local::
1085 If true the web server started by linkgit:git-instaweb[1] will
1086 be bound to the local IP (127.0.0.1).
1087
1088instaweb.modulepath::
1089 The module path for an apache httpd used by linkgit:git-instaweb[1].
1090
1091instaweb.port::
1092 The port number to bind the gitweb httpd to. See
1093 linkgit:git-instaweb[1].
1094
ca6ac7f1
TR
1095interactive.singlekey::
1096 In interactive programs, allow the user to provide one-letter
1097 input with a single key (i.e., without hitting enter).
1098 Currently this is used only by the `\--patch` mode of
1099 linkgit:git-add[1]. Note that this setting is silently
1100 ignored if portable keystroke input is not available.
1101
dd0ffd5b
HO
1102log.date::
1103 Set default date-time mode for the log command. Setting log.date
0979c106 1104 value is similar to using 'git-log'\'s --date option. The value is one of the
dd0ffd5b
HO
1105 following alternatives: {relative,local,default,iso,rfc,short}.
1106 See linkgit:git-log[1].
1107
0f03ca94
PB
1108log.showroot::
1109 If true, the initial commit will be shown as a big creation event.
1110 This is equivalent to a diff against an empty tree.
5162e697 1111 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1112 normally hide the root commit will now show it. True by default.
1113
d551a488
MSO
1114mailmap.file::
1115 The location of an augmenting mailmap file. The default
1116 mailmap, located in the root of the repository, is loaded
1117 first, then the mailmap file pointed to by this variable.
1118 The location of the mailmap file may be in a repository
1119 subdirectory, or somewhere outside of the repository itself.
1120 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1121
b5578f33 1122man.viewer::
b8322ea8 1123 Specify the programs that may be used to display help in the
b5578f33
CC
1124 'man' format. See linkgit:git-help[1].
1125
0bb64009
CC
1126man.<tool>.cmd::
1127 Specify the command to invoke the specified man viewer. The
1128 specified command is evaluated in shell with the man page
1129 passed as argument. (See linkgit:git-help[1].)
1130
7e8114c0
CC
1131man.<tool>.path::
1132 Override the path for the given tool that may be used to
1133 display help in the 'man' format. See linkgit:git-help[1].
1134
b0f34c3d 1135include::merge-config.txt[]
b5412484 1136
77680caa
JS
1137mergetool.<tool>.path::
1138 Override the path for the given tool. This is useful in case
1139 your tool is not in the PATH.
1140
964473a0
CB
1141mergetool.<tool>.cmd::
1142 Specify the command to invoke the specified merge tool. The
1143 specified command is evaluated in shell with the following
1144 variables available: 'BASE' is the name of a temporary file
1145 containing the common base of the files to be merged, if available;
1146 'LOCAL' is the name of a temporary file containing the contents of
1147 the file on the current branch; 'REMOTE' is the name of a temporary
1148 file containing the contents of the file from the branch being
1149 merged; 'MERGED' contains the name of the file to which the merge
1150 tool should write the results of a successful merge.
1151
1152mergetool.<tool>.trustExitCode::
1153 For a custom merge command, specify whether the exit code of
1154 the merge command can be used to determine whether the merge was
1155 successful. If this is not set to true then the merge target file
1156 timestamp is checked and the merge assumed to have been successful
1157 if the file has been updated, otherwise the user is prompted to
1158 indicate the success of the merge.
1159
44c36d1c
CB
1160mergetool.keepBackup::
1161 After performing a merge, the original file with conflict markers
1162 can be saved as a file with a `.orig` extension. If this variable
1163 is set to `false` then this file is not preserved. Defaults to
1164 `true` (i.e. keep the backup files).
1165
162eba8b
CB
1166mergetool.keepTemporaries::
1167 When invoking a custom merge tool, git uses a set of temporary
1168 files to pass to the tool. If the tool returns an error and this
1169 variable is set to `true`, then these temporary files will be
1170 preserved, otherwise they will be removed after the tool has
1171 exited. Defaults to `false`.
1172
682b451f
CB
1173mergetool.prompt::
1174 Prompt before each invocation of the merge resolution program.
1175
4812a93a 1176pack.window::
5162e697 1177 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1178 window size is given on the command line. Defaults to 10.
1179
842aaf93 1180pack.depth::
5162e697 1181 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1182 maximum depth is given on the command line. Defaults to 50.
842aaf93 1183
e93b15cd 1184pack.windowMemory::
5162e697 1185 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1186 when no limit is given on the command line. The value can be
1187 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1188 limit.
1189
960ccca6
DH
1190pack.compression::
1191 An integer -1..9, indicating the compression level for objects
1192 in a pack file. -1 is the zlib default. 0 means no
1193 compression, and 1..9 are various speed/size tradeoffs, 9 being
1194 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1195 not set, defaults to -1, the zlib default, which is "a default
1196 compromise between speed and compression (currently equivalent
1197 to level 6)."
960ccca6 1198
074b2eea 1199pack.deltaCacheSize::
02783075 1200 The maximum memory in bytes used for caching deltas in
5162e697 1201 linkgit:git-pack-objects[1].
074b2eea
MK
1202 A value of 0 means no limit. Defaults to 0.
1203
e3dfddb3 1204pack.deltaCacheLimit::
693b86ff 1205 The maximum size of a delta, that is cached in
5162e697 1206 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 1207
693b86ff
NP
1208pack.threads::
1209 Specifies the number of threads to spawn when searching for best
5162e697 1210 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1211 be compiled with pthreads otherwise this option is ignored with a
1212 warning. This is meant to reduce packing time on multiprocessor
1213 machines. The required amount of memory for the delta search window
1214 is however multiplied by the number of threads.
833e3df1
AE
1215 Specifying 0 will cause git to auto-detect the number of CPU's
1216 and set the number of threads accordingly.
693b86ff 1217
4d00bda2
NP
1218pack.indexVersion::
1219 Specify the default pack index version. Valid values are 1 for
1220 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1221 the new pack index with capabilities for packs larger than 4 GB
1222 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1223 packs. Version 2 is the default. Note that version 2 is enforced
1224 and this config option ignored whenever the corresponding pack is
1225 larger than 2 GB.
1226+
1227If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1228cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1229that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1230other side may give you a repository that cannot be accessed with your
1231older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1232you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1233the `{asterisk}.idx` file.
4d00bda2 1234
dbdbfec4 1235pack.packSizeLimit::
2b84b5a8
JS
1236 The default maximum size of a pack. This setting only affects
1237 packing to a file, i.e. the git:// protocol is unaffected. It
1238 can be overridden by the `\--max-pack-size` option of
1239 linkgit:git-repack[1].
1240
4370c2d6 1241pager.<cmd>::
32818085
JN
1242 Allows turning on or off pagination of the output of a
1243 particular git subcommand when writing to a tty. If
1244 `\--paginate` or `\--no-pager` is specified on the command line,
1245 it takes precedence over this option. To disable pagination for
dcb11263 1246 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1247
1ab661dd
PB
1248pull.octopus::
1249 The default merge strategy to use when pulling multiple branches
1250 at once.
1251
1252pull.twohead::
1253 The default merge strategy to use when pulling a single branch.
1254
52153747
FAG
1255push.default::
1256 Defines the action git push should take if no refspec is given
1257 on the command line, no refspec is configured in the remote, and
1258 no refspec is implied by any of the options given on the command
01eadafc 1259 line. Possible values are:
52153747
FAG
1260+
1261* `nothing` do not push anything.
01eadafc 1262* `matching` push all matching branches.
52153747 1263 All branches having the same name in both ends are considered to be
01eadafc 1264 matching. This is the default.
e892dc71 1265* `tracking` push the current branch to its upstream branch.
01eadafc 1266* `current` push the current branch to a branch of the same name.
52153747 1267
a9c3821c
TAV
1268rebase.stat::
1269 Whether to show a diffstat of what changed upstream since the last
1270 rebase. False by default.
1271
b0f34c3d
MM
1272receive.fsckObjects::
1273 If it is set to true, git-receive-pack will check all received
1274 objects. It will abort in the case of a malformed object or a
1275 broken link. The result of an abort are only dangling objects.
1276 Defaults to false.
1277
1278receive.unpackLimit::
1279 If the number of objects received in a push is below this
1280 limit then the objects will be unpacked into loose object
1281 files. However if the number of received objects equals or
1282 exceeds this limit then the received pack will be stored as
1283 a pack, after adding any missing delta bases. Storing the
1284 pack from a push can make the push operation complete faster,
1285 especially on slow filesystems. If not set, the value of
1286 `transfer.unpackLimit` is used instead.
1287
42fc11c1
JH
1288receive.denyDeletes::
1289 If set to true, git-receive-pack will deny a ref update that deletes
1290 the ref. Use this to prevent such a ref deletion via a push.
1291
1292receive.denyCurrentBranch::
1293 If set to true or "refuse", receive-pack will deny a ref update
1294 to the currently checked out branch of a non-bare repository.
1295 Such a push is potentially dangerous because it brings the HEAD
1296 out of sync with the index and working tree. If set to "warn",
1297 print a warning of such a push to stderr, but allow the push to
1298 proceed. If set to false or "ignore", allow such pushes with no
1299 message. Defaults to "warn".
1300
b0f34c3d
MM
1301receive.denyNonFastForwards::
1302 If set to true, git-receive-pack will deny a ref update which is
1303 not a fast forward. Use this to prevent such an update via a push,
1304 even if that push is forced. This configuration variable is
1305 set when initializing a shared repository.
1306
0cc6d346 1307remote.<name>.url::
5162e697
DM
1308 The URL of a remote repository. See linkgit:git-fetch[1] or
1309 linkgit:git-push[1].
0cc6d346 1310
14c98218
SV
1311remote.<name>.proxy::
1312 For remotes that require curl (http, https and ftp), the URL to
1313 the proxy to use for that remote. Set to the empty string to
1314 disable proxying for that remote.
1315
0cc6d346 1316remote.<name>.fetch::
5162e697
DM
1317 The default set of "refspec" for linkgit:git-fetch[1]. See
1318 linkgit:git-fetch[1].
0cc6d346
SB
1319
1320remote.<name>.push::
5162e697
DM
1321 The default set of "refspec" for linkgit:git-push[1]. See
1322 linkgit:git-push[1].
0cc6d346 1323
84bb2dfd
PB
1324remote.<name>.mirror::
1325 If true, pushing to this remote will automatically behave
1326 as if the `\--mirror` option was given on the command line.
1327
1918278e
TT
1328remote.<name>.skipDefaultUpdate::
1329 If true, this remote will be skipped by default when updating
5162e697 1330 using the update subcommand of linkgit:git-remote[1].
1918278e 1331
060aafc1 1332remote.<name>.receivepack::
5dee29ac 1333 The default program to execute on the remote side when pushing. See
79f43f3d 1334 option \--receive-pack of linkgit:git-push[1].
060aafc1 1335
5dee29ac
UKK
1336remote.<name>.uploadpack::
1337 The default program to execute on the remote side when fetching. See
79f43f3d 1338 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1339
047f636d 1340remote.<name>.tagopt::
79f43f3d
UKK
1341 Setting this value to \--no-tags disables automatic tag following when
1342 fetching from remote <name>
047f636d 1343
1918278e
TT
1344remotes.<group>::
1345 The list of remotes which are fetched by "git remote update
5162e697 1346 <group>". See linkgit:git-remote[1].
1918278e 1347
b6945f57 1348repack.usedeltabaseoffset::
22c79eab
NP
1349 By default, linkgit:git-repack[1] creates packs that use
1350 delta-base offset. If you need to share your repository with
1351 git older than version 1.4.4, either directly or via a dumb
1352 protocol such as http, then you need to set this option to
1353 "false" and repack. Access from old git versions over the
1354 native protocol are unaffected by this option.
b6945f57 1355
b0f34c3d
MM
1356rerere.autoupdate::
1357 When set to true, `git-rerere` updates the index with the
1358 resulting contents after it cleanly resolves conflicts using
1359 previously recorded resolution. Defaults to false.
1360
1361rerere.enabled::
1362 Activate recording of resolved conflicts, so that identical
1363 conflict hunks can be resolved automatically, should they
1364 be encountered again. linkgit:git-rerere[1] command is by
1365 default enabled if you create `rr-cache` directory under
1366 `$GIT_DIR`, but can be disabled by setting this option to false.
1367
1ab661dd 1368showbranch.default::
5162e697
DM
1369 The default set of branches for linkgit:git-show-branch[1].
1370 See linkgit:git-show-branch[1].
1ab661dd 1371
46f721c8 1372status.relativePaths::
5162e697 1373 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1374 current directory. Setting this variable to `false` shows paths
1375 relative to the repository root (this was the default for git
1376 prior to v1.5.4).
1377
d6293d1f
MSO
1378status.showUntrackedFiles::
1379 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1380 files which are not currently tracked by Git. Directories which
1381 contain only untracked files, are shown with the directory name
1382 only. Showing untracked files means that Git needs to lstat() all
1383 all the files in the whole repository, which might be slow on some
1384 systems. So, this variable controls how the commands displays
1385 the untracked files. Possible values are:
1386+
1387--
1388 - 'no' - Show no untracked files
1389 - 'normal' - Shows untracked files and directories
1390 - 'all' - Shows also individual files in untracked directories.
1391--
1392+
1393If this variable is not specified, it defaults to 'normal'.
1394This variable can be overridden with the -u|--untracked-files option
1395of linkgit:git-status[1] and linkgit:git-commit[1].
1396
ce1a79b6 1397tar.umask::
687157c7
RS
1398 This variable can be used to restrict the permission bits of
1399 tar archive entries. The default is 0002, which turns off the
1400 world write bit. The special value "user" indicates that the
1401 archiving user's umask will be used instead. See umask(2) and
5162e697 1402 linkgit:git-archive[1].
ce1a79b6 1403
b0f34c3d
MM
1404transfer.unpackLimit::
1405 When `fetch.unpackLimit` or `receive.unpackLimit` are
1406 not set, the value of this variable is used instead.
1407 The default value is 100.
1408
55029ae4
DB
1409url.<base>.insteadOf::
1410 Any URL that starts with this value will be rewritten to
1411 start, instead, with <base>. In cases where some site serves a
1412 large number of repositories, and serves them with multiple
1413 access methods, and some users need to use different access
1414 methods, this feature allows people to specify any of the
1415 equivalent URLs and have git automatically rewrite the URL to
1416 the best alternative for the particular user, even for a
844112ca
JH
1417 never-before-seen repository on the site. When more than one
1418 insteadOf strings match a given URL, the longest match is used.
55029ae4 1419
1ab661dd
PB
1420user.email::
1421 Your email address to be recorded in any newly created commits.
28a94f88 1422 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1423 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1424
1425user.name::
1426 Your full name to be recorded in any newly created commits.
abda1ef5 1427 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1428 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1429
d67778ec 1430user.signingkey::
5162e697 1431 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1432 automatically when creating a signed tag, you can override the
1433 default selection with this variable. This option is passed
1434 unchanged to gpg's --local-user parameter, so you may specify a key
1435 using any method that gpg supports.
1436
983a9eeb
CC
1437web.browser::
1438 Specify a web browser that may be used by some commands.
1439 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1440 may use it.