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