Allow git-mergetool to handle paths with a leading space
[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
78a8d641
JS
142core.symlinks::
143 If false, symbolic links are checked out as small plain files that
5162e697
DM
144 contain the link text. linkgit:git-update-index[1] and
145 linkgit:git-add[1] will not change the recorded type to regular
78a8d641
JS
146 file. Useful on filesystems like FAT that do not support
147 symbolic links. True by default.
148
1ab661dd
PB
149core.gitProxy::
150 A "proxy command" to execute (as 'command host port') instead
151 of establishing direct connection to the remote server when
152 using the git protocol for fetching. If the variable value is
153 in the "COMMAND for DOMAIN" format, the command is applied only
154 on hostnames ending with the specified domain string. This variable
155 may be set multiple times and is matched in the given order;
156 the first match wins.
b8936cf0
FD
157+
158Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
159(which always applies universally, without the special "for"
160handling).
1ab661dd
PB
161
162core.ignoreStat::
163 The working copy files are assumed to stay unchanged until you
164 mark them otherwise manually - Git will not detect the file changes
165 by lstat() calls. This is useful on systems where those are very
5162e697 166 slow, such as Microsoft Windows. See linkgit:git-update-index[1].
1ab661dd
PB
167 False by default.
168
9f0bb90d
JH
169core.preferSymlinkRefs::
170 Instead of the default "symref" format for HEAD
171 and other symbolic reference files, use symbolic links.
172 This is sometimes needed to work with old scripts that
173 expect HEAD to be a symbolic link.
1ab661dd 174
e4a15f40
SP
175core.bare::
176 If true this repository is assumed to be 'bare' and has no
177 working directory associated with it. If this is the case a
178 number of commands that require a working directory will be
5162e697 179 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 180+
5162e697
DM
181This setting is automatically guessed by linkgit:git-clone[1] or
182linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
183repository that ends in "/.git" is assumed to be not bare (bare =
184false), while all other repositories are assumed to be bare (bare
185= true).
186
892c41b9
ML
187core.worktree::
188 Set the path to the working tree. The value will not be
189 used in combination with repositories found automatically in
190 a .git directory (i.e. $GIT_DIR is not set).
06ada152 191 This can be overridden by the GIT_WORK_TREE environment
892c41b9
ML
192 variable and the '--work-tree' command line option.
193
6de08ae6 194core.logAllRefUpdates::
14cd5607 195 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
196 "$GIT_DIR/logs/<ref>", by appending the new and old
197 SHA1, the date/time and the reason of the update, but
198 only when the file exists. If this configuration
199 variable is set to true, missing "$GIT_DIR/logs/<ref>"
200 file is automatically created for branch heads.
a862f97e
JH
201+
202This information can be used to determine what commit
203was the tip of a branch "2 days ago".
204+
205This value is true by default in a repository that has
206a working directory associated with it, and false by
207default in a bare repository.
6de08ae6 208
1ab661dd
PB
209core.repositoryFormatVersion::
210 Internal variable identifying the repository format and layout
211 version.
212
213core.sharedRepository::
d5dc6a76
JF
214 When 'group' (or 'true'), the repository is made shareable between
215 several users in a group (making sure all the files and objects are
216 group-writable). When 'all' (or 'world' or 'everybody'), the
217 repository will be readable by all users, additionally to being
218 group-shareable. When 'umask' (or 'false'), git will use permissions
5162e697 219 reported by umask(2). See linkgit:git-init[1]. False by default.
1ab661dd
PB
220
221core.warnAmbiguousRefs::
222 If true, git will warn you if the ref name you passed it is ambiguous
223 and might match multiple refs in the .git/refs/ tree. True by default.
224
3d3e95af 225core.compression::
960ccca6
DH
226 An integer -1..9, indicating a default compression level.
227 -1 is the zlib default. 0 means no compression,
228 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
229 If set, this provides a default to other compression variables,
230 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
231
232core.loosecompression::
12f6c308 233 An integer -1..9, indicating the compression level for objects that
960ccca6 234 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 235 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 236 slowest. If not set, defaults to core.compression. If that is
de1b2460 237 not set, defaults to 1 (best speed).
12f6c308 238
60bb8b14
SP
239core.packedGitWindowSize::
240 Number of bytes of a pack file to map into memory in a
241 single mapping operation. Larger window sizes may allow
242 your system to process a smaller number of large pack files
243 more quickly. Smaller window sizes will negatively affect
eb92242f 244 performance due to increased calls to the operating system's
60bb8b14 245 memory manager, but may improve performance when accessing
22bac0ea
SP
246 a large number of large pack files.
247+
248Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
249MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
250be reasonable for all users/operating systems. You probably do
251not need to adjust this value.
eb92242f
SP
252+
253Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 254
77ccc5bb
SP
255core.packedGitLimit::
256 Maximum number of bytes to map simultaneously into memory
257 from pack files. If Git needs to access more than this many
258 bytes at once to complete an operation it will unmap existing
259 regions to reclaim virtual address space within the process.
22bac0ea
SP
260+
261Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
262This should be reasonable for all users/operating systems, except on
263the largest projects. You probably do not need to adjust this value.
eb92242f
SP
264+
265Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 266
18bdec11
SP
267core.deltaBaseCacheLimit::
268 Maximum number of bytes to reserve for caching base objects
269 that multiple deltafied objects reference. By storing the
270 entire decompressed base objects in a cache Git is able
271 to avoid unpacking and decompressing frequently used base
272 objects multiple times.
273+
274Default is 16 MiB on all platforms. This should be reasonable
275for all users/operating systems, except on the largest projects.
276You probably do not need to adjust this value.
277+
278Common unit suffixes of 'k', 'm', or 'g' are supported.
279
e8964a5b 280core.excludesfile::
0ba956d3
JS
281 In addition to '.gitignore' (per-directory) and
282 '.git/info/exclude', git looks into this file for patterns
cedb8d5d 283 of files which are not meant to be tracked. See
5162e697 284 linkgit:gitignore[5].
0ba956d3 285
ef0c2abf
AR
286core.editor::
287 Commands such as `commit` and `tag` that lets you edit
02783075 288 messages by launching an editor uses the value of this
ef0c2abf
AR
289 variable when it is set, and the environment variable
290 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
291 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
292 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 293
54adf370
BG
294core.pager::
295 The command that git will use to paginate output. Can be overridden
296 with the `GIT_PAGER` environment variable.
297
91af7ae5
JH
298core.whitespace::
299 A comma separated list of common whitespace problems to
300 notice. `git diff` will use `color.diff.whitespace` to
301 highlight them, and `git apply --whitespace=error` will
302 consider them as errors:
303+
304* `trailing-space` treats trailing whitespaces at the end of the line
305 as an error (enabled by default).
306* `space-before-tab` treats a space character that appears immediately
307 before a tab character in the initial indent part of the line as an
308 error (enabled by default).
309* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 310 space characters as an error (not enabled by default).
91af7ae5 311
4514ad4f 312alias.*::
5162e697 313 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
314 after defining "alias.last = cat-file commit HEAD", the invocation
315 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
316 confusion and troubles with script usage, aliases that
317 hide existing git commands are ignored. Arguments are split by
318 spaces, the usual shell quoting and escaping is supported.
319 quote pair and a backslash can be used to quote them.
f368f5a6
JH
320+
321If the alias expansion is prefixed with an exclamation point,
322it will be treated as a shell command. For example, defining
323"alias.new = !gitk --all --not ORIG_HEAD", the invocation
324"git new" is equivalent to running the shell command
325"gitk --all --not ORIG_HEAD".
dfd42a3c 326
1ab661dd
PB
327apply.whitespace::
328 Tells `git-apply` how to handle whitespaces, in the same way
5162e697 329 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 330
9902387d 331branch.autosetupmerge::
5fdcf75c 332 Tells `git-branch` and `git-checkout` to setup new branches
5162e697 333 so that linkgit:git-pull[1] will appropriately merge from that
9902387d
PB
334 remote branch. Note that even if this option is not set,
335 this behavior can be chosen per-branch using the `--track`
6f084a56 336 and `--no-track` options. This option defaults to false.
9902387d 337
648ad18f
SB
338branch.<name>.remote::
339 When in branch <name>, it tells `git fetch` which remote to fetch.
62b339a5 340 If this option is not given, `git fetch` defaults to remote "origin".
648ad18f 341
5372806a 342branch.<name>.merge::
b888d61c
DB
343 When in branch <name>, it tells `git fetch` the default
344 refspec to be marked for merging in FETCH_HEAD. The value is
345 handled like the remote part of a refspec, and must match a
346 ref which is fetched from the remote given by
347 "branch.<name>.remote".
62b339a5
JW
348 The merge information is used by `git pull` (which at first calls
349 `git fetch`) to lookup the default branch for merging. Without
350 this option, `git pull` defaults to merge the first refspec fetched.
351 Specify multiple values to get an octopus merge.
9debc324
PB
352 If you wish to setup `git pull` so that it merges into <name> from
353 another branch in the local repository, you can point
354 branch.<name>.merge to the desired branch, and use the special setting
355 `.` (a period) for branch.<name>.remote.
5372806a 356
aec7b362
LH
357branch.<name>.mergeoptions::
358 Sets default options for merging into branch <name>. The syntax and
5162e697 359 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
360 option values containing whitespace characters are currently not
361 supported.
362
cd67e4d4
JS
363branch.<name>.rebase::
364 When true, rebase the branch <name> on top of the fetched branch,
365 instead of merging the default branch from the default remote.
366 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 367 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
368 for details).
369
2122591b 370clean.requireForce::
562ca192
JH
371 A boolean to make git-clean do nothing unless given -f
372 or -n. Defaults to true.
2122591b 373
f3673988
BG
374color.branch::
375 A boolean to enable/disable color in the output of
5162e697 376 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 377 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
378 only when the output is to a terminal. Defaults to false.
379
380color.branch.<slot>::
381 Use customized color for branch coloration. `<slot>` is one of
382 `current` (the current branch), `local` (a local branch),
383 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
384 refs).
385+
386The value for these configuration variables is a list of colors (at most
387two) and attributes (at most one), separated by spaces. The colors
388accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
389`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
390`blink` and `reverse`. The first color given is the foreground; the
391second is the background. The position of the attribute, if any,
392doesn't matter.
f3673988 393
a159ca0c 394color.diff::
cec99d8c
JH
395 When set to `always`, always use colors in patch.
396 When false (or `never`), never. When set to `true` or `auto`, use
397 colors only when the output is to the terminal. Defaults to false.
b5376648 398
a159ca0c 399color.diff.<slot>::
4f193f20
MW
400 Use customized color for diff colorization. `<slot>` specifies
401 which part of the patch to use the specified color, and is one
402 of `plain` (context text), `meta` (metainformation), `frag`
403 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
404 `commit` (commit headers), or `whitespace` (highlighting
405 whitespace errors). The values of these variables may be specified as
4f193f20 406 in color.branch.<slot>.
b5376648 407
b4c61ed6 408color.interactive::
47ee06f1
JK
409 When set to `always`, always use colors for interactive prompts
410 and displays (such as those used by "git add --interactive").
b4c61ed6
JH
411 When false (or `never`), never. When set to `true` or `auto`, use
412 colors only when the output is to the terminal. Defaults to false.
413
414color.interactive.<slot>::
415 Use customized color for `git add --interactive`
416 output. `<slot>` may be `prompt`, `header`, or `help`, for
417 three distinct types of normal output from interactive
418 programs. The values of these variables may be specified as
419 in color.branch.<slot>.
420
1d77043b
JH
421color.pager::
422 A boolean to enable/disable colored output when the pager is in
423 use (default is true).
424
425color.status::
426 A boolean to enable/disable color in the output of
5162e697 427 linkgit:git-status[1]. May be set to `always`,
cec99d8c 428 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
429 only when the output is to a terminal. Defaults to false.
430
431color.status.<slot>::
432 Use customized color for status colorization. `<slot>` is
433 one of `header` (the header text of the status message),
82dca848
SP
434 `added` or `updated` (files which are added but not committed),
435 `changed` (files which are changed but not added in the index),
1d77043b 436 or `untracked` (files which are not tracked by git). The values of
f3673988 437 these variables may be specified as in color.branch.<slot>.
1d77043b 438
383e45ce
BG
439commit.template::
440 Specify a file to use as the template for new commit messages.
441
aecbf914
JH
442diff.autorefreshindex::
443 When using `git diff` to compare with work tree
444 files, do not consider stat-only change as changed.
445 Instead, silently run `git update-index --refresh` to
446 update the cached stat information for paths whose
447 contents in the work tree match the contents in the
448 index. This option defaults to true. Note that this
449 affects only `git diff` Porcelain, and not lower level
450 `diff` commands, such as `git diff-files`.
451
77680caa
JS
452diff.external::
453 If this config variable is set, diff generation is not
454 performed using the internal diff machinery, but using the
455 given command. Note: if you want to use an external diff
456 program only on a subset of your files, you might want to
5162e697 457 use linkgit:gitattributes[5] instead.
77680caa 458
1ab661dd
PB
459diff.renameLimit::
460 The number of files to consider when performing the copy/rename
461 detection; equivalent to the git diff option '-l'.
462
b68ea12e
EW
463diff.renames::
464 Tells git to detect renames. If set to any boolean value, it
465 will enable basic rename detection. If set to "copies" or
466 "copy", it will detect copies, as well.
467
af7cf268
JH
468fetch.unpackLimit::
469 If the number of objects fetched over the git native
470 transfer is below this
471 limit, then the objects will be unpacked into loose object
472 files. However if the number of received objects equals or
473 exceeds this limit then the received pack will be stored as
474 a pack, after adding any missing delta bases. Storing the
475 pack from a push can make the push operation complete faster,
476 especially on slow filesystems.
477
49604a4d
BG
478format.numbered::
479 A boolean which can enable sequence numbers in patch subjects.
02ff6250 480 Setting this option to "auto" will enable it only if there is
49604a4d 481 more than one patch. See --numbered option in
5162e697 482 linkgit:git-format-patch[1].
49604a4d 483
1ab661dd
PB
484format.headers::
485 Additional email headers to include in a patch to be submitted
5162e697 486 by mail. See linkgit:git-format-patch[1].
1ab661dd 487
78cb59c8
JS
488format.suffix::
489 The default for format-patch is to output files with the suffix
490 `.patch`. Use this variable to change that suffix (make sure to
491 include the dot if you want it).
1ab661dd 492
0d7566a5
TT
493gc.aggressiveWindow::
494 The window size parameter used in the delta compression
495 algorithm used by 'git gc --aggressive'. This defaults
496 to 10.
497
e9831e83
JH
498gc.auto::
499 When there are approximately more than this many loose
500 objects in the repository, `git gc --auto` will pack them.
501 Some Porcelain commands use this command to perform a
502 light-weight garbage collection from time to time. Setting
503 this to 0 disables it.
504
17815501
JH
505gc.autopacklimit::
506 When there are more than this many packs that are not
507 marked with `*.keep` file in the repository, `git gc
508 --auto` consolidates them into one larger pack. Setting
509 this to 0 disables this.
510
c2120e5e
JS
511gc.packrefs::
512 `git gc` does not run `git pack-refs` in a bare repository by
513 default so that older dumb-transport clients can still fetch
514 from the repository. Setting this to `true` lets `git
515 gc` to run `git pack-refs`. Setting this to `false` tells
516 `git gc` never to run `git pack-refs`. The default setting is
517 `notbare`. Enable it only when you know you do not have to
518 support such clients. The default setting will change to `true`
519 at some stage, and setting this to `false` will continue to
520 prevent `git pack-refs` from being run from `git gc`.
521
4aec56d1
JH
522gc.reflogexpire::
523 `git reflog expire` removes reflog entries older than
524 this time; defaults to 90 days.
525
526gc.reflogexpireunreachable::
527 `git reflog expire` removes reflog entries older than
528 this time and are not reachable from the current tip;
529 defaults to 30 days.
530
48c32424
JH
531gc.rerereresolved::
532 Records of conflicted merge you resolved earlier are
533 kept for this many days when `git rerere gc` is run.
5162e697 534 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
535
536gc.rerereunresolved::
537 Records of conflicted merge you have not resolved are
538 kept for this many days when `git rerere gc` is run.
5162e697 539 The default is 15 days. See linkgit:git-rerere[1].
48c32424 540
b4372ef1
JS
541rerere.enabled::
542 Activate recording of resolved conflicts, so that identical
543 conflict hunks can be resolved automatically, should they
5162e697 544 be encountered again. linkgit:git-rerere[1] command is by
4f571479
JH
545 default enabled, but can be disabled by setting this option to
546 false.
b4372ef1 547
1ab661dd 548gitcvs.enabled::
db218723 549 Whether the CVS server interface is enabled for this repository.
5162e697 550 See linkgit:git-cvsserver[1].
1ab661dd
PB
551
552gitcvs.logfile::
db218723 553 Path to a log file where the CVS server interface well... logs
5162e697 554 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 555
eabb0bfd
FL
556gitcvs.allbinary::
557 If true, all files are sent to the client in mode '-kb'. This
558 causes the client to treat all files as binary files which suppresses
559 any newline munging it otherwise might do. A work-around for the
560 fact that there is no way yet to set single files to mode '-kb'.
abbf5947 561
04752868
FL
562gitcvs.dbname::
563 Database used by git-cvsserver to cache revision information
564 derived from the git repository. The exact meaning depends on the
565 used database driver, for SQLite (which is the default driver) this
566 is a filename. Supports variable substitution (see
5162e697 567 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
568 Default: '%Ggitcvs.%m.sqlite'
569
570gitcvs.dbdriver::
571 Used Perl DBI driver. You can specify any available driver
572 for this here, but it might not work. git-cvsserver is tested
573 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
574 reported *not* to work with 'DBD::mysql'. Experimental feature.
575 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 576 See linkgit:git-cvsserver[1].
eabb0bfd 577
04752868
FL
578gitcvs.dbuser, gitcvs.dbpass::
579 Database user and password. Only useful if setting 'gitcvs.dbdriver',
580 since SQLite has no concept of database users and/or passwords.
581 'gitcvs.dbuser' supports variable substitution (see
5162e697 582 linkgit:git-cvsserver[1] for details).
04752868 583
02783075
BH
584All gitcvs variables except for 'gitcvs.allbinary' can also be
585specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
586is one of "ext" and "pserver") to make them apply only for the given
587access method.
04752868 588
9c5665aa
SV
589http.proxy::
590 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 591 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 592 on a per-remote basis; see remote.<name>.proxy
9c5665aa 593
1ab661dd
PB
594http.sslVerify::
595 Whether to verify the SSL certificate when fetching or pushing
37425065 596 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
597 variable.
598
599http.sslCert::
600 File containing the SSL certificate when fetching or pushing
37425065 601 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
602 variable.
603
604http.sslKey::
605 File containing the SSL private key when fetching or pushing
abda1ef5 606 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
607 variable.
608
609http.sslCAInfo::
610 File containing the certificates to verify the peer with when
abda1ef5 611 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
612 'GIT_SSL_CAINFO' environment variable.
613
614http.sslCAPath::
615 Path containing files with the CA certificates to verify the peer
37425065 616 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
617 by the 'GIT_SSL_CAPATH' environment variable.
618
619http.maxRequests::
abda1ef5 620 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
621 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
622
623http.lowSpeedLimit, http.lowSpeedTime::
624 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
625 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 626 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
627 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
628
3ea099d4
SK
629http.noEPSV::
630 A boolean which disables using of EPSV ftp command by curl.
befc9c42 631 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
632 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
633 environment variable. Default is false (curl will use EPSV).
634
1ab661dd
PB
635i18n.commitEncoding::
636 Character encoding the commit messages are stored in; git itself
637 does not care per se, but this information is necessary e.g. when
638 importing commits from emails or in the gitk graphical history
639 browser (and possibly at other places in the future or in other
5162e697 640 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 641
d2c11a38
JH
642i18n.logOutputEncoding::
643 Character encoding the commit messages are converted to when
644 running `git-log` and friends.
645
0f03ca94
PB
646log.showroot::
647 If true, the initial commit will be shown as a big creation event.
648 This is equivalent to a diff against an empty tree.
5162e697 649 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
650 normally hide the root commit will now show it. True by default.
651
1ab661dd
PB
652merge.summary::
653 Whether to include summaries of merged commits in newly created
654 merge commit messages. False by default.
655
c4b4a5af
TT
656merge.tool::
657 Controls which merge resolution program is used by
5162e697 658 linkgit:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff",
730b5b45 659 "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff".
c4b4a5af 660
8c3275ab
SP
661merge.verbosity::
662 Controls the amount of output shown by the recursive merge
663 strategy. Level 0 outputs nothing except a final error
664 message if conflicts were detected. Level 1 outputs only
665 conflicts, 2 outputs conflicts and file changes. Level 5 and
666 above outputs debugging information. The default is level 2.
06ada152 667 Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
8c3275ab 668
88e7fdf2
JH
669merge.<driver>.name::
670 Defines a human readable name for a custom low-level
5162e697 671 merge driver. See linkgit:gitattributes[5] for details.
88e7fdf2
JH
672
673merge.<driver>.driver::
674 Defines the command that implements a custom low-level
5162e697 675 merge driver. See linkgit:gitattributes[5] for details.
88e7fdf2
JH
676
677merge.<driver>.recursive::
678 Names a low-level merge driver to be used when
679 performing an internal merge between common ancestors.
5162e697 680 See linkgit:gitattributes[5] for details.
88e7fdf2 681
77680caa
JS
682mergetool.<tool>.path::
683 Override the path for the given tool. This is useful in case
684 your tool is not in the PATH.
685
4812a93a 686pack.window::
5162e697 687 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
688 window size is given on the command line. Defaults to 10.
689
842aaf93 690pack.depth::
5162e697 691 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 692 maximum depth is given on the command line. Defaults to 50.
842aaf93 693
e93b15cd 694pack.windowMemory::
5162e697 695 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
696 when no limit is given on the command line. The value can be
697 suffixed with "k", "m", or "g". Defaults to 0, meaning no
698 limit.
699
960ccca6
DH
700pack.compression::
701 An integer -1..9, indicating the compression level for objects
702 in a pack file. -1 is the zlib default. 0 means no
703 compression, and 1..9 are various speed/size tradeoffs, 9 being
704 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
705 not set, defaults to -1, the zlib default, which is "a default
706 compromise between speed and compression (currently equivalent
707 to level 6)."
960ccca6 708
074b2eea 709pack.deltaCacheSize::
02783075 710 The maximum memory in bytes used for caching deltas in
5162e697 711 linkgit:git-pack-objects[1].
074b2eea
MK
712 A value of 0 means no limit. Defaults to 0.
713
e3dfddb3 714pack.deltaCacheLimit::
693b86ff 715 The maximum size of a delta, that is cached in
5162e697 716 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 717
693b86ff
NP
718pack.threads::
719 Specifies the number of threads to spawn when searching for best
5162e697 720 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
721 be compiled with pthreads otherwise this option is ignored with a
722 warning. This is meant to reduce packing time on multiprocessor
723 machines. The required amount of memory for the delta search window
724 is however multiplied by the number of threads.
725
4d00bda2
NP
726pack.indexVersion::
727 Specify the default pack index version. Valid values are 1 for
728 legacy pack index used by Git versions prior to 1.5.2, and 2 for
729 the new pack index with capabilities for packs larger than 4 GB
730 as well as proper protection against the repacking of corrupted
731 packs. Version 2 is selected and this config option ignored
732 whenever the corresponding pack is larger than 2 GB. Otherwise
733 the default is 1.
734
1ab661dd
PB
735pull.octopus::
736 The default merge strategy to use when pulling multiple branches
737 at once.
738
739pull.twohead::
740 The default merge strategy to use when pulling a single branch.
741
0cc6d346 742remote.<name>.url::
5162e697
DM
743 The URL of a remote repository. See linkgit:git-fetch[1] or
744 linkgit:git-push[1].
0cc6d346 745
14c98218
SV
746remote.<name>.proxy::
747 For remotes that require curl (http, https and ftp), the URL to
748 the proxy to use for that remote. Set to the empty string to
749 disable proxying for that remote.
750
0cc6d346 751remote.<name>.fetch::
5162e697
DM
752 The default set of "refspec" for linkgit:git-fetch[1]. See
753 linkgit:git-fetch[1].
0cc6d346
SB
754
755remote.<name>.push::
5162e697
DM
756 The default set of "refspec" for linkgit:git-push[1]. See
757 linkgit:git-push[1].
0cc6d346 758
1918278e
TT
759remote.<name>.skipDefaultUpdate::
760 If true, this remote will be skipped by default when updating
5162e697 761 using the update subcommand of linkgit:git-remote[1].
1918278e 762
060aafc1 763remote.<name>.receivepack::
5dee29ac 764 The default program to execute on the remote side when pushing. See
5162e697 765 option \--exec of linkgit:git-push[1].
060aafc1 766
5dee29ac
UKK
767remote.<name>.uploadpack::
768 The default program to execute on the remote side when fetching. See
5162e697 769 option \--exec of linkgit:git-fetch-pack[1].
5dee29ac 770
047f636d
AK
771remote.<name>.tagopt::
772 Setting this value to --no-tags disables automatic tag following when fetching
773 from remote <name>
774
1918278e
TT
775remotes.<group>::
776 The list of remotes which are fetched by "git remote update
5162e697 777 <group>". See linkgit:git-remote[1].
1918278e 778
b6945f57 779repack.usedeltabaseoffset::
5162e697 780 Allow linkgit:git-repack[1] to create packs that uses
b6945f57
JH
781 delta-base offset. Defaults to false.
782
1ab661dd 783show.difftree::
5162e697
DM
784 The default linkgit:git-diff-tree[1] arguments to be used
785 for linkgit:git-show[1].
1ab661dd
PB
786
787showbranch.default::
5162e697
DM
788 The default set of branches for linkgit:git-show-branch[1].
789 See linkgit:git-show-branch[1].
1ab661dd 790
46f721c8 791status.relativePaths::
5162e697 792 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
793 current directory. Setting this variable to `false` shows paths
794 relative to the repository root (this was the default for git
795 prior to v1.5.4).
796
ce1a79b6 797tar.umask::
687157c7
RS
798 This variable can be used to restrict the permission bits of
799 tar archive entries. The default is 0002, which turns off the
800 world write bit. The special value "user" indicates that the
801 archiving user's umask will be used instead. See umask(2) and
5162e697 802 linkgit:git-archive[1].
ce1a79b6 803
1ab661dd
PB
804user.email::
805 Your email address to be recorded in any newly created commits.
28a94f88 806 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 807 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
808
809user.name::
810 Your full name to be recorded in any newly created commits.
abda1ef5 811 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 812 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 813
d67778ec 814user.signingkey::
5162e697 815 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
816 automatically when creating a signed tag, you can override the
817 default selection with this variable. This option is passed
818 unchanged to gpg's --local-user parameter, so you may specify a key
819 using any method that gpg supports.
820
1ab661dd 821whatchanged.difftree::
5162e697
DM
822 The default linkgit:git-diff-tree[1] arguments to be used
823 for linkgit:git-whatchanged[1].
1ab661dd
PB
824
825imap::
826 The configuration variables in the 'imap' section are described
5162e697 827 in linkgit:git-imap-send[1].
199a9218 828
fc04c412
SP
829receive.unpackLimit::
830 If the number of objects received in a push is below this
831 limit then the objects will be unpacked into loose object
832 files. However if the number of received objects equals or
833 exceeds this limit then the received pack will be stored as
834 a pack, after adding any missing delta bases. Storing the
835 pack from a push can make the push operation complete faster,
836 especially on slow filesystems.
837
838receive.denyNonFastForwards::
199a9218
JS
839 If set to true, git-receive-pack will deny a ref update which is
840 not a fast forward. Use this to prevent such an update via a push,
841 even if that push is forced. This configuration variable is
842 set when initializing a shared repository.
843
e28714c5
JH
844transfer.unpackLimit::
845 When `fetch.unpackLimit` or `receive.unpackLimit` are
846 not set, the value of this variable is used instead.