a8759cff804c98a7f4d13634ce8775edd2315a0d
[git/git.git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
10
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
17
18 Syntax
19 ~~~~~~
20
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
24
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
31
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
35
36 --------
37 [section "subsection"]
38
39 --------
40
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
47
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
51
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
59
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
62
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 0/1, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
68
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
75
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
80
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
83
84 Some variables may require a special value format.
85
86 Example
87 ~~~~~~~
88
89 # Core variables
90 [core]
91 ; Don't trust file modes
92 filemode = false
93
94 # Our diff algorithm
95 [diff]
96 external = /usr/local/bin/diff-wrapper
97 renames = true
98
99 [branch "devel"]
100 remote = origin
101 merge = refs/heads/devel
102
103 # Proxy settings
104 [core]
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
107
108 Variables
109 ~~~~~~~~~
110
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
115
116 advice.*::
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.
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.
129 commitBeforeMerge::
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwriting local changes.
132 Default: true.
133 resolveConflict::
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
136 Default: true.
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.
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.
146 --
147
148 core.fileMode::
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
151 See linkgit:git-update-index[1].
152 +
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
156
157 core.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
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.
167
168 core.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 +
176 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177 will probe and set core.ignorecase true if appropriate when the repository
178 is created.
179
180 core.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
187 core.quotepath::
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
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
199 core.eol::
200 Sets the line ending type to use in the working directory for
201 files that have the `text` property set. Alternatives are
202 'lf', 'crlf' and 'native', which uses the platform's native
203 line ending. The default value is `native`. See
204 linkgit:gitattributes[5] for more information on end-of-line
205 conversion.
206
207 core.safecrlf::
208 If true, makes git check if converting `CRLF` is reversible when
209 end-of-line conversion is active. Git will verify if a command
210 modifies a file in the work tree either directly or indirectly.
211 For example, committing a file followed by checking out the
212 same file should yield the original file in the work tree. If
213 this is not the case for the current setting of
214 `core.autocrlf`, git will reject the file. The variable can
215 be set to "warn", in which case git will only warn about an
216 irreversible conversion but continue the operation.
217 +
218 CRLF conversion bears a slight chance of corrupting data.
219 When it is enabled, git will convert CRLF to LF during commit and LF to
220 CRLF during checkout. A file that contains a mixture of LF and
221 CRLF before the commit cannot be recreated by git. For text
222 files this is the right thing to do: it corrects line endings
223 such that we have only LF line endings in the repository.
224 But for binary files that are accidentally classified as text the
225 conversion can corrupt data.
226 +
227 If you recognize such corruption early you can easily fix it by
228 setting the conversion type explicitly in .gitattributes. Right
229 after committing you still have the original file in your work
230 tree and this file is not yet corrupted. You can explicitly tell
231 git that this file is binary and git will handle the file
232 appropriately.
233 +
234 Unfortunately, the desired effect of cleaning up text files with
235 mixed line endings and the undesired effect of corrupting binary
236 files cannot be distinguished. In both cases CRLFs are removed
237 in an irreversible way. For text files this is the right thing
238 to do because CRLFs are line endings, while for binary files
239 converting CRLFs corrupts data.
240 +
241 Note, this safety check does not mean that a checkout will generate a
242 file identical to the original file for a different setting of
243 `core.eol` and `core.autocrlf`, but only for the current one. For
244 example, a text file with `LF` would be accepted with `core.eol=lf`
245 and could later be checked out with `core.eol=crlf`, in which case the
246 resulting file would contain `CRLF`, although the original file
247 contained `LF`. However, in both work trees the line endings would be
248 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249 file with mixed line endings would be reported by the `core.safecrlf`
250 mechanism.
251
252 core.autocrlf::
253 Setting this variable to "true" is almost the same as setting
254 the `text` attribute to "auto" on all files except that text
255 files are not guaranteed to be normalized: files that contain
256 `CRLF` in the repository will not be touched. Use this
257 setting if you want to have `CRLF` line endings in your
258 working directory even though the repository does not have
259 normalized line endings. This variable can be set to 'input',
260 in which case no output conversion is performed.
261
262 core.symlinks::
263 If false, symbolic links are checked out as small plain files that
264 contain the link text. linkgit:git-update-index[1] and
265 linkgit:git-add[1] will not change the recorded type to regular
266 file. Useful on filesystems like FAT that do not support
267 symbolic links.
268 +
269 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270 will probe and set core.symlinks false if appropriate when the repository
271 is created.
272
273 core.gitProxy::
274 A "proxy command" to execute (as 'command host port') instead
275 of establishing direct connection to the remote server when
276 using the git protocol for fetching. If the variable value is
277 in the "COMMAND for DOMAIN" format, the command is applied only
278 on hostnames ending with the specified domain string. This variable
279 may be set multiple times and is matched in the given order;
280 the first match wins.
281 +
282 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283 (which always applies universally, without the special "for"
284 handling).
285 +
286 The special string `none` can be used as the proxy command to
287 specify that no proxy be used for a given domain pattern.
288 This is useful for excluding servers inside a firewall from
289 proxy use, while defaulting to a common proxy for external domains.
290
291 core.ignoreStat::
292 If true, commands which modify both the working tree and the index
293 will mark the updated paths with the "assume unchanged" bit in the
294 index. These marked files are then assumed to stay unchanged in the
295 working copy, until you mark them otherwise manually - Git will not
296 detect the file changes by lstat() calls. This is useful on systems
297 where those are very slow, such as Microsoft Windows.
298 See linkgit:git-update-index[1].
299 False by default.
300
301 core.preferSymlinkRefs::
302 Instead of the default "symref" format for HEAD
303 and other symbolic reference files, use symbolic links.
304 This is sometimes needed to work with old scripts that
305 expect HEAD to be a symbolic link.
306
307 core.bare::
308 If true this repository is assumed to be 'bare' and has no
309 working directory associated with it. If this is the case a
310 number of commands that require a working directory will be
311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
312 +
313 This setting is automatically guessed by linkgit:git-clone[1] or
314 linkgit:git-init[1] when the repository was created. By default a
315 repository that ends in "/.git" is assumed to be not bare (bare =
316 false), while all other repositories are assumed to be bare (bare
317 = true).
318
319 core.worktree::
320 Set the path to the working tree. The value will not be
321 used in combination with repositories found automatically in
322 a .git directory (i.e. $GIT_DIR is not set).
323 This can be overridden by the GIT_WORK_TREE environment
324 variable and the '--work-tree' command line option. It can be
325 an absolute path or relative path to the directory specified by
326 --git-dir or GIT_DIR.
327 Note: If --git-dir or GIT_DIR are specified but none of
328 --work-tree, GIT_WORK_TREE and core.worktree is specified,
329 the current working directory is regarded as the top directory
330 of your working tree.
331
332 core.logAllRefUpdates::
333 Enable the reflog. Updates to a ref <ref> is logged to the file
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.
339 +
340 This information can be used to determine what commit
341 was the tip of a branch "2 days ago".
342 +
343 This value is true by default in a repository that has
344 a working directory associated with it, and false by
345 default in a bare repository.
346
347 core.repositoryFormatVersion::
348 Internal variable identifying the repository format and layout
349 version.
350
351 core.sharedRepository::
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
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
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
363 repository that is group-readable but not group-writable.
364 See linkgit:git-init[1]. False by default.
365
366 core.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
370 core.abbrevguard::
371 Even though git makes sure that it uses enough hexdigits to show
372 an abbreviated object name unambiguously, as more objects are
373 added to the repository over time, a short name that used to be
374 unique will stop being unique. Git uses this many extra hexdigits
375 that are more than necessary to make the object name currently
376 unique, in the hope that its output will stay unique a bit longer.
377 Defaults to 0.
378
379 core.compression::
380 An integer -1..9, indicating a default compression level.
381 -1 is the zlib default. 0 means no compression,
382 and 1..9 are various speed/size tradeoffs, 9 being slowest.
383 If set, this provides a default to other compression variables,
384 such as 'core.loosecompression' and 'pack.compression'.
385
386 core.loosecompression::
387 An integer -1..9, indicating the compression level for objects that
388 are not in a pack file. -1 is the zlib default. 0 means no
389 compression, and 1..9 are various speed/size tradeoffs, 9 being
390 slowest. If not set, defaults to core.compression. If that is
391 not set, defaults to 1 (best speed).
392
393 core.packedGitWindowSize::
394 Number of bytes of a pack file to map into memory in a
395 single mapping operation. Larger window sizes may allow
396 your system to process a smaller number of large pack files
397 more quickly. Smaller window sizes will negatively affect
398 performance due to increased calls to the operating system's
399 memory manager, but may improve performance when accessing
400 a large number of large pack files.
401 +
402 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
403 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
404 be reasonable for all users/operating systems. You probably do
405 not need to adjust this value.
406 +
407 Common unit suffixes of 'k', 'm', or 'g' are supported.
408
409 core.packedGitLimit::
410 Maximum number of bytes to map simultaneously into memory
411 from pack files. If Git needs to access more than this many
412 bytes at once to complete an operation it will unmap existing
413 regions to reclaim virtual address space within the process.
414 +
415 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
416 This should be reasonable for all users/operating systems, except on
417 the largest projects. You probably do not need to adjust this value.
418 +
419 Common unit suffixes of 'k', 'm', or 'g' are supported.
420
421 core.deltaBaseCacheLimit::
422 Maximum number of bytes to reserve for caching base objects
423 that may be referenced by multiple deltified objects. By storing the
424 entire decompressed base objects in a cache Git is able
425 to avoid unpacking and decompressing frequently used base
426 objects multiple times.
427 +
428 Default is 16 MiB on all platforms. This should be reasonable
429 for all users/operating systems, except on the largest projects.
430 You probably do not need to adjust this value.
431 +
432 Common unit suffixes of 'k', 'm', or 'g' are supported.
433
434 core.bigFileThreshold::
435 Files larger than this size are stored deflated, without
436 attempting delta compression. Storing large files without
437 delta compression avoids excessive memory usage, at the
438 slight expense of increased disk usage.
439 +
440 Default is 512 MiB on all platforms. This should be reasonable
441 for most projects as source code and other text files can still
442 be delta compressed, but larger binary media files won't be.
443 +
444 Common unit suffixes of 'k', 'm', or 'g' are supported.
445 +
446 Currently only linkgit:git-fast-import[1] honors this setting.
447
448 core.excludesfile::
449 In addition to '.gitignore' (per-directory) and
450 '.git/info/exclude', git looks into this file for patterns
451 of files which are not meant to be tracked. "{tilde}/" is expanded
452 to the value of `$HOME` and "{tilde}user/" to the specified user's
453 home directory. See linkgit:gitignore[5].
454
455 core.askpass::
456 Some commands (e.g. svn and http interfaces) that interactively
457 ask for a password can be told to use an external program given
458 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
459 environment variable. If not set, fall back to the value of the
460 'SSH_ASKPASS' environment variable or, failing that, a simple password
461 prompt. The external program shall be given a suitable prompt as
462 command line argument and write the password on its STDOUT.
463
464 core.attributesfile::
465 In addition to '.gitattributes' (per-directory) and
466 '.git/info/attributes', git looks into this file for attributes
467 (see linkgit:gitattributes[5]). Path expansions are made the same
468 way as for `core.excludesfile`.
469
470 core.editor::
471 Commands such as `commit` and `tag` that lets you edit
472 messages by launching an editor uses the value of this
473 variable when it is set, and the environment variable
474 `GIT_EDITOR` is not set. See linkgit:git-var[1].
475
476 core.pager::
477 The command that git will use to paginate output. Can
478 be overridden with the `GIT_PAGER` environment
479 variable. Note that git sets the `LESS` environment
480 variable to `FRSX` if it is unset when it runs the
481 pager. One can change these settings by setting the
482 `LESS` variable to some other value. Alternately,
483 these settings can be overridden on a project or
484 global basis by setting the `core.pager` option.
485 Setting `core.pager` has no affect on the `LESS`
486 environment variable behaviour above, so if you want
487 to override git's default settings this way, you need
488 to be explicit. For example, to disable the S option
489 in a backward compatible manner, set `core.pager`
490 to `less -+$LESS -FRX`. This will be passed to the
491 shell by git, which will translate the final command to
492 `LESS=FRSX less -+FRSX -FRX`.
493
494 core.whitespace::
495 A comma separated list of common whitespace problems to
496 notice. 'git diff' will use `color.diff.whitespace` to
497 highlight them, and 'git apply --whitespace=error' will
498 consider them as errors. You can prefix `-` to disable
499 any of them (e.g. `-trailing-space`):
500 +
501 * `blank-at-eol` treats trailing whitespaces at the end of the line
502 as an error (enabled by default).
503 * `space-before-tab` treats a space character that appears immediately
504 before a tab character in the initial indent part of the line as an
505 error (enabled by default).
506 * `indent-with-non-tab` treats a line that is indented with 8 or more
507 space characters as an error (not enabled by default).
508 * `tab-in-indent` treats a tab character in the initial indent part of
509 the line as an error (not enabled by default).
510 * `blank-at-eof` treats blank lines added at the end of file as an error
511 (enabled by default).
512 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
513 `blank-at-eof`.
514 * `cr-at-eol` treats a carriage-return at the end of line as
515 part of the line terminator, i.e. with it, `trailing-space`
516 does not trigger if the character before such a carriage-return
517 is not a whitespace (not enabled by default).
518 * `tabwidth=<n>` tells how many character positions a tab occupies; this
519 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
520 errors. The default tab width is 8. Allowed values are 1 to 63.
521
522 core.fsyncobjectfiles::
523 This boolean will enable 'fsync()' when writing object files.
524 +
525 This is a total waste of time and effort on a filesystem that orders
526 data writes properly, but can be useful for filesystems that do not use
527 journalling (traditional UNIX filesystems) or that only journal metadata
528 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
529
530 core.preloadindex::
531 Enable parallel index preload for operations like 'git diff'
532 +
533 This can speed up operations like 'git diff' and 'git status' especially
534 on filesystems like NFS that have weak caching semantics and thus
535 relatively high IO latencies. With this set to 'true', git will do the
536 index comparison to the filesystem data in parallel, allowing
537 overlapping IO's.
538
539 core.createObject::
540 You can set this to 'link', in which case a hardlink followed by
541 a delete of the source are used to make sure that object creation
542 will not overwrite existing objects.
543 +
544 On some file system/operating system combinations, this is unreliable.
545 Set this config setting to 'rename' there; However, This will remove the
546 check that makes sure that existing object files will not get overwritten.
547
548 core.notesRef::
549 When showing commit messages, also show notes which are stored in
550 the given ref. The ref must be fully qualified. If the given
551 ref does not exist, it is not an error but means that no
552 notes should be printed.
553 +
554 This setting defaults to "refs/notes/commits", and it can be overridden by
555 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
556
557 core.sparseCheckout::
558 Enable "sparse checkout" feature. See section "Sparse checkout" in
559 linkgit:git-read-tree[1] for more information.
560
561 add.ignore-errors::
562 add.ignoreErrors::
563 Tells 'git add' to continue adding files when some files cannot be
564 added due to indexing errors. Equivalent to the '--ignore-errors'
565 option of linkgit:git-add[1]. Older versions of git accept only
566 `add.ignore-errors`, which does not follow the usual naming
567 convention for configuration variables. Newer versions of git
568 honor `add.ignoreErrors` as well.
569
570 alias.*::
571 Command aliases for the linkgit:git[1] command wrapper - e.g.
572 after defining "alias.last = cat-file commit HEAD", the invocation
573 "git last" is equivalent to "git cat-file commit HEAD". To avoid
574 confusion and troubles with script usage, aliases that
575 hide existing git commands are ignored. Arguments are split by
576 spaces, the usual shell quoting and escaping is supported.
577 quote pair and a backslash can be used to quote them.
578 +
579 If the alias expansion is prefixed with an exclamation point,
580 it will be treated as a shell command. For example, defining
581 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
582 "git new" is equivalent to running the shell command
583 "gitk --all --not ORIG_HEAD". Note that shell commands will be
584 executed from the top-level directory of a repository, which may
585 not necessarily be the current directory.
586
587 am.keepcr::
588 If true, git-am will call git-mailsplit for patches in mbox format
589 with parameter '--keep-cr'. In this case git-mailsplit will
590 not remove `\r` from lines ending with `\r\n`. Can be overridden
591 by giving '--no-keep-cr' from the command line.
592 See linkgit:git-am[1], linkgit:git-mailsplit[1].
593
594 apply.ignorewhitespace::
595 When set to 'change', tells 'git apply' to ignore changes in
596 whitespace, in the same way as the '--ignore-space-change'
597 option.
598 When set to one of: no, none, never, false tells 'git apply' to
599 respect all whitespace differences.
600 See linkgit:git-apply[1].
601
602 apply.whitespace::
603 Tells 'git apply' how to handle whitespaces, in the same way
604 as the '--whitespace' option. See linkgit:git-apply[1].
605
606 branch.autosetupmerge::
607 Tells 'git branch' and 'git checkout' to set up new branches
608 so that linkgit:git-pull[1] will appropriately merge from the
609 starting point branch. Note that even if this option is not set,
610 this behavior can be chosen per-branch using the `--track`
611 and `--no-track` options. The valid settings are: `false` -- no
612 automatic setup is done; `true` -- automatic setup is done when the
613 starting point is a remote-tracking branch; `always` --
614 automatic setup is done when the starting point is either a
615 local branch or remote-tracking
616 branch. This option defaults to true.
617
618 branch.autosetuprebase::
619 When a new branch is created with 'git branch' or 'git checkout'
620 that tracks another branch, this variable tells git to set
621 up pull to rebase instead of merge (see "branch.<name>.rebase").
622 When `never`, rebase is never automatically set to true.
623 When `local`, rebase is set to true for tracked branches of
624 other local branches.
625 When `remote`, rebase is set to true for tracked branches of
626 remote-tracking branches.
627 When `always`, rebase will be set to true for all tracking
628 branches.
629 See "branch.autosetupmerge" for details on how to set up a
630 branch to track another branch.
631 This option defaults to never.
632
633 branch.<name>.remote::
634 When in branch <name>, it tells 'git fetch' and 'git push' which
635 remote to fetch from/push to. It defaults to `origin` if no remote is
636 configured. `origin` is also used if you are not on any branch.
637
638 branch.<name>.merge::
639 Defines, together with branch.<name>.remote, the upstream branch
640 for the given branch. It tells 'git fetch'/'git pull' which
641 branch to merge and can also affect 'git push' (see push.default).
642 When in branch <name>, it tells 'git fetch' the default
643 refspec to be marked for merging in FETCH_HEAD. The value is
644 handled like the remote part of a refspec, and must match a
645 ref which is fetched from the remote given by
646 "branch.<name>.remote".
647 The merge information is used by 'git pull' (which at first calls
648 'git fetch') to lookup the default branch for merging. Without
649 this option, 'git pull' defaults to merge the first refspec fetched.
650 Specify multiple values to get an octopus merge.
651 If you wish to setup 'git pull' so that it merges into <name> from
652 another branch in the local repository, you can point
653 branch.<name>.merge to the desired branch, and use the special setting
654 `.` (a period) for branch.<name>.remote.
655
656 branch.<name>.mergeoptions::
657 Sets default options for merging into branch <name>. The syntax and
658 supported options are the same as those of linkgit:git-merge[1], but
659 option values containing whitespace characters are currently not
660 supported.
661
662 branch.<name>.rebase::
663 When true, rebase the branch <name> on top of the fetched branch,
664 instead of merging the default branch from the default remote when
665 "git pull" is run.
666 *NOTE*: this is a possibly dangerous operation; do *not* use
667 it unless you understand the implications (see linkgit:git-rebase[1]
668 for details).
669
670 browser.<tool>.cmd::
671 Specify the command to invoke the specified browser. The
672 specified command is evaluated in shell with the URLs passed
673 as arguments. (See linkgit:git-web--browse[1].)
674
675 browser.<tool>.path::
676 Override the path for the given tool that may be used to
677 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
678 working repository in gitweb (see linkgit:git-instaweb[1]).
679
680 clean.requireForce::
681 A boolean to make git-clean do nothing unless given -f
682 or -n. Defaults to true.
683
684 color.branch::
685 A boolean to enable/disable color in the output of
686 linkgit:git-branch[1]. May be set to `always`,
687 `false` (or `never`) or `auto` (or `true`), in which case colors are used
688 only when the output is to a terminal. Defaults to false.
689
690 color.branch.<slot>::
691 Use customized color for branch coloration. `<slot>` is one of
692 `current` (the current branch), `local` (a local branch),
693 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
694 refs).
695 +
696 The value for these configuration variables is a list of colors (at most
697 two) and attributes (at most one), separated by spaces. The colors
698 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
699 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
700 `blink` and `reverse`. The first color given is the foreground; the
701 second is the background. The position of the attribute, if any,
702 doesn't matter.
703
704 color.diff::
705 When set to `always`, always use colors in patch.
706 When false (or `never`), never. When set to `true` or `auto`, use
707 colors only when the output is to the terminal. Defaults to false.
708
709 color.diff.<slot>::
710 Use customized color for diff colorization. `<slot>` specifies
711 which part of the patch to use the specified color, and is one
712 of `plain` (context text), `meta` (metainformation), `frag`
713 (hunk header), 'func' (function in hunk header), `old` (removed lines),
714 `new` (added lines), `commit` (commit headers), or `whitespace`
715 (highlighting whitespace errors). The values of these variables may be
716 specified as in color.branch.<slot>.
717
718 color.decorate.<slot>::
719 Use customized color for 'git log --decorate' output. `<slot>` is one
720 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
721 branches, remote-tracking branches, tags, stash and HEAD, respectively.
722
723 color.grep::
724 When set to `always`, always highlight matches. When `false` (or
725 `never`), never. When set to `true` or `auto`, use color only
726 when the output is written to the terminal. Defaults to `false`.
727
728 color.grep.<slot>::
729 Use customized color for grep colorization. `<slot>` specifies which
730 part of the line to use the specified color, and is one of
731 +
732 --
733 `context`;;
734 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
735 `filename`;;
736 filename prefix (when not using `-h`)
737 `function`;;
738 function name lines (when using `-p`)
739 `linenumber`;;
740 line number prefix (when using `-n`)
741 `match`;;
742 matching text
743 `selected`;;
744 non-matching text in selected lines
745 `separator`;;
746 separators between fields on a line (`:`, `-`, and `=`)
747 and between hunks (`--`)
748 --
749 +
750 The values of these variables may be specified as in color.branch.<slot>.
751
752 color.interactive::
753 When set to `always`, always use colors for interactive prompts
754 and displays (such as those used by "git-add --interactive").
755 When false (or `never`), never. When set to `true` or `auto`, use
756 colors only when the output is to the terminal. Defaults to false.
757
758 color.interactive.<slot>::
759 Use customized color for 'git add --interactive'
760 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
761 four distinct types of normal output from interactive
762 commands. The values of these variables may be specified as
763 in color.branch.<slot>.
764
765 color.pager::
766 A boolean to enable/disable colored output when the pager is in
767 use (default is true).
768
769 color.showbranch::
770 A boolean to enable/disable color in the output of
771 linkgit:git-show-branch[1]. May be set to `always`,
772 `false` (or `never`) or `auto` (or `true`), in which case colors are used
773 only when the output is to a terminal. Defaults to false.
774
775 color.status::
776 A boolean to enable/disable color in the output of
777 linkgit:git-status[1]. May be set to `always`,
778 `false` (or `never`) or `auto` (or `true`), in which case colors are used
779 only when the output is to a terminal. Defaults to false.
780
781 color.status.<slot>::
782 Use customized color for status colorization. `<slot>` is
783 one of `header` (the header text of the status message),
784 `added` or `updated` (files which are added but not committed),
785 `changed` (files which are changed but not added in the index),
786 `untracked` (files which are not tracked by git),
787 `branch` (the current branch), or
788 `nobranch` (the color the 'no branch' warning is shown in, defaulting
789 to red). The values of these variables may be specified as in
790 color.branch.<slot>.
791
792 color.ui::
793 When set to `always`, always use colors in all git commands which
794 are capable of colored output. When false (or `never`), never. When
795 set to `true` or `auto`, use colors only when the output is to the
796 terminal. When more specific variables of color.* are set, they always
797 take precedence over this setting. Defaults to false.
798
799 commit.status::
800 A boolean to enable/disable inclusion of status information in the
801 commit message template when using an editor to prepare the commit
802 message. Defaults to true.
803
804 commit.template::
805 Specify a file to use as the template for new commit messages.
806 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
807 specified user's home directory.
808
809 diff.autorefreshindex::
810 When using 'git diff' to compare with work tree
811 files, do not consider stat-only change as changed.
812 Instead, silently run `git update-index --refresh` to
813 update the cached stat information for paths whose
814 contents in the work tree match the contents in the
815 index. This option defaults to true. Note that this
816 affects only 'git diff' Porcelain, and not lower level
817 'diff' commands such as 'git diff-files'.
818
819 diff.external::
820 If this config variable is set, diff generation is not
821 performed using the internal diff machinery, but using the
822 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
823 environment variable. The command is called with parameters
824 as described under "git Diffs" in linkgit:git[1]. Note: if
825 you want to use an external diff program only on a subset of
826 your files, you might want to use linkgit:gitattributes[5] instead.
827
828 diff.mnemonicprefix::
829 If set, 'git diff' uses a prefix pair that is different from the
830 standard "a/" and "b/" depending on what is being compared. When
831 this configuration is in effect, reverse diff output also swaps
832 the order of the prefixes:
833 `git diff`;;
834 compares the (i)ndex and the (w)ork tree;
835 `git diff HEAD`;;
836 compares a (c)ommit and the (w)ork tree;
837 `git diff --cached`;;
838 compares a (c)ommit and the (i)ndex;
839 `git diff HEAD:file1 file2`;;
840 compares an (o)bject and a (w)ork tree entity;
841 `git diff --no-index a b`;;
842 compares two non-git things (1) and (2).
843
844 diff.noprefix::
845 If set, 'git diff' does not show any source or destination prefix.
846
847 diff.renameLimit::
848 The number of files to consider when performing the copy/rename
849 detection; equivalent to the 'git diff' option '-l'.
850
851 diff.renames::
852 Tells git to detect renames. If set to any boolean value, it
853 will enable basic rename detection. If set to "copies" or
854 "copy", it will detect copies, as well.
855
856 diff.ignoreSubmodules::
857 Sets the default value of --ignore-submodules. Note that this
858 affects only 'git diff' Porcelain, and not lower level 'diff'
859 commands such as 'git diff-files'. 'git checkout' also honors
860 this setting when reporting uncommitted changes.
861
862 diff.suppressBlankEmpty::
863 A boolean to inhibit the standard behavior of printing a space
864 before each empty output line. Defaults to false.
865
866 diff.tool::
867 Controls which diff tool is used. `diff.tool` overrides
868 `merge.tool` when used by linkgit:git-difftool[1] and has
869 the same valid values as `merge.tool` minus "tortoisemerge"
870 and plus "kompare".
871
872 difftool.<tool>.path::
873 Override the path for the given tool. This is useful in case
874 your tool is not in the PATH.
875
876 difftool.<tool>.cmd::
877 Specify the command to invoke the specified diff tool.
878 The specified command is evaluated in shell with the following
879 variables available: 'LOCAL' is set to the name of the temporary
880 file containing the contents of the diff pre-image and 'REMOTE'
881 is set to the name of the temporary file containing the contents
882 of the diff post-image.
883
884 difftool.prompt::
885 Prompt before each invocation of the diff tool.
886
887 diff.wordRegex::
888 A POSIX Extended Regular Expression used to determine what is a "word"
889 when performing word-by-word difference calculations. Character
890 sequences that match the regular expression are "words", all other
891 characters are *ignorable* whitespace.
892
893 fetch.recurseSubmodules::
894 A boolean value which changes the behavior for fetch and pull, the
895 default is to not recursively fetch populated sumodules unless
896 configured otherwise.
897
898 fetch.unpackLimit::
899 If the number of objects fetched over the git native
900 transfer is below this
901 limit, then the objects will be unpacked into loose object
902 files. However if the number of received objects equals or
903 exceeds this limit then the received pack will be stored as
904 a pack, after adding any missing delta bases. Storing the
905 pack from a push can make the push operation complete faster,
906 especially on slow filesystems. If not set, the value of
907 `transfer.unpackLimit` is used instead.
908
909 format.attach::
910 Enable multipart/mixed attachments as the default for
911 'format-patch'. The value can also be a double quoted string
912 which will enable attachments as the default and set the
913 value as the boundary. See the --attach option in
914 linkgit:git-format-patch[1].
915
916 format.numbered::
917 A boolean which can enable or disable sequence numbers in patch
918 subjects. It defaults to "auto" which enables it only if there
919 is more than one patch. It can be enabled or disabled for all
920 messages by setting it to "true" or "false". See --numbered
921 option in linkgit:git-format-patch[1].
922
923 format.headers::
924 Additional email headers to include in a patch to be submitted
925 by mail. See linkgit:git-format-patch[1].
926
927 format.to::
928 format.cc::
929 Additional recipients to include in a patch to be submitted
930 by mail. See the --to and --cc options in
931 linkgit:git-format-patch[1].
932
933 format.subjectprefix::
934 The default for format-patch is to output files with the '[PATCH]'
935 subject prefix. Use this variable to change that prefix.
936
937 format.signature::
938 The default for format-patch is to output a signature containing
939 the git version number. Use this variable to change that default.
940 Set this variable to the empty string ("") to suppress
941 signature generation.
942
943 format.suffix::
944 The default for format-patch is to output files with the suffix
945 `.patch`. Use this variable to change that suffix (make sure to
946 include the dot if you want it).
947
948 format.pretty::
949 The default pretty format for log/show/whatchanged command,
950 See linkgit:git-log[1], linkgit:git-show[1],
951 linkgit:git-whatchanged[1].
952
953 format.thread::
954 The default threading style for 'git format-patch'. Can be
955 a boolean value, or `shallow` or `deep`. `shallow` threading
956 makes every mail a reply to the head of the series,
957 where the head is chosen from the cover letter, the
958 `\--in-reply-to`, and the first patch mail, in this order.
959 `deep` threading makes every mail a reply to the previous one.
960 A true boolean value is the same as `shallow`, and a false
961 value disables threading.
962
963 format.signoff::
964 A boolean value which lets you enable the `-s/--signoff` option of
965 format-patch by default. *Note:* Adding the Signed-off-by: line to a
966 patch should be a conscious act and means that you certify you have
967 the rights to submit this work under the same open source license.
968 Please see the 'SubmittingPatches' document for further discussion.
969
970 gc.aggressiveWindow::
971 The window size parameter used in the delta compression
972 algorithm used by 'git gc --aggressive'. This defaults
973 to 250.
974
975 gc.auto::
976 When there are approximately more than this many loose
977 objects in the repository, `git gc --auto` will pack them.
978 Some Porcelain commands use this command to perform a
979 light-weight garbage collection from time to time. The
980 default value is 6700. Setting this to 0 disables it.
981
982 gc.autopacklimit::
983 When there are more than this many packs that are not
984 marked with `*.keep` file in the repository, `git gc
985 --auto` consolidates them into one larger pack. The
986 default value is 50. Setting this to 0 disables it.
987
988 gc.packrefs::
989 Running `git pack-refs` in a repository renders it
990 unclonable by Git versions prior to 1.5.1.2 over dumb
991 transports such as HTTP. This variable determines whether
992 'git gc' runs `git pack-refs`. This can be set to `notbare`
993 to enable it within all non-bare repos or it can be set to a
994 boolean value. The default is `true`.
995
996 gc.pruneexpire::
997 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
998 Override the grace period with this config variable. The value
999 "now" may be used to disable this grace period and always prune
1000 unreachable objects immediately.
1001
1002 gc.reflogexpire::
1003 gc.<pattern>.reflogexpire::
1004 'git reflog expire' removes reflog entries older than
1005 this time; defaults to 90 days. With "<pattern>" (e.g.
1006 "refs/stash") in the middle the setting applies only to
1007 the refs that match the <pattern>.
1008
1009 gc.reflogexpireunreachable::
1010 gc.<ref>.reflogexpireunreachable::
1011 'git reflog expire' removes reflog entries older than
1012 this time and are not reachable from the current tip;
1013 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1014 in the middle, the setting applies only to the refs that
1015 match the <pattern>.
1016
1017 gc.rerereresolved::
1018 Records of conflicted merge you resolved earlier are
1019 kept for this many days when 'git rerere gc' is run.
1020 The default is 60 days. See linkgit:git-rerere[1].
1021
1022 gc.rerereunresolved::
1023 Records of conflicted merge you have not resolved are
1024 kept for this many days when 'git rerere gc' is run.
1025 The default is 15 days. See linkgit:git-rerere[1].
1026
1027 gitcvs.commitmsgannotation::
1028 Append this string to each commit message. Set to empty string
1029 to disable this feature. Defaults to "via git-CVS emulator".
1030
1031 gitcvs.enabled::
1032 Whether the CVS server interface is enabled for this repository.
1033 See linkgit:git-cvsserver[1].
1034
1035 gitcvs.logfile::
1036 Path to a log file where the CVS server interface well... logs
1037 various stuff. See linkgit:git-cvsserver[1].
1038
1039 gitcvs.usecrlfattr::
1040 If true, the server will look up the end-of-line conversion
1041 attributes for files to determine the '-k' modes to use. If
1042 the attributes force git to treat a file as text,
1043 the '-k' mode will be left blank so CVS clients will
1044 treat it as text. If they suppress text conversion, the file
1045 will be set with '-kb' mode, which suppresses any newline munging
1046 the client might otherwise do. If the attributes do not allow
1047 the file type to be determined, then 'gitcvs.allbinary' is
1048 used. See linkgit:gitattributes[5].
1049
1050 gitcvs.allbinary::
1051 This is used if 'gitcvs.usecrlfattr' does not resolve
1052 the correct '-kb' mode to use. If true, all
1053 unresolved files are sent to the client in
1054 mode '-kb'. This causes the client to treat them
1055 as binary files, which suppresses any newline munging it
1056 otherwise might do. Alternatively, if it is set to "guess",
1057 then the contents of the file are examined to decide if
1058 it is binary, similar to 'core.autocrlf'.
1059
1060 gitcvs.dbname::
1061 Database used by git-cvsserver to cache revision information
1062 derived from the git repository. The exact meaning depends on the
1063 used database driver, for SQLite (which is the default driver) this
1064 is a filename. Supports variable substitution (see
1065 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1066 Default: '%Ggitcvs.%m.sqlite'
1067
1068 gitcvs.dbdriver::
1069 Used Perl DBI driver. You can specify any available driver
1070 for this here, but it might not work. git-cvsserver is tested
1071 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1072 reported *not* to work with 'DBD::mysql'. Experimental feature.
1073 May not contain double colons (`:`). Default: 'SQLite'.
1074 See linkgit:git-cvsserver[1].
1075
1076 gitcvs.dbuser, gitcvs.dbpass::
1077 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1078 since SQLite has no concept of database users and/or passwords.
1079 'gitcvs.dbuser' supports variable substitution (see
1080 linkgit:git-cvsserver[1] for details).
1081
1082 gitcvs.dbTableNamePrefix::
1083 Database table name prefix. Prepended to the names of any
1084 database tables used, allowing a single database to be used
1085 for several repositories. Supports variable substitution (see
1086 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1087 characters will be replaced with underscores.
1088
1089 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1090 'gitcvs.allbinary' can also be specified as
1091 'gitcvs.<access_method>.<varname>' (where 'access_method'
1092 is one of "ext" and "pserver") to make them apply only for the given
1093 access method.
1094
1095 gui.commitmsgwidth::
1096 Defines how wide the commit message window is in the
1097 linkgit:git-gui[1]. "75" is the default.
1098
1099 gui.diffcontext::
1100 Specifies how many context lines should be used in calls to diff
1101 made by the linkgit:git-gui[1]. The default is "5".
1102
1103 gui.encoding::
1104 Specifies the default encoding to use for displaying of
1105 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1106 It can be overridden by setting the 'encoding' attribute
1107 for relevant files (see linkgit:gitattributes[5]).
1108 If this option is not set, the tools default to the
1109 locale encoding.
1110
1111 gui.matchtrackingbranch::
1112 Determines if new branches created with linkgit:git-gui[1] should
1113 default to tracking remote branches with matching names or
1114 not. Default: "false".
1115
1116 gui.newbranchtemplate::
1117 Is used as suggested name when creating new branches using the
1118 linkgit:git-gui[1].
1119
1120 gui.pruneduringfetch::
1121 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1122 performing a fetch. The default value is "false".
1123
1124 gui.trustmtime::
1125 Determines if linkgit:git-gui[1] should trust the file modification
1126 timestamp or not. By default the timestamps are not trusted.
1127
1128 gui.spellingdictionary::
1129 Specifies the dictionary used for spell checking commit messages in
1130 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1131 off.
1132
1133 gui.fastcopyblame::
1134 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1135 location detection. It makes blame significantly faster on huge
1136 repositories at the expense of less thorough copy detection.
1137
1138 gui.copyblamethreshold::
1139 Specifies the threshold to use in 'git gui blame' original location
1140 detection, measured in alphanumeric characters. See the
1141 linkgit:git-blame[1] manual for more information on copy detection.
1142
1143 gui.blamehistoryctx::
1144 Specifies the radius of history context in days to show in
1145 linkgit:gitk[1] for the selected commit, when the `Show History
1146 Context` menu item is invoked from 'git gui blame'. If this
1147 variable is set to zero, the whole history is shown.
1148
1149 guitool.<name>.cmd::
1150 Specifies the shell command line to execute when the corresponding item
1151 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1152 mandatory for every tool. The command is executed from the root of
1153 the working directory, and in the environment it receives the name of
1154 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1155 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1156 the head is detached, 'CUR_BRANCH' is empty).
1157
1158 guitool.<name>.needsfile::
1159 Run the tool only if a diff is selected in the GUI. It guarantees
1160 that 'FILENAME' is not empty.
1161
1162 guitool.<name>.noconsole::
1163 Run the command silently, without creating a window to display its
1164 output.
1165
1166 guitool.<name>.norescan::
1167 Don't rescan the working directory for changes after the tool
1168 finishes execution.
1169
1170 guitool.<name>.confirm::
1171 Show a confirmation dialog before actually running the tool.
1172
1173 guitool.<name>.argprompt::
1174 Request a string argument from the user, and pass it to the tool
1175 through the 'ARGS' environment variable. Since requesting an
1176 argument implies confirmation, the 'confirm' option has no effect
1177 if this is enabled. If the option is set to 'true', 'yes', or '1',
1178 the dialog uses a built-in generic prompt; otherwise the exact
1179 value of the variable is used.
1180
1181 guitool.<name>.revprompt::
1182 Request a single valid revision from the user, and set the
1183 'REVISION' environment variable. In other aspects this option
1184 is similar to 'argprompt', and can be used together with it.
1185
1186 guitool.<name>.revunmerged::
1187 Show only unmerged branches in the 'revprompt' subdialog.
1188 This is useful for tools similar to merge or rebase, but not
1189 for things like checkout or reset.
1190
1191 guitool.<name>.title::
1192 Specifies the title to use for the prompt dialog. The default
1193 is the tool name.
1194
1195 guitool.<name>.prompt::
1196 Specifies the general prompt string to display at the top of
1197 the dialog, before subsections for 'argprompt' and 'revprompt'.
1198 The default value includes the actual command.
1199
1200 help.browser::
1201 Specify the browser that will be used to display help in the
1202 'web' format. See linkgit:git-help[1].
1203
1204 help.format::
1205 Override the default help format used by linkgit:git-help[1].
1206 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1207 the default. 'web' and 'html' are the same.
1208
1209 help.autocorrect::
1210 Automatically correct and execute mistyped commands after
1211 waiting for the given number of deciseconds (0.1 sec). If more
1212 than one command can be deduced from the entered text, nothing
1213 will be executed. If the value of this option is negative,
1214 the corrected command will be executed immediately. If the
1215 value is 0 - the command will be just shown but not executed.
1216 This is the default.
1217
1218 http.proxy::
1219 Override the HTTP proxy, normally configured using the 'http_proxy'
1220 environment variable (see linkgit:curl[1]). This can be overridden
1221 on a per-remote basis; see remote.<name>.proxy
1222
1223 http.sslVerify::
1224 Whether to verify the SSL certificate when fetching or pushing
1225 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1226 variable.
1227
1228 http.sslCert::
1229 File containing the SSL certificate when fetching or pushing
1230 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1231 variable.
1232
1233 http.sslKey::
1234 File containing the SSL private key when fetching or pushing
1235 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1236 variable.
1237
1238 http.sslCertPasswordProtected::
1239 Enable git's password prompt for the SSL certificate. Otherwise
1240 OpenSSL will prompt the user, possibly many times, if the
1241 certificate or private key is encrypted. Can be overridden by the
1242 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1243
1244 http.sslCAInfo::
1245 File containing the certificates to verify the peer with when
1246 fetching or pushing over HTTPS. Can be overridden by the
1247 'GIT_SSL_CAINFO' environment variable.
1248
1249 http.sslCAPath::
1250 Path containing files with the CA certificates to verify the peer
1251 with when fetching or pushing over HTTPS. Can be overridden
1252 by the 'GIT_SSL_CAPATH' environment variable.
1253
1254 http.maxRequests::
1255 How many HTTP requests to launch in parallel. Can be overridden
1256 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1257
1258 http.minSessions::
1259 The number of curl sessions (counted across slots) to be kept across
1260 requests. They will not be ended with curl_easy_cleanup() until
1261 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1262 value will be capped at 1. Defaults to 1.
1263
1264 http.postBuffer::
1265 Maximum size in bytes of the buffer used by smart HTTP
1266 transports when POSTing data to the remote system.
1267 For requests larger than this buffer size, HTTP/1.1 and
1268 Transfer-Encoding: chunked is used to avoid creating a
1269 massive pack file locally. Default is 1 MiB, which is
1270 sufficient for most requests.
1271
1272 http.lowSpeedLimit, http.lowSpeedTime::
1273 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1274 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1275 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1276 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1277
1278 http.noEPSV::
1279 A boolean which disables using of EPSV ftp command by curl.
1280 This can helpful with some "poor" ftp servers which don't
1281 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1282 environment variable. Default is false (curl will use EPSV).
1283
1284 http.useragent::
1285 The HTTP USER_AGENT string presented to an HTTP server. The default
1286 value represents the version of the client git such as git/1.7.1.
1287 This option allows you to override this value to a more common value
1288 such as Mozilla/4.0. This may be necessary, for instance, if
1289 connecting through a firewall that restricts HTTP connections to a set
1290 of common USER_AGENT strings (but not including those like git/1.7.1).
1291 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1292
1293 i18n.commitEncoding::
1294 Character encoding the commit messages are stored in; git itself
1295 does not care per se, but this information is necessary e.g. when
1296 importing commits from emails or in the gitk graphical history
1297 browser (and possibly at other places in the future or in other
1298 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1299
1300 i18n.logOutputEncoding::
1301 Character encoding the commit messages are converted to when
1302 running 'git log' and friends.
1303
1304 imap::
1305 The configuration variables in the 'imap' section are described
1306 in linkgit:git-imap-send[1].
1307
1308 init.templatedir::
1309 Specify the directory from which templates will be copied.
1310 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1311
1312 instaweb.browser::
1313 Specify the program that will be used to browse your working
1314 repository in gitweb. See linkgit:git-instaweb[1].
1315
1316 instaweb.httpd::
1317 The HTTP daemon command-line to start gitweb on your working
1318 repository. See linkgit:git-instaweb[1].
1319
1320 instaweb.local::
1321 If true the web server started by linkgit:git-instaweb[1] will
1322 be bound to the local IP (127.0.0.1).
1323
1324 instaweb.modulepath::
1325 The default module path for linkgit:git-instaweb[1] to use
1326 instead of /usr/lib/apache2/modules. Only used if httpd
1327 is Apache.
1328
1329 instaweb.port::
1330 The port number to bind the gitweb httpd to. See
1331 linkgit:git-instaweb[1].
1332
1333 interactive.singlekey::
1334 In interactive commands, allow the user to provide one-letter
1335 input with a single key (i.e., without hitting enter).
1336 Currently this is used only by the `\--patch` mode of
1337 linkgit:git-add[1]. Note that this setting is silently
1338 ignored if portable keystroke input is not available.
1339
1340 log.date::
1341 Set the default date-time mode for the 'log' command.
1342 Setting a value for log.date is similar to using 'git log''s
1343 `\--date` option. Possible values are `relative`, `local`,
1344 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1345 for details.
1346
1347 log.decorate::
1348 Print out the ref names of any commits that are shown by the log
1349 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1350 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1351 specified, the full ref name (including prefix) will be printed.
1352 This is the same as the log commands '--decorate' option.
1353
1354 log.showroot::
1355 If true, the initial commit will be shown as a big creation event.
1356 This is equivalent to a diff against an empty tree.
1357 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1358 normally hide the root commit will now show it. True by default.
1359
1360 mailmap.file::
1361 The location of an augmenting mailmap file. The default
1362 mailmap, located in the root of the repository, is loaded
1363 first, then the mailmap file pointed to by this variable.
1364 The location of the mailmap file may be in a repository
1365 subdirectory, or somewhere outside of the repository itself.
1366 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1367
1368 man.viewer::
1369 Specify the programs that may be used to display help in the
1370 'man' format. See linkgit:git-help[1].
1371
1372 man.<tool>.cmd::
1373 Specify the command to invoke the specified man viewer. The
1374 specified command is evaluated in shell with the man page
1375 passed as argument. (See linkgit:git-help[1].)
1376
1377 man.<tool>.path::
1378 Override the path for the given tool that may be used to
1379 display help in the 'man' format. See linkgit:git-help[1].
1380
1381 include::merge-config.txt[]
1382
1383 mergetool.<tool>.path::
1384 Override the path for the given tool. This is useful in case
1385 your tool is not in the PATH.
1386
1387 mergetool.<tool>.cmd::
1388 Specify the command to invoke the specified merge tool. The
1389 specified command is evaluated in shell with the following
1390 variables available: 'BASE' is the name of a temporary file
1391 containing the common base of the files to be merged, if available;
1392 'LOCAL' is the name of a temporary file containing the contents of
1393 the file on the current branch; 'REMOTE' is the name of a temporary
1394 file containing the contents of the file from the branch being
1395 merged; 'MERGED' contains the name of the file to which the merge
1396 tool should write the results of a successful merge.
1397
1398 mergetool.<tool>.trustExitCode::
1399 For a custom merge command, specify whether the exit code of
1400 the merge command can be used to determine whether the merge was
1401 successful. If this is not set to true then the merge target file
1402 timestamp is checked and the merge assumed to have been successful
1403 if the file has been updated, otherwise the user is prompted to
1404 indicate the success of the merge.
1405
1406 mergetool.keepBackup::
1407 After performing a merge, the original file with conflict markers
1408 can be saved as a file with a `.orig` extension. If this variable
1409 is set to `false` then this file is not preserved. Defaults to
1410 `true` (i.e. keep the backup files).
1411
1412 mergetool.keepTemporaries::
1413 When invoking a custom merge tool, git uses a set of temporary
1414 files to pass to the tool. If the tool returns an error and this
1415 variable is set to `true`, then these temporary files will be
1416 preserved, otherwise they will be removed after the tool has
1417 exited. Defaults to `false`.
1418
1419 mergetool.prompt::
1420 Prompt before each invocation of the merge resolution program.
1421
1422 notes.displayRef::
1423 The (fully qualified) refname from which to show notes when
1424 showing commit messages. The value of this variable can be set
1425 to a glob, in which case notes from all matching refs will be
1426 shown. You may also specify this configuration variable
1427 several times. A warning will be issued for refs that do not
1428 exist, but a glob that does not match any refs is silently
1429 ignored.
1430 +
1431 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1432 environment variable, which must be a colon separated list of refs or
1433 globs.
1434 +
1435 The effective value of "core.notesRef" (possibly overridden by
1436 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1437 displayed.
1438
1439 notes.rewrite.<command>::
1440 When rewriting commits with <command> (currently `amend` or
1441 `rebase`) and this variable is set to `true`, git
1442 automatically copies your notes from the original to the
1443 rewritten commit. Defaults to `true`, but see
1444 "notes.rewriteRef" below.
1445
1446 notes.rewriteMode::
1447 When copying notes during a rewrite (see the
1448 "notes.rewrite.<command>" option), determines what to do if
1449 the target commit already has a note. Must be one of
1450 `overwrite`, `concatenate`, or `ignore`. Defaults to
1451 `concatenate`.
1452 +
1453 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1454 environment variable.
1455
1456 notes.rewriteRef::
1457 When copying notes during a rewrite, specifies the (fully
1458 qualified) ref whose notes should be copied. The ref may be a
1459 glob, in which case notes in all matching refs will be copied.
1460 You may also specify this configuration several times.
1461 +
1462 Does not have a default value; you must configure this variable to
1463 enable note rewriting.
1464 +
1465 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1466 environment variable, which must be a colon separated list of refs or
1467 globs.
1468
1469 pack.window::
1470 The size of the window used by linkgit:git-pack-objects[1] when no
1471 window size is given on the command line. Defaults to 10.
1472
1473 pack.depth::
1474 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1475 maximum depth is given on the command line. Defaults to 50.
1476
1477 pack.windowMemory::
1478 The window memory size limit used by linkgit:git-pack-objects[1]
1479 when no limit is given on the command line. The value can be
1480 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1481 limit.
1482
1483 pack.compression::
1484 An integer -1..9, indicating the compression level for objects
1485 in a pack file. -1 is the zlib default. 0 means no
1486 compression, and 1..9 are various speed/size tradeoffs, 9 being
1487 slowest. If not set, defaults to core.compression. If that is
1488 not set, defaults to -1, the zlib default, which is "a default
1489 compromise between speed and compression (currently equivalent
1490 to level 6)."
1491 +
1492 Note that changing the compression level will not automatically recompress
1493 all existing objects. You can force recompression by passing the -F option
1494 to linkgit:git-repack[1].
1495
1496 pack.deltaCacheSize::
1497 The maximum memory in bytes used for caching deltas in
1498 linkgit:git-pack-objects[1] before writing them out to a pack.
1499 This cache is used to speed up the writing object phase by not
1500 having to recompute the final delta result once the best match
1501 for all objects is found. Repacking large repositories on machines
1502 which are tight with memory might be badly impacted by this though,
1503 especially if this cache pushes the system into swapping.
1504 A value of 0 means no limit. The smallest size of 1 byte may be
1505 used to virtually disable this cache. Defaults to 256 MiB.
1506
1507 pack.deltaCacheLimit::
1508 The maximum size of a delta, that is cached in
1509 linkgit:git-pack-objects[1]. This cache is used to speed up the
1510 writing object phase by not having to recompute the final delta
1511 result once the best match for all objects is found. Defaults to 1000.
1512
1513 pack.threads::
1514 Specifies the number of threads to spawn when searching for best
1515 delta matches. This requires that linkgit:git-pack-objects[1]
1516 be compiled with pthreads otherwise this option is ignored with a
1517 warning. This is meant to reduce packing time on multiprocessor
1518 machines. The required amount of memory for the delta search window
1519 is however multiplied by the number of threads.
1520 Specifying 0 will cause git to auto-detect the number of CPU's
1521 and set the number of threads accordingly.
1522
1523 pack.indexVersion::
1524 Specify the default pack index version. Valid values are 1 for
1525 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1526 the new pack index with capabilities for packs larger than 4 GB
1527 as well as proper protection against the repacking of corrupted
1528 packs. Version 2 is the default. Note that version 2 is enforced
1529 and this config option ignored whenever the corresponding pack is
1530 larger than 2 GB.
1531 +
1532 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1533 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1534 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1535 other side may give you a repository that cannot be accessed with your
1536 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1537 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1538 the `{asterisk}.idx` file.
1539
1540 pack.packSizeLimit::
1541 The maximum size of a pack. This setting only affects
1542 packing to a file when repacking, i.e. the git:// protocol
1543 is unaffected. It can be overridden by the `\--max-pack-size`
1544 option of linkgit:git-repack[1]. The minimum size allowed is
1545 limited to 1 MiB. The default is unlimited.
1546 Common unit suffixes of 'k', 'm', or 'g' are
1547 supported.
1548
1549 pager.<cmd>::
1550 If the value is boolean, turns on or off pagination of the
1551 output of a particular git subcommand when writing to a tty.
1552 Otherwise, turns on pagination for the subcommand using the
1553 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1554 or `\--no-pager` is specified on the command line, it takes
1555 precedence over this option. To disable pagination for all
1556 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1557
1558 pretty.<name>::
1559 Alias for a --pretty= format string, as specified in
1560 linkgit:git-log[1]. Any aliases defined here can be used just
1561 as the built-in pretty formats could. For example,
1562 running `git config pretty.changelog "format:{asterisk} %H %s"`
1563 would cause the invocation `git log --pretty=changelog`
1564 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1565 Note that an alias with the same name as a built-in format
1566 will be silently ignored.
1567
1568 pull.octopus::
1569 The default merge strategy to use when pulling multiple branches
1570 at once.
1571
1572 pull.twohead::
1573 The default merge strategy to use when pulling a single branch.
1574
1575 push.default::
1576 Defines the action git push should take if no refspec is given
1577 on the command line, no refspec is configured in the remote, and
1578 no refspec is implied by any of the options given on the command
1579 line. Possible values are:
1580 +
1581 * `nothing` - do not push anything.
1582 * `matching` - push all matching branches.
1583 All branches having the same name in both ends are considered to be
1584 matching. This is the default.
1585 * `tracking` - push the current branch to its upstream branch.
1586 * `current` - push the current branch to a branch of the same name.
1587
1588 rebase.stat::
1589 Whether to show a diffstat of what changed upstream since the last
1590 rebase. False by default.
1591
1592 rebase.autosquash::
1593 If set to true enable '--autosquash' option by default.
1594
1595 receive.autogc::
1596 By default, git-receive-pack will run "git-gc --auto" after
1597 receiving data from git-push and updating refs. You can stop
1598 it by setting this variable to false.
1599
1600 receive.fsckObjects::
1601 If it is set to true, git-receive-pack will check all received
1602 objects. It will abort in the case of a malformed object or a
1603 broken link. The result of an abort are only dangling objects.
1604 Defaults to false.
1605
1606 receive.unpackLimit::
1607 If the number of objects received in a push is below this
1608 limit then the objects will be unpacked into loose object
1609 files. However if the number of received objects equals or
1610 exceeds this limit then the received pack will be stored as
1611 a pack, after adding any missing delta bases. Storing the
1612 pack from a push can make the push operation complete faster,
1613 especially on slow filesystems. If not set, the value of
1614 `transfer.unpackLimit` is used instead.
1615
1616 receive.denyDeletes::
1617 If set to true, git-receive-pack will deny a ref update that deletes
1618 the ref. Use this to prevent such a ref deletion via a push.
1619
1620 receive.denyDeleteCurrent::
1621 If set to true, git-receive-pack will deny a ref update that
1622 deletes the currently checked out branch of a non-bare repository.
1623
1624 receive.denyCurrentBranch::
1625 If set to true or "refuse", git-receive-pack will deny a ref update
1626 to the currently checked out branch of a non-bare repository.
1627 Such a push is potentially dangerous because it brings the HEAD
1628 out of sync with the index and working tree. If set to "warn",
1629 print a warning of such a push to stderr, but allow the push to
1630 proceed. If set to false or "ignore", allow such pushes with no
1631 message. Defaults to "refuse".
1632
1633 receive.denyNonFastForwards::
1634 If set to true, git-receive-pack will deny a ref update which is
1635 not a fast-forward. Use this to prevent such an update via a push,
1636 even if that push is forced. This configuration variable is
1637 set when initializing a shared repository.
1638
1639 receive.updateserverinfo::
1640 If set to true, git-receive-pack will run git-update-server-info
1641 after receiving data from git-push and updating refs.
1642
1643 remote.<name>.url::
1644 The URL of a remote repository. See linkgit:git-fetch[1] or
1645 linkgit:git-push[1].
1646
1647 remote.<name>.pushurl::
1648 The push URL of a remote repository. See linkgit:git-push[1].
1649
1650 remote.<name>.proxy::
1651 For remotes that require curl (http, https and ftp), the URL to
1652 the proxy to use for that remote. Set to the empty string to
1653 disable proxying for that remote.
1654
1655 remote.<name>.fetch::
1656 The default set of "refspec" for linkgit:git-fetch[1]. See
1657 linkgit:git-fetch[1].
1658
1659 remote.<name>.push::
1660 The default set of "refspec" for linkgit:git-push[1]. See
1661 linkgit:git-push[1].
1662
1663 remote.<name>.mirror::
1664 If true, pushing to this remote will automatically behave
1665 as if the `\--mirror` option was given on the command line.
1666
1667 remote.<name>.skipDefaultUpdate::
1668 If true, this remote will be skipped by default when updating
1669 using linkgit:git-fetch[1] or the `update` subcommand of
1670 linkgit:git-remote[1].
1671
1672 remote.<name>.skipFetchAll::
1673 If true, this remote will be skipped by default when updating
1674 using linkgit:git-fetch[1] or the `update` subcommand of
1675 linkgit:git-remote[1].
1676
1677 remote.<name>.receivepack::
1678 The default program to execute on the remote side when pushing. See
1679 option \--receive-pack of linkgit:git-push[1].
1680
1681 remote.<name>.uploadpack::
1682 The default program to execute on the remote side when fetching. See
1683 option \--upload-pack of linkgit:git-fetch-pack[1].
1684
1685 remote.<name>.tagopt::
1686 Setting this value to \--no-tags disables automatic tag following when
1687 fetching from remote <name>. Setting it to \--tags will fetch every
1688 tag from remote <name>, even if they are not reachable from remote
1689 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1690 override this setting. See options \--tags and \--no-tags of
1691 linkgit:git-fetch[1].
1692
1693 remote.<name>.vcs::
1694 Setting this to a value <vcs> will cause git to interact with
1695 the remote with the git-remote-<vcs> helper.
1696
1697 remotes.<group>::
1698 The list of remotes which are fetched by "git remote update
1699 <group>". See linkgit:git-remote[1].
1700
1701 repack.usedeltabaseoffset::
1702 By default, linkgit:git-repack[1] creates packs that use
1703 delta-base offset. If you need to share your repository with
1704 git older than version 1.4.4, either directly or via a dumb
1705 protocol such as http, then you need to set this option to
1706 "false" and repack. Access from old git versions over the
1707 native protocol are unaffected by this option.
1708
1709 rerere.autoupdate::
1710 When set to true, `git-rerere` updates the index with the
1711 resulting contents after it cleanly resolves conflicts using
1712 previously recorded resolution. Defaults to false.
1713
1714 rerere.enabled::
1715 Activate recording of resolved conflicts, so that identical
1716 conflict hunks can be resolved automatically, should they
1717 be encountered again. linkgit:git-rerere[1] command is by
1718 default enabled if you create `rr-cache` directory under
1719 `$GIT_DIR`, but can be disabled by setting this option to false.
1720
1721 sendemail.identity::
1722 A configuration identity. When given, causes values in the
1723 'sendemail.<identity>' subsection to take precedence over
1724 values in the 'sendemail' section. The default identity is
1725 the value of 'sendemail.identity'.
1726
1727 sendemail.smtpencryption::
1728 See linkgit:git-send-email[1] for description. Note that this
1729 setting is not subject to the 'identity' mechanism.
1730
1731 sendemail.smtpssl::
1732 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1733
1734 sendemail.<identity>.*::
1735 Identity-specific versions of the 'sendemail.*' parameters
1736 found below, taking precedence over those when the this
1737 identity is selected, through command-line or
1738 'sendemail.identity'.
1739
1740 sendemail.aliasesfile::
1741 sendemail.aliasfiletype::
1742 sendemail.bcc::
1743 sendemail.cc::
1744 sendemail.cccmd::
1745 sendemail.chainreplyto::
1746 sendemail.confirm::
1747 sendemail.envelopesender::
1748 sendemail.from::
1749 sendemail.multiedit::
1750 sendemail.signedoffbycc::
1751 sendemail.smtppass::
1752 sendemail.suppresscc::
1753 sendemail.suppressfrom::
1754 sendemail.to::
1755 sendemail.smtpdomain::
1756 sendemail.smtpserver::
1757 sendemail.smtpserverport::
1758 sendemail.smtpserveroption::
1759 sendemail.smtpuser::
1760 sendemail.thread::
1761 sendemail.validate::
1762 See linkgit:git-send-email[1] for description.
1763
1764 sendemail.signedoffcc::
1765 Deprecated alias for 'sendemail.signedoffbycc'.
1766
1767 showbranch.default::
1768 The default set of branches for linkgit:git-show-branch[1].
1769 See linkgit:git-show-branch[1].
1770
1771 status.relativePaths::
1772 By default, linkgit:git-status[1] shows paths relative to the
1773 current directory. Setting this variable to `false` shows paths
1774 relative to the repository root (this was the default for git
1775 prior to v1.5.4).
1776
1777 status.showUntrackedFiles::
1778 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1779 files which are not currently tracked by Git. Directories which
1780 contain only untracked files, are shown with the directory name
1781 only. Showing untracked files means that Git needs to lstat() all
1782 all the files in the whole repository, which might be slow on some
1783 systems. So, this variable controls how the commands displays
1784 the untracked files. Possible values are:
1785 +
1786 --
1787 * `no` - Show no untracked files.
1788 * `normal` - Show untracked files and directories.
1789 * `all` - Show also individual files in untracked directories.
1790 --
1791 +
1792 If this variable is not specified, it defaults to 'normal'.
1793 This variable can be overridden with the -u|--untracked-files option
1794 of linkgit:git-status[1] and linkgit:git-commit[1].
1795
1796 status.submodulesummary::
1797 Defaults to false.
1798 If this is set to a non zero number or true (identical to -1 or an
1799 unlimited number), the submodule summary will be enabled and a
1800 summary of commits for modified submodules will be shown (see
1801 --summary-limit option of linkgit:git-submodule[1]).
1802
1803 submodule.<name>.path::
1804 submodule.<name>.url::
1805 submodule.<name>.update::
1806 The path within this project, URL, and the updating strategy
1807 for a submodule. These variables are initially populated
1808 by 'git submodule init'; edit them to override the
1809 URL and other values found in the `.gitmodules` file. See
1810 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1811
1812 submodule.<name>.fetchRecurseSubmodules::
1813 This option can be used to enable/disable recursive fetching of this
1814 submodule. It can be overriden by using the --[no-]recurse-submodules
1815 command line option to "git fetch" and "git pull".
1816 This setting will override that from in the linkgit:gitmodules[5]
1817 file.
1818
1819 submodule.<name>.ignore::
1820 Defines under what circumstances "git status" and the diff family show
1821 a submodule as modified. When set to "all", it will never be considered
1822 modified, "dirty" will ignore all changes to the submodules work tree and
1823 takes only differences between the HEAD of the submodule and the commit
1824 recorded in the superproject into account. "untracked" will additionally
1825 let submodules with modified tracked files in their work tree show up.
1826 Using "none" (the default when this option is not set) also shows
1827 submodules that have untracked files in their work tree as changed.
1828 This setting overrides any setting made in .gitmodules for this submodule,
1829 both settings can be overridden on the command line by using the
1830 "--ignore-submodules" option.
1831
1832 tar.umask::
1833 This variable can be used to restrict the permission bits of
1834 tar archive entries. The default is 0002, which turns off the
1835 world write bit. The special value "user" indicates that the
1836 archiving user's umask will be used instead. See umask(2) and
1837 linkgit:git-archive[1].
1838
1839 transfer.unpackLimit::
1840 When `fetch.unpackLimit` or `receive.unpackLimit` are
1841 not set, the value of this variable is used instead.
1842 The default value is 100.
1843
1844 url.<base>.insteadOf::
1845 Any URL that starts with this value will be rewritten to
1846 start, instead, with <base>. In cases where some site serves a
1847 large number of repositories, and serves them with multiple
1848 access methods, and some users need to use different access
1849 methods, this feature allows people to specify any of the
1850 equivalent URLs and have git automatically rewrite the URL to
1851 the best alternative for the particular user, even for a
1852 never-before-seen repository on the site. When more than one
1853 insteadOf strings match a given URL, the longest match is used.
1854
1855 url.<base>.pushInsteadOf::
1856 Any URL that starts with this value will not be pushed to;
1857 instead, it will be rewritten to start with <base>, and the
1858 resulting URL will be pushed to. In cases where some site serves
1859 a large number of repositories, and serves them with multiple
1860 access methods, some of which do not allow push, this feature
1861 allows people to specify a pull-only URL and have git
1862 automatically use an appropriate URL to push, even for a
1863 never-before-seen repository on the site. When more than one
1864 pushInsteadOf strings match a given URL, the longest match is
1865 used. If a remote has an explicit pushurl, git will ignore this
1866 setting for that remote.
1867
1868 user.email::
1869 Your email address to be recorded in any newly created commits.
1870 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1871 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1872
1873 user.name::
1874 Your full name to be recorded in any newly created commits.
1875 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1876 environment variables. See linkgit:git-commit-tree[1].
1877
1878 user.signingkey::
1879 If linkgit:git-tag[1] is not selecting the key you want it to
1880 automatically when creating a signed tag, you can override the
1881 default selection with this variable. This option is passed
1882 unchanged to gpg's --local-user parameter, so you may specify a key
1883 using any method that gpg supports.
1884
1885 web.browser::
1886 Specify a web browser that may be used by some commands.
1887 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1888 may use it.