Documentation: use lowercase for shallow and deep threading
[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
dcb11263 28characters, `-` and `.` are allowed in section names. Each variable
e136f33b
JN
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 41Subsection names can contain any characters except newline (doublequote
dcb11263 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
dcb11263 56characters and `-` are allowed. There can be more than one value
e136f33b
JN
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,
0cbcf7ad 640/1, true/false or on/off. Case is not significant in boolean values, when
e136f33b 65converting value to the canonical form using '--bool' type specifier;
ba020ef5 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 ';').
dcb11263
CJ
72Double quote `"` and backslash `\` characters in variable value must
73be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 74
dcb11263
CJ
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
e136f33b
JN
78char sequences are valid.
79
dcb11263 80Variable value ending in a `\` is continued on the next line in the
e136f33b
JN
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]
6bb9e51b 95 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
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
adbc0b6b
DP
120core.ignoreCygwinFSTricks::
121 This option is only used by Cygwin implementation of Git. If false,
122 the Cygwin stat() and lstat() functions are used. This may be useful
123 if your repository consists of a few separate directories joined in
124 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125 whenever it is possible and falls back to Cygwin functions only to
126 handle symbol links. The native mode is more than twice faster than
7faee6b8
ML
127 normal Cygwin l/stat() functions. True by default, unless core.filemode
128 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129 POSIX emulation is required to support core.filemode.
adbc0b6b 130
1ce4790b
AR
131core.trustctime::
132 If false, the ctime differences between the index and the
133 working copy are ignored; useful when the inode change time
134 is regularly modified by something outside Git (file system
135 crawlers and some backup systems).
136 See linkgit:git-update-index[1]. True by default.
137
9378c161 138core.quotepath::
5833d730
JN
139 The commands that output paths (e.g. 'ls-files',
140 'diff'), when not given the `-z` option, will quote
9378c161
JH
141 "unusual" characters in the pathname by enclosing the
142 pathname in a double-quote pair and with backslashes the
143 same way strings in C source code are quoted. If this
144 variable is set to false, the bytes higher than 0x80 are
145 not quoted but output as verbatim. Note that double
146 quote, backslash and control characters are always
147 quoted without `-z` regardless of the setting of this
148 variable.
149
5cb71f82
FL
150core.autocrlf::
151 If true, makes git convert `CRLF` at the end of lines in text files to
152 `LF` when reading from the filesystem, and convert in reverse when
153 writing to the filesystem. The variable can be set to
154 'input', in which case the conversion happens only while
155 reading from the filesystem but files are written out with
156 `LF` at the end of lines. Currently, which paths to consider
157 "text" (i.e. be subjected to the autocrlf mechanism) is
158 decided purely based on the contents.
159
21e5ad50
SP
160core.safecrlf::
161 If true, makes git check if converting `CRLF` as controlled by
162 `core.autocrlf` is reversible. Git will verify if a command
163 modifies a file in the work tree either directly or indirectly.
164 For example, committing a file followed by checking out the
165 same file should yield the original file in the work tree. If
166 this is not the case for the current setting of
167 `core.autocrlf`, git will reject the file. The variable can
168 be set to "warn", in which case git will only warn about an
169 irreversible conversion but continue the operation.
170+
171CRLF conversion bears a slight chance of corrupting data.
172autocrlf=true will convert CRLF to LF during commit and LF to
173CRLF during checkout. A file that contains a mixture of LF and
174CRLF before the commit cannot be recreated by git. For text
175files this is the right thing to do: it corrects line endings
176such that we have only LF line endings in the repository.
177But for binary files that are accidentally classified as text the
178conversion can corrupt data.
179+
180If you recognize such corruption early you can easily fix it by
181setting the conversion type explicitly in .gitattributes. Right
182after committing you still have the original file in your work
183tree and this file is not yet corrupted. You can explicitly tell
184git that this file is binary and git will handle the file
185appropriately.
186+
187Unfortunately, the desired effect of cleaning up text files with
188mixed line endings and the undesired effect of corrupting binary
189files cannot be distinguished. In both cases CRLFs are removed
190in an irreversible way. For text files this is the right thing
191to do because CRLFs are line endings, while for binary files
192converting CRLFs corrupts data.
193+
194Note, this safety check does not mean that a checkout will generate a
195file identical to the original file for a different setting of
196`core.autocrlf`, but only for the current one. For example, a text
197file with `LF` would be accepted with `core.autocrlf=input` and could
198later be checked out with `core.autocrlf=true`, in which case the
199resulting file would contain `CRLF`, although the original file
200contained `LF`. However, in both work trees the line endings would be
201consistent, that is either all `LF` or all `CRLF`, but never mixed. A
202file with mixed line endings would be reported by the `core.safecrlf`
203mechanism.
204
78a8d641
JS
205core.symlinks::
206 If false, symbolic links are checked out as small plain files that
5162e697
DM
207 contain the link text. linkgit:git-update-index[1] and
208 linkgit:git-add[1] will not change the recorded type to regular
78a8d641
JS
209 file. Useful on filesystems like FAT that do not support
210 symbolic links. True by default.
211
1ab661dd
PB
212core.gitProxy::
213 A "proxy command" to execute (as 'command host port') instead
214 of establishing direct connection to the remote server when
215 using the git protocol for fetching. If the variable value is
216 in the "COMMAND for DOMAIN" format, the command is applied only
217 on hostnames ending with the specified domain string. This variable
218 may be set multiple times and is matched in the given order;
219 the first match wins.
b8936cf0
FD
220+
221Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222(which always applies universally, without the special "for"
223handling).
642d0844
ES
224+
225The special string `none` can be used as the proxy command to
226specify that no proxy be used for a given domain pattern.
227This is useful for excluding servers inside a firewall from
228proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
229
230core.ignoreStat::
b7f685a7
MSO
231 If true, commands which modify both the working tree and the index
232 will mark the updated paths with the "assume unchanged" bit in the
233 index. These marked files are then assumed to stay unchanged in the
234 working copy, until you mark them otherwise manually - Git will not
235 detect the file changes by lstat() calls. This is useful on systems
236 where those are very slow, such as Microsoft Windows.
237 See linkgit:git-update-index[1].
1ab661dd
PB
238 False by default.
239
9f0bb90d
JH
240core.preferSymlinkRefs::
241 Instead of the default "symref" format for HEAD
242 and other symbolic reference files, use symbolic links.
243 This is sometimes needed to work with old scripts that
244 expect HEAD to be a symbolic link.
1ab661dd 245
e4a15f40
SP
246core.bare::
247 If true this repository is assumed to be 'bare' and has no
248 working directory associated with it. If this is the case a
249 number of commands that require a working directory will be
5162e697 250 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 251+
5162e697
DM
252This setting is automatically guessed by linkgit:git-clone[1] or
253linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
254repository that ends in "/.git" is assumed to be not bare (bare =
255false), while all other repositories are assumed to be bare (bare
256= true).
257
892c41b9
ML
258core.worktree::
259 Set the path to the working tree. The value will not be
260 used in combination with repositories found automatically in
261 a .git directory (i.e. $GIT_DIR is not set).
06ada152 262 This can be overridden by the GIT_WORK_TREE environment
302cc11a
LY
263 variable and the '--work-tree' command line option. It can be
264 a absolute path or relative path to the directory specified by
265 --git-dir or GIT_DIR.
266 Note: If --git-dir or GIT_DIR are specified but none of
267 --work-tree, GIT_WORK_TREE and core.worktree is specified,
268 the current working directory is regarded as the top directory
269 of your working tree.
892c41b9 270
6de08ae6 271core.logAllRefUpdates::
14cd5607 272 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
273 "$GIT_DIR/logs/<ref>", by appending the new and old
274 SHA1, the date/time and the reason of the update, but
275 only when the file exists. If this configuration
276 variable is set to true, missing "$GIT_DIR/logs/<ref>"
277 file is automatically created for branch heads.
a862f97e
JH
278+
279This information can be used to determine what commit
280was the tip of a branch "2 days ago".
281+
282This value is true by default in a repository that has
283a working directory associated with it, and false by
284default in a bare repository.
6de08ae6 285
1ab661dd
PB
286core.repositoryFormatVersion::
287 Internal variable identifying the repository format and layout
288 version.
289
290core.sharedRepository::
d5dc6a76
JF
291 When 'group' (or 'true'), the repository is made shareable between
292 several users in a group (making sure all the files and objects are
293 group-writable). When 'all' (or 'world' or 'everybody'), the
294 repository will be readable by all users, additionally to being
295 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
296 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
297 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
298 user's umask value (whereas the other options will only override
299 requested parts of the user's umask value). Examples: '0660' will make
300 the repo read/write-able for the owner and group, but inaccessible to
301 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
302 repository that is group-readable but not group-writable.
303 See linkgit:git-init[1]. False by default.
1ab661dd
PB
304
305core.warnAmbiguousRefs::
306 If true, git will warn you if the ref name you passed it is ambiguous
307 and might match multiple refs in the .git/refs/ tree. True by default.
308
3d3e95af 309core.compression::
960ccca6
DH
310 An integer -1..9, indicating a default compression level.
311 -1 is the zlib default. 0 means no compression,
312 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
313 If set, this provides a default to other compression variables,
314 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
315
316core.loosecompression::
12f6c308 317 An integer -1..9, indicating the compression level for objects that
960ccca6 318 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 319 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 320 slowest. If not set, defaults to core.compression. If that is
de1b2460 321 not set, defaults to 1 (best speed).
12f6c308 322
60bb8b14
SP
323core.packedGitWindowSize::
324 Number of bytes of a pack file to map into memory in a
325 single mapping operation. Larger window sizes may allow
326 your system to process a smaller number of large pack files
327 more quickly. Smaller window sizes will negatively affect
eb92242f 328 performance due to increased calls to the operating system's
60bb8b14 329 memory manager, but may improve performance when accessing
22bac0ea
SP
330 a large number of large pack files.
331+
332Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
333MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
334be reasonable for all users/operating systems. You probably do
335not need to adjust this value.
eb92242f
SP
336+
337Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 338
77ccc5bb
SP
339core.packedGitLimit::
340 Maximum number of bytes to map simultaneously into memory
341 from pack files. If Git needs to access more than this many
342 bytes at once to complete an operation it will unmap existing
343 regions to reclaim virtual address space within the process.
22bac0ea
SP
344+
345Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
346This should be reasonable for all users/operating systems, except on
347the largest projects. You probably do not need to adjust this value.
eb92242f
SP
348+
349Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 350
18bdec11
SP
351core.deltaBaseCacheLimit::
352 Maximum number of bytes to reserve for caching base objects
353 that multiple deltafied objects reference. By storing the
354 entire decompressed base objects in a cache Git is able
355 to avoid unpacking and decompressing frequently used base
356 objects multiple times.
357+
358Default is 16 MiB on all platforms. This should be reasonable
359for all users/operating systems, except on the largest projects.
360You probably do not need to adjust this value.
361+
362Common unit suffixes of 'k', 'm', or 'g' are supported.
363
e8964a5b 364core.excludesfile::
0ba956d3
JS
365 In addition to '.gitignore' (per-directory) and
366 '.git/info/exclude', git looks into this file for patterns
cedb8d5d 367 of files which are not meant to be tracked. See
5162e697 368 linkgit:gitignore[5].
0ba956d3 369
ef0c2abf
AR
370core.editor::
371 Commands such as `commit` and `tag` that lets you edit
02783075 372 messages by launching an editor uses the value of this
ef0c2abf
AR
373 variable when it is set, and the environment variable
374 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
375 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
376 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 377
54adf370 378core.pager::
ab54cd6c
JN
379 The command that git will use to paginate output. Can
380 be overridden with the `GIT_PAGER` environment
381 variable. Note that git sets the `LESS` environment
382 variable to `FRSX` if it is unset when it runs the
383 pager. One can change these settings by setting the
fee75457
CF
384 `LESS` variable to some other value. Alternately,
385 these settings can be overridden on a project or
386 global basis by setting the `core.pager` option.
387 Setting `core.pager` has no affect on the `LESS`
388 environment variable behaviour above, so if you want
389 to override git's default settings this way, you need
390 to be explicit. For example, to disable the S option
391 in a backward compatible manner, set `core.pager`
dcb11263 392 to `less -+$LESS -FRX`. This will be passed to the
fee75457 393 shell by git, which will translate the final command to
dcb11263 394 `LESS=FRSX less -+FRSX -FRX`.
54adf370 395
91af7ae5
JH
396core.whitespace::
397 A comma separated list of common whitespace problems to
ba020ef5
JN
398 notice. 'git-diff' will use `color.diff.whitespace` to
399 highlight them, and 'git-apply --whitespace=error' will
c921cc92
JH
400 consider them as errors. You can prefix `-` to disable
401 any of them (e.g. `-trailing-space`):
91af7ae5
JH
402+
403* `trailing-space` treats trailing whitespaces at the end of the line
404 as an error (enabled by default).
405* `space-before-tab` treats a space character that appears immediately
406 before a tab character in the initial indent part of the line as an
407 error (enabled by default).
408* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 409 space characters as an error (not enabled by default).
b2979ff5
JH
410* `cr-at-eol` treats a carriage-return at the end of line as
411 part of the line terminator, i.e. with it, `trailing-space`
412 does not trigger if the character before such a carriage-return
413 is not a whitespace (not enabled by default).
91af7ae5 414
aafe9fba
LT
415core.fsyncobjectfiles::
416 This boolean will enable 'fsync()' when writing object files.
417+
418This is a total waste of time and effort on a filesystem that orders
419data writes properly, but can be useful for filesystems that do not use
420journalling (traditional UNIX filesystems) or that only journal metadata
421and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
422
671c9b7e
LT
423core.preloadindex::
424 Enable parallel index preload for operations like 'git diff'
425+
426This can speed up operations like 'git diff' and 'git status' especially
427on filesystems like NFS that have weak caching semantics and thus
428relatively high IO latencies. With this set to 'true', git will do the
429index comparison to the filesystem data in parallel, allowing
430overlapping IO's.
431
4514ad4f 432alias.*::
5162e697 433 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
434 after defining "alias.last = cat-file commit HEAD", the invocation
435 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
436 confusion and troubles with script usage, aliases that
437 hide existing git commands are ignored. Arguments are split by
438 spaces, the usual shell quoting and escaping is supported.
439 quote pair and a backslash can be used to quote them.
f368f5a6
JH
440+
441If the alias expansion is prefixed with an exclamation point,
442it will be treated as a shell command. For example, defining
443"alias.new = !gitk --all --not ORIG_HEAD", the invocation
444"git new" is equivalent to running the shell command
445"gitk --all --not ORIG_HEAD".
dfd42a3c 446
1ab661dd 447apply.whitespace::
ba020ef5 448 Tells 'git-apply' how to handle whitespaces, in the same way
5162e697 449 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 450
9902387d 451branch.autosetupmerge::
ba020ef5 452 Tells 'git-branch' and 'git-checkout' to setup new branches
572fc81d
JS
453 so that linkgit:git-pull[1] will appropriately merge from the
454 starting point branch. Note that even if this option is not set,
9902387d 455 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
456 and `--no-track` options. The valid settings are: `false` -- no
457 automatic setup is done; `true` -- automatic setup is done when the
458 starting point is a remote branch; `always` -- automatic setup is
459 done when the starting point is either a local branch or remote
460 branch. This option defaults to true.
9902387d 461
c998ae9b 462branch.autosetuprebase::
ba020ef5 463 When a new branch is created with 'git-branch' or 'git-checkout'
c998ae9b
DS
464 that tracks another branch, this variable tells git to set
465 up pull to rebase instead of merge (see "branch.<name>.rebase").
466 When `never`, rebase is never automatically set to true.
467 When `local`, rebase is set to true for tracked branches of
468 other local branches.
469 When `remote`, rebase is set to true for tracked branches of
470 remote branches.
471 When `always`, rebase will be set to true for all tracking
472 branches.
473 See "branch.autosetupmerge" for details on how to set up a
474 branch to track another branch.
475 This option defaults to never.
476
648ad18f 477branch.<name>.remote::
76d3cc50
SB
478 When in branch <name>, it tells 'git-fetch' and 'git-push' which
479 remote to fetch from/push to. It defaults to `origin` if no remote is
480 configured. `origin` is also used if you are not on any branch.
648ad18f 481
5372806a 482branch.<name>.merge::
76d3cc50
SB
483 Defines, together with branch.<name>.remote, the upstream branch
484 for the given branch. It tells 'git-fetch'/'git-pull' which
5c9c9903 485 branch to merge and can also affect 'git-push' (see push.default).
ba020ef5 486 When in branch <name>, it tells 'git-fetch' the default
b888d61c
DB
487 refspec to be marked for merging in FETCH_HEAD. The value is
488 handled like the remote part of a refspec, and must match a
489 ref which is fetched from the remote given by
490 "branch.<name>.remote".
ba020ef5
JN
491 The merge information is used by 'git-pull' (which at first calls
492 'git-fetch') to lookup the default branch for merging. Without
493 this option, 'git-pull' defaults to merge the first refspec fetched.
62b339a5 494 Specify multiple values to get an octopus merge.
ba020ef5 495 If you wish to setup 'git-pull' so that it merges into <name> from
9debc324
PB
496 another branch in the local repository, you can point
497 branch.<name>.merge to the desired branch, and use the special setting
498 `.` (a period) for branch.<name>.remote.
5372806a 499
aec7b362
LH
500branch.<name>.mergeoptions::
501 Sets default options for merging into branch <name>. The syntax and
5162e697 502 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
503 option values containing whitespace characters are currently not
504 supported.
505
cd67e4d4
JS
506branch.<name>.rebase::
507 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
508 instead of merging the default branch from the default remote when
509 "git pull" is run.
cd67e4d4 510 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 511 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
512 for details).
513
1658c614
CC
514browser.<tool>.cmd::
515 Specify the command to invoke the specified browser. The
516 specified command is evaluated in shell with the URLs passed
517 as arguments. (See linkgit:git-web--browse[1].)
518
584627b4
CC
519browser.<tool>.path::
520 Override the path for the given tool that may be used to
ab989adf
CC
521 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
522 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 523
2122591b 524clean.requireForce::
562ca192
JH
525 A boolean to make git-clean do nothing unless given -f
526 or -n. Defaults to true.
2122591b 527
f3673988
BG
528color.branch::
529 A boolean to enable/disable color in the output of
5162e697 530 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 531 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
532 only when the output is to a terminal. Defaults to false.
533
534color.branch.<slot>::
535 Use customized color for branch coloration. `<slot>` is one of
536 `current` (the current branch), `local` (a local branch),
537 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
538 refs).
539+
540The value for these configuration variables is a list of colors (at most
541two) and attributes (at most one), separated by spaces. The colors
542accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
543`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
544`blink` and `reverse`. The first color given is the foreground; the
545second is the background. The position of the attribute, if any,
546doesn't matter.
f3673988 547
a159ca0c 548color.diff::
cec99d8c
JH
549 When set to `always`, always use colors in patch.
550 When false (or `never`), never. When set to `true` or `auto`, use
551 colors only when the output is to the terminal. Defaults to false.
b5376648 552
a159ca0c 553color.diff.<slot>::
4f193f20
MW
554 Use customized color for diff colorization. `<slot>` specifies
555 which part of the patch to use the specified color, and is one
556 of `plain` (context text), `meta` (metainformation), `frag`
557 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
558 `commit` (commit headers), or `whitespace` (highlighting
559 whitespace errors). The values of these variables may be specified as
4f193f20 560 in color.branch.<slot>.
b5376648 561
7e8f59d5
RS
562color.grep::
563 When set to `always`, always highlight matches. When `false` (or
564 `never`), never. When set to `true` or `auto`, use color only
565 when the output is written to the terminal. Defaults to `false`.
566
a94982ef
RS
567color.grep.external::
568 The string value of this variable is passed to an external 'grep'
569 command as a command line option if match highlighting is turned
570 on. If set to an empty string, no option is passed at all,
571 turning off coloring for external 'grep' calls; this is the default.
572 For GNU grep, set it to `--color=always` to highlight matches even
573 when a pager is used.
574
7e8f59d5
RS
575color.grep.match::
576 Use customized color for matches. The value of this variable
a94982ef
RS
577 may be specified as in color.branch.<slot>. It is passed using
578 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
579 calling an external 'grep'.
7e8f59d5 580
b4c61ed6 581color.interactive::
47ee06f1 582 When set to `always`, always use colors for interactive prompts
467c0197 583 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
584 When false (or `never`), never. When set to `true` or `auto`, use
585 colors only when the output is to the terminal. Defaults to false.
586
587color.interactive.<slot>::
ba020ef5 588 Use customized color for 'git-add --interactive'
a3019736
TR
589 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
590 four distinct types of normal output from interactive
b4c61ed6
JH
591 programs. The values of these variables may be specified as
592 in color.branch.<slot>.
593
1d77043b
JH
594color.pager::
595 A boolean to enable/disable colored output when the pager is in
596 use (default is true).
597
598color.status::
599 A boolean to enable/disable color in the output of
5162e697 600 linkgit:git-status[1]. May be set to `always`,
cec99d8c 601 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
602 only when the output is to a terminal. Defaults to false.
603
604color.status.<slot>::
605 Use customized color for status colorization. `<slot>` is
606 one of `header` (the header text of the status message),
82dca848
SP
607 `added` or `updated` (files which are added but not committed),
608 `changed` (files which are changed but not added in the index),
950ce2e2
CP
609 `untracked` (files which are not tracked by git), or
610 `nobranch` (the color the 'no branch' warning is shown in, defaulting
611 to red). The values of these variables may be specified as in
612 color.branch.<slot>.
1d77043b 613
6b2f2d98
MK
614color.ui::
615 When set to `always`, always use colors in all git commands which
616 are capable of colored output. When false (or `never`), never. When
617 set to `true` or `auto`, use colors only when the output is to the
618 terminal. When more specific variables of color.* are set, they always
619 take precedence over this setting. Defaults to false.
620
b0f34c3d
MM
621commit.template::
622 Specify a file to use as the template for new commit messages.
623
aecbf914 624diff.autorefreshindex::
ba020ef5 625 When using 'git-diff' to compare with work tree
aecbf914
JH
626 files, do not consider stat-only change as changed.
627 Instead, silently run `git update-index --refresh` to
628 update the cached stat information for paths whose
629 contents in the work tree match the contents in the
630 index. This option defaults to true. Note that this
ba020ef5 631 affects only 'git-diff' Porcelain, and not lower level
5833d730 632 'diff' commands, such as 'git-diff-files'.
aecbf914 633
77680caa
JS
634diff.external::
635 If this config variable is set, diff generation is not
636 performed using the internal diff machinery, but using the
6bb9e51b
AM
637 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
638 environment variable. The command is called with parameters
639 as described under "git Diffs" in linkgit:git[1]. Note: if
640 you want to use an external diff program only on a subset of
641 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 642
a5a818ee
JH
643diff.mnemonicprefix::
644 If set, 'git-diff' uses a prefix pair that is different from the
645 standard "a/" and "b/" depending on what is being compared. When
646 this configuration is in effect, reverse diff output also swaps
647 the order of the prefixes:
648'git-diff';;
649 compares the (i)ndex and the (w)ork tree;
650'git-diff HEAD';;
651 compares a (c)ommit and the (w)ork tree;
652'git diff --cached';;
653 compares a (c)ommit and the (i)ndex;
654'git-diff HEAD:file1 file2';;
655 compares an (o)bject and a (w)ork tree entity;
656'git diff --no-index a b';;
657 compares two non-git things (1) and (2).
658
1ab661dd
PB
659diff.renameLimit::
660 The number of files to consider when performing the copy/rename
0979c106 661 detection; equivalent to the 'git-diff' option '-l'.
1ab661dd 662
b68ea12e
EW
663diff.renames::
664 Tells git to detect renames. If set to any boolean value, it
665 will enable basic rename detection. If set to "copies" or
666 "copy", it will detect copies, as well.
667
950db879 668diff.suppressBlankEmpty::
5fdb7098
RH
669 A boolean to inhibit the standard behavior of printing a space
670 before each empty output line. Defaults to false.
671
afcbc8e7
DA
672diff.tool::
673 Controls which diff tool is used. `diff.tool` overrides
674 `merge.tool` when used by linkgit:git-difftool[1] and has
675 the same valid values as `merge.tool` minus "tortoisemerge"
676 and plus "kompare".
677
678difftool.<tool>.path::
679 Override the path for the given tool. This is useful in case
680 your tool is not in the PATH.
681
682difftool.<tool>.cmd::
683 Specify the command to invoke the specified diff tool.
684 The specified command is evaluated in shell with the following
685 variables available: 'LOCAL' is set to the name of the temporary
686 file containing the contents of the diff pre-image and 'REMOTE'
687 is set to the name of the temporary file containing the contents
688 of the diff post-image.
689
a904392e
DA
690difftool.prompt::
691 Prompt before each invocation of the diff tool.
692
ae3b970a 693diff.wordRegex::
98a4d87b
BSSJ
694 A POSIX Extended Regular Expression used to determine what is a "word"
695 when performing word-by-word difference calculations. Character
696 sequences that match the regular expression are "words", all other
697 characters are *ignorable* whitespace.
698
af7cf268
JH
699fetch.unpackLimit::
700 If the number of objects fetched over the git native
701 transfer is below this
702 limit, then the objects will be unpacked into loose object
703 files. However if the number of received objects equals or
704 exceeds this limit then the received pack will be stored as
705 a pack, after adding any missing delta bases. Storing the
706 pack from a push can make the push operation complete faster,
80cd9cf9
MB
707 especially on slow filesystems. If not set, the value of
708 `transfer.unpackLimit` is used instead.
af7cf268 709
48d3448d
SB
710format.attach::
711 Enable multipart/mixed attachments as the default for
712 'format-patch'. The value can also be a double quoted string
713 which will enable attachments as the default and set the
714 value as the boundary. See the --attach option in
715 linkgit:git-format-patch[1].
716
49604a4d 717format.numbered::
a567fdcb
BG
718 A boolean which can enable or disable sequence numbers in patch
719 subjects. It defaults to "auto" which enables it only if there
720 is more than one patch. It can be enabled or disabled for all
721 messages by setting it to "true" or "false". See --numbered
722 option in linkgit:git-format-patch[1].
49604a4d 723
1ab661dd
PB
724format.headers::
725 Additional email headers to include in a patch to be submitted
5162e697 726 by mail. See linkgit:git-format-patch[1].
1ab661dd 727
48d3448d
SB
728format.cc::
729 Additional "Cc:" headers to include in a patch to be submitted
730 by mail. See the --cc option in linkgit:git-format-patch[1].
731
732format.subjectprefix::
733 The default for format-patch is to output files with the '[PATCH]'
734 subject prefix. Use this variable to change that prefix.
735
78cb59c8
JS
736format.suffix::
737 The default for format-patch is to output files with the suffix
738 `.patch`. Use this variable to change that suffix (make sure to
739 include the dot if you want it).
1ab661dd 740
94c22a5e
CR
741format.pretty::
742 The default pretty format for log/show/whatchanged command,
743 See linkgit:git-log[1], linkgit:git-show[1],
744 linkgit:git-whatchanged[1].
745
30984ed2
TR
746format.thread::
747 The default threading style for 'git-format-patch'. Can be
fd1ff306 748 either a boolean value, `shallow` or `deep`. `shallow`
30984ed2
TR
749 threading makes every mail a reply to the head of the series,
750 where the head is chosen from the cover letter, the
751 `\--in-reply-to`, and the first patch mail, in this order.
fd1ff306 752 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
753 A true boolean value is the same as `shallow`, and a false
754 value disables threading.
755
1d1876e9
HV
756format.signoff::
757 A boolean value which lets you enable the `-s/--signoff` option of
758 format-patch by default. *Note:* Adding the Signed-off-by: line to a
759 patch should be a conscious act and means that you certify you have
760 the rights to submit this work under the same open source license.
761 Please see the 'SubmittingPatches' document for further discussion.
762
0d7566a5
TT
763gc.aggressiveWindow::
764 The window size parameter used in the delta compression
467c0197 765 algorithm used by 'git-gc --aggressive'. This defaults
0d7566a5
TT
766 to 10.
767
e9831e83
JH
768gc.auto::
769 When there are approximately more than this many loose
770 objects in the repository, `git gc --auto` will pack them.
771 Some Porcelain commands use this command to perform a
80cd9cf9
MB
772 light-weight garbage collection from time to time. The
773 default value is 6700. Setting this to 0 disables it.
e9831e83 774
17815501
JH
775gc.autopacklimit::
776 When there are more than this many packs that are not
777 marked with `*.keep` file in the repository, `git gc
80cd9cf9 778 --auto` consolidates them into one larger pack. The
97063974 779 default value is 50. Setting this to 0 disables it.
17815501 780
c2120e5e 781gc.packrefs::
ba020ef5 782 'git-gc' does not run `git pack-refs` in a bare repository by
c2120e5e 783 default so that older dumb-transport clients can still fetch
ba020ef5 784 from the repository. Setting this to `true` lets 'git-gc'
7a7d4ef6 785 to run `git pack-refs`. Setting this to `false` tells
ba020ef5 786 'git-gc' never to run `git pack-refs`. The default setting is
c2120e5e
JS
787 `notbare`. Enable it only when you know you do not have to
788 support such clients. The default setting will change to `true`
789 at some stage, and setting this to `false` will continue to
ba020ef5 790 prevent `git pack-refs` from being run from 'git-gc'.
c2120e5e 791
25ee9731 792gc.pruneexpire::
5833d730 793 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
794 Override the grace period with this config variable. The value
795 "now" may be used to disable this grace period and always prune
796 unreachable objects immediately.
25ee9731 797
4aec56d1 798gc.reflogexpire::
ba020ef5 799 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
800 this time; defaults to 90 days.
801
802gc.reflogexpireunreachable::
ba020ef5 803 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
804 this time and are not reachable from the current tip;
805 defaults to 30 days.
806
48c32424
JH
807gc.rerereresolved::
808 Records of conflicted merge you resolved earlier are
ba020ef5 809 kept for this many days when 'git-rerere gc' is run.
5162e697 810 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
811
812gc.rerereunresolved::
813 Records of conflicted merge you have not resolved are
ba020ef5 814 kept for this many days when 'git-rerere gc' is run.
5162e697 815 The default is 15 days. See linkgit:git-rerere[1].
48c32424 816
280514e1
FE
817gitcvs.commitmsgannotation::
818 Append this string to each commit message. Set to empty string
819 to disable this feature. Defaults to "via git-CVS emulator".
820
1ab661dd 821gitcvs.enabled::
db218723 822 Whether the CVS server interface is enabled for this repository.
5162e697 823 See linkgit:git-cvsserver[1].
1ab661dd
PB
824
825gitcvs.logfile::
db218723 826 Path to a log file where the CVS server interface well... logs
5162e697 827 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 828
1707adb7 829gitcvs.usecrlfattr::
8a06a632
MO
830 If true, the server will look up the `crlf` attribute for
831 files to determine the '-k' modes to use. If `crlf` is set,
832 the '-k' mode will be left blank, so cvs clients will
833 treat it as text. If `crlf` is explicitly unset, the file
1168d402 834 will be set with '-kb' mode, which suppresses any newline munging
8a06a632 835 the client might otherwise do. If `crlf` is not specified,
ea449615 836 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
8a06a632 837
eabb0bfd 838gitcvs.allbinary::
90948a42
MO
839 This is used if 'gitcvs.usecrlfattr' does not resolve
840 the correct '-kb' mode to use. If true, all
841 unresolved files are sent to the client in
842 mode '-kb'. This causes the client to treat them
843 as binary files, which suppresses any newline munging it
844 otherwise might do. Alternatively, if it is set to "guess",
845 then the contents of the file are examined to decide if
846 it is binary, similar to 'core.autocrlf'.
abbf5947 847
04752868
FL
848gitcvs.dbname::
849 Database used by git-cvsserver to cache revision information
850 derived from the git repository. The exact meaning depends on the
851 used database driver, for SQLite (which is the default driver) this
852 is a filename. Supports variable substitution (see
5162e697 853 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
854 Default: '%Ggitcvs.%m.sqlite'
855
856gitcvs.dbdriver::
857 Used Perl DBI driver. You can specify any available driver
858 for this here, but it might not work. git-cvsserver is tested
859 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
860 reported *not* to work with 'DBD::mysql'. Experimental feature.
861 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 862 See linkgit:git-cvsserver[1].
eabb0bfd 863
04752868
FL
864gitcvs.dbuser, gitcvs.dbpass::
865 Database user and password. Only useful if setting 'gitcvs.dbdriver',
866 since SQLite has no concept of database users and/or passwords.
867 'gitcvs.dbuser' supports variable substitution (see
5162e697 868 linkgit:git-cvsserver[1] for details).
04752868 869
6aeeffd1
JE
870gitcvs.dbTableNamePrefix::
871 Database table name prefix. Prepended to the names of any
872 database tables used, allowing a single database to be used
873 for several repositories. Supports variable substitution (see
874 linkgit:git-cvsserver[1] for details). Any non-alphabetic
875 characters will be replaced with underscores.
876
8a06a632
MO
877All gitcvs variables except for 'gitcvs.usecrlfattr' and
878'gitcvs.allbinary' can also be specified as
879'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
880is one of "ext" and "pserver") to make them apply only for the given
881access method.
04752868 882
d84ae0db
GH
883gui.commitmsgwidth::
884 Defines how wide the commit message window is in the
885 linkgit:git-gui[1]. "75" is the default.
886
887gui.diffcontext::
888 Specifies how many context lines should be used in calls to diff
889 made by the linkgit:git-gui[1]. The default is "5".
890
a2df1fb2
AG
891gui.encoding::
892 Specifies the default encoding to use for displaying of
893 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
894 It can be overridden by setting the 'encoding' attribute
895 for relevant files (see linkgit:gitattributes[5]).
896 If this option is not set, the tools default to the
897 locale encoding.
898
d84ae0db
GH
899gui.matchtrackingbranch::
900 Determines if new branches created with linkgit:git-gui[1] should
901 default to tracking remote branches with matching names or
902 not. Default: "false".
903
904gui.newbranchtemplate::
905 Is used as suggested name when creating new branches using the
906 linkgit:git-gui[1].
907
908gui.pruneduringfetch::
909 "true" if linkgit:git-gui[1] should prune tracking branches when
910 performing a fetch. The default value is "false".
911
912gui.trustmtime::
913 Determines if linkgit:git-gui[1] should trust the file modification
914 timestamp or not. By default the timestamps are not trusted.
915
916gui.spellingdictionary::
917 Specifies the dictionary used for spell checking commit messages in
918 the linkgit:git-gui[1]. When set to "none" spell checking is turned
919 off.
920
a2df1fb2
AG
921gui.fastcopyblame::
922 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
923 location detection. It makes blame significantly faster on huge
924 repositories at the expense of less thorough copy detection.
925
926gui.copyblamethreshold::
76bac890 927 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
928 detection, measured in alphanumeric characters. See the
929 linkgit:git-blame[1] manual for more information on copy detection.
930
931gui.blamehistoryctx::
932 Specifies the radius of history context in days to show in
933 linkgit:gitk[1] for the selected commit, when the `Show History
934 Context` menu item is invoked from 'git gui blame'. If this
935 variable is set to zero, the whole history is shown.
936
390c3480
AG
937guitool.<name>.cmd::
938 Specifies the shell command line to execute when the corresponding item
939 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
940 mandatory for every tool. The command is executed from the root of
941 the working directory, and in the environment it receives the name of
942 the tool as 'GIT_GUITOOL', the name of the currently selected file as
943 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
944 the head is detached, 'CUR_BRANCH' is empty).
945
946guitool.<name>.needsfile::
947 Run the tool only if a diff is selected in the GUI. It guarantees
948 that 'FILENAME' is not empty.
949
950guitool.<name>.noconsole::
951 Run the command silently, without creating a window to display its
952 output.
953
954guitool.<name>.norescan::
955 Don't rescan the working directory for changes after the tool
956 finishes execution.
957
958guitool.<name>.confirm::
959 Show a confirmation dialog before actually running the tool.
960
961guitool.<name>.argprompt::
962 Request a string argument from the user, and pass it to the tool
963 through the 'ARGS' environment variable. Since requesting an
964 argument implies confirmation, the 'confirm' option has no effect
965 if this is enabled. If the option is set to 'true', 'yes', or '1',
966 the dialog uses a built-in generic prompt; otherwise the exact
967 value of the variable is used.
968
969guitool.<name>.revprompt::
970 Request a single valid revision from the user, and set the
971 'REVISION' environment variable. In other aspects this option
972 is similar to 'argprompt', and can be used together with it.
973
974guitool.<name>.revunmerged::
975 Show only unmerged branches in the 'revprompt' subdialog.
976 This is useful for tools similar to merge or rebase, but not
977 for things like checkout or reset.
978
979guitool.<name>.title::
980 Specifies the title to use for the prompt dialog. The default
981 is the tool name.
982
983guitool.<name>.prompt::
984 Specifies the general prompt string to display at the top of
985 the dialog, before subsections for 'argprompt' and 'revprompt'.
986 The default value includes the actual command.
987
983a9eeb
CC
988help.browser::
989 Specify the browser that will be used to display help in the
990 'web' format. See linkgit:git-help[1].
991
992help.format::
993 Override the default help format used by linkgit:git-help[1].
994 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
995 the default. 'web' and 'html' are the same.
996
f0e90716
AR
997help.autocorrect::
998 Automatically correct and execute mistyped commands after
999 waiting for the given number of deciseconds (0.1 sec). If more
1000 than one command can be deduced from the entered text, nothing
1001 will be executed. If the value of this option is negative,
1002 the corrected command will be executed immediately. If the
1003 value is 0 - the command will be just shown but not executed.
1004 This is the default.
1005
9c5665aa
SV
1006http.proxy::
1007 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 1008 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 1009 on a per-remote basis; see remote.<name>.proxy
9c5665aa 1010
1ab661dd
PB
1011http.sslVerify::
1012 Whether to verify the SSL certificate when fetching or pushing
37425065 1013 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1014 variable.
1015
1016http.sslCert::
1017 File containing the SSL certificate when fetching or pushing
37425065 1018 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1019 variable.
1020
1021http.sslKey::
1022 File containing the SSL private key when fetching or pushing
abda1ef5 1023 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1024 variable.
1025
1026http.sslCAInfo::
1027 File containing the certificates to verify the peer with when
abda1ef5 1028 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1029 'GIT_SSL_CAINFO' environment variable.
1030
1031http.sslCAPath::
1032 Path containing files with the CA certificates to verify the peer
37425065 1033 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1034 by the 'GIT_SSL_CAPATH' environment variable.
1035
1036http.maxRequests::
abda1ef5 1037 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1038 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1039
1040http.lowSpeedLimit, http.lowSpeedTime::
1041 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1042 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1043 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1044 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1045
3ea099d4
SK
1046http.noEPSV::
1047 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1048 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1049 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1050 environment variable. Default is false (curl will use EPSV).
1051
1ab661dd
PB
1052i18n.commitEncoding::
1053 Character encoding the commit messages are stored in; git itself
1054 does not care per se, but this information is necessary e.g. when
1055 importing commits from emails or in the gitk graphical history
1056 browser (and possibly at other places in the future or in other
5162e697 1057 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1058
d2c11a38
JH
1059i18n.logOutputEncoding::
1060 Character encoding the commit messages are converted to when
ba020ef5 1061 running 'git-log' and friends.
d2c11a38 1062
b0f34c3d
MM
1063imap::
1064 The configuration variables in the 'imap' section are described
1065 in linkgit:git-imap-send[1].
1066
983a9eeb
CC
1067instaweb.browser::
1068 Specify the program that will be used to browse your working
1069 repository in gitweb. See linkgit:git-instaweb[1].
1070
1071instaweb.httpd::
1072 The HTTP daemon command-line to start gitweb on your working
1073 repository. See linkgit:git-instaweb[1].
1074
1075instaweb.local::
1076 If true the web server started by linkgit:git-instaweb[1] will
1077 be bound to the local IP (127.0.0.1).
1078
1079instaweb.modulepath::
1080 The module path for an apache httpd used by linkgit:git-instaweb[1].
1081
1082instaweb.port::
1083 The port number to bind the gitweb httpd to. See
1084 linkgit:git-instaweb[1].
1085
ca6ac7f1
TR
1086interactive.singlekey::
1087 In interactive programs, allow the user to provide one-letter
1088 input with a single key (i.e., without hitting enter).
1089 Currently this is used only by the `\--patch` mode of
1090 linkgit:git-add[1]. Note that this setting is silently
1091 ignored if portable keystroke input is not available.
1092
dd0ffd5b
HO
1093log.date::
1094 Set default date-time mode for the log command. Setting log.date
0979c106 1095 value is similar to using 'git-log'\'s --date option. The value is one of the
dd0ffd5b
HO
1096 following alternatives: {relative,local,default,iso,rfc,short}.
1097 See linkgit:git-log[1].
1098
0f03ca94
PB
1099log.showroot::
1100 If true, the initial commit will be shown as a big creation event.
1101 This is equivalent to a diff against an empty tree.
5162e697 1102 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1103 normally hide the root commit will now show it. True by default.
1104
d551a488
MSO
1105mailmap.file::
1106 The location of an augmenting mailmap file. The default
1107 mailmap, located in the root of the repository, is loaded
1108 first, then the mailmap file pointed to by this variable.
1109 The location of the mailmap file may be in a repository
1110 subdirectory, or somewhere outside of the repository itself.
1111 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1112
b5578f33 1113man.viewer::
b8322ea8 1114 Specify the programs that may be used to display help in the
b5578f33
CC
1115 'man' format. See linkgit:git-help[1].
1116
0bb64009
CC
1117man.<tool>.cmd::
1118 Specify the command to invoke the specified man viewer. The
1119 specified command is evaluated in shell with the man page
1120 passed as argument. (See linkgit:git-help[1].)
1121
7e8114c0
CC
1122man.<tool>.path::
1123 Override the path for the given tool that may be used to
1124 display help in the 'man' format. See linkgit:git-help[1].
1125
b0f34c3d 1126include::merge-config.txt[]
b5412484 1127
77680caa
JS
1128mergetool.<tool>.path::
1129 Override the path for the given tool. This is useful in case
1130 your tool is not in the PATH.
1131
964473a0
CB
1132mergetool.<tool>.cmd::
1133 Specify the command to invoke the specified merge tool. The
1134 specified command is evaluated in shell with the following
1135 variables available: 'BASE' is the name of a temporary file
1136 containing the common base of the files to be merged, if available;
1137 'LOCAL' is the name of a temporary file containing the contents of
1138 the file on the current branch; 'REMOTE' is the name of a temporary
1139 file containing the contents of the file from the branch being
1140 merged; 'MERGED' contains the name of the file to which the merge
1141 tool should write the results of a successful merge.
1142
1143mergetool.<tool>.trustExitCode::
1144 For a custom merge command, specify whether the exit code of
1145 the merge command can be used to determine whether the merge was
1146 successful. If this is not set to true then the merge target file
1147 timestamp is checked and the merge assumed to have been successful
1148 if the file has been updated, otherwise the user is prompted to
1149 indicate the success of the merge.
1150
44c36d1c
CB
1151mergetool.keepBackup::
1152 After performing a merge, the original file with conflict markers
1153 can be saved as a file with a `.orig` extension. If this variable
1154 is set to `false` then this file is not preserved. Defaults to
1155 `true` (i.e. keep the backup files).
1156
162eba8b
CB
1157mergetool.keepTemporaries::
1158 When invoking a custom merge tool, git uses a set of temporary
1159 files to pass to the tool. If the tool returns an error and this
1160 variable is set to `true`, then these temporary files will be
1161 preserved, otherwise they will be removed after the tool has
1162 exited. Defaults to `false`.
1163
682b451f
CB
1164mergetool.prompt::
1165 Prompt before each invocation of the merge resolution program.
1166
4812a93a 1167pack.window::
5162e697 1168 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1169 window size is given on the command line. Defaults to 10.
1170
842aaf93 1171pack.depth::
5162e697 1172 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1173 maximum depth is given on the command line. Defaults to 50.
842aaf93 1174
e93b15cd 1175pack.windowMemory::
5162e697 1176 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1177 when no limit is given on the command line. The value can be
1178 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1179 limit.
1180
960ccca6
DH
1181pack.compression::
1182 An integer -1..9, indicating the compression level for objects
1183 in a pack file. -1 is the zlib default. 0 means no
1184 compression, and 1..9 are various speed/size tradeoffs, 9 being
1185 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1186 not set, defaults to -1, the zlib default, which is "a default
1187 compromise between speed and compression (currently equivalent
1188 to level 6)."
960ccca6 1189
074b2eea 1190pack.deltaCacheSize::
02783075 1191 The maximum memory in bytes used for caching deltas in
5162e697 1192 linkgit:git-pack-objects[1].
074b2eea
MK
1193 A value of 0 means no limit. Defaults to 0.
1194
e3dfddb3 1195pack.deltaCacheLimit::
693b86ff 1196 The maximum size of a delta, that is cached in
5162e697 1197 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 1198
693b86ff
NP
1199pack.threads::
1200 Specifies the number of threads to spawn when searching for best
5162e697 1201 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1202 be compiled with pthreads otherwise this option is ignored with a
1203 warning. This is meant to reduce packing time on multiprocessor
1204 machines. The required amount of memory for the delta search window
1205 is however multiplied by the number of threads.
833e3df1
AE
1206 Specifying 0 will cause git to auto-detect the number of CPU's
1207 and set the number of threads accordingly.
693b86ff 1208
4d00bda2
NP
1209pack.indexVersion::
1210 Specify the default pack index version. Valid values are 1 for
1211 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1212 the new pack index with capabilities for packs larger than 4 GB
1213 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1214 packs. Version 2 is the default. Note that version 2 is enforced
1215 and this config option ignored whenever the corresponding pack is
1216 larger than 2 GB.
1217+
1218If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1219cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1220that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1221other side may give you a repository that cannot be accessed with your
1222older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1223you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1224the `{asterisk}.idx` file.
4d00bda2 1225
dbdbfec4 1226pack.packSizeLimit::
2b84b5a8
JS
1227 The default maximum size of a pack. This setting only affects
1228 packing to a file, i.e. the git:// protocol is unaffected. It
1229 can be overridden by the `\--max-pack-size` option of
1230 linkgit:git-repack[1].
1231
4370c2d6 1232pager.<cmd>::
32818085
JN
1233 Allows turning on or off pagination of the output of a
1234 particular git subcommand when writing to a tty. If
1235 `\--paginate` or `\--no-pager` is specified on the command line,
1236 it takes precedence over this option. To disable pagination for
dcb11263 1237 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1238
1ab661dd
PB
1239pull.octopus::
1240 The default merge strategy to use when pulling multiple branches
1241 at once.
1242
1243pull.twohead::
1244 The default merge strategy to use when pulling a single branch.
1245
52153747
FAG
1246push.default::
1247 Defines the action git push should take if no refspec is given
1248 on the command line, no refspec is configured in the remote, and
1249 no refspec is implied by any of the options given on the command
01eadafc 1250 line. Possible values are:
52153747
FAG
1251+
1252* `nothing` do not push anything.
01eadafc 1253* `matching` push all matching branches.
52153747 1254 All branches having the same name in both ends are considered to be
01eadafc 1255 matching. This is the default.
e892dc71 1256* `tracking` push the current branch to its upstream branch.
01eadafc 1257* `current` push the current branch to a branch of the same name.
52153747 1258
a9c3821c
TAV
1259rebase.stat::
1260 Whether to show a diffstat of what changed upstream since the last
1261 rebase. False by default.
1262
b0f34c3d
MM
1263receive.fsckObjects::
1264 If it is set to true, git-receive-pack will check all received
1265 objects. It will abort in the case of a malformed object or a
1266 broken link. The result of an abort are only dangling objects.
1267 Defaults to false.
1268
1269receive.unpackLimit::
1270 If the number of objects received in a push is below this
1271 limit then the objects will be unpacked into loose object
1272 files. However if the number of received objects equals or
1273 exceeds this limit then the received pack will be stored as
1274 a pack, after adding any missing delta bases. Storing the
1275 pack from a push can make the push operation complete faster,
1276 especially on slow filesystems. If not set, the value of
1277 `transfer.unpackLimit` is used instead.
1278
42fc11c1
JH
1279receive.denyDeletes::
1280 If set to true, git-receive-pack will deny a ref update that deletes
1281 the ref. Use this to prevent such a ref deletion via a push.
1282
1283receive.denyCurrentBranch::
1284 If set to true or "refuse", receive-pack will deny a ref update
1285 to the currently checked out branch of a non-bare repository.
1286 Such a push is potentially dangerous because it brings the HEAD
1287 out of sync with the index and working tree. If set to "warn",
1288 print a warning of such a push to stderr, but allow the push to
1289 proceed. If set to false or "ignore", allow such pushes with no
1290 message. Defaults to "warn".
1291
b0f34c3d
MM
1292receive.denyNonFastForwards::
1293 If set to true, git-receive-pack will deny a ref update which is
1294 not a fast forward. Use this to prevent such an update via a push,
1295 even if that push is forced. This configuration variable is
1296 set when initializing a shared repository.
1297
0cc6d346 1298remote.<name>.url::
5162e697
DM
1299 The URL of a remote repository. See linkgit:git-fetch[1] or
1300 linkgit:git-push[1].
0cc6d346 1301
14c98218
SV
1302remote.<name>.proxy::
1303 For remotes that require curl (http, https and ftp), the URL to
1304 the proxy to use for that remote. Set to the empty string to
1305 disable proxying for that remote.
1306
0cc6d346 1307remote.<name>.fetch::
5162e697
DM
1308 The default set of "refspec" for linkgit:git-fetch[1]. See
1309 linkgit:git-fetch[1].
0cc6d346
SB
1310
1311remote.<name>.push::
5162e697
DM
1312 The default set of "refspec" for linkgit:git-push[1]. See
1313 linkgit:git-push[1].
0cc6d346 1314
84bb2dfd
PB
1315remote.<name>.mirror::
1316 If true, pushing to this remote will automatically behave
1317 as if the `\--mirror` option was given on the command line.
1318
1918278e
TT
1319remote.<name>.skipDefaultUpdate::
1320 If true, this remote will be skipped by default when updating
5162e697 1321 using the update subcommand of linkgit:git-remote[1].
1918278e 1322
060aafc1 1323remote.<name>.receivepack::
5dee29ac 1324 The default program to execute on the remote side when pushing. See
79f43f3d 1325 option \--receive-pack of linkgit:git-push[1].
060aafc1 1326
5dee29ac
UKK
1327remote.<name>.uploadpack::
1328 The default program to execute on the remote side when fetching. See
79f43f3d 1329 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1330
047f636d 1331remote.<name>.tagopt::
79f43f3d
UKK
1332 Setting this value to \--no-tags disables automatic tag following when
1333 fetching from remote <name>
047f636d 1334
1918278e
TT
1335remotes.<group>::
1336 The list of remotes which are fetched by "git remote update
5162e697 1337 <group>". See linkgit:git-remote[1].
1918278e 1338
b6945f57 1339repack.usedeltabaseoffset::
22c79eab
NP
1340 By default, linkgit:git-repack[1] creates packs that use
1341 delta-base offset. If you need to share your repository with
1342 git older than version 1.4.4, either directly or via a dumb
1343 protocol such as http, then you need to set this option to
1344 "false" and repack. Access from old git versions over the
1345 native protocol are unaffected by this option.
b6945f57 1346
b0f34c3d
MM
1347rerere.autoupdate::
1348 When set to true, `git-rerere` updates the index with the
1349 resulting contents after it cleanly resolves conflicts using
1350 previously recorded resolution. Defaults to false.
1351
1352rerere.enabled::
1353 Activate recording of resolved conflicts, so that identical
1354 conflict hunks can be resolved automatically, should they
1355 be encountered again. linkgit:git-rerere[1] command is by
1356 default enabled if you create `rr-cache` directory under
1357 `$GIT_DIR`, but can be disabled by setting this option to false.
1358
1ab661dd 1359showbranch.default::
5162e697
DM
1360 The default set of branches for linkgit:git-show-branch[1].
1361 See linkgit:git-show-branch[1].
1ab661dd 1362
46f721c8 1363status.relativePaths::
5162e697 1364 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1365 current directory. Setting this variable to `false` shows paths
1366 relative to the repository root (this was the default for git
1367 prior to v1.5.4).
1368
d6293d1f
MSO
1369status.showUntrackedFiles::
1370 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1371 files which are not currently tracked by Git. Directories which
1372 contain only untracked files, are shown with the directory name
1373 only. Showing untracked files means that Git needs to lstat() all
1374 all the files in the whole repository, which might be slow on some
1375 systems. So, this variable controls how the commands displays
1376 the untracked files. Possible values are:
1377+
1378--
1379 - 'no' - Show no untracked files
1380 - 'normal' - Shows untracked files and directories
1381 - 'all' - Shows also individual files in untracked directories.
1382--
1383+
1384If this variable is not specified, it defaults to 'normal'.
1385This variable can be overridden with the -u|--untracked-files option
1386of linkgit:git-status[1] and linkgit:git-commit[1].
1387
ce1a79b6 1388tar.umask::
687157c7
RS
1389 This variable can be used to restrict the permission bits of
1390 tar archive entries. The default is 0002, which turns off the
1391 world write bit. The special value "user" indicates that the
1392 archiving user's umask will be used instead. See umask(2) and
5162e697 1393 linkgit:git-archive[1].
ce1a79b6 1394
b0f34c3d
MM
1395transfer.unpackLimit::
1396 When `fetch.unpackLimit` or `receive.unpackLimit` are
1397 not set, the value of this variable is used instead.
1398 The default value is 100.
1399
55029ae4
DB
1400url.<base>.insteadOf::
1401 Any URL that starts with this value will be rewritten to
1402 start, instead, with <base>. In cases where some site serves a
1403 large number of repositories, and serves them with multiple
1404 access methods, and some users need to use different access
1405 methods, this feature allows people to specify any of the
1406 equivalent URLs and have git automatically rewrite the URL to
1407 the best alternative for the particular user, even for a
844112ca
JH
1408 never-before-seen repository on the site. When more than one
1409 insteadOf strings match a given URL, the longest match is used.
55029ae4 1410
1ab661dd
PB
1411user.email::
1412 Your email address to be recorded in any newly created commits.
28a94f88 1413 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1414 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1415
1416user.name::
1417 Your full name to be recorded in any newly created commits.
abda1ef5 1418 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1419 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1420
d67778ec 1421user.signingkey::
5162e697 1422 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1423 automatically when creating a signed tag, you can override the
1424 default selection with this variable. This option is passed
1425 unchanged to gpg's --local-user parameter, so you may specify a key
1426 using any method that gpg supports.
1427
983a9eeb
CC
1428web.browser::
1429 Specify a web browser that may be used by some commands.
1430 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1431 may use it.