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