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