git-svn: fix cloning of HTTP URLs with '+' in their path
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
5ea5621f
JH
5the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
32043c9f
JS
8fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
5ea5621f
JH
10
11They can be used by both the git plumbing
b8936cf0 12and the porcelains. The variables are divided into sections, where
1ab661dd
PB
13in the fully qualified variable name the variable itself is the last
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
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must belong to some section, which means that there must be section
30header before first setting of a variable.
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,
34in the section header, like in example below:
35
36--------
37 [section "subsection"]
38
39--------
40
191453f6
JN
41Subsection names can contain any characters except newline (doublequote
42'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
3dff5379 43respectively) and are case sensitive. Section header 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
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
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
56characters and '`-`' are allowed. There can be more than one value
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,
640/1 or true/false. Case is not significant in boolean values, when
65converting value to the canonical form using '--bool' type specifier;
e0d10e1c 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.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
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
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary UNIX fashion.
82
83Some variables may require 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]
95 external = "/usr/local/bin/gnu-diff -u"
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
9378c161
JH
120core.quotepath::
121 The commands that output paths (e.g. `ls-files`,
122 `diff`), when not given the `-z` option, will quote
123 "unusual" characters in the pathname by enclosing the
124 pathname in a double-quote pair and with backslashes the
125 same way strings in C source code are quoted. If this
126 variable is set to false, the bytes higher than 0x80 are
127 not quoted but output as verbatim. Note that double
128 quote, backslash and control characters are always
129 quoted without `-z` regardless of the setting of this
130 variable.
131
5cb71f82
FL
132core.autocrlf::
133 If true, makes git convert `CRLF` at the end of lines in text files to
134 `LF` when reading from the filesystem, and convert in reverse when
135 writing to the filesystem. The variable can be set to
136 'input', in which case the conversion happens only while
137 reading from the filesystem but files are written out with
138 `LF` at the end of lines. Currently, which paths to consider
139 "text" (i.e. be subjected to the autocrlf mechanism) is
140 decided purely based on the contents.
141
21e5ad50
SP
142core.safecrlf::
143 If true, makes git check if converting `CRLF` as controlled by
144 `core.autocrlf` is reversible. Git will verify if a command
145 modifies a file in the work tree either directly or indirectly.
146 For example, committing a file followed by checking out the
147 same file should yield the original file in the work tree. If
148 this is not the case for the current setting of
149 `core.autocrlf`, git will reject the file. The variable can
150 be set to "warn", in which case git will only warn about an
151 irreversible conversion but continue the operation.
152+
153CRLF conversion bears a slight chance of corrupting data.
154autocrlf=true will convert CRLF to LF during commit and LF to
155CRLF during checkout. A file that contains a mixture of LF and
156CRLF before the commit cannot be recreated by git. For text
157files this is the right thing to do: it corrects line endings
158such that we have only LF line endings in the repository.
159But for binary files that are accidentally classified as text the
160conversion can corrupt data.
161+
162If you recognize such corruption early you can easily fix it by
163setting the conversion type explicitly in .gitattributes. Right
164after committing you still have the original file in your work
165tree and this file is not yet corrupted. You can explicitly tell
166git that this file is binary and git will handle the file
167appropriately.
168+
169Unfortunately, the desired effect of cleaning up text files with
170mixed line endings and the undesired effect of corrupting binary
171files cannot be distinguished. In both cases CRLFs are removed
172in an irreversible way. For text files this is the right thing
173to do because CRLFs are line endings, while for binary files
174converting CRLFs corrupts data.
175+
176Note, this safety check does not mean that a checkout will generate a
177file identical to the original file for a different setting of
178`core.autocrlf`, but only for the current one. For example, a text
179file with `LF` would be accepted with `core.autocrlf=input` and could
180later be checked out with `core.autocrlf=true`, in which case the
181resulting file would contain `CRLF`, although the original file
182contained `LF`. However, in both work trees the line endings would be
183consistent, that is either all `LF` or all `CRLF`, but never mixed. A
184file with mixed line endings would be reported by the `core.safecrlf`
185mechanism.
186
78a8d641
JS
187core.symlinks::
188 If false, symbolic links are checked out as small plain files that
5162e697
DM
189 contain the link text. linkgit:git-update-index[1] and
190 linkgit:git-add[1] will not change the recorded type to regular
78a8d641
JS
191 file. Useful on filesystems like FAT that do not support
192 symbolic links. True by default.
193
1ab661dd
PB
194core.gitProxy::
195 A "proxy command" to execute (as 'command host port') instead
196 of establishing direct connection to the remote server when
197 using the git protocol for fetching. If the variable value is
198 in the "COMMAND for DOMAIN" format, the command is applied only
199 on hostnames ending with the specified domain string. This variable
200 may be set multiple times and is matched in the given order;
201 the first match wins.
b8936cf0
FD
202+
203Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
204(which always applies universally, without the special "for"
205handling).
1ab661dd
PB
206
207core.ignoreStat::
208 The working copy files are assumed to stay unchanged until you
209 mark them otherwise manually - Git will not detect the file changes
210 by lstat() calls. This is useful on systems where those are very
5162e697 211 slow, such as Microsoft Windows. See linkgit:git-update-index[1].
1ab661dd
PB
212 False by default.
213
9f0bb90d
JH
214core.preferSymlinkRefs::
215 Instead of the default "symref" format for HEAD
216 and other symbolic reference files, use symbolic links.
217 This is sometimes needed to work with old scripts that
218 expect HEAD to be a symbolic link.
1ab661dd 219
e4a15f40
SP
220core.bare::
221 If true this repository is assumed to be 'bare' and has no
222 working directory associated with it. If this is the case a
223 number of commands that require a working directory will be
5162e697 224 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 225+
5162e697
DM
226This setting is automatically guessed by linkgit:git-clone[1] or
227linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
228repository that ends in "/.git" is assumed to be not bare (bare =
229false), while all other repositories are assumed to be bare (bare
230= true).
231
892c41b9
ML
232core.worktree::
233 Set the path to the working tree. The value will not be
234 used in combination with repositories found automatically in
235 a .git directory (i.e. $GIT_DIR is not set).
06ada152 236 This can be overridden by the GIT_WORK_TREE environment
302cc11a
LY
237 variable and the '--work-tree' command line option. It can be
238 a absolute path or relative path to the directory specified by
239 --git-dir or GIT_DIR.
240 Note: If --git-dir or GIT_DIR are specified but none of
241 --work-tree, GIT_WORK_TREE and core.worktree is specified,
242 the current working directory is regarded as the top directory
243 of your working tree.
892c41b9 244
6de08ae6 245core.logAllRefUpdates::
14cd5607 246 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
247 "$GIT_DIR/logs/<ref>", by appending the new and old
248 SHA1, the date/time and the reason of the update, but
249 only when the file exists. If this configuration
250 variable is set to true, missing "$GIT_DIR/logs/<ref>"
251 file is automatically created for branch heads.
a862f97e
JH
252+
253This information can be used to determine what commit
254was the tip of a branch "2 days ago".
255+
256This value is true by default in a repository that has
257a working directory associated with it, and false by
258default in a bare repository.
6de08ae6 259
1ab661dd
PB
260core.repositoryFormatVersion::
261 Internal variable identifying the repository format and layout
262 version.
263
264core.sharedRepository::
d5dc6a76
JF
265 When 'group' (or 'true'), the repository is made shareable between
266 several users in a group (making sure all the files and objects are
267 group-writable). When 'all' (or 'world' or 'everybody'), the
268 repository will be readable by all users, additionally to being
269 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
270 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
271 files in the repository will have this mode value. '0xxx' will override
272 user's umask value, and thus, users with a safe umask (0077) can use
273 this option. Examples: '0660' is equivalent to 'group'. '0640' is a
274 repository that is group-readable but not group-writable.
275 See linkgit:git-init[1]. False by default.
1ab661dd
PB
276
277core.warnAmbiguousRefs::
278 If true, git will warn you if the ref name you passed it is ambiguous
279 and might match multiple refs in the .git/refs/ tree. True by default.
280
3d3e95af 281core.compression::
960ccca6
DH
282 An integer -1..9, indicating a default compression level.
283 -1 is the zlib default. 0 means no compression,
284 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
285 If set, this provides a default to other compression variables,
286 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
287
288core.loosecompression::
12f6c308 289 An integer -1..9, indicating the compression level for objects that
960ccca6 290 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 291 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 292 slowest. If not set, defaults to core.compression. If that is
de1b2460 293 not set, defaults to 1 (best speed).
12f6c308 294
60bb8b14
SP
295core.packedGitWindowSize::
296 Number of bytes of a pack file to map into memory in a
297 single mapping operation. Larger window sizes may allow
298 your system to process a smaller number of large pack files
299 more quickly. Smaller window sizes will negatively affect
eb92242f 300 performance due to increased calls to the operating system's
60bb8b14 301 memory manager, but may improve performance when accessing
22bac0ea
SP
302 a large number of large pack files.
303+
304Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
305MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
306be reasonable for all users/operating systems. You probably do
307not need to adjust this value.
eb92242f
SP
308+
309Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 310
77ccc5bb
SP
311core.packedGitLimit::
312 Maximum number of bytes to map simultaneously into memory
313 from pack files. If Git needs to access more than this many
314 bytes at once to complete an operation it will unmap existing
315 regions to reclaim virtual address space within the process.
22bac0ea
SP
316+
317Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
318This should be reasonable for all users/operating systems, except on
319the largest projects. You probably do not need to adjust this value.
eb92242f
SP
320+
321Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 322
18bdec11
SP
323core.deltaBaseCacheLimit::
324 Maximum number of bytes to reserve for caching base objects
325 that multiple deltafied objects reference. By storing the
326 entire decompressed base objects in a cache Git is able
327 to avoid unpacking and decompressing frequently used base
328 objects multiple times.
329+
330Default is 16 MiB on all platforms. This should be reasonable
331for all users/operating systems, except on the largest projects.
332You probably do not need to adjust this value.
333+
334Common unit suffixes of 'k', 'm', or 'g' are supported.
335
e8964a5b 336core.excludesfile::
0ba956d3
JS
337 In addition to '.gitignore' (per-directory) and
338 '.git/info/exclude', git looks into this file for patterns
cedb8d5d 339 of files which are not meant to be tracked. See
5162e697 340 linkgit:gitignore[5].
0ba956d3 341
ef0c2abf
AR
342core.editor::
343 Commands such as `commit` and `tag` that lets you edit
02783075 344 messages by launching an editor uses the value of this
ef0c2abf
AR
345 variable when it is set, and the environment variable
346 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
347 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
348 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 349
54adf370
BG
350core.pager::
351 The command that git will use to paginate output. Can be overridden
352 with the `GIT_PAGER` environment variable.
353
91af7ae5
JH
354core.whitespace::
355 A comma separated list of common whitespace problems to
356 notice. `git diff` will use `color.diff.whitespace` to
357 highlight them, and `git apply --whitespace=error` will
358 consider them as errors:
359+
360* `trailing-space` treats trailing whitespaces at the end of the line
361 as an error (enabled by default).
362* `space-before-tab` treats a space character that appears immediately
363 before a tab character in the initial indent part of the line as an
364 error (enabled by default).
365* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 366 space characters as an error (not enabled by default).
b2979ff5
JH
367* `cr-at-eol` treats a carriage-return at the end of line as
368 part of the line terminator, i.e. with it, `trailing-space`
369 does not trigger if the character before such a carriage-return
370 is not a whitespace (not enabled by default).
91af7ae5 371
4514ad4f 372alias.*::
5162e697 373 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
374 after defining "alias.last = cat-file commit HEAD", the invocation
375 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
376 confusion and troubles with script usage, aliases that
377 hide existing git commands are ignored. Arguments are split by
378 spaces, the usual shell quoting and escaping is supported.
379 quote pair and a backslash can be used to quote them.
f368f5a6
JH
380+
381If the alias expansion is prefixed with an exclamation point,
382it will be treated as a shell command. For example, defining
383"alias.new = !gitk --all --not ORIG_HEAD", the invocation
384"git new" is equivalent to running the shell command
385"gitk --all --not ORIG_HEAD".
dfd42a3c 386
1ab661dd
PB
387apply.whitespace::
388 Tells `git-apply` how to handle whitespaces, in the same way
5162e697 389 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 390
9902387d 391branch.autosetupmerge::
5fdcf75c 392 Tells `git-branch` and `git-checkout` to setup new branches
572fc81d
JS
393 so that linkgit:git-pull[1] will appropriately merge from the
394 starting point branch. Note that even if this option is not set,
9902387d 395 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
396 and `--no-track` options. The valid settings are: `false` -- no
397 automatic setup is done; `true` -- automatic setup is done when the
398 starting point is a remote branch; `always` -- automatic setup is
399 done when the starting point is either a local branch or remote
400 branch. This option defaults to true.
9902387d 401
648ad18f
SB
402branch.<name>.remote::
403 When in branch <name>, it tells `git fetch` which remote to fetch.
62b339a5 404 If this option is not given, `git fetch` defaults to remote "origin".
648ad18f 405
5372806a 406branch.<name>.merge::
b888d61c
DB
407 When in branch <name>, it tells `git fetch` the default
408 refspec to be marked for merging in FETCH_HEAD. The value is
409 handled like the remote part of a refspec, and must match a
410 ref which is fetched from the remote given by
411 "branch.<name>.remote".
62b339a5
JW
412 The merge information is used by `git pull` (which at first calls
413 `git fetch`) to lookup the default branch for merging. Without
414 this option, `git pull` defaults to merge the first refspec fetched.
415 Specify multiple values to get an octopus merge.
9debc324
PB
416 If you wish to setup `git pull` so that it merges into <name> from
417 another branch in the local repository, you can point
418 branch.<name>.merge to the desired branch, and use the special setting
419 `.` (a period) for branch.<name>.remote.
5372806a 420
aec7b362
LH
421branch.<name>.mergeoptions::
422 Sets default options for merging into branch <name>. The syntax and
5162e697 423 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
424 option values containing whitespace characters are currently not
425 supported.
426
cd67e4d4
JS
427branch.<name>.rebase::
428 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
429 instead of merging the default branch from the default remote when
430 "git pull" is run.
cd67e4d4 431 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 432 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
433 for details).
434
1658c614
CC
435browser.<tool>.cmd::
436 Specify the command to invoke the specified browser. The
437 specified command is evaluated in shell with the URLs passed
438 as arguments. (See linkgit:git-web--browse[1].)
439
584627b4
CC
440browser.<tool>.path::
441 Override the path for the given tool that may be used to
ab989adf
CC
442 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
443 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 444
2122591b 445clean.requireForce::
562ca192
JH
446 A boolean to make git-clean do nothing unless given -f
447 or -n. Defaults to true.
2122591b 448
f3673988
BG
449color.branch::
450 A boolean to enable/disable color in the output of
5162e697 451 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 452 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
453 only when the output is to a terminal. Defaults to false.
454
455color.branch.<slot>::
456 Use customized color for branch coloration. `<slot>` is one of
457 `current` (the current branch), `local` (a local branch),
458 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
459 refs).
460+
461The value for these configuration variables is a list of colors (at most
462two) and attributes (at most one), separated by spaces. The colors
463accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
464`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
465`blink` and `reverse`. The first color given is the foreground; the
466second is the background. The position of the attribute, if any,
467doesn't matter.
f3673988 468
a159ca0c 469color.diff::
cec99d8c
JH
470 When set to `always`, always use colors in patch.
471 When false (or `never`), never. When set to `true` or `auto`, use
472 colors only when the output is to the terminal. Defaults to false.
b5376648 473
a159ca0c 474color.diff.<slot>::
4f193f20
MW
475 Use customized color for diff colorization. `<slot>` specifies
476 which part of the patch to use the specified color, and is one
477 of `plain` (context text), `meta` (metainformation), `frag`
478 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
479 `commit` (commit headers), or `whitespace` (highlighting
480 whitespace errors). The values of these variables may be specified as
4f193f20 481 in color.branch.<slot>.
b5376648 482
b4c61ed6 483color.interactive::
47ee06f1
JK
484 When set to `always`, always use colors for interactive prompts
485 and displays (such as those used by "git add --interactive").
b4c61ed6
JH
486 When false (or `never`), never. When set to `true` or `auto`, use
487 colors only when the output is to the terminal. Defaults to false.
488
489color.interactive.<slot>::
490 Use customized color for `git add --interactive`
491 output. `<slot>` may be `prompt`, `header`, or `help`, for
492 three distinct types of normal output from interactive
493 programs. The values of these variables may be specified as
494 in color.branch.<slot>.
495
1d77043b
JH
496color.pager::
497 A boolean to enable/disable colored output when the pager is in
498 use (default is true).
499
500color.status::
501 A boolean to enable/disable color in the output of
5162e697 502 linkgit:git-status[1]. May be set to `always`,
cec99d8c 503 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
504 only when the output is to a terminal. Defaults to false.
505
506color.status.<slot>::
507 Use customized color for status colorization. `<slot>` is
508 one of `header` (the header text of the status message),
82dca848
SP
509 `added` or `updated` (files which are added but not committed),
510 `changed` (files which are changed but not added in the index),
1d77043b 511 or `untracked` (files which are not tracked by git). The values of
f3673988 512 these variables may be specified as in color.branch.<slot>.
1d77043b 513
383e45ce
BG
514commit.template::
515 Specify a file to use as the template for new commit messages.
516
6b2f2d98
MK
517color.ui::
518 When set to `always`, always use colors in all git commands which
519 are capable of colored output. When false (or `never`), never. When
520 set to `true` or `auto`, use colors only when the output is to the
521 terminal. When more specific variables of color.* are set, they always
522 take precedence over this setting. Defaults to false.
523
aecbf914
JH
524diff.autorefreshindex::
525 When using `git diff` to compare with work tree
526 files, do not consider stat-only change as changed.
527 Instead, silently run `git update-index --refresh` to
528 update the cached stat information for paths whose
529 contents in the work tree match the contents in the
530 index. This option defaults to true. Note that this
531 affects only `git diff` Porcelain, and not lower level
532 `diff` commands, such as `git diff-files`.
533
77680caa
JS
534diff.external::
535 If this config variable is set, diff generation is not
536 performed using the internal diff machinery, but using the
537 given command. Note: if you want to use an external diff
538 program only on a subset of your files, you might want to
5162e697 539 use linkgit:gitattributes[5] instead.
77680caa 540
1ab661dd
PB
541diff.renameLimit::
542 The number of files to consider when performing the copy/rename
543 detection; equivalent to the git diff option '-l'.
544
b68ea12e
EW
545diff.renames::
546 Tells git to detect renames. If set to any boolean value, it
547 will enable basic rename detection. If set to "copies" or
548 "copy", it will detect copies, as well.
549
af7cf268
JH
550fetch.unpackLimit::
551 If the number of objects fetched over the git native
552 transfer is below this
553 limit, then the objects will be unpacked into loose object
554 files. However if the number of received objects equals or
555 exceeds this limit then the received pack will be stored as
556 a pack, after adding any missing delta bases. Storing the
557 pack from a push can make the push operation complete faster,
80cd9cf9
MB
558 especially on slow filesystems. If not set, the value of
559 `transfer.unpackLimit` is used instead.
af7cf268 560
49604a4d
BG
561format.numbered::
562 A boolean which can enable sequence numbers in patch subjects.
02ff6250 563 Setting this option to "auto" will enable it only if there is
49604a4d 564 more than one patch. See --numbered option in
5162e697 565 linkgit:git-format-patch[1].
49604a4d 566
1ab661dd
PB
567format.headers::
568 Additional email headers to include in a patch to be submitted
5162e697 569 by mail. See linkgit:git-format-patch[1].
1ab661dd 570
78cb59c8
JS
571format.suffix::
572 The default for format-patch is to output files with the suffix
573 `.patch`. Use this variable to change that suffix (make sure to
574 include the dot if you want it).
1ab661dd 575
94c22a5e
CR
576format.pretty::
577 The default pretty format for log/show/whatchanged command,
578 See linkgit:git-log[1], linkgit:git-show[1],
579 linkgit:git-whatchanged[1].
580
0d7566a5
TT
581gc.aggressiveWindow::
582 The window size parameter used in the delta compression
583 algorithm used by 'git gc --aggressive'. This defaults
584 to 10.
585
e9831e83
JH
586gc.auto::
587 When there are approximately more than this many loose
588 objects in the repository, `git gc --auto` will pack them.
589 Some Porcelain commands use this command to perform a
80cd9cf9
MB
590 light-weight garbage collection from time to time. The
591 default value is 6700. Setting this to 0 disables it.
e9831e83 592
17815501
JH
593gc.autopacklimit::
594 When there are more than this many packs that are not
595 marked with `*.keep` file in the repository, `git gc
80cd9cf9 596 --auto` consolidates them into one larger pack. The
97063974 597 default value is 50. Setting this to 0 disables it.
17815501 598
c2120e5e
JS
599gc.packrefs::
600 `git gc` does not run `git pack-refs` in a bare repository by
601 default so that older dumb-transport clients can still fetch
602 from the repository. Setting this to `true` lets `git
603 gc` to run `git pack-refs`. Setting this to `false` tells
604 `git gc` never to run `git pack-refs`. The default setting is
605 `notbare`. Enable it only when you know you do not have to
606 support such clients. The default setting will change to `true`
607 at some stage, and setting this to `false` will continue to
608 prevent `git pack-refs` from being run from `git gc`.
609
25ee9731
JS
610gc.pruneexpire::
611 When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
612 Override the grace period with this config variable.
613
4aec56d1
JH
614gc.reflogexpire::
615 `git reflog expire` removes reflog entries older than
616 this time; defaults to 90 days.
617
618gc.reflogexpireunreachable::
619 `git reflog expire` removes reflog entries older than
620 this time and are not reachable from the current tip;
621 defaults to 30 days.
622
48c32424
JH
623gc.rerereresolved::
624 Records of conflicted merge you resolved earlier are
625 kept for this many days when `git rerere gc` is run.
5162e697 626 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
627
628gc.rerereunresolved::
629 Records of conflicted merge you have not resolved are
630 kept for this many days when `git rerere gc` is run.
5162e697 631 The default is 15 days. See linkgit:git-rerere[1].
48c32424 632
b4372ef1
JS
633rerere.enabled::
634 Activate recording of resolved conflicts, so that identical
635 conflict hunks can be resolved automatically, should they
5162e697 636 be encountered again. linkgit:git-rerere[1] command is by
11c57e6a
JH
637 default enabled if you create `rr-cache` directory under
638 `$GIT_DIR`, but can be disabled by setting this option to false.
b4372ef1 639
1ab661dd 640gitcvs.enabled::
db218723 641 Whether the CVS server interface is enabled for this repository.
5162e697 642 See linkgit:git-cvsserver[1].
1ab661dd
PB
643
644gitcvs.logfile::
db218723 645 Path to a log file where the CVS server interface well... logs
5162e697 646 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 647
eabb0bfd
FL
648gitcvs.allbinary::
649 If true, all files are sent to the client in mode '-kb'. This
650 causes the client to treat all files as binary files which suppresses
651 any newline munging it otherwise might do. A work-around for the
652 fact that there is no way yet to set single files to mode '-kb'.
abbf5947 653
04752868
FL
654gitcvs.dbname::
655 Database used by git-cvsserver to cache revision information
656 derived from the git repository. The exact meaning depends on the
657 used database driver, for SQLite (which is the default driver) this
658 is a filename. Supports variable substitution (see
5162e697 659 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
660 Default: '%Ggitcvs.%m.sqlite'
661
662gitcvs.dbdriver::
663 Used Perl DBI driver. You can specify any available driver
664 for this here, but it might not work. git-cvsserver is tested
665 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
666 reported *not* to work with 'DBD::mysql'. Experimental feature.
667 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 668 See linkgit:git-cvsserver[1].
eabb0bfd 669
04752868
FL
670gitcvs.dbuser, gitcvs.dbpass::
671 Database user and password. Only useful if setting 'gitcvs.dbdriver',
672 since SQLite has no concept of database users and/or passwords.
673 'gitcvs.dbuser' supports variable substitution (see
5162e697 674 linkgit:git-cvsserver[1] for details).
04752868 675
6aeeffd1
JE
676gitcvs.dbTableNamePrefix::
677 Database table name prefix. Prepended to the names of any
678 database tables used, allowing a single database to be used
679 for several repositories. Supports variable substitution (see
680 linkgit:git-cvsserver[1] for details). Any non-alphabetic
681 characters will be replaced with underscores.
682
02783075
BH
683All gitcvs variables except for 'gitcvs.allbinary' can also be
684specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
685is one of "ext" and "pserver") to make them apply only for the given
686access method.
04752868 687
d84ae0db
GH
688gui.commitmsgwidth::
689 Defines how wide the commit message window is in the
690 linkgit:git-gui[1]. "75" is the default.
691
692gui.diffcontext::
693 Specifies how many context lines should be used in calls to diff
694 made by the linkgit:git-gui[1]. The default is "5".
695
696gui.matchtrackingbranch::
697 Determines if new branches created with linkgit:git-gui[1] should
698 default to tracking remote branches with matching names or
699 not. Default: "false".
700
701gui.newbranchtemplate::
702 Is used as suggested name when creating new branches using the
703 linkgit:git-gui[1].
704
705gui.pruneduringfetch::
706 "true" if linkgit:git-gui[1] should prune tracking branches when
707 performing a fetch. The default value is "false".
708
709gui.trustmtime::
710 Determines if linkgit:git-gui[1] should trust the file modification
711 timestamp or not. By default the timestamps are not trusted.
712
713gui.spellingdictionary::
714 Specifies the dictionary used for spell checking commit messages in
715 the linkgit:git-gui[1]. When set to "none" spell checking is turned
716 off.
717
983a9eeb
CC
718help.browser::
719 Specify the browser that will be used to display help in the
720 'web' format. See linkgit:git-help[1].
721
722help.format::
723 Override the default help format used by linkgit:git-help[1].
724 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
725 the default. 'web' and 'html' are the same.
726
9c5665aa
SV
727http.proxy::
728 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 729 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 730 on a per-remote basis; see remote.<name>.proxy
9c5665aa 731
1ab661dd
PB
732http.sslVerify::
733 Whether to verify the SSL certificate when fetching or pushing
37425065 734 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
735 variable.
736
737http.sslCert::
738 File containing the SSL certificate when fetching or pushing
37425065 739 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
740 variable.
741
742http.sslKey::
743 File containing the SSL private key when fetching or pushing
abda1ef5 744 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
745 variable.
746
747http.sslCAInfo::
748 File containing the certificates to verify the peer with when
abda1ef5 749 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
750 'GIT_SSL_CAINFO' environment variable.
751
752http.sslCAPath::
753 Path containing files with the CA certificates to verify the peer
37425065 754 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
755 by the 'GIT_SSL_CAPATH' environment variable.
756
757http.maxRequests::
abda1ef5 758 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
759 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
760
761http.lowSpeedLimit, http.lowSpeedTime::
762 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
763 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 764 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
765 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
766
3ea099d4
SK
767http.noEPSV::
768 A boolean which disables using of EPSV ftp command by curl.
befc9c42 769 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
770 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
771 environment variable. Default is false (curl will use EPSV).
772
1ab661dd
PB
773i18n.commitEncoding::
774 Character encoding the commit messages are stored in; git itself
775 does not care per se, but this information is necessary e.g. when
776 importing commits from emails or in the gitk graphical history
777 browser (and possibly at other places in the future or in other
5162e697 778 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 779
d2c11a38
JH
780i18n.logOutputEncoding::
781 Character encoding the commit messages are converted to when
782 running `git-log` and friends.
783
983a9eeb
CC
784instaweb.browser::
785 Specify the program that will be used to browse your working
786 repository in gitweb. See linkgit:git-instaweb[1].
787
788instaweb.httpd::
789 The HTTP daemon command-line to start gitweb on your working
790 repository. See linkgit:git-instaweb[1].
791
792instaweb.local::
793 If true the web server started by linkgit:git-instaweb[1] will
794 be bound to the local IP (127.0.0.1).
795
796instaweb.modulepath::
797 The module path for an apache httpd used by linkgit:git-instaweb[1].
798
799instaweb.port::
800 The port number to bind the gitweb httpd to. See
801 linkgit:git-instaweb[1].
802
0f03ca94
PB
803log.showroot::
804 If true, the initial commit will be shown as a big creation event.
805 This is equivalent to a diff against an empty tree.
5162e697 806 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
807 normally hide the root commit will now show it. True by default.
808
b5578f33 809man.viewer::
b8322ea8 810 Specify the programs that may be used to display help in the
b5578f33
CC
811 'man' format. See linkgit:git-help[1].
812
f5a84c37 813include::merge-config.txt[]
88e7fdf2 814
0bb64009
CC
815man.<tool>.cmd::
816 Specify the command to invoke the specified man viewer. The
817 specified command is evaluated in shell with the man page
818 passed as argument. (See linkgit:git-help[1].)
819
7e8114c0
CC
820man.<tool>.path::
821 Override the path for the given tool that may be used to
822 display help in the 'man' format. See linkgit:git-help[1].
823
77680caa
JS
824mergetool.<tool>.path::
825 Override the path for the given tool. This is useful in case
826 your tool is not in the PATH.
827
964473a0
CB
828mergetool.<tool>.cmd::
829 Specify the command to invoke the specified merge tool. The
830 specified command is evaluated in shell with the following
831 variables available: 'BASE' is the name of a temporary file
832 containing the common base of the files to be merged, if available;
833 'LOCAL' is the name of a temporary file containing the contents of
834 the file on the current branch; 'REMOTE' is the name of a temporary
835 file containing the contents of the file from the branch being
836 merged; 'MERGED' contains the name of the file to which the merge
837 tool should write the results of a successful merge.
838
839mergetool.<tool>.trustExitCode::
840 For a custom merge command, specify whether the exit code of
841 the merge command can be used to determine whether the merge was
842 successful. If this is not set to true then the merge target file
843 timestamp is checked and the merge assumed to have been successful
844 if the file has been updated, otherwise the user is prompted to
845 indicate the success of the merge.
846
44c36d1c
CB
847mergetool.keepBackup::
848 After performing a merge, the original file with conflict markers
849 can be saved as a file with a `.orig` extension. If this variable
850 is set to `false` then this file is not preserved. Defaults to
851 `true` (i.e. keep the backup files).
852
4812a93a 853pack.window::
5162e697 854 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
855 window size is given on the command line. Defaults to 10.
856
842aaf93 857pack.depth::
5162e697 858 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 859 maximum depth is given on the command line. Defaults to 50.
842aaf93 860
e93b15cd 861pack.windowMemory::
5162e697 862 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
863 when no limit is given on the command line. The value can be
864 suffixed with "k", "m", or "g". Defaults to 0, meaning no
865 limit.
866
960ccca6
DH
867pack.compression::
868 An integer -1..9, indicating the compression level for objects
869 in a pack file. -1 is the zlib default. 0 means no
870 compression, and 1..9 are various speed/size tradeoffs, 9 being
871 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
872 not set, defaults to -1, the zlib default, which is "a default
873 compromise between speed and compression (currently equivalent
874 to level 6)."
960ccca6 875
074b2eea 876pack.deltaCacheSize::
02783075 877 The maximum memory in bytes used for caching deltas in
5162e697 878 linkgit:git-pack-objects[1].
074b2eea
MK
879 A value of 0 means no limit. Defaults to 0.
880
e3dfddb3 881pack.deltaCacheLimit::
693b86ff 882 The maximum size of a delta, that is cached in
5162e697 883 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 884
693b86ff
NP
885pack.threads::
886 Specifies the number of threads to spawn when searching for best
5162e697 887 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
888 be compiled with pthreads otherwise this option is ignored with a
889 warning. This is meant to reduce packing time on multiprocessor
890 machines. The required amount of memory for the delta search window
891 is however multiplied by the number of threads.
833e3df1
AE
892 Specifying 0 will cause git to auto-detect the number of CPU's
893 and set the number of threads accordingly.
693b86ff 894
4d00bda2
NP
895pack.indexVersion::
896 Specify the default pack index version. Valid values are 1 for
897 legacy pack index used by Git versions prior to 1.5.2, and 2 for
898 the new pack index with capabilities for packs larger than 4 GB
899 as well as proper protection against the repacking of corrupted
900 packs. Version 2 is selected and this config option ignored
901 whenever the corresponding pack is larger than 2 GB. Otherwise
902 the default is 1.
903
dbdbfec4 904pack.packSizeLimit::
2b84b5a8
JS
905 The default maximum size of a pack. This setting only affects
906 packing to a file, i.e. the git:// protocol is unaffected. It
907 can be overridden by the `\--max-pack-size` option of
908 linkgit:git-repack[1].
909
1ab661dd
PB
910pull.octopus::
911 The default merge strategy to use when pulling multiple branches
912 at once.
913
914pull.twohead::
915 The default merge strategy to use when pulling a single branch.
916
0cc6d346 917remote.<name>.url::
5162e697
DM
918 The URL of a remote repository. See linkgit:git-fetch[1] or
919 linkgit:git-push[1].
0cc6d346 920
14c98218
SV
921remote.<name>.proxy::
922 For remotes that require curl (http, https and ftp), the URL to
923 the proxy to use for that remote. Set to the empty string to
924 disable proxying for that remote.
925
0cc6d346 926remote.<name>.fetch::
5162e697
DM
927 The default set of "refspec" for linkgit:git-fetch[1]. See
928 linkgit:git-fetch[1].
0cc6d346
SB
929
930remote.<name>.push::
5162e697
DM
931 The default set of "refspec" for linkgit:git-push[1]. See
932 linkgit:git-push[1].
0cc6d346 933
84bb2dfd
PB
934remote.<name>.mirror::
935 If true, pushing to this remote will automatically behave
936 as if the `\--mirror` option was given on the command line.
937
1918278e
TT
938remote.<name>.skipDefaultUpdate::
939 If true, this remote will be skipped by default when updating
5162e697 940 using the update subcommand of linkgit:git-remote[1].
1918278e 941
060aafc1 942remote.<name>.receivepack::
5dee29ac 943 The default program to execute on the remote side when pushing. See
79f43f3d 944 option \--receive-pack of linkgit:git-push[1].
060aafc1 945
5dee29ac
UKK
946remote.<name>.uploadpack::
947 The default program to execute on the remote side when fetching. See
79f43f3d 948 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 949
047f636d 950remote.<name>.tagopt::
79f43f3d
UKK
951 Setting this value to \--no-tags disables automatic tag following when
952 fetching from remote <name>
047f636d 953
1918278e
TT
954remotes.<group>::
955 The list of remotes which are fetched by "git remote update
5162e697 956 <group>". See linkgit:git-remote[1].
1918278e 957
b6945f57 958repack.usedeltabaseoffset::
5162e697 959 Allow linkgit:git-repack[1] to create packs that uses
b6945f57
JH
960 delta-base offset. Defaults to false.
961
1ab661dd 962show.difftree::
5162e697
DM
963 The default linkgit:git-diff-tree[1] arguments to be used
964 for linkgit:git-show[1].
1ab661dd
PB
965
966showbranch.default::
5162e697
DM
967 The default set of branches for linkgit:git-show-branch[1].
968 See linkgit:git-show-branch[1].
1ab661dd 969
46f721c8 970status.relativePaths::
5162e697 971 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
972 current directory. Setting this variable to `false` shows paths
973 relative to the repository root (this was the default for git
974 prior to v1.5.4).
975
ce1a79b6 976tar.umask::
687157c7
RS
977 This variable can be used to restrict the permission bits of
978 tar archive entries. The default is 0002, which turns off the
979 world write bit. The special value "user" indicates that the
980 archiving user's umask will be used instead. See umask(2) and
5162e697 981 linkgit:git-archive[1].
ce1a79b6 982
55029ae4
DB
983url.<base>.insteadOf::
984 Any URL that starts with this value will be rewritten to
985 start, instead, with <base>. In cases where some site serves a
986 large number of repositories, and serves them with multiple
987 access methods, and some users need to use different access
988 methods, this feature allows people to specify any of the
989 equivalent URLs and have git automatically rewrite the URL to
990 the best alternative for the particular user, even for a
844112ca
JH
991 never-before-seen repository on the site. When more than one
992 insteadOf strings match a given URL, the longest match is used.
55029ae4 993
1ab661dd
PB
994user.email::
995 Your email address to be recorded in any newly created commits.
28a94f88 996 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 997 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
998
999user.name::
1000 Your full name to be recorded in any newly created commits.
abda1ef5 1001 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1002 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1003
d67778ec 1004user.signingkey::
5162e697 1005 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1006 automatically when creating a signed tag, you can override the
1007 default selection with this variable. This option is passed
1008 unchanged to gpg's --local-user parameter, so you may specify a key
1009 using any method that gpg supports.
1010
1ab661dd 1011whatchanged.difftree::
5162e697
DM
1012 The default linkgit:git-diff-tree[1] arguments to be used
1013 for linkgit:git-whatchanged[1].
1ab661dd
PB
1014
1015imap::
1016 The configuration variables in the 'imap' section are described
5162e697 1017 in linkgit:git-imap-send[1].
199a9218 1018
20dc0016
MK
1019receive.fsckObjects::
1020 If it is set to true, git-receive-pack will check all received
1021 objects. It will abort in the case of a malformed object or a
1022 broken link. The result of an abort are only dangling objects.
1023 Defaults to false.
1024
fc04c412
SP
1025receive.unpackLimit::
1026 If the number of objects received in a push is below this
1027 limit then the objects will be unpacked into loose object
1028 files. However if the number of received objects equals or
1029 exceeds this limit then the received pack will be stored as
1030 a pack, after adding any missing delta bases. Storing the
1031 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1032 especially on slow filesystems. If not set, the value of
1033 `transfer.unpackLimit` is used instead.
fc04c412
SP
1034
1035receive.denyNonFastForwards::
199a9218
JS
1036 If set to true, git-receive-pack will deny a ref update which is
1037 not a fast forward. Use this to prevent such an update via a push,
1038 even if that push is forced. This configuration variable is
1039 set when initializing a shared repository.
1040
e28714c5
JH
1041transfer.unpackLimit::
1042 When `fetch.unpackLimit` or `receive.unpackLimit` are
1043 not set, the value of this variable is used instead.
80cd9cf9 1044 The default value is 100.
983a9eeb
CC
1045
1046web.browser::
1047 Specify a web browser that may be used by some commands.
1048 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1049 may use it.