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