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