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