parse_color: support 24-bit RGB values
[git/git.git] / Documentation / config.txt
2 ------------------
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.
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.
19 Syntax
20 ~~~~~~
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.
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.
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:
37 --------
38 [section "subsection"]
40 --------
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.
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.
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.
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
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".
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 `\`.
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.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
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.
102 Example
103 ~~~~~~~
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
110 # Our diff algorithm
111 [diff]
112 external = /usr/local/bin/diff-wrapper
113 renames = true
115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
119 # Proxy settings
120 [core]
121 gitProxy="ssh" for ""
122 gitProxy=default-proxy ; for the rest
124 [include]
125 path = /path/to/ ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
129 Variables
130 ~~~~~~~~~
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.
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.
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 --
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
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).
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.
420 core.repositoryFormatVersion::
421 Internal variable identifying the repository format and layout
422 version.
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.
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.
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'.
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).
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.
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.
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.
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.
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].
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.
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.
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].
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.
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.
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`.
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.
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").
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.
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.
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].
646 core.sparseCheckout::
647 Enable "sparse checkout" feature. See section "Sparse checkout" in
648 linkgit:git-read-tree[1] for more information.
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.
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.
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 " = !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].
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].
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].
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].
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.
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.
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.
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.
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.
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.
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).
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.
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].)
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]).
804 clean.requireForce::
805 A boolean to make git-clean do nothing unless given -f,
806 -i or -n. Defaults to true.
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.
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). If your terminal supports it, you may also
832 specify 24-bit RGB values as hex, like `#ff0ab3`.
834 color.diff::
835 Whether to use ANSI escape sequences to add color to patches.
836 If this is set to `always`, linkgit:git-diff[1],
837 linkgit:git-log[1], and linkgit:git-show[1] will use color
838 for all patches. If it is set to `true` or `auto`, those
839 commands will only use color when output is to the terminal.
840 Defaults to false.
841 +
842 This does not affect linkgit:git-format-patch[1] or the
843 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
844 command line with the `--color[=<when>]` option.
846 color.diff.<slot>::
847 Use customized color for diff colorization. `<slot>` specifies
848 which part of the patch to use the specified color, and is one
849 of `plain` (context text), `meta` (metainformation), `frag`
850 (hunk header), 'func' (function in hunk header), `old` (removed lines),
851 `new` (added lines), `commit` (commit headers), or `whitespace`
852 (highlighting whitespace errors). The values of these variables may be
853 specified as in color.branch.<slot>.
855 color.decorate.<slot>::
856 Use customized color for 'git log --decorate' output. `<slot>` is one
857 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
858 branches, remote-tracking branches, tags, stash and HEAD, respectively.
860 color.grep::
861 When set to `always`, always highlight matches. When `false` (or
862 `never`), never. When set to `true` or `auto`, use color only
863 when the output is written to the terminal. Defaults to `false`.
865 color.grep.<slot>::
866 Use customized color for grep colorization. `<slot>` specifies which
867 part of the line to use the specified color, and is one of
868 +
869 --
870 `context`;;
871 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
872 `filename`;;
873 filename prefix (when not using `-h`)
874 `function`;;
875 function name lines (when using `-p`)
876 `linenumber`;;
877 line number prefix (when using `-n`)
878 `match`;;
879 matching text
880 `selected`;;
881 non-matching text in selected lines
882 `separator`;;
883 separators between fields on a line (`:`, `-`, and `=`)
884 and between hunks (`--`)
885 --
886 +
887 The values of these variables may be specified as in color.branch.<slot>.
889 color.interactive::
890 When set to `always`, always use colors for interactive prompts
891 and displays (such as those used by "git-add --interactive" and
892 "git-clean --interactive"). When false (or `never`), never.
893 When set to `true` or `auto`, use colors only when the output is
894 to the terminal. Defaults to false.
896 color.interactive.<slot>::
897 Use customized color for 'git add --interactive' and 'git clean
898 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
899 or `error`, for four distinct types of normal output from
900 interactive commands. The values of these variables may be
901 specified as in color.branch.<slot>.
903 color.pager::
904 A boolean to enable/disable colored output when the pager is in
905 use (default is true).
907 color.showbranch::
908 A boolean to enable/disable color in the output of
909 linkgit:git-show-branch[1]. May be set to `always`,
910 `false` (or `never`) or `auto` (or `true`), in which case colors are used
911 only when the output is to a terminal. Defaults to false.
913 color.status::
914 A boolean to enable/disable color in the output of
915 linkgit:git-status[1]. May be set to `always`,
916 `false` (or `never`) or `auto` (or `true`), in which case colors are used
917 only when the output is to a terminal. Defaults to false.
919 color.status.<slot>::
920 Use customized color for status colorization. `<slot>` is
921 one of `header` (the header text of the status message),
922 `added` or `updated` (files which are added but not committed),
923 `changed` (files which are changed but not added in the index),
924 `untracked` (files which are not tracked by Git),
925 `branch` (the current branch), or
926 `nobranch` (the color the 'no branch' warning is shown in, defaulting
927 to red). The values of these variables may be specified as in
928 color.branch.<slot>.
930 color.ui::
931 This variable determines the default value for variables such
932 as `color.diff` and `color.grep` that control the use of color
933 per command family. Its scope will expand as more commands learn
934 configuration to set a default for the `--color` option. Set it
935 to `false` or `never` if you prefer Git commands not to use
936 color unless enabled explicitly with some other configuration
937 or the `--color` option. Set it to `always` if you want all
938 output not intended for machine consumption to use color, to
939 `true` or `auto` (this is the default since Git 1.8.4) if you
940 want such output to use color when written to the terminal.
942 column.ui::
943 Specify whether supported commands should output in columns.
944 This variable consists of a list of tokens separated by spaces
945 or commas:
946 +
947 These options control when the feature should be enabled
948 (defaults to 'never'):
949 +
950 --
951 `always`;;
952 always show in columns
953 `never`;;
954 never show in columns
955 `auto`;;
956 show in columns if the output is to the terminal
957 --
958 +
959 These options control layout (defaults to 'column'). Setting any
960 of these implies 'always' if none of 'always', 'never', or 'auto' are
961 specified.
962 +
963 --
964 `column`;;
965 fill columns before rows
966 `row`;;
967 fill rows before columns
968 `plain`;;
969 show in one column
970 --
971 +
972 Finally, these options can be combined with a layout option (defaults
973 to 'nodense'):
974 +
975 --
976 `dense`;;
977 make unequal size columns to utilize more space
978 `nodense`;;
979 make equal size columns
980 --
982 column.branch::
983 Specify whether to output branch listing in `git branch` in columns.
984 See `column.ui` for details.
986 column.clean::
987 Specify the layout when list items in `git clean -i`, which always
988 shows files and directories in columns. See `column.ui` for details.
990 column.status::
991 Specify whether to output untracked files in `git status` in columns.
992 See `column.ui` for details.
994 column.tag::
995 Specify whether to output tag listing in `git tag` in columns.
996 See `column.ui` for details.
998 commit.cleanup::
999 This setting overrides the default of the `--cleanup` option in
1000 `git commit`. See linkgit:git-commit[1] for details. Changing the
1001 default can be useful when you always want to keep lines that begin
1002 with comment character `#` in your log message, in which case you
1003 would do `git config commit.cleanup whitespace` (note that you will
1004 have to remove the help lines that begin with `#` in the commit log
1005 template yourself, if you do this).
1007 commit.gpgsign::
1009 A boolean to specify whether all commits should be GPG signed.
1010 Use of this option when doing operations such as rebase can
1011 result in a large number of commits being signed. It may be
1012 convenient to use an agent to avoid typing your GPG passphrase
1013 several times.
1015 commit.status::
1016 A boolean to enable/disable inclusion of status information in the
1017 commit message template when using an editor to prepare the commit
1018 message. Defaults to true.
1020 commit.template::
1021 Specify a file to use as the template for new commit messages.
1022 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1023 specified user's home directory.
1025 credential.helper::
1026 Specify an external helper to be called when a username or
1027 password credential is needed; the helper may consult external
1028 storage to avoid prompting the user for the credentials. See
1029 linkgit:gitcredentials[7] for details.
1031 credential.useHttpPath::
1032 When acquiring credentials, consider the "path" component of an http
1033 or https URL to be important. Defaults to false. See
1034 linkgit:gitcredentials[7] for more information.
1036 credential.username::
1037 If no username is set for a network authentication, use this username
1038 by default. See credential.<context>.* below, and
1039 linkgit:gitcredentials[7].
1041 credential.<url>.*::
1042 Any of the credential.* options above can be applied selectively to
1043 some credentials. For example "credential."
1044 would set the default username only for https connections to
1045 See linkgit:gitcredentials[7] for details on how URLs are
1046 matched.
1048 include::diff-config.txt[]
1050 difftool.<tool>.path::
1051 Override the path for the given tool. This is useful in case
1052 your tool is not in the PATH.
1054 difftool.<tool>.cmd::
1055 Specify the command to invoke the specified diff tool.
1056 The specified command is evaluated in shell with the following
1057 variables available: 'LOCAL' is set to the name of the temporary
1058 file containing the contents of the diff pre-image and 'REMOTE'
1059 is set to the name of the temporary file containing the contents
1060 of the diff post-image.
1062 difftool.prompt::
1063 Prompt before each invocation of the diff tool.
1065 fetch.recurseSubmodules::
1066 This option can be either set to a boolean value or to 'on-demand'.
1067 Setting it to a boolean changes the behavior of fetch and pull to
1068 unconditionally recurse into submodules when set to true or to not
1069 recurse at all when set to false. When set to 'on-demand' (the default
1070 value), fetch and pull will only recurse into a populated submodule
1071 when its superproject retrieves a commit that updates the submodule's
1072 reference.
1074 fetch.fsckObjects::
1075 If it is set to true, git-fetch-pack will check all fetched
1076 objects. It will abort in the case of a malformed object or a
1077 broken link. The result of an abort are only dangling objects.
1078 Defaults to false. If not set, the value of `transfer.fsckObjects`
1079 is used instead.
1081 fetch.unpackLimit::
1082 If the number of objects fetched over the Git native
1083 transfer is below this
1084 limit, then the objects will be unpacked into loose object
1085 files. However if the number of received objects equals or
1086 exceeds this limit then the received pack will be stored as
1087 a pack, after adding any missing delta bases. Storing the
1088 pack from a push can make the push operation complete faster,
1089 especially on slow filesystems. If not set, the value of
1090 `transfer.unpackLimit` is used instead.
1092 fetch.prune::
1093 If true, fetch will automatically behave as if the `--prune`
1094 option was given on the command line. See also `remote.<name>.prune`.
1096 format.attach::
1097 Enable multipart/mixed attachments as the default for
1098 'format-patch'. The value can also be a double quoted string
1099 which will enable attachments as the default and set the
1100 value as the boundary. See the --attach option in
1101 linkgit:git-format-patch[1].
1103 format.numbered::
1104 A boolean which can enable or disable sequence numbers in patch
1105 subjects. It defaults to "auto" which enables it only if there
1106 is more than one patch. It can be enabled or disabled for all
1107 messages by setting it to "true" or "false". See --numbered
1108 option in linkgit:git-format-patch[1].
1110 format.headers::
1111 Additional email headers to include in a patch to be submitted
1112 by mail. See linkgit:git-format-patch[1].
1116 Additional recipients to include in a patch to be submitted
1117 by mail. See the --to and --cc options in
1118 linkgit:git-format-patch[1].
1120 format.subjectprefix::
1121 The default for format-patch is to output files with the '[PATCH]'
1122 subject prefix. Use this variable to change that prefix.
1124 format.signature::
1125 The default for format-patch is to output a signature containing
1126 the Git version number. Use this variable to change that default.
1127 Set this variable to the empty string ("") to suppress
1128 signature generation.
1130 format.signaturefile::
1131 Works just like format.signature except the contents of the
1132 file specified by this variable will be used as the signature.
1134 format.suffix::
1135 The default for format-patch is to output files with the suffix
1136 `.patch`. Use this variable to change that suffix (make sure to
1137 include the dot if you want it).
1139 format.pretty::
1140 The default pretty format for log/show/whatchanged command,
1141 See linkgit:git-log[1], linkgit:git-show[1],
1142 linkgit:git-whatchanged[1].
1144 format.thread::
1145 The default threading style for 'git format-patch'. Can be
1146 a boolean value, or `shallow` or `deep`. `shallow` threading
1147 makes every mail a reply to the head of the series,
1148 where the head is chosen from the cover letter, the
1149 `--in-reply-to`, and the first patch mail, in this order.
1150 `deep` threading makes every mail a reply to the previous one.
1151 A true boolean value is the same as `shallow`, and a false
1152 value disables threading.
1154 format.signoff::
1155 A boolean value which lets you enable the `-s/--signoff` option of
1156 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1157 patch should be a conscious act and means that you certify you have
1158 the rights to submit this work under the same open source license.
1159 Please see the 'SubmittingPatches' document for further discussion.
1161 format.coverLetter::
1162 A boolean that controls whether to generate a cover-letter when
1163 format-patch is invoked, but in addition can be set to "auto", to
1164 generate a cover-letter only when there's more than one patch.
1166 filter.<driver>.clean::
1167 The command which is used to convert the content of a worktree
1168 file to a blob upon checkin. See linkgit:gitattributes[5] for
1169 details.
1171 filter.<driver>.smudge::
1172 The command which is used to convert the content of a blob
1173 object to a worktree file upon checkout. See
1174 linkgit:gitattributes[5] for details.
1176 gc.aggressiveDepth::
1177 The depth parameter used in the delta compression
1178 algorithm used by 'git gc --aggressive'. This defaults
1179 to 250.
1181 gc.aggressiveWindow::
1182 The window size parameter used in the delta compression
1183 algorithm used by 'git gc --aggressive'. This defaults
1184 to 250.
1187 When there are approximately more than this many loose
1188 objects in the repository, `git gc --auto` will pack them.
1189 Some Porcelain commands use this command to perform a
1190 light-weight garbage collection from time to time. The
1191 default value is 6700. Setting this to 0 disables it.
1193 gc.autopacklimit::
1194 When there are more than this many packs that are not
1195 marked with `*.keep` file in the repository, `git gc
1196 --auto` consolidates them into one larger pack. The
1197 default value is 50. Setting this to 0 disables it.
1199 gc.autodetach::
1200 Make `git gc --auto` return immediately andrun in background
1201 if the system supports it. Default is true.
1203 gc.packrefs::
1204 Running `git pack-refs` in a repository renders it
1205 unclonable by Git versions prior to over dumb
1206 transports such as HTTP. This variable determines whether
1207 'git gc' runs `git pack-refs`. This can be set to `notbare`
1208 to enable it within all non-bare repos or it can be set to a
1209 boolean value. The default is `true`.
1211 gc.pruneexpire::
1212 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1213 Override the grace period with this config variable. The value
1214 "now" may be used to disable this grace period and always prune
1215 unreachable objects immediately.
1217 gc.reflogexpire::
1218 gc.<pattern>.reflogexpire::
1219 'git reflog expire' removes reflog entries older than
1220 this time; defaults to 90 days. With "<pattern>" (e.g.
1221 "refs/stash") in the middle the setting applies only to
1222 the refs that match the <pattern>.
1224 gc.reflogexpireunreachable::
1225 gc.<ref>.reflogexpireunreachable::
1226 'git reflog expire' removes reflog entries older than
1227 this time and are not reachable from the current tip;
1228 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1229 in the middle, the setting applies only to the refs that
1230 match the <pattern>.
1232 gc.rerereresolved::
1233 Records of conflicted merge you resolved earlier are
1234 kept for this many days when 'git rerere gc' is run.
1235 The default is 60 days. See linkgit:git-rerere[1].
1237 gc.rerereunresolved::
1238 Records of conflicted merge you have not resolved are
1239 kept for this many days when 'git rerere gc' is run.
1240 The default is 15 days. See linkgit:git-rerere[1].
1242 gitcvs.commitmsgannotation::
1243 Append this string to each commit message. Set to empty string
1244 to disable this feature. Defaults to "via git-CVS emulator".
1246 gitcvs.enabled::
1247 Whether the CVS server interface is enabled for this repository.
1248 See linkgit:git-cvsserver[1].
1250 gitcvs.logfile::
1251 Path to a log file where the CVS server interface well... logs
1252 various stuff. See linkgit:git-cvsserver[1].
1254 gitcvs.usecrlfattr::
1255 If true, the server will look up the end-of-line conversion
1256 attributes for files to determine the '-k' modes to use. If
1257 the attributes force Git to treat a file as text,
1258 the '-k' mode will be left blank so CVS clients will
1259 treat it as text. If they suppress text conversion, the file
1260 will be set with '-kb' mode, which suppresses any newline munging
1261 the client might otherwise do. If the attributes do not allow
1262 the file type to be determined, then 'gitcvs.allbinary' is
1263 used. See linkgit:gitattributes[5].
1265 gitcvs.allbinary::
1266 This is used if 'gitcvs.usecrlfattr' does not resolve
1267 the correct '-kb' mode to use. If true, all
1268 unresolved files are sent to the client in
1269 mode '-kb'. This causes the client to treat them
1270 as binary files, which suppresses any newline munging it
1271 otherwise might do. Alternatively, if it is set to "guess",
1272 then the contents of the file are examined to decide if
1273 it is binary, similar to 'core.autocrlf'.
1275 gitcvs.dbname::
1276 Database used by git-cvsserver to cache revision information
1277 derived from the Git repository. The exact meaning depends on the
1278 used database driver, for SQLite (which is the default driver) this
1279 is a filename. Supports variable substitution (see
1280 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1281 Default: '%Ggitcvs.%m.sqlite'
1283 gitcvs.dbdriver::
1284 Used Perl DBI driver. You can specify any available driver
1285 for this here, but it might not work. git-cvsserver is tested
1286 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1287 reported *not* to work with 'DBD::mysql'. Experimental feature.
1288 May not contain double colons (`:`). Default: 'SQLite'.
1289 See linkgit:git-cvsserver[1].
1291 gitcvs.dbuser, gitcvs.dbpass::
1292 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1293 since SQLite has no concept of database users and/or passwords.
1294 'gitcvs.dbuser' supports variable substitution (see
1295 linkgit:git-cvsserver[1] for details).
1297 gitcvs.dbTableNamePrefix::
1298 Database table name prefix. Prepended to the names of any
1299 database tables used, allowing a single database to be used
1300 for several repositories. Supports variable substitution (see
1301 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1302 characters will be replaced with underscores.
1304 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1305 'gitcvs.allbinary' can also be specified as
1306 'gitcvs.<access_method>.<varname>' (where 'access_method'
1307 is one of "ext" and "pserver") to make them apply only for the given
1308 access method.
1310 gitweb.category::
1311 gitweb.description::
1312 gitweb.owner::
1313 gitweb.url::
1314 See linkgit:gitweb[1] for description.
1316 gitweb.avatar::
1317 gitweb.blame::
1318 gitweb.grep::
1319 gitweb.highlight::
1320 gitweb.patches::
1321 gitweb.pickaxe::
1322 gitweb.remote_heads::
1323 gitweb.showsizes::
1324 gitweb.snapshot::
1325 See linkgit:gitweb.conf[5] for description.
1327 grep.lineNumber::
1328 If set to true, enable '-n' option by default.
1330 grep.patternType::
1331 Set the default matching behavior. Using a value of 'basic', 'extended',
1332 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1333 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1334 value 'default' will return to the default matching behavior.
1336 grep.extendedRegexp::
1337 If set to true, enable '--extended-regexp' option by default. This
1338 option is ignored when the 'grep.patternType' option is set to a value
1339 other than 'default'.
1341 gpg.program::
1342 Use this custom program instead of "gpg" found on $PATH when
1343 making or verifying a PGP signature. The program must support the
1344 same command-line interface as GPG, namely, to verify a detached
1345 signature, "gpg --verify $file - <$signature" is run, and the
1346 program is expected to signal a good signature by exiting with
1347 code 0, and to generate an ascii-armored detached signature, the
1348 standard input of "gpg -bsau $key" is fed with the contents to be
1349 signed, and the program is expected to send the result to its
1350 standard output.
1352 gui.commitmsgwidth::
1353 Defines how wide the commit message window is in the
1354 linkgit:git-gui[1]. "75" is the default.
1356 gui.diffcontext::
1357 Specifies how many context lines should be used in calls to diff
1358 made by the linkgit:git-gui[1]. The default is "5".
1360 gui.displayuntracked::
1361 Determines if linkgit::git-gui[1] shows untracked files
1362 in the file list. The default is "true".
1364 gui.encoding::
1365 Specifies the default encoding to use for displaying of
1366 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1367 It can be overridden by setting the 'encoding' attribute
1368 for relevant files (see linkgit:gitattributes[5]).
1369 If this option is not set, the tools default to the
1370 locale encoding.
1372 gui.matchtrackingbranch::
1373 Determines if new branches created with linkgit:git-gui[1] should
1374 default to tracking remote branches with matching names or
1375 not. Default: "false".
1377 gui.newbranchtemplate::
1378 Is used as suggested name when creating new branches using the
1379 linkgit:git-gui[1].
1381 gui.pruneduringfetch::
1382 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1383 performing a fetch. The default value is "false".
1385 gui.trustmtime::
1386 Determines if linkgit:git-gui[1] should trust the file modification
1387 timestamp or not. By default the timestamps are not trusted.
1389 gui.spellingdictionary::
1390 Specifies the dictionary used for spell checking commit messages in
1391 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1392 off.
1394 gui.fastcopyblame::
1395 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1396 location detection. It makes blame significantly faster on huge
1397 repositories at the expense of less thorough copy detection.
1399 gui.copyblamethreshold::
1400 Specifies the threshold to use in 'git gui blame' original location
1401 detection, measured in alphanumeric characters. See the
1402 linkgit:git-blame[1] manual for more information on copy detection.
1404 gui.blamehistoryctx::
1405 Specifies the radius of history context in days to show in
1406 linkgit:gitk[1] for the selected commit, when the `Show History
1407 Context` menu item is invoked from 'git gui blame'. If this
1408 variable is set to zero, the whole history is shown.
1410 guitool.<name>.cmd::
1411 Specifies the shell command line to execute when the corresponding item
1412 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1413 mandatory for every tool. The command is executed from the root of
1414 the working directory, and in the environment it receives the name of
1415 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1416 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1417 the head is detached, 'CUR_BRANCH' is empty).
1419 guitool.<name>.needsfile::
1420 Run the tool only if a diff is selected in the GUI. It guarantees
1421 that 'FILENAME' is not empty.
1423 guitool.<name>.noconsole::
1424 Run the command silently, without creating a window to display its
1425 output.
1427 guitool.<name>.norescan::
1428 Don't rescan the working directory for changes after the tool
1429 finishes execution.
1431 guitool.<name>.confirm::
1432 Show a confirmation dialog before actually running the tool.
1434 guitool.<name>.argprompt::
1435 Request a string argument from the user, and pass it to the tool
1436 through the 'ARGS' environment variable. Since requesting an
1437 argument implies confirmation, the 'confirm' option has no effect
1438 if this is enabled. If the option is set to 'true', 'yes', or '1',
1439 the dialog uses a built-in generic prompt; otherwise the exact
1440 value of the variable is used.
1442 guitool.<name>.revprompt::
1443 Request a single valid revision from the user, and set the
1444 'REVISION' environment variable. In other aspects this option
1445 is similar to 'argprompt', and can be used together with it.
1447 guitool.<name>.revunmerged::
1448 Show only unmerged branches in the 'revprompt' subdialog.
1449 This is useful for tools similar to merge or rebase, but not
1450 for things like checkout or reset.
1452 guitool.<name>.title::
1453 Specifies the title to use for the prompt dialog. The default
1454 is the tool name.
1456 guitool.<name>.prompt::
1457 Specifies the general prompt string to display at the top of
1458 the dialog, before subsections for 'argprompt' and 'revprompt'.
1459 The default value includes the actual command.
1461 help.browser::
1462 Specify the browser that will be used to display help in the
1463 'web' format. See linkgit:git-help[1].
1465 help.format::
1466 Override the default help format used by linkgit:git-help[1].
1467 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1468 the default. 'web' and 'html' are the same.
1470 help.autocorrect::
1471 Automatically correct and execute mistyped commands after
1472 waiting for the given number of deciseconds (0.1 sec). If more
1473 than one command can be deduced from the entered text, nothing
1474 will be executed. If the value of this option is negative,
1475 the corrected command will be executed immediately. If the
1476 value is 0 - the command will be just shown but not executed.
1477 This is the default.
1479 help.htmlpath::
1480 Specify the path where the HTML documentation resides. File system paths
1481 and URLs are supported. HTML pages will be prefixed with this path when
1482 help is displayed in the 'web' format. This defaults to the documentation
1483 path of your Git installation.
1485 http.proxy::
1486 Override the HTTP proxy, normally configured using the 'http_proxy',
1487 'https_proxy', and 'all_proxy' environment variables (see
1488 `curl(1)`). This can be overridden on a per-remote basis; see
1489 remote.<name>.proxy
1491 http.cookiefile::
1492 File containing previously stored cookie lines which should be used
1493 in the Git http session, if they match the server. The file format
1494 of the file to read cookies from should be plain HTTP headers or
1495 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1496 NOTE that the file specified with http.cookiefile is only used as
1497 input unless http.saveCookies is set.
1499 http.savecookies::
1500 If set, store cookies received during requests to the file specified by
1501 http.cookiefile. Has no effect if http.cookiefile is unset.
1503 http.sslVerify::
1504 Whether to verify the SSL certificate when fetching or pushing
1505 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1506 variable.
1508 http.sslCert::
1509 File containing the SSL certificate when fetching or pushing
1510 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1511 variable.
1513 http.sslKey::
1514 File containing the SSL private key when fetching or pushing
1515 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1516 variable.
1518 http.sslCertPasswordProtected::
1519 Enable Git's password prompt for the SSL certificate. Otherwise
1520 OpenSSL will prompt the user, possibly many times, if the
1521 certificate or private key is encrypted. Can be overridden by the
1522 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1524 http.sslCAInfo::
1525 File containing the certificates to verify the peer with when
1526 fetching or pushing over HTTPS. Can be overridden by the
1527 'GIT_SSL_CAINFO' environment variable.
1529 http.sslCAPath::
1530 Path containing files with the CA certificates to verify the peer
1531 with when fetching or pushing over HTTPS. Can be overridden
1532 by the 'GIT_SSL_CAPATH' environment variable.
1534 http.sslTry::
1535 Attempt to use AUTH SSL/TLS and encrypted data transfers
1536 when connecting via regular FTP protocol. This might be needed
1537 if the FTP server requires it for security reasons or you wish
1538 to connect securely whenever remote FTP server supports it.
1539 Default is false since it might trigger certificate verification
1540 errors on misconfigured servers.
1542 http.maxRequests::
1543 How many HTTP requests to launch in parallel. Can be overridden
1544 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1546 http.minSessions::
1547 The number of curl sessions (counted across slots) to be kept across
1548 requests. They will not be ended with curl_easy_cleanup() until
1549 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1550 value will be capped at 1. Defaults to 1.
1552 http.postBuffer::
1553 Maximum size in bytes of the buffer used by smart HTTP
1554 transports when POSTing data to the remote system.
1555 For requests larger than this buffer size, HTTP/1.1 and
1556 Transfer-Encoding: chunked is used to avoid creating a
1557 massive pack file locally. Default is 1 MiB, which is
1558 sufficient for most requests.
1560 http.lowSpeedLimit, http.lowSpeedTime::
1561 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1562 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1563 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1564 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1566 http.noEPSV::
1567 A boolean which disables using of EPSV ftp command by curl.
1568 This can helpful with some "poor" ftp servers which don't
1569 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1570 environment variable. Default is false (curl will use EPSV).
1572 http.useragent::
1573 The HTTP USER_AGENT string presented to an HTTP server. The default
1574 value represents the version of the client Git such as git/1.7.1.
1575 This option allows you to override this value to a more common value
1576 such as Mozilla/4.0. This may be necessary, for instance, if
1577 connecting through a firewall that restricts HTTP connections to a set
1578 of common USER_AGENT strings (but not including those like git/1.7.1).
1579 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1581 http.<url>.*::
1582 Any of the http.* options above can be applied selectively to some urls.
1583 For a config key to match a URL, each element of the config key is
1584 compared to that of the URL, in the following order:
1585 +
1586 --
1587 . Scheme (e.g., `https` in ``). This field
1588 must match exactly between the config key and the URL.
1590 . Host/domain name (e.g., `` in ``).
1591 This field must match exactly between the config key and the URL.
1593 . Port number (e.g., `8080` in ``).
1594 This field must match exactly between the config key and the URL.
1595 Omitted port numbers are automatically converted to the correct
1596 default for the scheme before matching.
1598 . Path (e.g., `repo.git` in ``). The
1599 path field of the config key must match the path field of the URL
1600 either exactly or as a prefix of slash-delimited path elements. This means
1601 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1602 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1603 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1604 key with just path `foo/`).
1606 . User name (e.g., `user` in ``). If
1607 the config key has a user name it must match the user name in the
1608 URL exactly. If the config key does not have a user name, that
1609 config key will match a URL with any user name (including none),
1610 but at a lower precedence than a config key with a user name.
1611 --
1612 +
1613 The list above is ordered by decreasing precedence; a URL that matches
1614 a config key's path is preferred to one that matches its user name. For example,
1615 if the URL is `` a config key match of
1616 `` will be preferred over a config key match of
1617 ``.
1618 +
1619 All URLs are normalized before attempting any matching (the password part,
1620 if embedded in the URL, is always ignored for matching purposes) so that
1621 equivalent urls that are simply spelled differently will match properly.
1622 Environment variable settings always override any matches. The urls that are
1623 matched against are those given directly to Git commands. This means any URLs
1624 visited as a result of a redirection do not participate in matching.
1626 i18n.commitEncoding::
1627 Character encoding the commit messages are stored in; Git itself
1628 does not care per se, but this information is necessary e.g. when
1629 importing commits from emails or in the gitk graphical history
1630 browser (and possibly at other places in the future or in other
1631 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1633 i18n.logOutputEncoding::
1634 Character encoding the commit messages are converted to when
1635 running 'git log' and friends.
1637 imap::
1638 The configuration variables in the 'imap' section are described
1639 in linkgit:git-imap-send[1].
1641 index.version::
1642 Specify the version with which new index files should be
1643 initialized. This does not affect existing repositories.
1645 init.templatedir::
1646 Specify the directory from which templates will be copied.
1647 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1649 instaweb.browser::
1650 Specify the program that will be used to browse your working
1651 repository in gitweb. See linkgit:git-instaweb[1].
1653 instaweb.httpd::
1654 The HTTP daemon command-line to start gitweb on your working
1655 repository. See linkgit:git-instaweb[1].
1657 instaweb.local::
1658 If true the web server started by linkgit:git-instaweb[1] will
1659 be bound to the local IP (
1661 instaweb.modulepath::
1662 The default module path for linkgit:git-instaweb[1] to use
1663 instead of /usr/lib/apache2/modules. Only used if httpd
1664 is Apache.
1666 instaweb.port::
1667 The port number to bind the gitweb httpd to. See
1668 linkgit:git-instaweb[1].
1670 interactive.singlekey::
1671 In interactive commands, allow the user to provide one-letter
1672 input with a single key (i.e., without hitting enter).
1673 Currently this is used by the `--patch` mode of
1674 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1675 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1676 setting is silently ignored if portable keystroke input
1677 is not available; requires the Perl module Term::ReadKey.
1679 log.abbrevCommit::
1680 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1681 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1682 override this option with `--no-abbrev-commit`.
1685 Set the default date-time mode for the 'log' command.
1686 Setting a value for is similar to using 'git log''s
1687 `--date` option. Possible values are `relative`, `local`,
1688 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1689 for details.
1691 log.decorate::
1692 Print out the ref names of any commits that are shown by the log
1693 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1694 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1695 specified, the full ref name (including prefix) will be printed.
1696 This is the same as the log commands '--decorate' option.
1698 log.showroot::
1699 If true, the initial commit will be shown as a big creation event.
1700 This is equivalent to a diff against an empty tree.
1701 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1702 normally hide the root commit will now show it. True by default.
1704 log.mailmap::
1705 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1706 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1708 mailmap.file::
1709 The location of an augmenting mailmap file. The default
1710 mailmap, located in the root of the repository, is loaded
1711 first, then the mailmap file pointed to by this variable.
1712 The location of the mailmap file may be in a repository
1713 subdirectory, or somewhere outside of the repository itself.
1714 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1716 mailmap.blob::
1717 Like `mailmap.file`, but consider the value as a reference to a
1718 blob in the repository. If both `mailmap.file` and
1719 `mailmap.blob` are given, both are parsed, with entries from
1720 `mailmap.file` taking precedence. In a bare repository, this
1721 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1722 defaults to empty.
1724 man.viewer::
1725 Specify the programs that may be used to display help in the
1726 'man' format. See linkgit:git-help[1].
1728 man.<tool>.cmd::
1729 Specify the command to invoke the specified man viewer. The
1730 specified command is evaluated in shell with the man page
1731 passed as argument. (See linkgit:git-help[1].)
1733 man.<tool>.path::
1734 Override the path for the given tool that may be used to
1735 display help in the 'man' format. See linkgit:git-help[1].
1737 include::merge-config.txt[]
1739 mergetool.<tool>.path::
1740 Override the path for the given tool. This is useful in case
1741 your tool is not in the PATH.
1743 mergetool.<tool>.cmd::
1744 Specify the command to invoke the specified merge tool. The
1745 specified command is evaluated in shell with the following
1746 variables available: 'BASE' is the name of a temporary file
1747 containing the common base of the files to be merged, if available;
1748 'LOCAL' is the name of a temporary file containing the contents of
1749 the file on the current branch; 'REMOTE' is the name of a temporary
1750 file containing the contents of the file from the branch being
1751 merged; 'MERGED' contains the name of the file to which the merge
1752 tool should write the results of a successful merge.
1754 mergetool.<tool>.trustExitCode::
1755 For a custom merge command, specify whether the exit code of
1756 the merge command can be used to determine whether the merge was
1757 successful. If this is not set to true then the merge target file
1758 timestamp is checked and the merge assumed to have been successful
1759 if the file has been updated, otherwise the user is prompted to
1760 indicate the success of the merge.
1762 mergetool.meld.hasOutput::
1763 Older versions of `meld` do not support the `--output` option.
1764 Git will attempt to detect whether `meld` supports `--output`
1765 by inspecting the output of `meld --help`. Configuring
1766 `mergetool.meld.hasOutput` will make Git skip these checks and
1767 use the configured value instead. Setting `mergetool.meld.hasOutput`
1768 to `true` tells Git to unconditionally use the `--output` option,
1769 and `false` avoids using `--output`.
1771 mergetool.keepBackup::
1772 After performing a merge, the original file with conflict markers
1773 can be saved as a file with a `.orig` extension. If this variable
1774 is set to `false` then this file is not preserved. Defaults to
1775 `true` (i.e. keep the backup files).
1777 mergetool.keepTemporaries::
1778 When invoking a custom merge tool, Git uses a set of temporary
1779 files to pass to the tool. If the tool returns an error and this
1780 variable is set to `true`, then these temporary files will be
1781 preserved, otherwise they will be removed after the tool has
1782 exited. Defaults to `false`.
1784 mergetool.prompt::
1785 Prompt before each invocation of the merge resolution program.
1787 notes.displayRef::
1788 The (fully qualified) refname from which to show notes when
1789 showing commit messages. The value of this variable can be set
1790 to a glob, in which case notes from all matching refs will be
1791 shown. You may also specify this configuration variable
1792 several times. A warning will be issued for refs that do not
1793 exist, but a glob that does not match any refs is silently
1794 ignored.
1795 +
1796 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1797 environment variable, which must be a colon separated list of refs or
1798 globs.
1799 +
1800 The effective value of "core.notesRef" (possibly overridden by
1801 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1802 displayed.
1804 notes.rewrite.<command>::
1805 When rewriting commits with <command> (currently `amend` or
1806 `rebase`) and this variable is set to `true`, Git
1807 automatically copies your notes from the original to the
1808 rewritten commit. Defaults to `true`, but see
1809 "notes.rewriteRef" below.
1811 notes.rewriteMode::
1812 When copying notes during a rewrite (see the
1813 "notes.rewrite.<command>" option), determines what to do if
1814 the target commit already has a note. Must be one of
1815 `overwrite`, `concatenate`, or `ignore`. Defaults to
1816 `concatenate`.
1817 +
1818 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1819 environment variable.
1821 notes.rewriteRef::
1822 When copying notes during a rewrite, specifies the (fully
1823 qualified) ref whose notes should be copied. The ref may be a
1824 glob, in which case notes in all matching refs will be copied.
1825 You may also specify this configuration several times.
1826 +
1827 Does not have a default value; you must configure this variable to
1828 enable note rewriting. Set it to `refs/notes/commits` to enable
1829 rewriting for the default commit notes.
1830 +
1831 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1832 environment variable, which must be a colon separated list of refs or
1833 globs.
1835 pack.window::
1836 The size of the window used by linkgit:git-pack-objects[1] when no
1837 window size is given on the command line. Defaults to 10.
1839 pack.depth::
1840 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1841 maximum depth is given on the command line. Defaults to 50.
1843 pack.windowMemory::
1844 The window memory size limit used by linkgit:git-pack-objects[1]
1845 when no limit is given on the command line. The value can be
1846 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1847 limit.
1849 pack.compression::
1850 An integer -1..9, indicating the compression level for objects
1851 in a pack file. -1 is the zlib default. 0 means no
1852 compression, and 1..9 are various speed/size tradeoffs, 9 being
1853 slowest. If not set, defaults to core.compression. If that is
1854 not set, defaults to -1, the zlib default, which is "a default
1855 compromise between speed and compression (currently equivalent
1856 to level 6)."
1857 +
1858 Note that changing the compression level will not automatically recompress
1859 all existing objects. You can force recompression by passing the -F option
1860 to linkgit:git-repack[1].
1862 pack.deltaCacheSize::
1863 The maximum memory in bytes used for caching deltas in
1864 linkgit:git-pack-objects[1] before writing them out to a pack.
1865 This cache is used to speed up the writing object phase by not
1866 having to recompute the final delta result once the best match
1867 for all objects is found. Repacking large repositories on machines
1868 which are tight with memory might be badly impacted by this though,
1869 especially if this cache pushes the system into swapping.
1870 A value of 0 means no limit. The smallest size of 1 byte may be
1871 used to virtually disable this cache. Defaults to 256 MiB.
1873 pack.deltaCacheLimit::
1874 The maximum size of a delta, that is cached in
1875 linkgit:git-pack-objects[1]. This cache is used to speed up the
1876 writing object phase by not having to recompute the final delta
1877 result once the best match for all objects is found. Defaults to 1000.
1879 pack.threads::
1880 Specifies the number of threads to spawn when searching for best
1881 delta matches. This requires that linkgit:git-pack-objects[1]
1882 be compiled with pthreads otherwise this option is ignored with a
1883 warning. This is meant to reduce packing time on multiprocessor
1884 machines. The required amount of memory for the delta search window
1885 is however multiplied by the number of threads.
1886 Specifying 0 will cause Git to auto-detect the number of CPU's
1887 and set the number of threads accordingly.
1889 pack.indexVersion::
1890 Specify the default pack index version. Valid values are 1 for
1891 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1892 the new pack index with capabilities for packs larger than 4 GB
1893 as well as proper protection against the repacking of corrupted
1894 packs. Version 2 is the default. Note that version 2 is enforced
1895 and this config option ignored whenever the corresponding pack is
1896 larger than 2 GB.
1897 +
1898 If you have an old Git that does not understand the version 2 `*.idx` file,
1899 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1900 that will copy both `*.pack` file and corresponding `*.idx` file from the
1901 other side may give you a repository that cannot be accessed with your
1902 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1903 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1904 the `*.idx` file.
1906 pack.packSizeLimit::
1907 The maximum size of a pack. This setting only affects
1908 packing to a file when repacking, i.e. the git:// protocol
1909 is unaffected. It can be overridden by the `--max-pack-size`
1910 option of linkgit:git-repack[1]. The minimum size allowed is
1911 limited to 1 MiB. The default is unlimited.
1912 Common unit suffixes of 'k', 'm', or 'g' are
1913 supported.
1915 pack.useBitmaps::
1916 When true, git will use pack bitmaps (if available) when packing
1917 to stdout (e.g., during the server side of a fetch). Defaults to
1918 true. You should not generally need to turn this off unless
1919 you are debugging pack bitmaps.
1921 pack.writebitmaps::
1922 This is a deprecated synonym for `repack.writeBitmaps`.
1924 pack.writeBitmapHashCache::
1925 When true, git will include a "hash cache" section in the bitmap
1926 index (if one is written). This cache can be used to feed git's
1927 delta heuristics, potentially leading to better deltas between
1928 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1929 between an older, bitmapped pack and objects that have been
1930 pushed since the last gc). The downside is that it consumes 4
1931 bytes per object of disk space, and that JGit's bitmap
1932 implementation does not understand it, causing it to complain if
1933 Git and JGit are used on the same repository. Defaults to false.
1935 pager.<cmd>::
1936 If the value is boolean, turns on or off pagination of the
1937 output of a particular Git subcommand when writing to a tty.
1938 Otherwise, turns on pagination for the subcommand using the
1939 pager specified by the value of `pager.<cmd>`. If `--paginate`
1940 or `--no-pager` is specified on the command line, it takes
1941 precedence over this option. To disable pagination for all
1942 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1944 pretty.<name>::
1945 Alias for a --pretty= format string, as specified in
1946 linkgit:git-log[1]. Any aliases defined here can be used just
1947 as the built-in pretty formats could. For example,
1948 running `git config pretty.changelog "format:* %H %s"`
1949 would cause the invocation `git log --pretty=changelog`
1950 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1951 Note that an alias with the same name as a built-in format
1952 will be silently ignored.
1954 pull.ff::
1955 By default, Git does not create an extra merge commit when merging
1956 a commit that is a descendant of the current commit. Instead, the
1957 tip of the current branch is fast-forwarded. When set to `false`,
1958 this variable tells Git to create an extra merge commit in such
1959 a case (equivalent to giving the `--no-ff` option from the command
1960 line). When set to `only`, only such fast-forward merges are
1961 allowed (equivalent to giving the `--ff-only` option from the
1962 command line).
1964 pull.rebase::
1965 When true, rebase branches on top of the fetched branch, instead
1966 of merging the default branch from the default remote when "git
1967 pull" is run. See "branch.<name>.rebase" for setting this on a
1968 per-branch basis.
1969 +
1970 When preserve, also pass `--preserve-merges` along to 'git rebase'
1971 so that locally committed merge commits will not be flattened
1972 by running 'git pull'.
1973 +
1974 *NOTE*: this is a possibly dangerous operation; do *not* use
1975 it unless you understand the implications (see linkgit:git-rebase[1]
1976 for details).
1978 pull.octopus::
1979 The default merge strategy to use when pulling multiple branches
1980 at once.
1982 pull.twohead::
1983 The default merge strategy to use when pulling a single branch.
1985 push.default::
1986 Defines the action `git push` should take if no refspec is
1987 explicitly given. Different values are well-suited for
1988 specific workflows; for instance, in a purely central workflow
1989 (i.e. the fetch source is equal to the push destination),
1990 `upstream` is probably what you want. Possible values are:
1991 +
1992 --
1994 * `nothing` - do not push anything (error out) unless a refspec is
1995 explicitly given. This is primarily meant for people who want to
1996 avoid mistakes by always being explicit.
1998 * `current` - push the current branch to update a branch with the same
1999 name on the receiving end. Works in both central and non-central
2000 workflows.
2002 * `upstream` - push the current branch back to the branch whose
2003 changes are usually integrated into the current branch (which is
2004 called `@{upstream}`). This mode only makes sense if you are
2005 pushing to the same repository you would normally pull from
2006 (i.e. central workflow).
2008 * `simple` - in centralized workflow, work like `upstream` with an
2009 added safety to refuse to push if the upstream branch's name is
2010 different from the local one.
2011 +
2012 When pushing to a remote that is different from the remote you normally
2013 pull from, work as `current`. This is the safest option and is suited
2014 for beginners.
2015 +
2016 This mode has become the default in Git 2.0.
2018 * `matching` - push all branches having the same name on both ends.
2019 This makes the repository you are pushing to remember the set of
2020 branches that will be pushed out (e.g. if you always push 'maint'
2021 and 'master' there and no other branches, the repository you push
2022 to will have these two branches, and your local 'maint' and
2023 'master' will be pushed there).
2024 +
2025 To use this mode effectively, you have to make sure _all_ the
2026 branches you would push out are ready to be pushed out before
2027 running 'git push', as the whole point of this mode is to allow you
2028 to push all of the branches in one go. If you usually finish work
2029 on only one branch and push out the result, while other branches are
2030 unfinished, this mode is not for you. Also this mode is not
2031 suitable for pushing into a shared central repository, as other
2032 people may add new branches there, or update the tip of existing
2033 branches outside your control.
2034 +
2035 This used to be the default, but not since Git 2.0 (`simple` is the
2036 new default).
2038 --
2040 rebase.stat::
2041 Whether to show a diffstat of what changed upstream since the last
2042 rebase. False by default.
2044 rebase.autosquash::
2045 If set to true enable '--autosquash' option by default.
2047 rebase.autostash::
2048 When set to true, automatically create a temporary stash
2049 before the operation begins, and apply it after the operation
2050 ends. This means that you can run rebase on a dirty worktree.
2051 However, use with care: the final stash application after a
2052 successful rebase might result in non-trivial conflicts.
2053 Defaults to false.
2055 receive.autogc::
2056 By default, git-receive-pack will run "git-gc --auto" after
2057 receiving data from git-push and updating refs. You can stop
2058 it by setting this variable to false.
2060 receive.fsckObjects::
2061 If it is set to true, git-receive-pack will check all received
2062 objects. It will abort in the case of a malformed object or a
2063 broken link. The result of an abort are only dangling objects.
2064 Defaults to false. If not set, the value of `transfer.fsckObjects`
2065 is used instead.
2067 receive.unpackLimit::
2068 If the number of objects received in a push is below this
2069 limit then the objects will be unpacked into loose object
2070 files. However if the number of received objects equals or
2071 exceeds this limit then the received pack will be stored as
2072 a pack, after adding any missing delta bases. Storing the
2073 pack from a push can make the push operation complete faster,
2074 especially on slow filesystems. If not set, the value of
2075 `transfer.unpackLimit` is used instead.
2077 receive.denyDeletes::
2078 If set to true, git-receive-pack will deny a ref update that deletes
2079 the ref. Use this to prevent such a ref deletion via a push.
2081 receive.denyDeleteCurrent::
2082 If set to true, git-receive-pack will deny a ref update that
2083 deletes the currently checked out branch of a non-bare repository.
2085 receive.denyCurrentBranch::
2086 If set to true or "refuse", git-receive-pack will deny a ref update
2087 to the currently checked out branch of a non-bare repository.
2088 Such a push is potentially dangerous because it brings the HEAD
2089 out of sync with the index and working tree. If set to "warn",
2090 print a warning of such a push to stderr, but allow the push to
2091 proceed. If set to false or "ignore", allow such pushes with no
2092 message. Defaults to "refuse".
2094 receive.denyNonFastForwards::
2095 If set to true, git-receive-pack will deny a ref update which is
2096 not a fast-forward. Use this to prevent such an update via a push,
2097 even if that push is forced. This configuration variable is
2098 set when initializing a shared repository.
2100 receive.hiderefs::
2101 String(s) `receive-pack` uses to decide which refs to omit
2102 from its initial advertisement. Use more than one
2103 definitions to specify multiple prefix strings. A ref that
2104 are under the hierarchies listed on the value of this
2105 variable is excluded, and is hidden when responding to `git
2106 push`, and an attempt to update or delete a hidden ref by
2107 `git push` is rejected.
2109 receive.updateserverinfo::
2110 If set to true, git-receive-pack will run git-update-server-info
2111 after receiving data from git-push and updating refs.
2113 receive.shallowupdate::
2114 If set to true, .git/shallow can be updated when new refs
2115 require new shallow roots. Otherwise those refs are rejected.
2117 remote.pushdefault::
2118 The remote to push to by default. Overrides
2119 `branch.<name>.remote` for all branches, and is overridden by
2120 `branch.<name>.pushremote` for specific branches.
2122 remote.<name>.url::
2123 The URL of a remote repository. See linkgit:git-fetch[1] or
2124 linkgit:git-push[1].
2126 remote.<name>.pushurl::
2127 The push URL of a remote repository. See linkgit:git-push[1].
2129 remote.<name>.proxy::
2130 For remotes that require curl (http, https and ftp), the URL to
2131 the proxy to use for that remote. Set to the empty string to
2132 disable proxying for that remote.
2134 remote.<name>.fetch::
2135 The default set of "refspec" for linkgit:git-fetch[1]. See
2136 linkgit:git-fetch[1].
2138 remote.<name>.push::
2139 The default set of "refspec" for linkgit:git-push[1]. See
2140 linkgit:git-push[1].
2142 remote.<name>.mirror::
2143 If true, pushing to this remote will automatically behave
2144 as if the `--mirror` option was given on the command line.
2146 remote.<name>.skipDefaultUpdate::
2147 If true, this remote will be skipped by default when updating
2148 using linkgit:git-fetch[1] or the `update` subcommand of
2149 linkgit:git-remote[1].
2151 remote.<name>.skipFetchAll::
2152 If true, this remote will be skipped by default when updating
2153 using linkgit:git-fetch[1] or the `update` subcommand of
2154 linkgit:git-remote[1].
2156 remote.<name>.receivepack::
2157 The default program to execute on the remote side when pushing. See
2158 option \--receive-pack of linkgit:git-push[1].
2160 remote.<name>.uploadpack::
2161 The default program to execute on the remote side when fetching. See
2162 option \--upload-pack of linkgit:git-fetch-pack[1].
2164 remote.<name>.tagopt::
2165 Setting this value to \--no-tags disables automatic tag following when
2166 fetching from remote <name>. Setting it to \--tags will fetch every
2167 tag from remote <name>, even if they are not reachable from remote
2168 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2169 override this setting. See options \--tags and \--no-tags of
2170 linkgit:git-fetch[1].
2172 remote.<name>.vcs::
2173 Setting this to a value <vcs> will cause Git to interact with
2174 the remote with the git-remote-<vcs> helper.
2176 remote.<name>.prune::
2177 When set to true, fetching from this remote by default will also
2178 remove any remote-tracking references that no longer exist on the
2179 remote (as if the `--prune` option was given on the command line).
2180 Overrides `fetch.prune` settings, if any.
2182 remotes.<group>::
2183 The list of remotes which are fetched by "git remote update
2184 <group>". See linkgit:git-remote[1].
2186 repack.usedeltabaseoffset::
2187 By default, linkgit:git-repack[1] creates packs that use
2188 delta-base offset. If you need to share your repository with
2189 Git older than version 1.4.4, either directly or via a dumb
2190 protocol such as http, then you need to set this option to
2191 "false" and repack. Access from old Git versions over the
2192 native protocol are unaffected by this option.
2194 repack.packKeptObjects::
2195 If set to true, makes `git repack` act as if
2196 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2197 details. Defaults to `false` normally, but `true` if a bitmap
2198 index is being written (either via `--write-bitmap-index` or
2199 `repack.writeBitmaps`).
2201 repack.writeBitmaps::
2202 When true, git will write a bitmap index when packing all
2203 objects to disk (e.g., when `git repack -a` is run). This
2204 index can speed up the "counting objects" phase of subsequent
2205 packs created for clones and fetches, at the cost of some disk
2206 space and extra time spent on the initial repack. Defaults to
2207 false.
2209 rerere.autoupdate::
2210 When set to true, `git-rerere` updates the index with the
2211 resulting contents after it cleanly resolves conflicts using
2212 previously recorded resolution. Defaults to false.
2214 rerere.enabled::
2215 Activate recording of resolved conflicts, so that identical
2216 conflict hunks can be resolved automatically, should they be
2217 encountered again. By default, linkgit:git-rerere[1] is
2218 enabled if there is an `rr-cache` directory under the
2219 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2220 repository.
2222 sendemail.identity::
2223 A configuration identity. When given, causes values in the
2224 'sendemail.<identity>' subsection to take precedence over
2225 values in the 'sendemail' section. The default identity is
2226 the value of 'sendemail.identity'.
2228 sendemail.smtpencryption::
2229 See linkgit:git-send-email[1] for description. Note that this
2230 setting is not subject to the 'identity' mechanism.
2232 sendemail.smtpssl::
2233 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2235 sendemail.smtpsslcertpath::
2236 Path to ca-certificates (either a directory or a single file).
2237 Set it to an empty string to disable certificate verification.
2239 sendemail.<identity>.*::
2240 Identity-specific versions of the 'sendemail.*' parameters
2241 found below, taking precedence over those when the this
2242 identity is selected, through command-line or
2243 'sendemail.identity'.
2245 sendemail.aliasesfile::
2246 sendemail.aliasfiletype::
2247 sendemail.annotate::
2248 sendemail.bcc::
2250 sendemail.cccmd::
2251 sendemail.chainreplyto::
2252 sendemail.confirm::
2253 sendemail.envelopesender::
2254 sendemail.from::
2255 sendemail.multiedit::
2256 sendemail.signedoffbycc::
2257 sendemail.smtppass::
2258 sendemail.suppresscc::
2259 sendemail.suppressfrom::
2261 sendemail.smtpdomain::
2262 sendemail.smtpserver::
2263 sendemail.smtpserverport::
2264 sendemail.smtpserveroption::
2265 sendemail.smtpuser::
2266 sendemail.thread::
2267 sendemail.validate::
2268 See linkgit:git-send-email[1] for description.
2270 sendemail.signedoffcc::
2271 Deprecated alias for 'sendemail.signedoffbycc'.
2273 showbranch.default::
2274 The default set of branches for linkgit:git-show-branch[1].
2275 See linkgit:git-show-branch[1].
2277 status.relativePaths::
2278 By default, linkgit:git-status[1] shows paths relative to the
2279 current directory. Setting this variable to `false` shows paths
2280 relative to the repository root (this was the default for Git
2281 prior to v1.5.4).
2283 status.short::
2284 Set to true to enable --short by default in linkgit:git-status[1].
2285 The option --no-short takes precedence over this variable.
2287 status.branch::
2288 Set to true to enable --branch by default in linkgit:git-status[1].
2289 The option --no-branch takes precedence over this variable.
2291 status.displayCommentPrefix::
2292 If set to true, linkgit:git-status[1] will insert a comment
2293 prefix before each output line (starting with
2294 `core.commentChar`, i.e. `#` by default). This was the
2295 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2296 Defaults to false.
2298 status.showUntrackedFiles::
2299 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2300 files which are not currently tracked by Git. Directories which
2301 contain only untracked files, are shown with the directory name
2302 only. Showing untracked files means that Git needs to lstat() all
2303 the files in the whole repository, which might be slow on some
2304 systems. So, this variable controls how the commands displays
2305 the untracked files. Possible values are:
2306 +
2307 --
2308 * `no` - Show no untracked files.
2309 * `normal` - Show untracked files and directories.
2310 * `all` - Show also individual files in untracked directories.
2311 --
2312 +
2313 If this variable is not specified, it defaults to 'normal'.
2314 This variable can be overridden with the -u|--untracked-files option
2315 of linkgit:git-status[1] and linkgit:git-commit[1].
2317 status.submodulesummary::
2318 Defaults to false.
2319 If this is set to a non zero number or true (identical to -1 or an
2320 unlimited number), the submodule summary will be enabled and a
2321 summary of commits for modified submodules will be shown (see
2322 --summary-limit option of linkgit:git-submodule[1]). Please note
2323 that the summary output command will be suppressed for all
2324 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2325 for those submodules where `submodule.<name>.ignore=all`. The only
2326 exception to that rule is that status and commit will show staged
2327 submodule changes. To
2328 also view the summary for ignored submodules you can either use
2329 the --ignore-submodules=dirty command-line option or the 'git
2330 submodule summary' command, which shows a similar output but does
2331 not honor these settings.
2333 submodule.<name>.path::
2334 submodule.<name>.url::
2335 submodule.<name>.update::
2336 The path within this project, URL, and the updating strategy
2337 for a submodule. These variables are initially populated
2338 by 'git submodule init'; edit them to override the
2339 URL and other values found in the `.gitmodules` file. See
2340 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2342 submodule.<name>.branch::
2343 The remote branch name for a submodule, used by `git submodule
2344 update --remote`. Set this option to override the value found in
2345 the `.gitmodules` file. See linkgit:git-submodule[1] and
2346 linkgit:gitmodules[5] for details.
2348 submodule.<name>.fetchRecurseSubmodules::
2349 This option can be used to control recursive fetching of this
2350 submodule. It can be overridden by using the --[no-]recurse-submodules
2351 command-line option to "git fetch" and "git pull".
2352 This setting will override that from in the linkgit:gitmodules[5]
2353 file.
2355 submodule.<name>.ignore::
2356 Defines under what circumstances "git status" and the diff family show
2357 a submodule as modified. When set to "all", it will never be considered
2358 modified (but it will nonetheless show up in the output of status and
2359 commit when it has been staged), "dirty" will ignore all changes
2360 to the submodules work tree and
2361 takes only differences between the HEAD of the submodule and the commit
2362 recorded in the superproject into account. "untracked" will additionally
2363 let submodules with modified tracked files in their work tree show up.
2364 Using "none" (the default when this option is not set) also shows
2365 submodules that have untracked files in their work tree as changed.
2366 This setting overrides any setting made in .gitmodules for this submodule,
2367 both settings can be overridden on the command line by using the
2368 "--ignore-submodules" option. The 'git submodule' commands are not
2369 affected by this setting.
2371 tag.sort::
2372 This variable controls the sort ordering of tags when displayed by
2373 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2374 value of this variable will be used as the default.
2376 tar.umask::
2377 This variable can be used to restrict the permission bits of
2378 tar archive entries. The default is 0002, which turns off the
2379 world write bit. The special value "user" indicates that the
2380 archiving user's umask will be used instead. See umask(2) and
2381 linkgit:git-archive[1].
2383 transfer.fsckObjects::
2384 When `fetch.fsckObjects` or `receive.fsckObjects` are
2385 not set, the value of this variable is used instead.
2386 Defaults to false.
2388 transfer.hiderefs::
2389 This variable can be used to set both `receive.hiderefs`
2390 and `uploadpack.hiderefs` at the same time to the same
2391 values. See entries for these other variables.
2393 transfer.unpackLimit::
2394 When `fetch.unpackLimit` or `receive.unpackLimit` are
2395 not set, the value of this variable is used instead.
2396 The default value is 100.
2398 uploadarchive.allowUnreachable::
2399 If true, allow clients to use `git archive --remote` to request
2400 any tree, whether reachable from the ref tips or not. See the
2401 discussion in the `SECURITY` section of
2402 linkgit:git-upload-archive[1] for more details. Defaults to
2403 `false`.
2405 uploadpack.hiderefs::
2406 String(s) `upload-pack` uses to decide which refs to omit
2407 from its initial advertisement. Use more than one
2408 definitions to specify multiple prefix strings. A ref that
2409 are under the hierarchies listed on the value of this
2410 variable is excluded, and is hidden from `git ls-remote`,
2411 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2412 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2414 uploadpack.allowtipsha1inwant::
2415 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2416 to accept a fetch request that asks for an object at the tip
2417 of a hidden ref (by default, such a request is rejected).
2418 see also `uploadpack.hiderefs`.
2420 uploadpack.keepalive::
2421 When `upload-pack` has started `pack-objects`, there may be a
2422 quiet period while `pack-objects` prepares the pack. Normally
2423 it would output progress information, but if `--quiet` was used
2424 for the fetch, `pack-objects` will output nothing at all until
2425 the pack data begins. Some clients and networks may consider
2426 the server to be hung and give up. Setting this option instructs
2427 `upload-pack` to send an empty keepalive packet every
2428 `uploadpack.keepalive` seconds. Setting this option to 0
2429 disables keepalive packets entirely. The default is 5 seconds.
2431 url.<base>.insteadOf::
2432 Any URL that starts with this value will be rewritten to
2433 start, instead, with <base>. In cases where some site serves a
2434 large number of repositories, and serves them with multiple
2435 access methods, and some users need to use different access
2436 methods, this feature allows people to specify any of the
2437 equivalent URLs and have Git automatically rewrite the URL to
2438 the best alternative for the particular user, even for a
2439 never-before-seen repository on the site. When more than one
2440 insteadOf strings match a given URL, the longest match is used.
2442 url.<base>.pushInsteadOf::
2443 Any URL that starts with this value will not be pushed to;
2444 instead, it will be rewritten to start with <base>, and the
2445 resulting URL will be pushed to. In cases where some site serves
2446 a large number of repositories, and serves them with multiple
2447 access methods, some of which do not allow push, this feature
2448 allows people to specify a pull-only URL and have Git
2449 automatically use an appropriate URL to push, even for a
2450 never-before-seen repository on the site. When more than one
2451 pushInsteadOf strings match a given URL, the longest match is
2452 used. If a remote has an explicit pushurl, Git will ignore this
2453 setting for that remote.
2456 Your email address to be recorded in any newly created commits.
2457 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2458 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2461 Your full name to be recorded in any newly created commits.
2462 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2463 environment variables. See linkgit:git-commit-tree[1].
2465 user.signingkey::
2466 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2467 key you want it to automatically when creating a signed tag or
2468 commit, you can override the default selection with this variable.
2469 This option is passed unchanged to gpg's --local-user parameter,
2470 so you may specify a key using any method that gpg supports.
2472 web.browser::
2473 Specify a web browser that may be used by some commands.
2474 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2475 may use it.