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