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