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