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