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