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