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