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