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