Merge branch 'sv/submitting-final-patch'
[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 commands' 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, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
18
19 Syntax
20 ~~~~~~
21
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
25
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
32
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
36
37 --------
38 [section "subsection"]
39
40 --------
41
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
48
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
53
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
62
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
65
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
71
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
78
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). Other char escape sequences (including octal
82 escape sequences) are invalid.
83
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
86
87 Some variables may require a special value format.
88
89 Includes
90 ~~~~~~~~
91
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
101
102 Example
103 ~~~~~~~
104
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
109
110 # Our diff algorithm
111 [diff]
112 external = /usr/local/bin/diff-wrapper
113 renames = true
114
115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
118
119 # Proxy settings
120 [core]
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
123
124 [include]
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
128
129 Variables
130 ~~~~~~~~~
131
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page.
135
136 Other git-related tools may and do use their own variables. When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
140
141
142 advice.*::
143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
146 +
147 --
148 pushUpdateRejected::
149 Set this variable to 'false' if you want to disable
150 'pushNonFFCurrent',
151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
153 simultaneously.
154 pushNonFFCurrent::
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
157 pushNonFFMatching::
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
162 pushAlreadyExists::
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
165 pushFetchFirst::
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
169 pushNeedsForce::
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
174 statusHints::
175 Show directions on how to proceed from the current
176 state in the output of linkgit:git-status[1], in
177 the template shown when writing commit messages in
178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
180 statusUoption::
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
183 files.
184 commitBeforeMerge::
185 Advice shown when linkgit:git-merge[1] refuses to
186 merge to avoid overwriting local changes.
187 resolveConflict::
188 Advice shown by various commands when conflicts
189 prevent the operation from being performed.
190 implicitIdentity::
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
193 domain name.
194 detachedHead::
195 Advice shown when you used linkgit:git-checkout[1] to
196 move to the detach HEAD state, to instruct how to create
197 a local branch after the fact.
198 amWorkDir::
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
201 rmHints::
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
204 --
205
206 core.fileMode::
207 Tells Git if the executable bit of files in the working tree
208 is to be honored.
209 +
210 Some filesystems lose the executable bit when a file that is
211 marked as executable is checked out, or checks out an
212 non-executable file with executable bit on.
213 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
214 to see if it handles the executable bit correctly
215 and this variable is automatically set as necessary.
216 +
217 A repository, however, may be on a filesystem that handles
218 the filemode correctly, and this variable is set to 'true'
219 when created, but later may be made accessible from another
220 environment that loses the filemode (e.g. exporting ext4 via
221 CIFS mount, visiting a Cygwin created repository with
222 Git for Windows or Eclipse).
223 In such a case it may be necessary to set this variable to 'false'.
224 See linkgit:git-update-index[1].
225 +
226 The default is true (when core.filemode is not specified in the config file).
227
228 core.ignorecase::
229 If true, this option enables various workarounds to enable
230 Git to work better on filesystems that are not case sensitive,
231 like FAT. For example, if a directory listing finds
232 "makefile" when Git expects "Makefile", Git will assume
233 it is really the same file, and continue to remember it as
234 "Makefile".
235 +
236 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
237 will probe and set core.ignorecase true if appropriate when the repository
238 is created.
239
240 core.precomposeunicode::
241 This option is only used by Mac OS implementation of Git.
242 When core.precomposeunicode=true, Git reverts the unicode decomposition
243 of filenames done by Mac OS. This is useful when sharing a repository
244 between Mac OS and Linux or Windows.
245 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
246 When false, file names are handled fully transparent by Git,
247 which is backward compatible with older versions of Git.
248
249 core.trustctime::
250 If false, the ctime differences between the index and the
251 working tree are ignored; useful when the inode change time
252 is regularly modified by something outside Git (file system
253 crawlers and some backup systems).
254 See linkgit:git-update-index[1]. True by default.
255
256 core.checkstat::
257 Determines which stat fields to match between the index
258 and work tree. The user can set this to 'default' or
259 'minimal'. Default (or explicitly 'default'), is to check
260 all fields, including the sub-second part of mtime and ctime.
261
262 core.quotepath::
263 The commands that output paths (e.g. 'ls-files',
264 'diff'), when not given the `-z` option, will quote
265 "unusual" characters in the pathname by enclosing the
266 pathname in a double-quote pair and with backslashes the
267 same way strings in C source code are quoted. If this
268 variable is set to false, the bytes higher than 0x80 are
269 not quoted but output as verbatim. Note that double
270 quote, backslash and control characters are always
271 quoted without `-z` regardless of the setting of this
272 variable.
273
274 core.eol::
275 Sets the line ending type to use in the working directory for
276 files that have the `text` property set. Alternatives are
277 'lf', 'crlf' and 'native', which uses the platform's native
278 line ending. The default value is `native`. See
279 linkgit:gitattributes[5] for more information on end-of-line
280 conversion.
281
282 core.safecrlf::
283 If true, makes Git check if converting `CRLF` is reversible when
284 end-of-line conversion is active. Git will verify if a command
285 modifies a file in the work tree either directly or indirectly.
286 For example, committing a file followed by checking out the
287 same file should yield the original file in the work tree. If
288 this is not the case for the current setting of
289 `core.autocrlf`, Git will reject the file. The variable can
290 be set to "warn", in which case Git will only warn about an
291 irreversible conversion but continue the operation.
292 +
293 CRLF conversion bears a slight chance of corrupting data.
294 When it is enabled, Git will convert CRLF to LF during commit and LF to
295 CRLF during checkout. A file that contains a mixture of LF and
296 CRLF before the commit cannot be recreated by Git. For text
297 files this is the right thing to do: it corrects line endings
298 such that we have only LF line endings in the repository.
299 But for binary files that are accidentally classified as text the
300 conversion can corrupt data.
301 +
302 If you recognize such corruption early you can easily fix it by
303 setting the conversion type explicitly in .gitattributes. Right
304 after committing you still have the original file in your work
305 tree and this file is not yet corrupted. You can explicitly tell
306 Git that this file is binary and Git will handle the file
307 appropriately.
308 +
309 Unfortunately, the desired effect of cleaning up text files with
310 mixed line endings and the undesired effect of corrupting binary
311 files cannot be distinguished. In both cases CRLFs are removed
312 in an irreversible way. For text files this is the right thing
313 to do because CRLFs are line endings, while for binary files
314 converting CRLFs corrupts data.
315 +
316 Note, this safety check does not mean that a checkout will generate a
317 file identical to the original file for a different setting of
318 `core.eol` and `core.autocrlf`, but only for the current one. For
319 example, a text file with `LF` would be accepted with `core.eol=lf`
320 and could later be checked out with `core.eol=crlf`, in which case the
321 resulting file would contain `CRLF`, although the original file
322 contained `LF`. However, in both work trees the line endings would be
323 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
324 file with mixed line endings would be reported by the `core.safecrlf`
325 mechanism.
326
327 core.autocrlf::
328 Setting this variable to "true" is almost the same as setting
329 the `text` attribute to "auto" on all files except that text
330 files are not guaranteed to be normalized: files that contain
331 `CRLF` in the repository will not be touched. Use this
332 setting if you want to have `CRLF` line endings in your
333 working directory even though the repository does not have
334 normalized line endings. This variable can be set to 'input',
335 in which case no output conversion is performed.
336
337 core.symlinks::
338 If false, symbolic links are checked out as small plain files that
339 contain the link text. linkgit:git-update-index[1] and
340 linkgit:git-add[1] will not change the recorded type to regular
341 file. Useful on filesystems like FAT that do not support
342 symbolic links.
343 +
344 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
345 will probe and set core.symlinks false if appropriate when the repository
346 is created.
347
348 core.gitProxy::
349 A "proxy command" to execute (as 'command host port') instead
350 of establishing direct connection to the remote server when
351 using the Git protocol for fetching. If the variable value is
352 in the "COMMAND for DOMAIN" format, the command is applied only
353 on hostnames ending with the specified domain string. This variable
354 may be set multiple times and is matched in the given order;
355 the first match wins.
356 +
357 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
358 (which always applies universally, without the special "for"
359 handling).
360 +
361 The special string `none` can be used as the proxy command to
362 specify that no proxy be used for a given domain pattern.
363 This is useful for excluding servers inside a firewall from
364 proxy use, while defaulting to a common proxy for external domains.
365
366 core.ignoreStat::
367 If true, commands which modify both the working tree and the index
368 will mark the updated paths with the "assume unchanged" bit in the
369 index. These marked files are then assumed to stay unchanged in the
370 working tree, until you mark them otherwise manually - Git will not
371 detect the file changes by lstat() calls. This is useful on systems
372 where those are very slow, such as Microsoft Windows.
373 See linkgit:git-update-index[1].
374 False by default.
375
376 core.preferSymlinkRefs::
377 Instead of the default "symref" format for HEAD
378 and other symbolic reference files, use symbolic links.
379 This is sometimes needed to work with old scripts that
380 expect HEAD to be a symbolic link.
381
382 core.bare::
383 If true this repository is assumed to be 'bare' and has no
384 working directory associated with it. If this is the case a
385 number of commands that require a working directory will be
386 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
387 +
388 This setting is automatically guessed by linkgit:git-clone[1] or
389 linkgit:git-init[1] when the repository was created. By default a
390 repository that ends in "/.git" is assumed to be not bare (bare =
391 false), while all other repositories are assumed to be bare (bare
392 = true).
393
394 core.worktree::
395 Set the path to the root of the working tree.
396 This can be overridden by the GIT_WORK_TREE environment
397 variable and the '--work-tree' command-line option.
398 The value can be an absolute path or relative to the path to
399 the .git directory, which is either specified by --git-dir
400 or GIT_DIR, or automatically discovered.
401 If --git-dir or GIT_DIR is specified but none of
402 --work-tree, GIT_WORK_TREE and core.worktree is specified,
403 the current working directory is regarded as the top level
404 of your working tree.
405 +
406 Note that this variable is honored even when set in a configuration
407 file in a ".git" subdirectory of a directory and its value differs
408 from the latter directory (e.g. "/path/to/.git/config" has
409 core.worktree set to "/different/path"), which is most likely a
410 misconfiguration. Running Git commands in the "/path/to" directory will
411 still use "/different/path" as the root of the work tree and can cause
412 confusion unless you know what you are doing (e.g. you are creating a
413 read-only snapshot of the same index to a location different from the
414 repository's usual working tree).
415
416 core.logAllRefUpdates::
417 Enable the reflog. Updates to a ref <ref> is logged to the file
418 "$GIT_DIR/logs/<ref>", by appending the new and old
419 SHA-1, the date/time and the reason of the update, but
420 only when the file exists. If this configuration
421 variable is set to true, missing "$GIT_DIR/logs/<ref>"
422 file is automatically created for branch heads (i.e. under
423 refs/heads/), remote refs (i.e. under refs/remotes/),
424 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
425 +
426 This information can be used to determine what commit
427 was the tip of a branch "2 days ago".
428 +
429 This value is true by default in a repository that has
430 a working directory associated with it, and false by
431 default in a bare repository.
432
433 core.repositoryFormatVersion::
434 Internal variable identifying the repository format and layout
435 version.
436
437 core.sharedRepository::
438 When 'group' (or 'true'), the repository is made shareable between
439 several users in a group (making sure all the files and objects are
440 group-writable). When 'all' (or 'world' or 'everybody'), the
441 repository will be readable by all users, additionally to being
442 group-shareable. When 'umask' (or 'false'), Git will use permissions
443 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
444 files in the repository will have this mode value. '0xxx' will override
445 user's umask value (whereas the other options will only override
446 requested parts of the user's umask value). Examples: '0660' will make
447 the repo read/write-able for the owner and group, but inaccessible to
448 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
449 repository that is group-readable but not group-writable.
450 See linkgit:git-init[1]. False by default.
451
452 core.warnAmbiguousRefs::
453 If true, Git will warn you if the ref name you passed it is ambiguous
454 and might match multiple refs in the repository. True by default.
455
456 core.compression::
457 An integer -1..9, indicating a default compression level.
458 -1 is the zlib default. 0 means no compression,
459 and 1..9 are various speed/size tradeoffs, 9 being slowest.
460 If set, this provides a default to other compression variables,
461 such as 'core.loosecompression' and 'pack.compression'.
462
463 core.loosecompression::
464 An integer -1..9, indicating the compression level for objects that
465 are not in a pack file. -1 is the zlib default. 0 means no
466 compression, and 1..9 are various speed/size tradeoffs, 9 being
467 slowest. If not set, defaults to core.compression. If that is
468 not set, defaults to 1 (best speed).
469
470 core.packedGitWindowSize::
471 Number of bytes of a pack file to map into memory in a
472 single mapping operation. Larger window sizes may allow
473 your system to process a smaller number of large pack files
474 more quickly. Smaller window sizes will negatively affect
475 performance due to increased calls to the operating system's
476 memory manager, but may improve performance when accessing
477 a large number of large pack files.
478 +
479 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
480 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
481 be reasonable for all users/operating systems. You probably do
482 not need to adjust this value.
483 +
484 Common unit suffixes of 'k', 'm', or 'g' are supported.
485
486 core.packedGitLimit::
487 Maximum number of bytes to map simultaneously into memory
488 from pack files. If Git needs to access more than this many
489 bytes at once to complete an operation it will unmap existing
490 regions to reclaim virtual address space within the process.
491 +
492 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
493 This should be reasonable for all users/operating systems, except on
494 the largest projects. You probably do not need to adjust this value.
495 +
496 Common unit suffixes of 'k', 'm', or 'g' are supported.
497
498 core.deltaBaseCacheLimit::
499 Maximum number of bytes to reserve for caching base objects
500 that may be referenced by multiple deltified objects. By storing the
501 entire decompressed base objects in a cache Git is able
502 to avoid unpacking and decompressing frequently used base
503 objects multiple times.
504 +
505 Default is 96 MiB on all platforms. This should be reasonable
506 for all users/operating systems, except on the largest projects.
507 You probably do not need to adjust this value.
508 +
509 Common unit suffixes of 'k', 'm', or 'g' are supported.
510
511 core.bigFileThreshold::
512 Files larger than this size are stored deflated, without
513 attempting delta compression. Storing large files without
514 delta compression avoids excessive memory usage, at the
515 slight expense of increased disk usage. Additionally files
516 larger than this size are always treated as binary.
517 +
518 Default is 512 MiB on all platforms. This should be reasonable
519 for most projects as source code and other text files can still
520 be delta compressed, but larger binary media files won't be.
521 +
522 Common unit suffixes of 'k', 'm', or 'g' are supported.
523
524 core.excludesfile::
525 In addition to '.gitignore' (per-directory) and
526 '.git/info/exclude', Git looks into this file for patterns
527 of files which are not meant to be tracked. "`~/`" is expanded
528 to the value of `$HOME` and "`~user/`" to the specified user's
529 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
530 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
531 is used instead. See linkgit:gitignore[5].
532
533 core.askpass::
534 Some commands (e.g. svn and http interfaces) that interactively
535 ask for a password can be told to use an external program given
536 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
537 environment variable. If not set, fall back to the value of the
538 'SSH_ASKPASS' environment variable or, failing that, a simple password
539 prompt. The external program shall be given a suitable prompt as
540 command-line argument and write the password on its STDOUT.
541
542 core.attributesfile::
543 In addition to '.gitattributes' (per-directory) and
544 '.git/info/attributes', Git looks into this file for attributes
545 (see linkgit:gitattributes[5]). Path expansions are made the same
546 way as for `core.excludesfile`. Its default value is
547 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
548 set or empty, $HOME/.config/git/attributes is used instead.
549
550 core.editor::
551 Commands such as `commit` and `tag` that lets you edit
552 messages by launching an editor uses the value of this
553 variable when it is set, and the environment variable
554 `GIT_EDITOR` is not set. See linkgit:git-var[1].
555
556 core.commentchar::
557 Commands such as `commit` and `tag` that lets you edit
558 messages consider a line that begins with this character
559 commented, and removes them after the editor returns
560 (default '#').
561 +
562 If set to "auto", `git-commit` would select a character that is not
563 the beginning character of any line in existing commit messages.
564
565 sequence.editor::
566 Text editor used by `git rebase -i` for editing the rebase instruction file.
567 The value is meant to be interpreted by the shell when it is used.
568 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
569 When not configured the default commit message editor is used instead.
570
571 core.pager::
572 Text viewer for use by Git commands (e.g., 'less'). The value
573 is meant to be interpreted by the shell. The order of preference
574 is the `$GIT_PAGER` environment variable, then `core.pager`
575 configuration, then `$PAGER`, and then the default chosen at
576 compile time (usually 'less').
577 +
578 When the `LESS` environment variable is unset, Git sets it to `FRX`
579 (if `LESS` environment variable is set, Git does not change it at
580 all). If you want to selectively override Git's default setting
581 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
582 be passed to the shell by Git, which will translate the final
583 command to `LESS=FRX less -S`. The environment does not set the
584 `S` option but the command line does, instructing less to truncate
585 long lines. Similarly, setting `core.pager` to `less -+F` will
586 deactivate the `F` option specified by the environment from the
587 command-line, deactivating the "quit if one screen" behavior of
588 `less`. One can specifically activate some flags for particular
589 commands: for example, setting `pager.blame` to `less -S` enables
590 line truncation only for `git blame`.
591 +
592 Likewise, when the `LV` environment variable is unset, Git sets it
593 to `-c`. You can override this setting by exporting `LV` with
594 another value or setting `core.pager` to `lv +c`.
595
596 core.whitespace::
597 A comma separated list of common whitespace problems to
598 notice. 'git diff' will use `color.diff.whitespace` to
599 highlight them, and 'git apply --whitespace=error' will
600 consider them as errors. You can prefix `-` to disable
601 any of them (e.g. `-trailing-space`):
602 +
603 * `blank-at-eol` treats trailing whitespaces at the end of the line
604 as an error (enabled by default).
605 * `space-before-tab` treats a space character that appears immediately
606 before a tab character in the initial indent part of the line as an
607 error (enabled by default).
608 * `indent-with-non-tab` treats a line that is indented with space
609 characters instead of the equivalent tabs as an error (not enabled by
610 default).
611 * `tab-in-indent` treats a tab character in the initial indent part of
612 the line as an error (not enabled by default).
613 * `blank-at-eof` treats blank lines added at the end of file as an error
614 (enabled by default).
615 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
616 `blank-at-eof`.
617 * `cr-at-eol` treats a carriage-return at the end of line as
618 part of the line terminator, i.e. with it, `trailing-space`
619 does not trigger if the character before such a carriage-return
620 is not a whitespace (not enabled by default).
621 * `tabwidth=<n>` tells how many character positions a tab occupies; this
622 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
623 errors. The default tab width is 8. Allowed values are 1 to 63.
624
625 core.fsyncobjectfiles::
626 This boolean will enable 'fsync()' when writing object files.
627 +
628 This is a total waste of time and effort on a filesystem that orders
629 data writes properly, but can be useful for filesystems that do not use
630 journalling (traditional UNIX filesystems) or that only journal metadata
631 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
632
633 core.preloadindex::
634 Enable parallel index preload for operations like 'git diff'
635 +
636 This can speed up operations like 'git diff' and 'git status' especially
637 on filesystems like NFS that have weak caching semantics and thus
638 relatively high IO latencies. When enabled, Git will do the
639 index comparison to the filesystem data in parallel, allowing
640 overlapping IO's. Defaults to true.
641
642 core.createObject::
643 You can set this to 'link', in which case a hardlink followed by
644 a delete of the source are used to make sure that object creation
645 will not overwrite existing objects.
646 +
647 On some file system/operating system combinations, this is unreliable.
648 Set this config setting to 'rename' there; However, This will remove the
649 check that makes sure that existing object files will not get overwritten.
650
651 core.notesRef::
652 When showing commit messages, also show notes which are stored in
653 the given ref. The ref must be fully qualified. If the given
654 ref does not exist, it is not an error but means that no
655 notes should be printed.
656 +
657 This setting defaults to "refs/notes/commits", and it can be overridden by
658 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
659
660 core.sparseCheckout::
661 Enable "sparse checkout" feature. See section "Sparse checkout" in
662 linkgit:git-read-tree[1] for more information.
663
664 core.abbrev::
665 Set the length object names are abbreviated to. If unspecified,
666 many commands abbreviate to 7 hexdigits, which may not be enough
667 for abbreviated object names to stay unique for sufficiently long
668 time.
669
670 add.ignore-errors::
671 add.ignoreErrors::
672 Tells 'git add' to continue adding files when some files cannot be
673 added due to indexing errors. Equivalent to the '--ignore-errors'
674 option of linkgit:git-add[1]. Older versions of Git accept only
675 `add.ignore-errors`, which does not follow the usual naming
676 convention for configuration variables. Newer versions of Git
677 honor `add.ignoreErrors` as well.
678
679 alias.*::
680 Command aliases for the linkgit:git[1] command wrapper - e.g.
681 after defining "alias.last = cat-file commit HEAD", the invocation
682 "git last" is equivalent to "git cat-file commit HEAD". To avoid
683 confusion and troubles with script usage, aliases that
684 hide existing Git commands are ignored. Arguments are split by
685 spaces, the usual shell quoting and escaping is supported.
686 A quote pair or a backslash can be used to quote them.
687 +
688 If the alias expansion is prefixed with an exclamation point,
689 it will be treated as a shell command. For example, defining
690 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
691 "git new" is equivalent to running the shell command
692 "gitk --all --not ORIG_HEAD". Note that shell commands will be
693 executed from the top-level directory of a repository, which may
694 not necessarily be the current directory.
695 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
696 from the original current directory. See linkgit:git-rev-parse[1].
697
698 am.keepcr::
699 If true, git-am will call git-mailsplit for patches in mbox format
700 with parameter '--keep-cr'. In this case git-mailsplit will
701 not remove `\r` from lines ending with `\r\n`. Can be overridden
702 by giving '--no-keep-cr' from the command line.
703 See linkgit:git-am[1], linkgit:git-mailsplit[1].
704
705 apply.ignorewhitespace::
706 When set to 'change', tells 'git apply' to ignore changes in
707 whitespace, in the same way as the '--ignore-space-change'
708 option.
709 When set to one of: no, none, never, false tells 'git apply' to
710 respect all whitespace differences.
711 See linkgit:git-apply[1].
712
713 apply.whitespace::
714 Tells 'git apply' how to handle whitespaces, in the same way
715 as the '--whitespace' option. See linkgit:git-apply[1].
716
717 branch.autosetupmerge::
718 Tells 'git branch' and 'git checkout' to set up new branches
719 so that linkgit:git-pull[1] will appropriately merge from the
720 starting point branch. Note that even if this option is not set,
721 this behavior can be chosen per-branch using the `--track`
722 and `--no-track` options. The valid settings are: `false` -- no
723 automatic setup is done; `true` -- automatic setup is done when the
724 starting point is a remote-tracking branch; `always` --
725 automatic setup is done when the starting point is either a
726 local branch or remote-tracking
727 branch. This option defaults to true.
728
729 branch.autosetuprebase::
730 When a new branch is created with 'git branch' or 'git checkout'
731 that tracks another branch, this variable tells Git to set
732 up pull to rebase instead of merge (see "branch.<name>.rebase").
733 When `never`, rebase is never automatically set to true.
734 When `local`, rebase is set to true for tracked branches of
735 other local branches.
736 When `remote`, rebase is set to true for tracked branches of
737 remote-tracking branches.
738 When `always`, rebase will be set to true for all tracking
739 branches.
740 See "branch.autosetupmerge" for details on how to set up a
741 branch to track another branch.
742 This option defaults to never.
743
744 branch.<name>.remote::
745 When on branch <name>, it tells 'git fetch' and 'git push'
746 which remote to fetch from/push to. The remote to push to
747 may be overridden with `remote.pushdefault` (for all branches).
748 The remote to push to, for the current branch, may be further
749 overridden by `branch.<name>.pushremote`. If no remote is
750 configured, or if you are not on any branch, it defaults to
751 `origin` for fetching and `remote.pushdefault` for pushing.
752 Additionally, `.` (a period) is the current local repository
753 (a dot-repository), see `branch.<name>.merge`'s final note below.
754
755 branch.<name>.pushremote::
756 When on branch <name>, it overrides `branch.<name>.remote` for
757 pushing. It also overrides `remote.pushdefault` for pushing
758 from branch <name>. When you pull from one place (e.g. your
759 upstream) and push to another place (e.g. your own publishing
760 repository), you would want to set `remote.pushdefault` to
761 specify the remote to push to for all branches, and use this
762 option to override it for a specific branch.
763
764 branch.<name>.merge::
765 Defines, together with branch.<name>.remote, the upstream branch
766 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
767 branch to merge and can also affect 'git push' (see push.default).
768 When in branch <name>, it tells 'git fetch' the default
769 refspec to be marked for merging in FETCH_HEAD. The value is
770 handled like the remote part of a refspec, and must match a
771 ref which is fetched from the remote given by
772 "branch.<name>.remote".
773 The merge information is used by 'git pull' (which at first calls
774 'git fetch') to lookup the default branch for merging. Without
775 this option, 'git pull' defaults to merge the first refspec fetched.
776 Specify multiple values to get an octopus merge.
777 If you wish to setup 'git pull' so that it merges into <name> from
778 another branch in the local repository, you can point
779 branch.<name>.merge to the desired branch, and use the relative path
780 setting `.` (a period) for branch.<name>.remote.
781
782 branch.<name>.mergeoptions::
783 Sets default options for merging into branch <name>. The syntax and
784 supported options are the same as those of linkgit:git-merge[1], but
785 option values containing whitespace characters are currently not
786 supported.
787
788 branch.<name>.rebase::
789 When true, rebase the branch <name> on top of the fetched branch,
790 instead of merging the default branch from the default remote when
791 "git pull" is run. See "pull.rebase" for doing this in a non
792 branch-specific manner.
793 +
794 When preserve, also pass `--preserve-merges` along to 'git rebase'
795 so that locally committed merge commits will not be flattened
796 by running 'git pull'.
797 +
798 *NOTE*: this is a possibly dangerous operation; do *not* use
799 it unless you understand the implications (see linkgit:git-rebase[1]
800 for details).
801
802 branch.<name>.description::
803 Branch description, can be edited with
804 `git branch --edit-description`. Branch description is
805 automatically added in the format-patch cover letter or
806 request-pull summary.
807
808 browser.<tool>.cmd::
809 Specify the command to invoke the specified browser. The
810 specified command is evaluated in shell with the URLs passed
811 as arguments. (See linkgit:git-web{litdd}browse[1].)
812
813 browser.<tool>.path::
814 Override the path for the given tool that may be used to
815 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
816 working repository in gitweb (see linkgit:git-instaweb[1]).
817
818 clean.requireForce::
819 A boolean to make git-clean do nothing unless given -f,
820 -i or -n. Defaults to true.
821
822 color.branch::
823 A boolean to enable/disable color in the output of
824 linkgit:git-branch[1]. May be set to `always`,
825 `false` (or `never`) or `auto` (or `true`), in which case colors are used
826 only when the output is to a terminal. Defaults to false.
827
828 color.branch.<slot>::
829 Use customized color for branch coloration. `<slot>` is one of
830 `current` (the current branch), `local` (a local branch),
831 `remote` (a remote-tracking branch in refs/remotes/),
832 `upstream` (upstream tracking branch), `plain` (other
833 refs).
834 +
835 The value for these configuration variables is a list of colors (at most
836 two) and attributes (at most one), separated by spaces. The colors
837 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
838 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
839 `blink` and `reverse`. The first color given is the foreground; the
840 second is the background. The position of the attribute, if any,
841 doesn't matter.
842
843 color.diff::
844 Whether to use ANSI escape sequences to add color to patches.
845 If this is set to `always`, linkgit:git-diff[1],
846 linkgit:git-log[1], and linkgit:git-show[1] will use color
847 for all patches. If it is set to `true` or `auto`, those
848 commands will only use color when output is to the terminal.
849 Defaults to false.
850 +
851 This does not affect linkgit:git-format-patch[1] or the
852 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
853 command line with the `--color[=<when>]` option.
854
855 color.diff.<slot>::
856 Use customized color for diff colorization. `<slot>` specifies
857 which part of the patch to use the specified color, and is one
858 of `plain` (context text), `meta` (metainformation), `frag`
859 (hunk header), 'func' (function in hunk header), `old` (removed lines),
860 `new` (added lines), `commit` (commit headers), or `whitespace`
861 (highlighting whitespace errors). The values of these variables may be
862 specified as in color.branch.<slot>.
863
864 color.decorate.<slot>::
865 Use customized color for 'git log --decorate' output. `<slot>` is one
866 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
867 branches, remote-tracking branches, tags, stash and HEAD, respectively.
868
869 color.grep::
870 When set to `always`, always highlight matches. When `false` (or
871 `never`), never. When set to `true` or `auto`, use color only
872 when the output is written to the terminal. Defaults to `false`.
873
874 color.grep.<slot>::
875 Use customized color for grep colorization. `<slot>` specifies which
876 part of the line to use the specified color, and is one of
877 +
878 --
879 `context`;;
880 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
881 `filename`;;
882 filename prefix (when not using `-h`)
883 `function`;;
884 function name lines (when using `-p`)
885 `linenumber`;;
886 line number prefix (when using `-n`)
887 `match`;;
888 matching text (same as setting `matchContext` and `matchSelected`)
889 `matchContext`;;
890 matching text in context lines
891 `matchSelected`;;
892 matching text in selected lines
893 `selected`;;
894 non-matching text in selected lines
895 `separator`;;
896 separators between fields on a line (`:`, `-`, and `=`)
897 and between hunks (`--`)
898 --
899 +
900 The values of these variables may be specified as in color.branch.<slot>.
901
902 color.interactive::
903 When set to `always`, always use colors for interactive prompts
904 and displays (such as those used by "git-add --interactive" and
905 "git-clean --interactive"). When false (or `never`), never.
906 When set to `true` or `auto`, use colors only when the output is
907 to the terminal. Defaults to false.
908
909 color.interactive.<slot>::
910 Use customized color for 'git add --interactive' and 'git clean
911 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
912 or `error`, for four distinct types of normal output from
913 interactive commands. The values of these variables may be
914 specified as in color.branch.<slot>.
915
916 color.pager::
917 A boolean to enable/disable colored output when the pager is in
918 use (default is true).
919
920 color.showbranch::
921 A boolean to enable/disable color in the output of
922 linkgit:git-show-branch[1]. May be set to `always`,
923 `false` (or `never`) or `auto` (or `true`), in which case colors are used
924 only when the output is to a terminal. Defaults to false.
925
926 color.status::
927 A boolean to enable/disable color in the output of
928 linkgit:git-status[1]. May be set to `always`,
929 `false` (or `never`) or `auto` (or `true`), in which case colors are used
930 only when the output is to a terminal. Defaults to false.
931
932 color.status.<slot>::
933 Use customized color for status colorization. `<slot>` is
934 one of `header` (the header text of the status message),
935 `added` or `updated` (files which are added but not committed),
936 `changed` (files which are changed but not added in the index),
937 `untracked` (files which are not tracked by Git),
938 `branch` (the current branch), or
939 `nobranch` (the color the 'no branch' warning is shown in, defaulting
940 to red). The values of these variables may be specified as in
941 color.branch.<slot>.
942
943 color.ui::
944 This variable determines the default value for variables such
945 as `color.diff` and `color.grep` that control the use of color
946 per command family. Its scope will expand as more commands learn
947 configuration to set a default for the `--color` option. Set it
948 to `false` or `never` if you prefer Git commands not to use
949 color unless enabled explicitly with some other configuration
950 or the `--color` option. Set it to `always` if you want all
951 output not intended for machine consumption to use color, to
952 `true` or `auto` (this is the default since Git 1.8.4) if you
953 want such output to use color when written to the terminal.
954
955 column.ui::
956 Specify whether supported commands should output in columns.
957 This variable consists of a list of tokens separated by spaces
958 or commas:
959 +
960 These options control when the feature should be enabled
961 (defaults to 'never'):
962 +
963 --
964 `always`;;
965 always show in columns
966 `never`;;
967 never show in columns
968 `auto`;;
969 show in columns if the output is to the terminal
970 --
971 +
972 These options control layout (defaults to 'column'). Setting any
973 of these implies 'always' if none of 'always', 'never', or 'auto' are
974 specified.
975 +
976 --
977 `column`;;
978 fill columns before rows
979 `row`;;
980 fill rows before columns
981 `plain`;;
982 show in one column
983 --
984 +
985 Finally, these options can be combined with a layout option (defaults
986 to 'nodense'):
987 +
988 --
989 `dense`;;
990 make unequal size columns to utilize more space
991 `nodense`;;
992 make equal size columns
993 --
994
995 column.branch::
996 Specify whether to output branch listing in `git branch` in columns.
997 See `column.ui` for details.
998
999 column.clean::
1000 Specify the layout when list items in `git clean -i`, which always
1001 shows files and directories in columns. See `column.ui` for details.
1002
1003 column.status::
1004 Specify whether to output untracked files in `git status` in columns.
1005 See `column.ui` for details.
1006
1007 column.tag::
1008 Specify whether to output tag listing in `git tag` in columns.
1009 See `column.ui` for details.
1010
1011 commit.cleanup::
1012 This setting overrides the default of the `--cleanup` option in
1013 `git commit`. See linkgit:git-commit[1] for details. Changing the
1014 default can be useful when you always want to keep lines that begin
1015 with comment character `#` in your log message, in which case you
1016 would do `git config commit.cleanup whitespace` (note that you will
1017 have to remove the help lines that begin with `#` in the commit log
1018 template yourself, if you do this).
1019
1020 commit.gpgsign::
1021
1022 A boolean to specify whether all commits should be GPG signed.
1023 Use of this option when doing operations such as rebase can
1024 result in a large number of commits being signed. It may be
1025 convenient to use an agent to avoid typing your GPG passphrase
1026 several times.
1027
1028 commit.status::
1029 A boolean to enable/disable inclusion of status information in the
1030 commit message template when using an editor to prepare the commit
1031 message. Defaults to true.
1032
1033 commit.template::
1034 Specify a file to use as the template for new commit messages.
1035 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1036 specified user's home directory.
1037
1038 credential.helper::
1039 Specify an external helper to be called when a username or
1040 password credential is needed; the helper may consult external
1041 storage to avoid prompting the user for the credentials. See
1042 linkgit:gitcredentials[7] for details.
1043
1044 credential.useHttpPath::
1045 When acquiring credentials, consider the "path" component of an http
1046 or https URL to be important. Defaults to false. See
1047 linkgit:gitcredentials[7] for more information.
1048
1049 credential.username::
1050 If no username is set for a network authentication, use this username
1051 by default. See credential.<context>.* below, and
1052 linkgit:gitcredentials[7].
1053
1054 credential.<url>.*::
1055 Any of the credential.* options above can be applied selectively to
1056 some credentials. For example "credential.https://example.com.username"
1057 would set the default username only for https connections to
1058 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1059 matched.
1060
1061 include::diff-config.txt[]
1062
1063 difftool.<tool>.path::
1064 Override the path for the given tool. This is useful in case
1065 your tool is not in the PATH.
1066
1067 difftool.<tool>.cmd::
1068 Specify the command to invoke the specified diff tool.
1069 The specified command is evaluated in shell with the following
1070 variables available: 'LOCAL' is set to the name of the temporary
1071 file containing the contents of the diff pre-image and 'REMOTE'
1072 is set to the name of the temporary file containing the contents
1073 of the diff post-image.
1074
1075 difftool.prompt::
1076 Prompt before each invocation of the diff tool.
1077
1078 fetch.recurseSubmodules::
1079 This option can be either set to a boolean value or to 'on-demand'.
1080 Setting it to a boolean changes the behavior of fetch and pull to
1081 unconditionally recurse into submodules when set to true or to not
1082 recurse at all when set to false. When set to 'on-demand' (the default
1083 value), fetch and pull will only recurse into a populated submodule
1084 when its superproject retrieves a commit that updates the submodule's
1085 reference.
1086
1087 fetch.fsckObjects::
1088 If it is set to true, git-fetch-pack will check all fetched
1089 objects. It will abort in the case of a malformed object or a
1090 broken link. The result of an abort are only dangling objects.
1091 Defaults to false. If not set, the value of `transfer.fsckObjects`
1092 is used instead.
1093
1094 fetch.unpackLimit::
1095 If the number of objects fetched over the Git native
1096 transfer is below this
1097 limit, then the objects will be unpacked into loose object
1098 files. However if the number of received objects equals or
1099 exceeds this limit then the received pack will be stored as
1100 a pack, after adding any missing delta bases. Storing the
1101 pack from a push can make the push operation complete faster,
1102 especially on slow filesystems. If not set, the value of
1103 `transfer.unpackLimit` is used instead.
1104
1105 fetch.prune::
1106 If true, fetch will automatically behave as if the `--prune`
1107 option was given on the command line. See also `remote.<name>.prune`.
1108
1109 format.attach::
1110 Enable multipart/mixed attachments as the default for
1111 'format-patch'. The value can also be a double quoted string
1112 which will enable attachments as the default and set the
1113 value as the boundary. See the --attach option in
1114 linkgit:git-format-patch[1].
1115
1116 format.numbered::
1117 A boolean which can enable or disable sequence numbers in patch
1118 subjects. It defaults to "auto" which enables it only if there
1119 is more than one patch. It can be enabled or disabled for all
1120 messages by setting it to "true" or "false". See --numbered
1121 option in linkgit:git-format-patch[1].
1122
1123 format.headers::
1124 Additional email headers to include in a patch to be submitted
1125 by mail. See linkgit:git-format-patch[1].
1126
1127 format.to::
1128 format.cc::
1129 Additional recipients to include in a patch to be submitted
1130 by mail. See the --to and --cc options in
1131 linkgit:git-format-patch[1].
1132
1133 format.subjectprefix::
1134 The default for format-patch is to output files with the '[PATCH]'
1135 subject prefix. Use this variable to change that prefix.
1136
1137 format.signature::
1138 The default for format-patch is to output a signature containing
1139 the Git version number. Use this variable to change that default.
1140 Set this variable to the empty string ("") to suppress
1141 signature generation.
1142
1143 format.signaturefile::
1144 Works just like format.signature except the contents of the
1145 file specified by this variable will be used as the signature.
1146
1147 format.suffix::
1148 The default for format-patch is to output files with the suffix
1149 `.patch`. Use this variable to change that suffix (make sure to
1150 include the dot if you want it).
1151
1152 format.pretty::
1153 The default pretty format for log/show/whatchanged command,
1154 See linkgit:git-log[1], linkgit:git-show[1],
1155 linkgit:git-whatchanged[1].
1156
1157 format.thread::
1158 The default threading style for 'git format-patch'. Can be
1159 a boolean value, or `shallow` or `deep`. `shallow` threading
1160 makes every mail a reply to the head of the series,
1161 where the head is chosen from the cover letter, the
1162 `--in-reply-to`, and the first patch mail, in this order.
1163 `deep` threading makes every mail a reply to the previous one.
1164 A true boolean value is the same as `shallow`, and a false
1165 value disables threading.
1166
1167 format.signoff::
1168 A boolean value which lets you enable the `-s/--signoff` option of
1169 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1170 patch should be a conscious act and means that you certify you have
1171 the rights to submit this work under the same open source license.
1172 Please see the 'SubmittingPatches' document for further discussion.
1173
1174 format.coverLetter::
1175 A boolean that controls whether to generate a cover-letter when
1176 format-patch is invoked, but in addition can be set to "auto", to
1177 generate a cover-letter only when there's more than one patch.
1178
1179 filter.<driver>.clean::
1180 The command which is used to convert the content of a worktree
1181 file to a blob upon checkin. See linkgit:gitattributes[5] for
1182 details.
1183
1184 filter.<driver>.smudge::
1185 The command which is used to convert the content of a blob
1186 object to a worktree file upon checkout. See
1187 linkgit:gitattributes[5] for details.
1188
1189 gc.aggressiveDepth::
1190 The depth parameter used in the delta compression
1191 algorithm used by 'git gc --aggressive'. This defaults
1192 to 250.
1193
1194 gc.aggressiveWindow::
1195 The window size parameter used in the delta compression
1196 algorithm used by 'git gc --aggressive'. This defaults
1197 to 250.
1198
1199 gc.auto::
1200 When there are approximately more than this many loose
1201 objects in the repository, `git gc --auto` will pack them.
1202 Some Porcelain commands use this command to perform a
1203 light-weight garbage collection from time to time. The
1204 default value is 6700. Setting this to 0 disables it.
1205
1206 gc.autopacklimit::
1207 When there are more than this many packs that are not
1208 marked with `*.keep` file in the repository, `git gc
1209 --auto` consolidates them into one larger pack. The
1210 default value is 50. Setting this to 0 disables it.
1211
1212 gc.autodetach::
1213 Make `git gc --auto` return immediately and run in background
1214 if the system supports it. Default is true.
1215
1216 gc.packrefs::
1217 Running `git pack-refs` in a repository renders it
1218 unclonable by Git versions prior to 1.5.1.2 over dumb
1219 transports such as HTTP. This variable determines whether
1220 'git gc' runs `git pack-refs`. This can be set to `notbare`
1221 to enable it within all non-bare repos or it can be set to a
1222 boolean value. The default is `true`.
1223
1224 gc.pruneexpire::
1225 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1226 Override the grace period with this config variable. The value
1227 "now" may be used to disable this grace period and always prune
1228 unreachable objects immediately.
1229
1230 gc.reflogexpire::
1231 gc.<pattern>.reflogexpire::
1232 'git reflog expire' removes reflog entries older than
1233 this time; defaults to 90 days. With "<pattern>" (e.g.
1234 "refs/stash") in the middle the setting applies only to
1235 the refs that match the <pattern>.
1236
1237 gc.reflogexpireunreachable::
1238 gc.<ref>.reflogexpireunreachable::
1239 'git reflog expire' removes reflog entries older than
1240 this time and are not reachable from the current tip;
1241 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1242 in the middle, the setting applies only to the refs that
1243 match the <pattern>.
1244
1245 gc.rerereresolved::
1246 Records of conflicted merge you resolved earlier are
1247 kept for this many days when 'git rerere gc' is run.
1248 The default is 60 days. See linkgit:git-rerere[1].
1249
1250 gc.rerereunresolved::
1251 Records of conflicted merge you have not resolved are
1252 kept for this many days when 'git rerere gc' is run.
1253 The default is 15 days. See linkgit:git-rerere[1].
1254
1255 gitcvs.commitmsgannotation::
1256 Append this string to each commit message. Set to empty string
1257 to disable this feature. Defaults to "via git-CVS emulator".
1258
1259 gitcvs.enabled::
1260 Whether the CVS server interface is enabled for this repository.
1261 See linkgit:git-cvsserver[1].
1262
1263 gitcvs.logfile::
1264 Path to a log file where the CVS server interface well... logs
1265 various stuff. See linkgit:git-cvsserver[1].
1266
1267 gitcvs.usecrlfattr::
1268 If true, the server will look up the end-of-line conversion
1269 attributes for files to determine the '-k' modes to use. If
1270 the attributes force Git to treat a file as text,
1271 the '-k' mode will be left blank so CVS clients will
1272 treat it as text. If they suppress text conversion, the file
1273 will be set with '-kb' mode, which suppresses any newline munging
1274 the client might otherwise do. If the attributes do not allow
1275 the file type to be determined, then 'gitcvs.allbinary' is
1276 used. See linkgit:gitattributes[5].
1277
1278 gitcvs.allbinary::
1279 This is used if 'gitcvs.usecrlfattr' does not resolve
1280 the correct '-kb' mode to use. If true, all
1281 unresolved files are sent to the client in
1282 mode '-kb'. This causes the client to treat them
1283 as binary files, which suppresses any newline munging it
1284 otherwise might do. Alternatively, if it is set to "guess",
1285 then the contents of the file are examined to decide if
1286 it is binary, similar to 'core.autocrlf'.
1287
1288 gitcvs.dbname::
1289 Database used by git-cvsserver to cache revision information
1290 derived from the Git repository. The exact meaning depends on the
1291 used database driver, for SQLite (which is the default driver) this
1292 is a filename. Supports variable substitution (see
1293 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1294 Default: '%Ggitcvs.%m.sqlite'
1295
1296 gitcvs.dbdriver::
1297 Used Perl DBI driver. You can specify any available driver
1298 for this here, but it might not work. git-cvsserver is tested
1299 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1300 reported *not* to work with 'DBD::mysql'. Experimental feature.
1301 May not contain double colons (`:`). Default: 'SQLite'.
1302 See linkgit:git-cvsserver[1].
1303
1304 gitcvs.dbuser, gitcvs.dbpass::
1305 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1306 since SQLite has no concept of database users and/or passwords.
1307 'gitcvs.dbuser' supports variable substitution (see
1308 linkgit:git-cvsserver[1] for details).
1309
1310 gitcvs.dbTableNamePrefix::
1311 Database table name prefix. Prepended to the names of any
1312 database tables used, allowing a single database to be used
1313 for several repositories. Supports variable substitution (see
1314 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1315 characters will be replaced with underscores.
1316
1317 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1318 'gitcvs.allbinary' can also be specified as
1319 'gitcvs.<access_method>.<varname>' (where 'access_method'
1320 is one of "ext" and "pserver") to make them apply only for the given
1321 access method.
1322
1323 gitweb.category::
1324 gitweb.description::
1325 gitweb.owner::
1326 gitweb.url::
1327 See linkgit:gitweb[1] for description.
1328
1329 gitweb.avatar::
1330 gitweb.blame::
1331 gitweb.grep::
1332 gitweb.highlight::
1333 gitweb.patches::
1334 gitweb.pickaxe::
1335 gitweb.remote_heads::
1336 gitweb.showsizes::
1337 gitweb.snapshot::
1338 See linkgit:gitweb.conf[5] for description.
1339
1340 grep.lineNumber::
1341 If set to true, enable '-n' option by default.
1342
1343 grep.patternType::
1344 Set the default matching behavior. Using a value of 'basic', 'extended',
1345 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1346 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1347 value 'default' will return to the default matching behavior.
1348
1349 grep.extendedRegexp::
1350 If set to true, enable '--extended-regexp' option by default. This
1351 option is ignored when the 'grep.patternType' option is set to a value
1352 other than 'default'.
1353
1354 gpg.program::
1355 Use this custom program instead of "gpg" found on $PATH when
1356 making or verifying a PGP signature. The program must support the
1357 same command-line interface as GPG, namely, to verify a detached
1358 signature, "gpg --verify $file - <$signature" is run, and the
1359 program is expected to signal a good signature by exiting with
1360 code 0, and to generate an ASCII-armored detached signature, the
1361 standard input of "gpg -bsau $key" is fed with the contents to be
1362 signed, and the program is expected to send the result to its
1363 standard output.
1364
1365 gui.commitmsgwidth::
1366 Defines how wide the commit message window is in the
1367 linkgit:git-gui[1]. "75" is the default.
1368
1369 gui.diffcontext::
1370 Specifies how many context lines should be used in calls to diff
1371 made by the linkgit:git-gui[1]. The default is "5".
1372
1373 gui.displayuntracked::
1374 Determines if linkgit::git-gui[1] shows untracked files
1375 in the file list. The default is "true".
1376
1377 gui.encoding::
1378 Specifies the default encoding to use for displaying of
1379 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1380 It can be overridden by setting the 'encoding' attribute
1381 for relevant files (see linkgit:gitattributes[5]).
1382 If this option is not set, the tools default to the
1383 locale encoding.
1384
1385 gui.matchtrackingbranch::
1386 Determines if new branches created with linkgit:git-gui[1] should
1387 default to tracking remote branches with matching names or
1388 not. Default: "false".
1389
1390 gui.newbranchtemplate::
1391 Is used as suggested name when creating new branches using the
1392 linkgit:git-gui[1].
1393
1394 gui.pruneduringfetch::
1395 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1396 performing a fetch. The default value is "false".
1397
1398 gui.trustmtime::
1399 Determines if linkgit:git-gui[1] should trust the file modification
1400 timestamp or not. By default the timestamps are not trusted.
1401
1402 gui.spellingdictionary::
1403 Specifies the dictionary used for spell checking commit messages in
1404 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1405 off.
1406
1407 gui.fastcopyblame::
1408 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1409 location detection. It makes blame significantly faster on huge
1410 repositories at the expense of less thorough copy detection.
1411
1412 gui.copyblamethreshold::
1413 Specifies the threshold to use in 'git gui blame' original location
1414 detection, measured in alphanumeric characters. See the
1415 linkgit:git-blame[1] manual for more information on copy detection.
1416
1417 gui.blamehistoryctx::
1418 Specifies the radius of history context in days to show in
1419 linkgit:gitk[1] for the selected commit, when the `Show History
1420 Context` menu item is invoked from 'git gui blame'. If this
1421 variable is set to zero, the whole history is shown.
1422
1423 guitool.<name>.cmd::
1424 Specifies the shell command line to execute when the corresponding item
1425 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1426 mandatory for every tool. The command is executed from the root of
1427 the working directory, and in the environment it receives the name of
1428 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1429 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1430 the head is detached, 'CUR_BRANCH' is empty).
1431
1432 guitool.<name>.needsfile::
1433 Run the tool only if a diff is selected in the GUI. It guarantees
1434 that 'FILENAME' is not empty.
1435
1436 guitool.<name>.noconsole::
1437 Run the command silently, without creating a window to display its
1438 output.
1439
1440 guitool.<name>.norescan::
1441 Don't rescan the working directory for changes after the tool
1442 finishes execution.
1443
1444 guitool.<name>.confirm::
1445 Show a confirmation dialog before actually running the tool.
1446
1447 guitool.<name>.argprompt::
1448 Request a string argument from the user, and pass it to the tool
1449 through the 'ARGS' environment variable. Since requesting an
1450 argument implies confirmation, the 'confirm' option has no effect
1451 if this is enabled. If the option is set to 'true', 'yes', or '1',
1452 the dialog uses a built-in generic prompt; otherwise the exact
1453 value of the variable is used.
1454
1455 guitool.<name>.revprompt::
1456 Request a single valid revision from the user, and set the
1457 'REVISION' environment variable. In other aspects this option
1458 is similar to 'argprompt', and can be used together with it.
1459
1460 guitool.<name>.revunmerged::
1461 Show only unmerged branches in the 'revprompt' subdialog.
1462 This is useful for tools similar to merge or rebase, but not
1463 for things like checkout or reset.
1464
1465 guitool.<name>.title::
1466 Specifies the title to use for the prompt dialog. The default
1467 is the tool name.
1468
1469 guitool.<name>.prompt::
1470 Specifies the general prompt string to display at the top of
1471 the dialog, before subsections for 'argprompt' and 'revprompt'.
1472 The default value includes the actual command.
1473
1474 help.browser::
1475 Specify the browser that will be used to display help in the
1476 'web' format. See linkgit:git-help[1].
1477
1478 help.format::
1479 Override the default help format used by linkgit:git-help[1].
1480 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1481 the default. 'web' and 'html' are the same.
1482
1483 help.autocorrect::
1484 Automatically correct and execute mistyped commands after
1485 waiting for the given number of deciseconds (0.1 sec). If more
1486 than one command can be deduced from the entered text, nothing
1487 will be executed. If the value of this option is negative,
1488 the corrected command will be executed immediately. If the
1489 value is 0 - the command will be just shown but not executed.
1490 This is the default.
1491
1492 help.htmlpath::
1493 Specify the path where the HTML documentation resides. File system paths
1494 and URLs are supported. HTML pages will be prefixed with this path when
1495 help is displayed in the 'web' format. This defaults to the documentation
1496 path of your Git installation.
1497
1498 http.proxy::
1499 Override the HTTP proxy, normally configured using the 'http_proxy',
1500 'https_proxy', and 'all_proxy' environment variables (see
1501 `curl(1)`). This can be overridden on a per-remote basis; see
1502 remote.<name>.proxy
1503
1504 http.cookiefile::
1505 File containing previously stored cookie lines which should be used
1506 in the Git http session, if they match the server. The file format
1507 of the file to read cookies from should be plain HTTP headers or
1508 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1509 NOTE that the file specified with http.cookiefile is only used as
1510 input unless http.saveCookies is set.
1511
1512 http.savecookies::
1513 If set, store cookies received during requests to the file specified by
1514 http.cookiefile. Has no effect if http.cookiefile is unset.
1515
1516 http.sslVerify::
1517 Whether to verify the SSL certificate when fetching or pushing
1518 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1519 variable.
1520
1521 http.sslCert::
1522 File containing the SSL certificate when fetching or pushing
1523 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1524 variable.
1525
1526 http.sslKey::
1527 File containing the SSL private key when fetching or pushing
1528 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1529 variable.
1530
1531 http.sslCertPasswordProtected::
1532 Enable Git's password prompt for the SSL certificate. Otherwise
1533 OpenSSL will prompt the user, possibly many times, if the
1534 certificate or private key is encrypted. Can be overridden by the
1535 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1536
1537 http.sslCAInfo::
1538 File containing the certificates to verify the peer with when
1539 fetching or pushing over HTTPS. Can be overridden by the
1540 'GIT_SSL_CAINFO' environment variable.
1541
1542 http.sslCAPath::
1543 Path containing files with the CA certificates to verify the peer
1544 with when fetching or pushing over HTTPS. Can be overridden
1545 by the 'GIT_SSL_CAPATH' environment variable.
1546
1547 http.sslTry::
1548 Attempt to use AUTH SSL/TLS and encrypted data transfers
1549 when connecting via regular FTP protocol. This might be needed
1550 if the FTP server requires it for security reasons or you wish
1551 to connect securely whenever remote FTP server supports it.
1552 Default is false since it might trigger certificate verification
1553 errors on misconfigured servers.
1554
1555 http.maxRequests::
1556 How many HTTP requests to launch in parallel. Can be overridden
1557 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1558
1559 http.minSessions::
1560 The number of curl sessions (counted across slots) to be kept across
1561 requests. They will not be ended with curl_easy_cleanup() until
1562 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1563 value will be capped at 1. Defaults to 1.
1564
1565 http.postBuffer::
1566 Maximum size in bytes of the buffer used by smart HTTP
1567 transports when POSTing data to the remote system.
1568 For requests larger than this buffer size, HTTP/1.1 and
1569 Transfer-Encoding: chunked is used to avoid creating a
1570 massive pack file locally. Default is 1 MiB, which is
1571 sufficient for most requests.
1572
1573 http.lowSpeedLimit, http.lowSpeedTime::
1574 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1575 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1576 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1577 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1578
1579 http.noEPSV::
1580 A boolean which disables using of EPSV ftp command by curl.
1581 This can helpful with some "poor" ftp servers which don't
1582 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1583 environment variable. Default is false (curl will use EPSV).
1584
1585 http.useragent::
1586 The HTTP USER_AGENT string presented to an HTTP server. The default
1587 value represents the version of the client Git such as git/1.7.1.
1588 This option allows you to override this value to a more common value
1589 such as Mozilla/4.0. This may be necessary, for instance, if
1590 connecting through a firewall that restricts HTTP connections to a set
1591 of common USER_AGENT strings (but not including those like git/1.7.1).
1592 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1593
1594 http.<url>.*::
1595 Any of the http.* options above can be applied selectively to some URLs.
1596 For a config key to match a URL, each element of the config key is
1597 compared to that of the URL, in the following order:
1598 +
1599 --
1600 . Scheme (e.g., `https` in `https://example.com/`). This field
1601 must match exactly between the config key and the URL.
1602
1603 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1604 This field must match exactly between the config key and the URL.
1605
1606 . Port number (e.g., `8080` in `http://example.com:8080/`).
1607 This field must match exactly between the config key and the URL.
1608 Omitted port numbers are automatically converted to the correct
1609 default for the scheme before matching.
1610
1611 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1612 path field of the config key must match the path field of the URL
1613 either exactly or as a prefix of slash-delimited path elements. This means
1614 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1615 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1616 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1617 key with just path `foo/`).
1618
1619 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1620 the config key has a user name it must match the user name in the
1621 URL exactly. If the config key does not have a user name, that
1622 config key will match a URL with any user name (including none),
1623 but at a lower precedence than a config key with a user name.
1624 --
1625 +
1626 The list above is ordered by decreasing precedence; a URL that matches
1627 a config key's path is preferred to one that matches its user name. For example,
1628 if the URL is `https://user@example.com/foo/bar` a config key match of
1629 `https://example.com/foo` will be preferred over a config key match of
1630 `https://user@example.com`.
1631 +
1632 All URLs are normalized before attempting any matching (the password part,
1633 if embedded in the URL, is always ignored for matching purposes) so that
1634 equivalent URLs that are simply spelled differently will match properly.
1635 Environment variable settings always override any matches. The URLs that are
1636 matched against are those given directly to Git commands. This means any URLs
1637 visited as a result of a redirection do not participate in matching.
1638
1639 i18n.commitEncoding::
1640 Character encoding the commit messages are stored in; Git itself
1641 does not care per se, but this information is necessary e.g. when
1642 importing commits from emails or in the gitk graphical history
1643 browser (and possibly at other places in the future or in other
1644 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1645
1646 i18n.logOutputEncoding::
1647 Character encoding the commit messages are converted to when
1648 running 'git log' and friends.
1649
1650 imap::
1651 The configuration variables in the 'imap' section are described
1652 in linkgit:git-imap-send[1].
1653
1654 index.version::
1655 Specify the version with which new index files should be
1656 initialized. This does not affect existing repositories.
1657
1658 init.templatedir::
1659 Specify the directory from which templates will be copied.
1660 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1661
1662 instaweb.browser::
1663 Specify the program that will be used to browse your working
1664 repository in gitweb. See linkgit:git-instaweb[1].
1665
1666 instaweb.httpd::
1667 The HTTP daemon command-line to start gitweb on your working
1668 repository. See linkgit:git-instaweb[1].
1669
1670 instaweb.local::
1671 If true the web server started by linkgit:git-instaweb[1] will
1672 be bound to the local IP (127.0.0.1).
1673
1674 instaweb.modulepath::
1675 The default module path for linkgit:git-instaweb[1] to use
1676 instead of /usr/lib/apache2/modules. Only used if httpd
1677 is Apache.
1678
1679 instaweb.port::
1680 The port number to bind the gitweb httpd to. See
1681 linkgit:git-instaweb[1].
1682
1683 interactive.singlekey::
1684 In interactive commands, allow the user to provide one-letter
1685 input with a single key (i.e., without hitting enter).
1686 Currently this is used by the `--patch` mode of
1687 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1688 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1689 setting is silently ignored if portable keystroke input
1690 is not available; requires the Perl module Term::ReadKey.
1691
1692 log.abbrevCommit::
1693 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1694 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1695 override this option with `--no-abbrev-commit`.
1696
1697 log.date::
1698 Set the default date-time mode for the 'log' command.
1699 Setting a value for log.date is similar to using 'git log''s
1700 `--date` option. Possible values are `relative`, `local`,
1701 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1702 for details.
1703
1704 log.decorate::
1705 Print out the ref names of any commits that are shown by the log
1706 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1707 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1708 specified, the full ref name (including prefix) will be printed.
1709 This is the same as the log commands '--decorate' option.
1710
1711 log.showroot::
1712 If true, the initial commit will be shown as a big creation event.
1713 This is equivalent to a diff against an empty tree.
1714 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1715 normally hide the root commit will now show it. True by default.
1716
1717 log.mailmap::
1718 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1719 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1720
1721 mailmap.file::
1722 The location of an augmenting mailmap file. The default
1723 mailmap, located in the root of the repository, is loaded
1724 first, then the mailmap file pointed to by this variable.
1725 The location of the mailmap file may be in a repository
1726 subdirectory, or somewhere outside of the repository itself.
1727 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1728
1729 mailmap.blob::
1730 Like `mailmap.file`, but consider the value as a reference to a
1731 blob in the repository. If both `mailmap.file` and
1732 `mailmap.blob` are given, both are parsed, with entries from
1733 `mailmap.file` taking precedence. In a bare repository, this
1734 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1735 defaults to empty.
1736
1737 man.viewer::
1738 Specify the programs that may be used to display help in the
1739 'man' format. See linkgit:git-help[1].
1740
1741 man.<tool>.cmd::
1742 Specify the command to invoke the specified man viewer. The
1743 specified command is evaluated in shell with the man page
1744 passed as argument. (See linkgit:git-help[1].)
1745
1746 man.<tool>.path::
1747 Override the path for the given tool that may be used to
1748 display help in the 'man' format. See linkgit:git-help[1].
1749
1750 include::merge-config.txt[]
1751
1752 mergetool.<tool>.path::
1753 Override the path for the given tool. This is useful in case
1754 your tool is not in the PATH.
1755
1756 mergetool.<tool>.cmd::
1757 Specify the command to invoke the specified merge tool. The
1758 specified command is evaluated in shell with the following
1759 variables available: 'BASE' is the name of a temporary file
1760 containing the common base of the files to be merged, if available;
1761 'LOCAL' is the name of a temporary file containing the contents of
1762 the file on the current branch; 'REMOTE' is the name of a temporary
1763 file containing the contents of the file from the branch being
1764 merged; 'MERGED' contains the name of the file to which the merge
1765 tool should write the results of a successful merge.
1766
1767 mergetool.<tool>.trustExitCode::
1768 For a custom merge command, specify whether the exit code of
1769 the merge command can be used to determine whether the merge was
1770 successful. If this is not set to true then the merge target file
1771 timestamp is checked and the merge assumed to have been successful
1772 if the file has been updated, otherwise the user is prompted to
1773 indicate the success of the merge.
1774
1775 mergetool.meld.hasOutput::
1776 Older versions of `meld` do not support the `--output` option.
1777 Git will attempt to detect whether `meld` supports `--output`
1778 by inspecting the output of `meld --help`. Configuring
1779 `mergetool.meld.hasOutput` will make Git skip these checks and
1780 use the configured value instead. Setting `mergetool.meld.hasOutput`
1781 to `true` tells Git to unconditionally use the `--output` option,
1782 and `false` avoids using `--output`.
1783
1784 mergetool.keepBackup::
1785 After performing a merge, the original file with conflict markers
1786 can be saved as a file with a `.orig` extension. If this variable
1787 is set to `false` then this file is not preserved. Defaults to
1788 `true` (i.e. keep the backup files).
1789
1790 mergetool.keepTemporaries::
1791 When invoking a custom merge tool, Git uses a set of temporary
1792 files to pass to the tool. If the tool returns an error and this
1793 variable is set to `true`, then these temporary files will be
1794 preserved, otherwise they will be removed after the tool has
1795 exited. Defaults to `false`.
1796
1797 mergetool.writeToTemp::
1798 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1799 conflicting files in the worktree by default. Git will attempt
1800 to use a temporary directory for these files when set `true`.
1801 Defaults to `false`.
1802
1803 mergetool.prompt::
1804 Prompt before each invocation of the merge resolution program.
1805
1806 notes.displayRef::
1807 The (fully qualified) refname from which to show notes when
1808 showing commit messages. The value of this variable can be set
1809 to a glob, in which case notes from all matching refs will be
1810 shown. You may also specify this configuration variable
1811 several times. A warning will be issued for refs that do not
1812 exist, but a glob that does not match any refs is silently
1813 ignored.
1814 +
1815 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1816 environment variable, which must be a colon separated list of refs or
1817 globs.
1818 +
1819 The effective value of "core.notesRef" (possibly overridden by
1820 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1821 displayed.
1822
1823 notes.rewrite.<command>::
1824 When rewriting commits with <command> (currently `amend` or
1825 `rebase`) and this variable is set to `true`, Git
1826 automatically copies your notes from the original to the
1827 rewritten commit. Defaults to `true`, but see
1828 "notes.rewriteRef" below.
1829
1830 notes.rewriteMode::
1831 When copying notes during a rewrite (see the
1832 "notes.rewrite.<command>" option), determines what to do if
1833 the target commit already has a note. Must be one of
1834 `overwrite`, `concatenate`, or `ignore`. Defaults to
1835 `concatenate`.
1836 +
1837 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1838 environment variable.
1839
1840 notes.rewriteRef::
1841 When copying notes during a rewrite, specifies the (fully
1842 qualified) ref whose notes should be copied. The ref may be a
1843 glob, in which case notes in all matching refs will be copied.
1844 You may also specify this configuration several times.
1845 +
1846 Does not have a default value; you must configure this variable to
1847 enable note rewriting. Set it to `refs/notes/commits` to enable
1848 rewriting for the default commit notes.
1849 +
1850 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1851 environment variable, which must be a colon separated list of refs or
1852 globs.
1853
1854 pack.window::
1855 The size of the window used by linkgit:git-pack-objects[1] when no
1856 window size is given on the command line. Defaults to 10.
1857
1858 pack.depth::
1859 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1860 maximum depth is given on the command line. Defaults to 50.
1861
1862 pack.windowMemory::
1863 The maximum size of memory that is consumed by each thread
1864 in linkgit:git-pack-objects[1] for pack window memory when
1865 no limit is given on the command line. The value can be
1866 suffixed with "k", "m", or "g". When left unconfigured (or
1867 set explicitly to 0), there will be no limit.
1868
1869 pack.compression::
1870 An integer -1..9, indicating the compression level for objects
1871 in a pack file. -1 is the zlib default. 0 means no
1872 compression, and 1..9 are various speed/size tradeoffs, 9 being
1873 slowest. If not set, defaults to core.compression. If that is
1874 not set, defaults to -1, the zlib default, which is "a default
1875 compromise between speed and compression (currently equivalent
1876 to level 6)."
1877 +
1878 Note that changing the compression level will not automatically recompress
1879 all existing objects. You can force recompression by passing the -F option
1880 to linkgit:git-repack[1].
1881
1882 pack.deltaCacheSize::
1883 The maximum memory in bytes used for caching deltas in
1884 linkgit:git-pack-objects[1] before writing them out to a pack.
1885 This cache is used to speed up the writing object phase by not
1886 having to recompute the final delta result once the best match
1887 for all objects is found. Repacking large repositories on machines
1888 which are tight with memory might be badly impacted by this though,
1889 especially if this cache pushes the system into swapping.
1890 A value of 0 means no limit. The smallest size of 1 byte may be
1891 used to virtually disable this cache. Defaults to 256 MiB.
1892
1893 pack.deltaCacheLimit::
1894 The maximum size of a delta, that is cached in
1895 linkgit:git-pack-objects[1]. This cache is used to speed up the
1896 writing object phase by not having to recompute the final delta
1897 result once the best match for all objects is found. Defaults to 1000.
1898
1899 pack.threads::
1900 Specifies the number of threads to spawn when searching for best
1901 delta matches. This requires that linkgit:git-pack-objects[1]
1902 be compiled with pthreads otherwise this option is ignored with a
1903 warning. This is meant to reduce packing time on multiprocessor
1904 machines. The required amount of memory for the delta search window
1905 is however multiplied by the number of threads.
1906 Specifying 0 will cause Git to auto-detect the number of CPU's
1907 and set the number of threads accordingly.
1908
1909 pack.indexVersion::
1910 Specify the default pack index version. Valid values are 1 for
1911 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1912 the new pack index with capabilities for packs larger than 4 GB
1913 as well as proper protection against the repacking of corrupted
1914 packs. Version 2 is the default. Note that version 2 is enforced
1915 and this config option ignored whenever the corresponding pack is
1916 larger than 2 GB.
1917 +
1918 If you have an old Git that does not understand the version 2 `*.idx` file,
1919 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1920 that will copy both `*.pack` file and corresponding `*.idx` file from the
1921 other side may give you a repository that cannot be accessed with your
1922 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1923 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1924 the `*.idx` file.
1925
1926 pack.packSizeLimit::
1927 The maximum size of a pack. This setting only affects
1928 packing to a file when repacking, i.e. the git:// protocol
1929 is unaffected. It can be overridden by the `--max-pack-size`
1930 option of linkgit:git-repack[1]. The minimum size allowed is
1931 limited to 1 MiB. The default is unlimited.
1932 Common unit suffixes of 'k', 'm', or 'g' are
1933 supported.
1934
1935 pack.useBitmaps::
1936 When true, git will use pack bitmaps (if available) when packing
1937 to stdout (e.g., during the server side of a fetch). Defaults to
1938 true. You should not generally need to turn this off unless
1939 you are debugging pack bitmaps.
1940
1941 pack.writebitmaps::
1942 This is a deprecated synonym for `repack.writeBitmaps`.
1943
1944 pack.writeBitmapHashCache::
1945 When true, git will include a "hash cache" section in the bitmap
1946 index (if one is written). This cache can be used to feed git's
1947 delta heuristics, potentially leading to better deltas between
1948 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1949 between an older, bitmapped pack and objects that have been
1950 pushed since the last gc). The downside is that it consumes 4
1951 bytes per object of disk space, and that JGit's bitmap
1952 implementation does not understand it, causing it to complain if
1953 Git and JGit are used on the same repository. Defaults to false.
1954
1955 pager.<cmd>::
1956 If the value is boolean, turns on or off pagination of the
1957 output of a particular Git subcommand when writing to a tty.
1958 Otherwise, turns on pagination for the subcommand using the
1959 pager specified by the value of `pager.<cmd>`. If `--paginate`
1960 or `--no-pager` is specified on the command line, it takes
1961 precedence over this option. To disable pagination for all
1962 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1963
1964 pretty.<name>::
1965 Alias for a --pretty= format string, as specified in
1966 linkgit:git-log[1]. Any aliases defined here can be used just
1967 as the built-in pretty formats could. For example,
1968 running `git config pretty.changelog "format:* %H %s"`
1969 would cause the invocation `git log --pretty=changelog`
1970 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1971 Note that an alias with the same name as a built-in format
1972 will be silently ignored.
1973
1974 pull.ff::
1975 By default, Git does not create an extra merge commit when merging
1976 a commit that is a descendant of the current commit. Instead, the
1977 tip of the current branch is fast-forwarded. When set to `false`,
1978 this variable tells Git to create an extra merge commit in such
1979 a case (equivalent to giving the `--no-ff` option from the command
1980 line). When set to `only`, only such fast-forward merges are
1981 allowed (equivalent to giving the `--ff-only` option from the
1982 command line).
1983
1984 pull.rebase::
1985 When true, rebase branches on top of the fetched branch, instead
1986 of merging the default branch from the default remote when "git
1987 pull" is run. See "branch.<name>.rebase" for setting this on a
1988 per-branch basis.
1989 +
1990 When preserve, also pass `--preserve-merges` along to 'git rebase'
1991 so that locally committed merge commits will not be flattened
1992 by running 'git pull'.
1993 +
1994 *NOTE*: this is a possibly dangerous operation; do *not* use
1995 it unless you understand the implications (see linkgit:git-rebase[1]
1996 for details).
1997
1998 pull.octopus::
1999 The default merge strategy to use when pulling multiple branches
2000 at once.
2001
2002 pull.twohead::
2003 The default merge strategy to use when pulling a single branch.
2004
2005 push.default::
2006 Defines the action `git push` should take if no refspec is
2007 explicitly given. Different values are well-suited for
2008 specific workflows; for instance, in a purely central workflow
2009 (i.e. the fetch source is equal to the push destination),
2010 `upstream` is probably what you want. Possible values are:
2011 +
2012 --
2013
2014 * `nothing` - do not push anything (error out) unless a refspec is
2015 explicitly given. This is primarily meant for people who want to
2016 avoid mistakes by always being explicit.
2017
2018 * `current` - push the current branch to update a branch with the same
2019 name on the receiving end. Works in both central and non-central
2020 workflows.
2021
2022 * `upstream` - push the current branch back to the branch whose
2023 changes are usually integrated into the current branch (which is
2024 called `@{upstream}`). This mode only makes sense if you are
2025 pushing to the same repository you would normally pull from
2026 (i.e. central workflow).
2027
2028 * `simple` - in centralized workflow, work like `upstream` with an
2029 added safety to refuse to push if the upstream branch's name is
2030 different from the local one.
2031 +
2032 When pushing to a remote that is different from the remote you normally
2033 pull from, work as `current`. This is the safest option and is suited
2034 for beginners.
2035 +
2036 This mode has become the default in Git 2.0.
2037
2038 * `matching` - push all branches having the same name on both ends.
2039 This makes the repository you are pushing to remember the set of
2040 branches that will be pushed out (e.g. if you always push 'maint'
2041 and 'master' there and no other branches, the repository you push
2042 to will have these two branches, and your local 'maint' and
2043 'master' will be pushed there).
2044 +
2045 To use this mode effectively, you have to make sure _all_ the
2046 branches you would push out are ready to be pushed out before
2047 running 'git push', as the whole point of this mode is to allow you
2048 to push all of the branches in one go. If you usually finish work
2049 on only one branch and push out the result, while other branches are
2050 unfinished, this mode is not for you. Also this mode is not
2051 suitable for pushing into a shared central repository, as other
2052 people may add new branches there, or update the tip of existing
2053 branches outside your control.
2054 +
2055 This used to be the default, but not since Git 2.0 (`simple` is the
2056 new default).
2057
2058 --
2059
2060 rebase.stat::
2061 Whether to show a diffstat of what changed upstream since the last
2062 rebase. False by default.
2063
2064 rebase.autosquash::
2065 If set to true enable '--autosquash' option by default.
2066
2067 rebase.autostash::
2068 When set to true, automatically create a temporary stash
2069 before the operation begins, and apply it after the operation
2070 ends. This means that you can run rebase on a dirty worktree.
2071 However, use with care: the final stash application after a
2072 successful rebase might result in non-trivial conflicts.
2073 Defaults to false.
2074
2075 receive.autogc::
2076 By default, git-receive-pack will run "git-gc --auto" after
2077 receiving data from git-push and updating refs. You can stop
2078 it by setting this variable to false.
2079
2080 receive.certnonceseed::
2081 By setting this variable to a string, `git receive-pack`
2082 will accept a `git push --signed` and verifies it by using
2083 a "nonce" protected by HMAC using this string as a secret
2084 key.
2085
2086 receive.certnonceslop::
2087 When a `git push --signed` sent a push certificate with a
2088 "nonce" that was issued by a receive-pack serving the same
2089 repository within this many seconds, export the "nonce"
2090 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2091 hooks (instead of what the receive-pack asked the sending
2092 side to include). This may allow writing checks in
2093 `pre-receive` and `post-receive` a bit easier. Instead of
2094 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2095 that records by how many seconds the nonce is stale to
2096 decide if they want to accept the certificate, they only
2097 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2098
2099 receive.fsckObjects::
2100 If it is set to true, git-receive-pack will check all received
2101 objects. It will abort in the case of a malformed object or a
2102 broken link. The result of an abort are only dangling objects.
2103 Defaults to false. If not set, the value of `transfer.fsckObjects`
2104 is used instead.
2105
2106 receive.unpackLimit::
2107 If the number of objects received in a push is below this
2108 limit then the objects will be unpacked into loose object
2109 files. However if the number of received objects equals or
2110 exceeds this limit then the received pack will be stored as
2111 a pack, after adding any missing delta bases. Storing the
2112 pack from a push can make the push operation complete faster,
2113 especially on slow filesystems. If not set, the value of
2114 `transfer.unpackLimit` is used instead.
2115
2116 receive.denyDeletes::
2117 If set to true, git-receive-pack will deny a ref update that deletes
2118 the ref. Use this to prevent such a ref deletion via a push.
2119
2120 receive.denyDeleteCurrent::
2121 If set to true, git-receive-pack will deny a ref update that
2122 deletes the currently checked out branch of a non-bare repository.
2123
2124 receive.denyCurrentBranch::
2125 If set to true or "refuse", git-receive-pack will deny a ref update
2126 to the currently checked out branch of a non-bare repository.
2127 Such a push is potentially dangerous because it brings the HEAD
2128 out of sync with the index and working tree. If set to "warn",
2129 print a warning of such a push to stderr, but allow the push to
2130 proceed. If set to false or "ignore", allow such pushes with no
2131 message. Defaults to "refuse".
2132
2133 receive.denyNonFastForwards::
2134 If set to true, git-receive-pack will deny a ref update which is
2135 not a fast-forward. Use this to prevent such an update via a push,
2136 even if that push is forced. This configuration variable is
2137 set when initializing a shared repository.
2138
2139 receive.hiderefs::
2140 String(s) `receive-pack` uses to decide which refs to omit
2141 from its initial advertisement. Use more than one
2142 definitions to specify multiple prefix strings. A ref that
2143 are under the hierarchies listed on the value of this
2144 variable is excluded, and is hidden when responding to `git
2145 push`, and an attempt to update or delete a hidden ref by
2146 `git push` is rejected.
2147
2148 receive.updateserverinfo::
2149 If set to true, git-receive-pack will run git-update-server-info
2150 after receiving data from git-push and updating refs.
2151
2152 receive.shallowupdate::
2153 If set to true, .git/shallow can be updated when new refs
2154 require new shallow roots. Otherwise those refs are rejected.
2155
2156 remote.pushdefault::
2157 The remote to push to by default. Overrides
2158 `branch.<name>.remote` for all branches, and is overridden by
2159 `branch.<name>.pushremote` for specific branches.
2160
2161 remote.<name>.url::
2162 The URL of a remote repository. See linkgit:git-fetch[1] or
2163 linkgit:git-push[1].
2164
2165 remote.<name>.pushurl::
2166 The push URL of a remote repository. See linkgit:git-push[1].
2167
2168 remote.<name>.proxy::
2169 For remotes that require curl (http, https and ftp), the URL to
2170 the proxy to use for that remote. Set to the empty string to
2171 disable proxying for that remote.
2172
2173 remote.<name>.fetch::
2174 The default set of "refspec" for linkgit:git-fetch[1]. See
2175 linkgit:git-fetch[1].
2176
2177 remote.<name>.push::
2178 The default set of "refspec" for linkgit:git-push[1]. See
2179 linkgit:git-push[1].
2180
2181 remote.<name>.mirror::
2182 If true, pushing to this remote will automatically behave
2183 as if the `--mirror` option was given on the command line.
2184
2185 remote.<name>.skipDefaultUpdate::
2186 If true, this remote will be skipped by default when updating
2187 using linkgit:git-fetch[1] or the `update` subcommand of
2188 linkgit:git-remote[1].
2189
2190 remote.<name>.skipFetchAll::
2191 If true, this remote will be skipped by default when updating
2192 using linkgit:git-fetch[1] or the `update` subcommand of
2193 linkgit:git-remote[1].
2194
2195 remote.<name>.receivepack::
2196 The default program to execute on the remote side when pushing. See
2197 option \--receive-pack of linkgit:git-push[1].
2198
2199 remote.<name>.uploadpack::
2200 The default program to execute on the remote side when fetching. See
2201 option \--upload-pack of linkgit:git-fetch-pack[1].
2202
2203 remote.<name>.tagopt::
2204 Setting this value to \--no-tags disables automatic tag following when
2205 fetching from remote <name>. Setting it to \--tags will fetch every
2206 tag from remote <name>, even if they are not reachable from remote
2207 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2208 override this setting. See options \--tags and \--no-tags of
2209 linkgit:git-fetch[1].
2210
2211 remote.<name>.vcs::
2212 Setting this to a value <vcs> will cause Git to interact with
2213 the remote with the git-remote-<vcs> helper.
2214
2215 remote.<name>.prune::
2216 When set to true, fetching from this remote by default will also
2217 remove any remote-tracking references that no longer exist on the
2218 remote (as if the `--prune` option was given on the command line).
2219 Overrides `fetch.prune` settings, if any.
2220
2221 remotes.<group>::
2222 The list of remotes which are fetched by "git remote update
2223 <group>". See linkgit:git-remote[1].
2224
2225 repack.usedeltabaseoffset::
2226 By default, linkgit:git-repack[1] creates packs that use
2227 delta-base offset. If you need to share your repository with
2228 Git older than version 1.4.4, either directly or via a dumb
2229 protocol such as http, then you need to set this option to
2230 "false" and repack. Access from old Git versions over the
2231 native protocol are unaffected by this option.
2232
2233 repack.packKeptObjects::
2234 If set to true, makes `git repack` act as if
2235 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2236 details. Defaults to `false` normally, but `true` if a bitmap
2237 index is being written (either via `--write-bitmap-index` or
2238 `repack.writeBitmaps`).
2239
2240 repack.writeBitmaps::
2241 When true, git will write a bitmap index when packing all
2242 objects to disk (e.g., when `git repack -a` is run). This
2243 index can speed up the "counting objects" phase of subsequent
2244 packs created for clones and fetches, at the cost of some disk
2245 space and extra time spent on the initial repack. Defaults to
2246 false.
2247
2248 rerere.autoupdate::
2249 When set to true, `git-rerere` updates the index with the
2250 resulting contents after it cleanly resolves conflicts using
2251 previously recorded resolution. Defaults to false.
2252
2253 rerere.enabled::
2254 Activate recording of resolved conflicts, so that identical
2255 conflict hunks can be resolved automatically, should they be
2256 encountered again. By default, linkgit:git-rerere[1] is
2257 enabled if there is an `rr-cache` directory under the
2258 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2259 repository.
2260
2261 sendemail.identity::
2262 A configuration identity. When given, causes values in the
2263 'sendemail.<identity>' subsection to take precedence over
2264 values in the 'sendemail' section. The default identity is
2265 the value of 'sendemail.identity'.
2266
2267 sendemail.smtpencryption::
2268 See linkgit:git-send-email[1] for description. Note that this
2269 setting is not subject to the 'identity' mechanism.
2270
2271 sendemail.smtpssl::
2272 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2273
2274 sendemail.smtpsslcertpath::
2275 Path to ca-certificates (either a directory or a single file).
2276 Set it to an empty string to disable certificate verification.
2277
2278 sendemail.<identity>.*::
2279 Identity-specific versions of the 'sendemail.*' parameters
2280 found below, taking precedence over those when the this
2281 identity is selected, through command-line or
2282 'sendemail.identity'.
2283
2284 sendemail.aliasesfile::
2285 sendemail.aliasfiletype::
2286 sendemail.annotate::
2287 sendemail.bcc::
2288 sendemail.cc::
2289 sendemail.cccmd::
2290 sendemail.chainreplyto::
2291 sendemail.confirm::
2292 sendemail.envelopesender::
2293 sendemail.from::
2294 sendemail.multiedit::
2295 sendemail.signedoffbycc::
2296 sendemail.smtppass::
2297 sendemail.suppresscc::
2298 sendemail.suppressfrom::
2299 sendemail.to::
2300 sendemail.smtpdomain::
2301 sendemail.smtpserver::
2302 sendemail.smtpserverport::
2303 sendemail.smtpserveroption::
2304 sendemail.smtpuser::
2305 sendemail.thread::
2306 sendemail.validate::
2307 See linkgit:git-send-email[1] for description.
2308
2309 sendemail.signedoffcc::
2310 Deprecated alias for 'sendemail.signedoffbycc'.
2311
2312 showbranch.default::
2313 The default set of branches for linkgit:git-show-branch[1].
2314 See linkgit:git-show-branch[1].
2315
2316 status.relativePaths::
2317 By default, linkgit:git-status[1] shows paths relative to the
2318 current directory. Setting this variable to `false` shows paths
2319 relative to the repository root (this was the default for Git
2320 prior to v1.5.4).
2321
2322 status.short::
2323 Set to true to enable --short by default in linkgit:git-status[1].
2324 The option --no-short takes precedence over this variable.
2325
2326 status.branch::
2327 Set to true to enable --branch by default in linkgit:git-status[1].
2328 The option --no-branch takes precedence over this variable.
2329
2330 status.displayCommentPrefix::
2331 If set to true, linkgit:git-status[1] will insert a comment
2332 prefix before each output line (starting with
2333 `core.commentChar`, i.e. `#` by default). This was the
2334 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2335 Defaults to false.
2336
2337 status.showUntrackedFiles::
2338 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2339 files which are not currently tracked by Git. Directories which
2340 contain only untracked files, are shown with the directory name
2341 only. Showing untracked files means that Git needs to lstat() all
2342 the files in the whole repository, which might be slow on some
2343 systems. So, this variable controls how the commands displays
2344 the untracked files. Possible values are:
2345 +
2346 --
2347 * `no` - Show no untracked files.
2348 * `normal` - Show untracked files and directories.
2349 * `all` - Show also individual files in untracked directories.
2350 --
2351 +
2352 If this variable is not specified, it defaults to 'normal'.
2353 This variable can be overridden with the -u|--untracked-files option
2354 of linkgit:git-status[1] and linkgit:git-commit[1].
2355
2356 status.submodulesummary::
2357 Defaults to false.
2358 If this is set to a non zero number or true (identical to -1 or an
2359 unlimited number), the submodule summary will be enabled and a
2360 summary of commits for modified submodules will be shown (see
2361 --summary-limit option of linkgit:git-submodule[1]). Please note
2362 that the summary output command will be suppressed for all
2363 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2364 for those submodules where `submodule.<name>.ignore=all`. The only
2365 exception to that rule is that status and commit will show staged
2366 submodule changes. To
2367 also view the summary for ignored submodules you can either use
2368 the --ignore-submodules=dirty command-line option or the 'git
2369 submodule summary' command, which shows a similar output but does
2370 not honor these settings.
2371
2372 submodule.<name>.path::
2373 submodule.<name>.url::
2374 submodule.<name>.update::
2375 The path within this project, URL, and the updating strategy
2376 for a submodule. These variables are initially populated
2377 by 'git submodule init'; edit them to override the
2378 URL and other values found in the `.gitmodules` file. See
2379 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2380
2381 submodule.<name>.branch::
2382 The remote branch name for a submodule, used by `git submodule
2383 update --remote`. Set this option to override the value found in
2384 the `.gitmodules` file. See linkgit:git-submodule[1] and
2385 linkgit:gitmodules[5] for details.
2386
2387 submodule.<name>.fetchRecurseSubmodules::
2388 This option can be used to control recursive fetching of this
2389 submodule. It can be overridden by using the --[no-]recurse-submodules
2390 command-line option to "git fetch" and "git pull".
2391 This setting will override that from in the linkgit:gitmodules[5]
2392 file.
2393
2394 submodule.<name>.ignore::
2395 Defines under what circumstances "git status" and the diff family show
2396 a submodule as modified. When set to "all", it will never be considered
2397 modified (but it will nonetheless show up in the output of status and
2398 commit when it has been staged), "dirty" will ignore all changes
2399 to the submodules work tree and
2400 takes only differences between the HEAD of the submodule and the commit
2401 recorded in the superproject into account. "untracked" will additionally
2402 let submodules with modified tracked files in their work tree show up.
2403 Using "none" (the default when this option is not set) also shows
2404 submodules that have untracked files in their work tree as changed.
2405 This setting overrides any setting made in .gitmodules for this submodule,
2406 both settings can be overridden on the command line by using the
2407 "--ignore-submodules" option. The 'git submodule' commands are not
2408 affected by this setting.
2409
2410 tag.sort::
2411 This variable controls the sort ordering of tags when displayed by
2412 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2413 value of this variable will be used as the default.
2414
2415 tar.umask::
2416 This variable can be used to restrict the permission bits of
2417 tar archive entries. The default is 0002, which turns off the
2418 world write bit. The special value "user" indicates that the
2419 archiving user's umask will be used instead. See umask(2) and
2420 linkgit:git-archive[1].
2421
2422 transfer.fsckObjects::
2423 When `fetch.fsckObjects` or `receive.fsckObjects` are
2424 not set, the value of this variable is used instead.
2425 Defaults to false.
2426
2427 transfer.hiderefs::
2428 This variable can be used to set both `receive.hiderefs`
2429 and `uploadpack.hiderefs` at the same time to the same
2430 values. See entries for these other variables.
2431
2432 transfer.unpackLimit::
2433 When `fetch.unpackLimit` or `receive.unpackLimit` are
2434 not set, the value of this variable is used instead.
2435 The default value is 100.
2436
2437 uploadarchive.allowUnreachable::
2438 If true, allow clients to use `git archive --remote` to request
2439 any tree, whether reachable from the ref tips or not. See the
2440 discussion in the `SECURITY` section of
2441 linkgit:git-upload-archive[1] for more details. Defaults to
2442 `false`.
2443
2444 uploadpack.hiderefs::
2445 String(s) `upload-pack` uses to decide which refs to omit
2446 from its initial advertisement. Use more than one
2447 definitions to specify multiple prefix strings. A ref that
2448 are under the hierarchies listed on the value of this
2449 variable is excluded, and is hidden from `git ls-remote`,
2450 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2451 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2452
2453 uploadpack.allowtipsha1inwant::
2454 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2455 to accept a fetch request that asks for an object at the tip
2456 of a hidden ref (by default, such a request is rejected).
2457 see also `uploadpack.hiderefs`.
2458
2459 uploadpack.keepalive::
2460 When `upload-pack` has started `pack-objects`, there may be a
2461 quiet period while `pack-objects` prepares the pack. Normally
2462 it would output progress information, but if `--quiet` was used
2463 for the fetch, `pack-objects` will output nothing at all until
2464 the pack data begins. Some clients and networks may consider
2465 the server to be hung and give up. Setting this option instructs
2466 `upload-pack` to send an empty keepalive packet every
2467 `uploadpack.keepalive` seconds. Setting this option to 0
2468 disables keepalive packets entirely. The default is 5 seconds.
2469
2470 url.<base>.insteadOf::
2471 Any URL that starts with this value will be rewritten to
2472 start, instead, with <base>. In cases where some site serves a
2473 large number of repositories, and serves them with multiple
2474 access methods, and some users need to use different access
2475 methods, this feature allows people to specify any of the
2476 equivalent URLs and have Git automatically rewrite the URL to
2477 the best alternative for the particular user, even for a
2478 never-before-seen repository on the site. When more than one
2479 insteadOf strings match a given URL, the longest match is used.
2480
2481 url.<base>.pushInsteadOf::
2482 Any URL that starts with this value will not be pushed to;
2483 instead, it will be rewritten to start with <base>, and the
2484 resulting URL will be pushed to. In cases where some site serves
2485 a large number of repositories, and serves them with multiple
2486 access methods, some of which do not allow push, this feature
2487 allows people to specify a pull-only URL and have Git
2488 automatically use an appropriate URL to push, even for a
2489 never-before-seen repository on the site. When more than one
2490 pushInsteadOf strings match a given URL, the longest match is
2491 used. If a remote has an explicit pushurl, Git will ignore this
2492 setting for that remote.
2493
2494 user.email::
2495 Your email address to be recorded in any newly created commits.
2496 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2497 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2498
2499 user.name::
2500 Your full name to be recorded in any newly created commits.
2501 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2502 environment variables. See linkgit:git-commit-tree[1].
2503
2504 user.signingkey::
2505 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2506 key you want it to automatically when creating a signed tag or
2507 commit, you can override the default selection with this variable.
2508 This option is passed unchanged to gpg's --local-user parameter,
2509 so you may specify a key using any method that gpg supports.
2510
2511 web.browser::
2512 Specify a web browser that may be used by some commands.
2513 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2514 may use it.