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