]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/config.txt
Merge branch 'nd/columns'
[thirdparty/git.git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
10
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
18
19 Syntax
20 ~~~~~~
21
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
25
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
32
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
36
37 --------
38 [section "subsection"]
39
40 --------
41
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
48
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
53
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
62
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
65
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
71
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
78
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). No other char escape sequence, nor octal
82 char sequences are valid.
83
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
86
87 Some variables may require a special value format.
88
89 Includes
90 ~~~~~~~~
91
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
101
102 Example
103 ~~~~~~~
104
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
109
110 # Our diff algorithm
111 [diff]
112 external = /usr/local/bin/diff-wrapper
113 renames = true
114
115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
118
119 # Proxy settings
120 [core]
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
123
124 [include]
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
128
129 Variables
130 ~~~~~~~~~
131
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
136
137 advice.*::
138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
141 +
142 --
143 pushNonFastForward::
144 Set this variable to 'false' if you want to disable
145 'pushNonFFCurrent', 'pushNonFFDefault', and
146 'pushNonFFMatching' simultaneously.
147 pushNonFFCurrent::
148 Advice shown when linkgit:git-push[1] fails due to a
149 non-fast-forward update to the current branch.
150 pushNonFFDefault::
151 Advice to set 'push.default' to 'upstream' or 'current'
152 when you ran linkgit:git-push[1] and pushed 'matching
153 refs' by default (i.e. you did not provide an explicit
154 refspec, and no 'push.default' configuration was set)
155 and it resulted in a non-fast-forward error.
156 pushNonFFMatching::
157 Advice shown when you ran linkgit:git-push[1] and pushed
158 'matching refs' explicitly (i.e. you used ':', or
159 specified a refspec that isn't your current branch) and
160 it resulted in a non-fast-forward error.
161 statusHints::
162 Directions on how to stage/unstage/add shown in the
163 output of linkgit:git-status[1] and the template shown
164 when writing commit messages.
165 commitBeforeMerge::
166 Advice shown when linkgit:git-merge[1] refuses to
167 merge to avoid overwriting local changes.
168 resolveConflict::
169 Advices shown by various commands when conflicts
170 prevent the operation from being performed.
171 implicitIdentity::
172 Advice on how to set your identity configuration when
173 your information is guessed from the system username and
174 domain name.
175 detachedHead::
176 Advice shown when you used linkgit:git-checkout[1] to
177 move to the detach HEAD state, to instruct how to create
178 a local branch after the fact.
179 --
180
181 core.fileMode::
182 If false, the executable bit differences between the index and
183 the working tree are ignored; useful on broken filesystems like FAT.
184 See linkgit:git-update-index[1].
185 +
186 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
187 will probe and set core.fileMode false if appropriate when the
188 repository is created.
189
190 core.ignoreCygwinFSTricks::
191 This option is only used by Cygwin implementation of Git. If false,
192 the Cygwin stat() and lstat() functions are used. This may be useful
193 if your repository consists of a few separate directories joined in
194 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
195 whenever it is possible and falls back to Cygwin functions only to
196 handle symbol links. The native mode is more than twice faster than
197 normal Cygwin l/stat() functions. True by default, unless core.filemode
198 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
199 POSIX emulation is required to support core.filemode.
200
201 core.ignorecase::
202 If true, this option enables various workarounds to enable
203 git to work better on filesystems that are not case sensitive,
204 like FAT. For example, if a directory listing finds
205 "makefile" when git expects "Makefile", git will assume
206 it is really the same file, and continue to remember it as
207 "Makefile".
208 +
209 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
210 will probe and set core.ignorecase true if appropriate when the repository
211 is created.
212
213 core.trustctime::
214 If false, the ctime differences between the index and the
215 working tree are ignored; useful when the inode change time
216 is regularly modified by something outside Git (file system
217 crawlers and some backup systems).
218 See linkgit:git-update-index[1]. True by default.
219
220 core.quotepath::
221 The commands that output paths (e.g. 'ls-files',
222 'diff'), when not given the `-z` option, will quote
223 "unusual" characters in the pathname by enclosing the
224 pathname in a double-quote pair and with backslashes the
225 same way strings in C source code are quoted. If this
226 variable is set to false, the bytes higher than 0x80 are
227 not quoted but output as verbatim. Note that double
228 quote, backslash and control characters are always
229 quoted without `-z` regardless of the setting of this
230 variable.
231
232 core.eol::
233 Sets the line ending type to use in the working directory for
234 files that have the `text` property set. Alternatives are
235 'lf', 'crlf' and 'native', which uses the platform's native
236 line ending. The default value is `native`. See
237 linkgit:gitattributes[5] for more information on end-of-line
238 conversion.
239
240 core.safecrlf::
241 If true, makes git check if converting `CRLF` is reversible when
242 end-of-line conversion is active. Git will verify if a command
243 modifies a file in the work tree either directly or indirectly.
244 For example, committing a file followed by checking out the
245 same file should yield the original file in the work tree. If
246 this is not the case for the current setting of
247 `core.autocrlf`, git will reject the file. The variable can
248 be set to "warn", in which case git will only warn about an
249 irreversible conversion but continue the operation.
250 +
251 CRLF conversion bears a slight chance of corrupting data.
252 When it is enabled, git will convert CRLF to LF during commit and LF to
253 CRLF during checkout. A file that contains a mixture of LF and
254 CRLF before the commit cannot be recreated by git. For text
255 files this is the right thing to do: it corrects line endings
256 such that we have only LF line endings in the repository.
257 But for binary files that are accidentally classified as text the
258 conversion can corrupt data.
259 +
260 If you recognize such corruption early you can easily fix it by
261 setting the conversion type explicitly in .gitattributes. Right
262 after committing you still have the original file in your work
263 tree and this file is not yet corrupted. You can explicitly tell
264 git that this file is binary and git will handle the file
265 appropriately.
266 +
267 Unfortunately, the desired effect of cleaning up text files with
268 mixed line endings and the undesired effect of corrupting binary
269 files cannot be distinguished. In both cases CRLFs are removed
270 in an irreversible way. For text files this is the right thing
271 to do because CRLFs are line endings, while for binary files
272 converting CRLFs corrupts data.
273 +
274 Note, this safety check does not mean that a checkout will generate a
275 file identical to the original file for a different setting of
276 `core.eol` and `core.autocrlf`, but only for the current one. For
277 example, a text file with `LF` would be accepted with `core.eol=lf`
278 and could later be checked out with `core.eol=crlf`, in which case the
279 resulting file would contain `CRLF`, although the original file
280 contained `LF`. However, in both work trees the line endings would be
281 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
282 file with mixed line endings would be reported by the `core.safecrlf`
283 mechanism.
284
285 core.autocrlf::
286 Setting this variable to "true" is almost the same as setting
287 the `text` attribute to "auto" on all files except that text
288 files are not guaranteed to be normalized: files that contain
289 `CRLF` in the repository will not be touched. Use this
290 setting if you want to have `CRLF` line endings in your
291 working directory even though the repository does not have
292 normalized line endings. This variable can be set to 'input',
293 in which case no output conversion is performed.
294
295 core.symlinks::
296 If false, symbolic links are checked out as small plain files that
297 contain the link text. linkgit:git-update-index[1] and
298 linkgit:git-add[1] will not change the recorded type to regular
299 file. Useful on filesystems like FAT that do not support
300 symbolic links.
301 +
302 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
303 will probe and set core.symlinks false if appropriate when the repository
304 is created.
305
306 core.gitProxy::
307 A "proxy command" to execute (as 'command host port') instead
308 of establishing direct connection to the remote server when
309 using the git protocol for fetching. If the variable value is
310 in the "COMMAND for DOMAIN" format, the command is applied only
311 on hostnames ending with the specified domain string. This variable
312 may be set multiple times and is matched in the given order;
313 the first match wins.
314 +
315 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
316 (which always applies universally, without the special "for"
317 handling).
318 +
319 The special string `none` can be used as the proxy command to
320 specify that no proxy be used for a given domain pattern.
321 This is useful for excluding servers inside a firewall from
322 proxy use, while defaulting to a common proxy for external domains.
323
324 core.ignoreStat::
325 If true, commands which modify both the working tree and the index
326 will mark the updated paths with the "assume unchanged" bit in the
327 index. These marked files are then assumed to stay unchanged in the
328 working tree, until you mark them otherwise manually - Git will not
329 detect the file changes by lstat() calls. This is useful on systems
330 where those are very slow, such as Microsoft Windows.
331 See linkgit:git-update-index[1].
332 False by default.
333
334 core.preferSymlinkRefs::
335 Instead of the default "symref" format for HEAD
336 and other symbolic reference files, use symbolic links.
337 This is sometimes needed to work with old scripts that
338 expect HEAD to be a symbolic link.
339
340 core.bare::
341 If true this repository is assumed to be 'bare' and has no
342 working directory associated with it. If this is the case a
343 number of commands that require a working directory will be
344 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
345 +
346 This setting is automatically guessed by linkgit:git-clone[1] or
347 linkgit:git-init[1] when the repository was created. By default a
348 repository that ends in "/.git" is assumed to be not bare (bare =
349 false), while all other repositories are assumed to be bare (bare
350 = true).
351
352 core.worktree::
353 Set the path to the root of the working tree.
354 This can be overridden by the GIT_WORK_TREE environment
355 variable and the '--work-tree' command line option.
356 The value can be an absolute path or relative to the path to
357 the .git directory, which is either specified by --git-dir
358 or GIT_DIR, or automatically discovered.
359 If --git-dir or GIT_DIR is specified but none of
360 --work-tree, GIT_WORK_TREE and core.worktree is specified,
361 the current working directory is regarded as the top level
362 of your working tree.
363 +
364 Note that this variable is honored even when set in a configuration
365 file in a ".git" subdirectory of a directory and its value differs
366 from the latter directory (e.g. "/path/to/.git/config" has
367 core.worktree set to "/different/path"), which is most likely a
368 misconfiguration. Running git commands in the "/path/to" directory will
369 still use "/different/path" as the root of the work tree and can cause
370 confusion unless you know what you are doing (e.g. you are creating a
371 read-only snapshot of the same index to a location different from the
372 repository's usual working tree).
373
374 core.logAllRefUpdates::
375 Enable the reflog. Updates to a ref <ref> is logged to the file
376 "$GIT_DIR/logs/<ref>", by appending the new and old
377 SHA1, the date/time and the reason of the update, but
378 only when the file exists. If this configuration
379 variable is set to true, missing "$GIT_DIR/logs/<ref>"
380 file is automatically created for branch heads (i.e. under
381 refs/heads/), remote refs (i.e. under refs/remotes/),
382 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
383 +
384 This information can be used to determine what commit
385 was the tip of a branch "2 days ago".
386 +
387 This value is true by default in a repository that has
388 a working directory associated with it, and false by
389 default in a bare repository.
390
391 core.repositoryFormatVersion::
392 Internal variable identifying the repository format and layout
393 version.
394
395 core.sharedRepository::
396 When 'group' (or 'true'), the repository is made shareable between
397 several users in a group (making sure all the files and objects are
398 group-writable). When 'all' (or 'world' or 'everybody'), the
399 repository will be readable by all users, additionally to being
400 group-shareable. When 'umask' (or 'false'), git will use permissions
401 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
402 files in the repository will have this mode value. '0xxx' will override
403 user's umask value (whereas the other options will only override
404 requested parts of the user's umask value). Examples: '0660' will make
405 the repo read/write-able for the owner and group, but inaccessible to
406 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
407 repository that is group-readable but not group-writable.
408 See linkgit:git-init[1]. False by default.
409
410 core.warnAmbiguousRefs::
411 If true, git will warn you if the ref name you passed it is ambiguous
412 and might match multiple refs in the .git/refs/ tree. True by default.
413
414 core.compression::
415 An integer -1..9, indicating a default compression level.
416 -1 is the zlib default. 0 means no compression,
417 and 1..9 are various speed/size tradeoffs, 9 being slowest.
418 If set, this provides a default to other compression variables,
419 such as 'core.loosecompression' and 'pack.compression'.
420
421 core.loosecompression::
422 An integer -1..9, indicating the compression level for objects that
423 are not in a pack file. -1 is the zlib default. 0 means no
424 compression, and 1..9 are various speed/size tradeoffs, 9 being
425 slowest. If not set, defaults to core.compression. If that is
426 not set, defaults to 1 (best speed).
427
428 core.packedGitWindowSize::
429 Number of bytes of a pack file to map into memory in a
430 single mapping operation. Larger window sizes may allow
431 your system to process a smaller number of large pack files
432 more quickly. Smaller window sizes will negatively affect
433 performance due to increased calls to the operating system's
434 memory manager, but may improve performance when accessing
435 a large number of large pack files.
436 +
437 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
438 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
439 be reasonable for all users/operating systems. You probably do
440 not need to adjust this value.
441 +
442 Common unit suffixes of 'k', 'm', or 'g' are supported.
443
444 core.packedGitLimit::
445 Maximum number of bytes to map simultaneously into memory
446 from pack files. If Git needs to access more than this many
447 bytes at once to complete an operation it will unmap existing
448 regions to reclaim virtual address space within the process.
449 +
450 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
451 This should be reasonable for all users/operating systems, except on
452 the largest projects. You probably do not need to adjust this value.
453 +
454 Common unit suffixes of 'k', 'm', or 'g' are supported.
455
456 core.deltaBaseCacheLimit::
457 Maximum number of bytes to reserve for caching base objects
458 that may be referenced by multiple deltified objects. By storing the
459 entire decompressed base objects in a cache Git is able
460 to avoid unpacking and decompressing frequently used base
461 objects multiple times.
462 +
463 Default is 16 MiB on all platforms. This should be reasonable
464 for all users/operating systems, except on the largest projects.
465 You probably do not need to adjust this value.
466 +
467 Common unit suffixes of 'k', 'm', or 'g' are supported.
468
469 core.bigFileThreshold::
470 Files larger than this size are stored deflated, without
471 attempting delta compression. Storing large files without
472 delta compression avoids excessive memory usage, at the
473 slight expense of increased disk usage.
474 +
475 Default is 512 MiB on all platforms. This should be reasonable
476 for most projects as source code and other text files can still
477 be delta compressed, but larger binary media files won't be.
478 +
479 Common unit suffixes of 'k', 'm', or 'g' are supported.
480
481 core.excludesfile::
482 In addition to '.gitignore' (per-directory) and
483 '.git/info/exclude', git looks into this file for patterns
484 of files which are not meant to be tracked. "`~/`" is expanded
485 to the value of `$HOME` and "`~user/`" to the specified user's
486 home directory. See linkgit:gitignore[5].
487
488 core.askpass::
489 Some commands (e.g. svn and http interfaces) that interactively
490 ask for a password can be told to use an external program given
491 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
492 environment variable. If not set, fall back to the value of the
493 'SSH_ASKPASS' environment variable or, failing that, a simple password
494 prompt. The external program shall be given a suitable prompt as
495 command line argument and write the password on its STDOUT.
496
497 core.attributesfile::
498 In addition to '.gitattributes' (per-directory) and
499 '.git/info/attributes', git looks into this file for attributes
500 (see linkgit:gitattributes[5]). Path expansions are made the same
501 way as for `core.excludesfile`.
502
503 core.editor::
504 Commands such as `commit` and `tag` that lets you edit
505 messages by launching an editor uses the value of this
506 variable when it is set, and the environment variable
507 `GIT_EDITOR` is not set. See linkgit:git-var[1].
508
509 sequence.editor::
510 Text editor used by `git rebase -i` for editing the rebase insn file.
511 The value is meant to be interpreted by the shell when it is used.
512 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
513 When not configured the default commit message editor is used instead.
514
515 core.pager::
516 The command that git will use to paginate output. Can
517 be overridden with the `GIT_PAGER` environment
518 variable. Note that git sets the `LESS` environment
519 variable to `FRSX` if it is unset when it runs the
520 pager. One can change these settings by setting the
521 `LESS` variable to some other value. Alternately,
522 these settings can be overridden on a project or
523 global basis by setting the `core.pager` option.
524 Setting `core.pager` has no affect on the `LESS`
525 environment variable behaviour above, so if you want
526 to override git's default settings this way, you need
527 to be explicit. For example, to disable the S option
528 in a backward compatible manner, set `core.pager`
529 to `less -+$LESS -FRX`. This will be passed to the
530 shell by git, which will translate the final command to
531 `LESS=FRSX less -+FRSX -FRX`.
532
533 core.whitespace::
534 A comma separated list of common whitespace problems to
535 notice. 'git diff' will use `color.diff.whitespace` to
536 highlight them, and 'git apply --whitespace=error' will
537 consider them as errors. You can prefix `-` to disable
538 any of them (e.g. `-trailing-space`):
539 +
540 * `blank-at-eol` treats trailing whitespaces at the end of the line
541 as an error (enabled by default).
542 * `space-before-tab` treats a space character that appears immediately
543 before a tab character in the initial indent part of the line as an
544 error (enabled by default).
545 * `indent-with-non-tab` treats a line that is indented with 8 or more
546 space characters as an error (not enabled by default).
547 * `tab-in-indent` treats a tab character in the initial indent part of
548 the line as an error (not enabled by default).
549 * `blank-at-eof` treats blank lines added at the end of file as an error
550 (enabled by default).
551 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
552 `blank-at-eof`.
553 * `cr-at-eol` treats a carriage-return at the end of line as
554 part of the line terminator, i.e. with it, `trailing-space`
555 does not trigger if the character before such a carriage-return
556 is not a whitespace (not enabled by default).
557 * `tabwidth=<n>` tells how many character positions a tab occupies; this
558 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
559 errors. The default tab width is 8. Allowed values are 1 to 63.
560
561 core.fsyncobjectfiles::
562 This boolean will enable 'fsync()' when writing object files.
563 +
564 This is a total waste of time and effort on a filesystem that orders
565 data writes properly, but can be useful for filesystems that do not use
566 journalling (traditional UNIX filesystems) or that only journal metadata
567 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
568
569 core.preloadindex::
570 Enable parallel index preload for operations like 'git diff'
571 +
572 This can speed up operations like 'git diff' and 'git status' especially
573 on filesystems like NFS that have weak caching semantics and thus
574 relatively high IO latencies. With this set to 'true', git will do the
575 index comparison to the filesystem data in parallel, allowing
576 overlapping IO's.
577
578 core.createObject::
579 You can set this to 'link', in which case a hardlink followed by
580 a delete of the source are used to make sure that object creation
581 will not overwrite existing objects.
582 +
583 On some file system/operating system combinations, this is unreliable.
584 Set this config setting to 'rename' there; However, This will remove the
585 check that makes sure that existing object files will not get overwritten.
586
587 core.notesRef::
588 When showing commit messages, also show notes which are stored in
589 the given ref. The ref must be fully qualified. If the given
590 ref does not exist, it is not an error but means that no
591 notes should be printed.
592 +
593 This setting defaults to "refs/notes/commits", and it can be overridden by
594 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
595
596 core.sparseCheckout::
597 Enable "sparse checkout" feature. See section "Sparse checkout" in
598 linkgit:git-read-tree[1] for more information.
599
600 core.abbrev::
601 Set the length object names are abbreviated to. If unspecified,
602 many commands abbreviate to 7 hexdigits, which may not be enough
603 for abbreviated object names to stay unique for sufficiently long
604 time.
605
606 add.ignore-errors::
607 add.ignoreErrors::
608 Tells 'git add' to continue adding files when some files cannot be
609 added due to indexing errors. Equivalent to the '--ignore-errors'
610 option of linkgit:git-add[1]. Older versions of git accept only
611 `add.ignore-errors`, which does not follow the usual naming
612 convention for configuration variables. Newer versions of git
613 honor `add.ignoreErrors` as well.
614
615 alias.*::
616 Command aliases for the linkgit:git[1] command wrapper - e.g.
617 after defining "alias.last = cat-file commit HEAD", the invocation
618 "git last" is equivalent to "git cat-file commit HEAD". To avoid
619 confusion and troubles with script usage, aliases that
620 hide existing git commands are ignored. Arguments are split by
621 spaces, the usual shell quoting and escaping is supported.
622 quote pair and a backslash can be used to quote them.
623 +
624 If the alias expansion is prefixed with an exclamation point,
625 it will be treated as a shell command. For example, defining
626 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
627 "git new" is equivalent to running the shell command
628 "gitk --all --not ORIG_HEAD". Note that shell commands will be
629 executed from the top-level directory of a repository, which may
630 not necessarily be the current directory.
631 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
632 from the original current directory. See linkgit:git-rev-parse[1].
633
634 am.keepcr::
635 If true, git-am will call git-mailsplit for patches in mbox format
636 with parameter '--keep-cr'. In this case git-mailsplit will
637 not remove `\r` from lines ending with `\r\n`. Can be overridden
638 by giving '--no-keep-cr' from the command line.
639 See linkgit:git-am[1], linkgit:git-mailsplit[1].
640
641 apply.ignorewhitespace::
642 When set to 'change', tells 'git apply' to ignore changes in
643 whitespace, in the same way as the '--ignore-space-change'
644 option.
645 When set to one of: no, none, never, false tells 'git apply' to
646 respect all whitespace differences.
647 See linkgit:git-apply[1].
648
649 apply.whitespace::
650 Tells 'git apply' how to handle whitespaces, in the same way
651 as the '--whitespace' option. See linkgit:git-apply[1].
652
653 branch.autosetupmerge::
654 Tells 'git branch' and 'git checkout' to set up new branches
655 so that linkgit:git-pull[1] will appropriately merge from the
656 starting point branch. Note that even if this option is not set,
657 this behavior can be chosen per-branch using the `--track`
658 and `--no-track` options. The valid settings are: `false` -- no
659 automatic setup is done; `true` -- automatic setup is done when the
660 starting point is a remote-tracking branch; `always` --
661 automatic setup is done when the starting point is either a
662 local branch or remote-tracking
663 branch. This option defaults to true.
664
665 branch.autosetuprebase::
666 When a new branch is created with 'git branch' or 'git checkout'
667 that tracks another branch, this variable tells git to set
668 up pull to rebase instead of merge (see "branch.<name>.rebase").
669 When `never`, rebase is never automatically set to true.
670 When `local`, rebase is set to true for tracked branches of
671 other local branches.
672 When `remote`, rebase is set to true for tracked branches of
673 remote-tracking branches.
674 When `always`, rebase will be set to true for all tracking
675 branches.
676 See "branch.autosetupmerge" for details on how to set up a
677 branch to track another branch.
678 This option defaults to never.
679
680 branch.<name>.remote::
681 When in branch <name>, it tells 'git fetch' and 'git push' which
682 remote to fetch from/push to. It defaults to `origin` if no remote is
683 configured. `origin` is also used if you are not on any branch.
684
685 branch.<name>.merge::
686 Defines, together with branch.<name>.remote, the upstream branch
687 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
688 branch to merge and can also affect 'git push' (see push.default).
689 When in branch <name>, it tells 'git fetch' the default
690 refspec to be marked for merging in FETCH_HEAD. The value is
691 handled like the remote part of a refspec, and must match a
692 ref which is fetched from the remote given by
693 "branch.<name>.remote".
694 The merge information is used by 'git pull' (which at first calls
695 'git fetch') to lookup the default branch for merging. Without
696 this option, 'git pull' defaults to merge the first refspec fetched.
697 Specify multiple values to get an octopus merge.
698 If you wish to setup 'git pull' so that it merges into <name> from
699 another branch in the local repository, you can point
700 branch.<name>.merge to the desired branch, and use the special setting
701 `.` (a period) for branch.<name>.remote.
702
703 branch.<name>.mergeoptions::
704 Sets default options for merging into branch <name>. The syntax and
705 supported options are the same as those of linkgit:git-merge[1], but
706 option values containing whitespace characters are currently not
707 supported.
708
709 branch.<name>.rebase::
710 When true, rebase the branch <name> on top of the fetched branch,
711 instead of merging the default branch from the default remote when
712 "git pull" is run. See "pull.rebase" for doing this in a non
713 branch-specific manner.
714 +
715 *NOTE*: this is a possibly dangerous operation; do *not* use
716 it unless you understand the implications (see linkgit:git-rebase[1]
717 for details).
718
719 browser.<tool>.cmd::
720 Specify the command to invoke the specified browser. The
721 specified command is evaluated in shell with the URLs passed
722 as arguments. (See linkgit:git-web{litdd}browse[1].)
723
724 browser.<tool>.path::
725 Override the path for the given tool that may be used to
726 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
727 working repository in gitweb (see linkgit:git-instaweb[1]).
728
729 clean.requireForce::
730 A boolean to make git-clean do nothing unless given -f
731 or -n. Defaults to true.
732
733 color.branch::
734 A boolean to enable/disable color in the output of
735 linkgit:git-branch[1]. May be set to `always`,
736 `false` (or `never`) or `auto` (or `true`), in which case colors are used
737 only when the output is to a terminal. Defaults to false.
738
739 color.branch.<slot>::
740 Use customized color for branch coloration. `<slot>` is one of
741 `current` (the current branch), `local` (a local branch),
742 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
743 refs).
744 +
745 The value for these configuration variables is a list of colors (at most
746 two) and attributes (at most one), separated by spaces. The colors
747 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
748 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
749 `blink` and `reverse`. The first color given is the foreground; the
750 second is the background. The position of the attribute, if any,
751 doesn't matter.
752
753 color.diff::
754 Whether to use ANSI escape sequences to add color to patches.
755 If this is set to `always`, linkgit:git-diff[1],
756 linkgit:git-log[1], and linkgit:git-show[1] will use color
757 for all patches. If it is set to `true` or `auto`, those
758 commands will only use color when output is to the terminal.
759 Defaults to false.
760 +
761 This does not affect linkgit:git-format-patch[1] nor the
762 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
763 command line with the `--color[=<when>]` option.
764
765 color.diff.<slot>::
766 Use customized color for diff colorization. `<slot>` specifies
767 which part of the patch to use the specified color, and is one
768 of `plain` (context text), `meta` (metainformation), `frag`
769 (hunk header), 'func' (function in hunk header), `old` (removed lines),
770 `new` (added lines), `commit` (commit headers), or `whitespace`
771 (highlighting whitespace errors). The values of these variables may be
772 specified as in color.branch.<slot>.
773
774 color.decorate.<slot>::
775 Use customized color for 'git log --decorate' output. `<slot>` is one
776 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
777 branches, remote-tracking branches, tags, stash and HEAD, respectively.
778
779 color.grep::
780 When set to `always`, always highlight matches. When `false` (or
781 `never`), never. When set to `true` or `auto`, use color only
782 when the output is written to the terminal. Defaults to `false`.
783
784 color.grep.<slot>::
785 Use customized color for grep colorization. `<slot>` specifies which
786 part of the line to use the specified color, and is one of
787 +
788 --
789 `context`;;
790 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
791 `filename`;;
792 filename prefix (when not using `-h`)
793 `function`;;
794 function name lines (when using `-p`)
795 `linenumber`;;
796 line number prefix (when using `-n`)
797 `match`;;
798 matching text
799 `selected`;;
800 non-matching text in selected lines
801 `separator`;;
802 separators between fields on a line (`:`, `-`, and `=`)
803 and between hunks (`--`)
804 --
805 +
806 The values of these variables may be specified as in color.branch.<slot>.
807
808 color.interactive::
809 When set to `always`, always use colors for interactive prompts
810 and displays (such as those used by "git-add --interactive").
811 When false (or `never`), never. When set to `true` or `auto`, use
812 colors only when the output is to the terminal. Defaults to false.
813
814 color.interactive.<slot>::
815 Use customized color for 'git add --interactive'
816 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
817 four distinct types of normal output from interactive
818 commands. The values of these variables may be specified as
819 in color.branch.<slot>.
820
821 color.pager::
822 A boolean to enable/disable colored output when the pager is in
823 use (default is true).
824
825 color.showbranch::
826 A boolean to enable/disable color in the output of
827 linkgit:git-show-branch[1]. May be set to `always`,
828 `false` (or `never`) or `auto` (or `true`), in which case colors are used
829 only when the output is to a terminal. Defaults to false.
830
831 color.status::
832 A boolean to enable/disable color in the output of
833 linkgit:git-status[1]. May be set to `always`,
834 `false` (or `never`) or `auto` (or `true`), in which case colors are used
835 only when the output is to a terminal. Defaults to false.
836
837 color.status.<slot>::
838 Use customized color for status colorization. `<slot>` is
839 one of `header` (the header text of the status message),
840 `added` or `updated` (files which are added but not committed),
841 `changed` (files which are changed but not added in the index),
842 `untracked` (files which are not tracked by git),
843 `branch` (the current branch), or
844 `nobranch` (the color the 'no branch' warning is shown in, defaulting
845 to red). The values of these variables may be specified as in
846 color.branch.<slot>.
847
848 color.ui::
849 This variable determines the default value for variables such
850 as `color.diff` and `color.grep` that control the use of color
851 per command family. Its scope will expand as more commands learn
852 configuration to set a default for the `--color` option. Set it
853 to `always` if you want all output not intended for machine
854 consumption to use color, to `true` or `auto` if you want such
855 output to use color when written to the terminal, or to `false` or
856 `never` if you prefer git commands not to use color unless enabled
857 explicitly with some other configuration or the `--color` option.
858
859 column.ui::
860 Specify whether supported commands should output in columns.
861 This variable consists of a list of tokens separated by spaces
862 or commas:
863 +
864 --
865 `always`;;
866 always show in columns
867 `never`;;
868 never show in columns
869 `auto`;;
870 show in columns if the output is to the terminal
871 `column`;;
872 fill columns before rows (default)
873 `row`;;
874 fill rows before columns
875 `plain`;;
876 show in one column
877 `dense`;;
878 make unequal size columns to utilize more space
879 `nodense`;;
880 make equal size columns
881 --
882 +
883 This option defaults to 'never'.
884
885 column.branch::
886 Specify whether to output branch listing in `git branch` in columns.
887 See `column.ui` for details.
888
889 column.status::
890 Specify whether to output untracked files in `git status` in columns.
891 See `column.ui` for details.
892
893 column.tag::
894 Specify whether to output tag listing in `git tag` in columns.
895 See `column.ui` for details.
896
897 commit.status::
898 A boolean to enable/disable inclusion of status information in the
899 commit message template when using an editor to prepare the commit
900 message. Defaults to true.
901
902 commit.template::
903 Specify a file to use as the template for new commit messages.
904 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
905 specified user's home directory.
906
907 credential.helper::
908 Specify an external helper to be called when a username or
909 password credential is needed; the helper may consult external
910 storage to avoid prompting the user for the credentials. See
911 linkgit:gitcredentials[7] for details.
912
913 credential.useHttpPath::
914 When acquiring credentials, consider the "path" component of an http
915 or https URL to be important. Defaults to false. See
916 linkgit:gitcredentials[7] for more information.
917
918 credential.username::
919 If no username is set for a network authentication, use this username
920 by default. See credential.<context>.* below, and
921 linkgit:gitcredentials[7].
922
923 credential.<url>.*::
924 Any of the credential.* options above can be applied selectively to
925 some credentials. For example "credential.https://example.com.username"
926 would set the default username only for https connections to
927 example.com. See linkgit:gitcredentials[7] for details on how URLs are
928 matched.
929
930 include::diff-config.txt[]
931
932 difftool.<tool>.path::
933 Override the path for the given tool. This is useful in case
934 your tool is not in the PATH.
935
936 difftool.<tool>.cmd::
937 Specify the command to invoke the specified diff tool.
938 The specified command is evaluated in shell with the following
939 variables available: 'LOCAL' is set to the name of the temporary
940 file containing the contents of the diff pre-image and 'REMOTE'
941 is set to the name of the temporary file containing the contents
942 of the diff post-image.
943
944 difftool.prompt::
945 Prompt before each invocation of the diff tool.
946
947 diff.wordRegex::
948 A POSIX Extended Regular Expression used to determine what is a "word"
949 when performing word-by-word difference calculations. Character
950 sequences that match the regular expression are "words", all other
951 characters are *ignorable* whitespace.
952
953 fetch.recurseSubmodules::
954 This option can be either set to a boolean value or to 'on-demand'.
955 Setting it to a boolean changes the behavior of fetch and pull to
956 unconditionally recurse into submodules when set to true or to not
957 recurse at all when set to false. When set to 'on-demand' (the default
958 value), fetch and pull will only recurse into a populated submodule
959 when its superproject retrieves a commit that updates the submodule's
960 reference.
961
962 fetch.fsckObjects::
963 If it is set to true, git-fetch-pack will check all fetched
964 objects. It will abort in the case of a malformed object or a
965 broken link. The result of an abort are only dangling objects.
966 Defaults to false. If not set, the value of `transfer.fsckObjects`
967 is used instead.
968
969 fetch.unpackLimit::
970 If the number of objects fetched over the git native
971 transfer is below this
972 limit, then the objects will be unpacked into loose object
973 files. However if the number of received objects equals or
974 exceeds this limit then the received pack will be stored as
975 a pack, after adding any missing delta bases. Storing the
976 pack from a push can make the push operation complete faster,
977 especially on slow filesystems. If not set, the value of
978 `transfer.unpackLimit` is used instead.
979
980 format.attach::
981 Enable multipart/mixed attachments as the default for
982 'format-patch'. The value can also be a double quoted string
983 which will enable attachments as the default and set the
984 value as the boundary. See the --attach option in
985 linkgit:git-format-patch[1].
986
987 format.numbered::
988 A boolean which can enable or disable sequence numbers in patch
989 subjects. It defaults to "auto" which enables it only if there
990 is more than one patch. It can be enabled or disabled for all
991 messages by setting it to "true" or "false". See --numbered
992 option in linkgit:git-format-patch[1].
993
994 format.headers::
995 Additional email headers to include in a patch to be submitted
996 by mail. See linkgit:git-format-patch[1].
997
998 format.to::
999 format.cc::
1000 Additional recipients to include in a patch to be submitted
1001 by mail. See the --to and --cc options in
1002 linkgit:git-format-patch[1].
1003
1004 format.subjectprefix::
1005 The default for format-patch is to output files with the '[PATCH]'
1006 subject prefix. Use this variable to change that prefix.
1007
1008 format.signature::
1009 The default for format-patch is to output a signature containing
1010 the git version number. Use this variable to change that default.
1011 Set this variable to the empty string ("") to suppress
1012 signature generation.
1013
1014 format.suffix::
1015 The default for format-patch is to output files with the suffix
1016 `.patch`. Use this variable to change that suffix (make sure to
1017 include the dot if you want it).
1018
1019 format.pretty::
1020 The default pretty format for log/show/whatchanged command,
1021 See linkgit:git-log[1], linkgit:git-show[1],
1022 linkgit:git-whatchanged[1].
1023
1024 format.thread::
1025 The default threading style for 'git format-patch'. Can be
1026 a boolean value, or `shallow` or `deep`. `shallow` threading
1027 makes every mail a reply to the head of the series,
1028 where the head is chosen from the cover letter, the
1029 `--in-reply-to`, and the first patch mail, in this order.
1030 `deep` threading makes every mail a reply to the previous one.
1031 A true boolean value is the same as `shallow`, and a false
1032 value disables threading.
1033
1034 format.signoff::
1035 A boolean value which lets you enable the `-s/--signoff` option of
1036 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1037 patch should be a conscious act and means that you certify you have
1038 the rights to submit this work under the same open source license.
1039 Please see the 'SubmittingPatches' document for further discussion.
1040
1041 filter.<driver>.clean::
1042 The command which is used to convert the content of a worktree
1043 file to a blob upon checkin. See linkgit:gitattributes[5] for
1044 details.
1045
1046 filter.<driver>.smudge::
1047 The command which is used to convert the content of a blob
1048 object to a worktree file upon checkout. See
1049 linkgit:gitattributes[5] for details.
1050
1051 gc.aggressiveWindow::
1052 The window size parameter used in the delta compression
1053 algorithm used by 'git gc --aggressive'. This defaults
1054 to 250.
1055
1056 gc.auto::
1057 When there are approximately more than this many loose
1058 objects in the repository, `git gc --auto` will pack them.
1059 Some Porcelain commands use this command to perform a
1060 light-weight garbage collection from time to time. The
1061 default value is 6700. Setting this to 0 disables it.
1062
1063 gc.autopacklimit::
1064 When there are more than this many packs that are not
1065 marked with `*.keep` file in the repository, `git gc
1066 --auto` consolidates them into one larger pack. The
1067 default value is 50. Setting this to 0 disables it.
1068
1069 gc.packrefs::
1070 Running `git pack-refs` in a repository renders it
1071 unclonable by Git versions prior to 1.5.1.2 over dumb
1072 transports such as HTTP. This variable determines whether
1073 'git gc' runs `git pack-refs`. This can be set to `notbare`
1074 to enable it within all non-bare repos or it can be set to a
1075 boolean value. The default is `true`.
1076
1077 gc.pruneexpire::
1078 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1079 Override the grace period with this config variable. The value
1080 "now" may be used to disable this grace period and always prune
1081 unreachable objects immediately.
1082
1083 gc.reflogexpire::
1084 gc.<pattern>.reflogexpire::
1085 'git reflog expire' removes reflog entries older than
1086 this time; defaults to 90 days. With "<pattern>" (e.g.
1087 "refs/stash") in the middle the setting applies only to
1088 the refs that match the <pattern>.
1089
1090 gc.reflogexpireunreachable::
1091 gc.<ref>.reflogexpireunreachable::
1092 'git reflog expire' removes reflog entries older than
1093 this time and are not reachable from the current tip;
1094 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1095 in the middle, the setting applies only to the refs that
1096 match the <pattern>.
1097
1098 gc.rerereresolved::
1099 Records of conflicted merge you resolved earlier are
1100 kept for this many days when 'git rerere gc' is run.
1101 The default is 60 days. See linkgit:git-rerere[1].
1102
1103 gc.rerereunresolved::
1104 Records of conflicted merge you have not resolved are
1105 kept for this many days when 'git rerere gc' is run.
1106 The default is 15 days. See linkgit:git-rerere[1].
1107
1108 gitcvs.commitmsgannotation::
1109 Append this string to each commit message. Set to empty string
1110 to disable this feature. Defaults to "via git-CVS emulator".
1111
1112 gitcvs.enabled::
1113 Whether the CVS server interface is enabled for this repository.
1114 See linkgit:git-cvsserver[1].
1115
1116 gitcvs.logfile::
1117 Path to a log file where the CVS server interface well... logs
1118 various stuff. See linkgit:git-cvsserver[1].
1119
1120 gitcvs.usecrlfattr::
1121 If true, the server will look up the end-of-line conversion
1122 attributes for files to determine the '-k' modes to use. If
1123 the attributes force git to treat a file as text,
1124 the '-k' mode will be left blank so CVS clients will
1125 treat it as text. If they suppress text conversion, the file
1126 will be set with '-kb' mode, which suppresses any newline munging
1127 the client might otherwise do. If the attributes do not allow
1128 the file type to be determined, then 'gitcvs.allbinary' is
1129 used. See linkgit:gitattributes[5].
1130
1131 gitcvs.allbinary::
1132 This is used if 'gitcvs.usecrlfattr' does not resolve
1133 the correct '-kb' mode to use. If true, all
1134 unresolved files are sent to the client in
1135 mode '-kb'. This causes the client to treat them
1136 as binary files, which suppresses any newline munging it
1137 otherwise might do. Alternatively, if it is set to "guess",
1138 then the contents of the file are examined to decide if
1139 it is binary, similar to 'core.autocrlf'.
1140
1141 gitcvs.dbname::
1142 Database used by git-cvsserver to cache revision information
1143 derived from the git repository. The exact meaning depends on the
1144 used database driver, for SQLite (which is the default driver) this
1145 is a filename. Supports variable substitution (see
1146 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1147 Default: '%Ggitcvs.%m.sqlite'
1148
1149 gitcvs.dbdriver::
1150 Used Perl DBI driver. You can specify any available driver
1151 for this here, but it might not work. git-cvsserver is tested
1152 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1153 reported *not* to work with 'DBD::mysql'. Experimental feature.
1154 May not contain double colons (`:`). Default: 'SQLite'.
1155 See linkgit:git-cvsserver[1].
1156
1157 gitcvs.dbuser, gitcvs.dbpass::
1158 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1159 since SQLite has no concept of database users and/or passwords.
1160 'gitcvs.dbuser' supports variable substitution (see
1161 linkgit:git-cvsserver[1] for details).
1162
1163 gitcvs.dbTableNamePrefix::
1164 Database table name prefix. Prepended to the names of any
1165 database tables used, allowing a single database to be used
1166 for several repositories. Supports variable substitution (see
1167 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1168 characters will be replaced with underscores.
1169
1170 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1171 'gitcvs.allbinary' can also be specified as
1172 'gitcvs.<access_method>.<varname>' (where 'access_method'
1173 is one of "ext" and "pserver") to make them apply only for the given
1174 access method.
1175
1176 gitweb.category::
1177 gitweb.description::
1178 gitweb.owner::
1179 gitweb.url::
1180 See linkgit:gitweb[1] for description.
1181
1182 gitweb.avatar::
1183 gitweb.blame::
1184 gitweb.grep::
1185 gitweb.highlight::
1186 gitweb.patches::
1187 gitweb.pickaxe::
1188 gitweb.remote_heads::
1189 gitweb.showsizes::
1190 gitweb.snapshot::
1191 See linkgit:gitweb.conf[5] for description.
1192
1193 grep.lineNumber::
1194 If set to true, enable '-n' option by default.
1195
1196 grep.extendedRegexp::
1197 If set to true, enable '--extended-regexp' option by default.
1198
1199 gpg.program::
1200 Use this custom program instead of "gpg" found on $PATH when
1201 making or verifying a PGP signature. The program must support the
1202 same command line interface as GPG, namely, to verify a detached
1203 signature, "gpg --verify $file - <$signature" is run, and the
1204 program is expected to signal a good signature by exiting with
1205 code 0, and to generate an ascii-armored detached signature, the
1206 standard input of "gpg -bsau $key" is fed with the contents to be
1207 signed, and the program is expected to send the result to its
1208 standard output.
1209
1210 gui.commitmsgwidth::
1211 Defines how wide the commit message window is in the
1212 linkgit:git-gui[1]. "75" is the default.
1213
1214 gui.diffcontext::
1215 Specifies how many context lines should be used in calls to diff
1216 made by the linkgit:git-gui[1]. The default is "5".
1217
1218 gui.encoding::
1219 Specifies the default encoding to use for displaying of
1220 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1221 It can be overridden by setting the 'encoding' attribute
1222 for relevant files (see linkgit:gitattributes[5]).
1223 If this option is not set, the tools default to the
1224 locale encoding.
1225
1226 gui.matchtrackingbranch::
1227 Determines if new branches created with linkgit:git-gui[1] should
1228 default to tracking remote branches with matching names or
1229 not. Default: "false".
1230
1231 gui.newbranchtemplate::
1232 Is used as suggested name when creating new branches using the
1233 linkgit:git-gui[1].
1234
1235 gui.pruneduringfetch::
1236 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1237 performing a fetch. The default value is "false".
1238
1239 gui.trustmtime::
1240 Determines if linkgit:git-gui[1] should trust the file modification
1241 timestamp or not. By default the timestamps are not trusted.
1242
1243 gui.spellingdictionary::
1244 Specifies the dictionary used for spell checking commit messages in
1245 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1246 off.
1247
1248 gui.fastcopyblame::
1249 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1250 location detection. It makes blame significantly faster on huge
1251 repositories at the expense of less thorough copy detection.
1252
1253 gui.copyblamethreshold::
1254 Specifies the threshold to use in 'git gui blame' original location
1255 detection, measured in alphanumeric characters. See the
1256 linkgit:git-blame[1] manual for more information on copy detection.
1257
1258 gui.blamehistoryctx::
1259 Specifies the radius of history context in days to show in
1260 linkgit:gitk[1] for the selected commit, when the `Show History
1261 Context` menu item is invoked from 'git gui blame'. If this
1262 variable is set to zero, the whole history is shown.
1263
1264 guitool.<name>.cmd::
1265 Specifies the shell command line to execute when the corresponding item
1266 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1267 mandatory for every tool. The command is executed from the root of
1268 the working directory, and in the environment it receives the name of
1269 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1270 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1271 the head is detached, 'CUR_BRANCH' is empty).
1272
1273 guitool.<name>.needsfile::
1274 Run the tool only if a diff is selected in the GUI. It guarantees
1275 that 'FILENAME' is not empty.
1276
1277 guitool.<name>.noconsole::
1278 Run the command silently, without creating a window to display its
1279 output.
1280
1281 guitool.<name>.norescan::
1282 Don't rescan the working directory for changes after the tool
1283 finishes execution.
1284
1285 guitool.<name>.confirm::
1286 Show a confirmation dialog before actually running the tool.
1287
1288 guitool.<name>.argprompt::
1289 Request a string argument from the user, and pass it to the tool
1290 through the 'ARGS' environment variable. Since requesting an
1291 argument implies confirmation, the 'confirm' option has no effect
1292 if this is enabled. If the option is set to 'true', 'yes', or '1',
1293 the dialog uses a built-in generic prompt; otherwise the exact
1294 value of the variable is used.
1295
1296 guitool.<name>.revprompt::
1297 Request a single valid revision from the user, and set the
1298 'REVISION' environment variable. In other aspects this option
1299 is similar to 'argprompt', and can be used together with it.
1300
1301 guitool.<name>.revunmerged::
1302 Show only unmerged branches in the 'revprompt' subdialog.
1303 This is useful for tools similar to merge or rebase, but not
1304 for things like checkout or reset.
1305
1306 guitool.<name>.title::
1307 Specifies the title to use for the prompt dialog. The default
1308 is the tool name.
1309
1310 guitool.<name>.prompt::
1311 Specifies the general prompt string to display at the top of
1312 the dialog, before subsections for 'argprompt' and 'revprompt'.
1313 The default value includes the actual command.
1314
1315 help.browser::
1316 Specify the browser that will be used to display help in the
1317 'web' format. See linkgit:git-help[1].
1318
1319 help.format::
1320 Override the default help format used by linkgit:git-help[1].
1321 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1322 the default. 'web' and 'html' are the same.
1323
1324 help.autocorrect::
1325 Automatically correct and execute mistyped commands after
1326 waiting for the given number of deciseconds (0.1 sec). If more
1327 than one command can be deduced from the entered text, nothing
1328 will be executed. If the value of this option is negative,
1329 the corrected command will be executed immediately. If the
1330 value is 0 - the command will be just shown but not executed.
1331 This is the default.
1332
1333 http.proxy::
1334 Override the HTTP proxy, normally configured using the 'http_proxy',
1335 'https_proxy', and 'all_proxy' environment variables (see
1336 `curl(1)`). This can be overridden on a per-remote basis; see
1337 remote.<name>.proxy
1338
1339 http.cookiefile::
1340 File containing previously stored cookie lines which should be used
1341 in the git http session, if they match the server. The file format
1342 of the file to read cookies from should be plain HTTP headers or
1343 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1344 NOTE that the file specified with http.cookiefile is only used as
1345 input. No cookies will be stored in the file.
1346
1347 http.sslVerify::
1348 Whether to verify the SSL certificate when fetching or pushing
1349 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1350 variable.
1351
1352 http.sslCert::
1353 File containing the SSL certificate when fetching or pushing
1354 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1355 variable.
1356
1357 http.sslKey::
1358 File containing the SSL private key when fetching or pushing
1359 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1360 variable.
1361
1362 http.sslCertPasswordProtected::
1363 Enable git's password prompt for the SSL certificate. Otherwise
1364 OpenSSL will prompt the user, possibly many times, if the
1365 certificate or private key is encrypted. Can be overridden by the
1366 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1367
1368 http.sslCAInfo::
1369 File containing the certificates to verify the peer with when
1370 fetching or pushing over HTTPS. Can be overridden by the
1371 'GIT_SSL_CAINFO' environment variable.
1372
1373 http.sslCAPath::
1374 Path containing files with the CA certificates to verify the peer
1375 with when fetching or pushing over HTTPS. Can be overridden
1376 by the 'GIT_SSL_CAPATH' environment variable.
1377
1378 http.maxRequests::
1379 How many HTTP requests to launch in parallel. Can be overridden
1380 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1381
1382 http.minSessions::
1383 The number of curl sessions (counted across slots) to be kept across
1384 requests. They will not be ended with curl_easy_cleanup() until
1385 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1386 value will be capped at 1. Defaults to 1.
1387
1388 http.postBuffer::
1389 Maximum size in bytes of the buffer used by smart HTTP
1390 transports when POSTing data to the remote system.
1391 For requests larger than this buffer size, HTTP/1.1 and
1392 Transfer-Encoding: chunked is used to avoid creating a
1393 massive pack file locally. Default is 1 MiB, which is
1394 sufficient for most requests.
1395
1396 http.lowSpeedLimit, http.lowSpeedTime::
1397 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1398 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1399 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1400 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1401
1402 http.noEPSV::
1403 A boolean which disables using of EPSV ftp command by curl.
1404 This can helpful with some "poor" ftp servers which don't
1405 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1406 environment variable. Default is false (curl will use EPSV).
1407
1408 http.useragent::
1409 The HTTP USER_AGENT string presented to an HTTP server. The default
1410 value represents the version of the client git such as git/1.7.1.
1411 This option allows you to override this value to a more common value
1412 such as Mozilla/4.0. This may be necessary, for instance, if
1413 connecting through a firewall that restricts HTTP connections to a set
1414 of common USER_AGENT strings (but not including those like git/1.7.1).
1415 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1416
1417 i18n.commitEncoding::
1418 Character encoding the commit messages are stored in; git itself
1419 does not care per se, but this information is necessary e.g. when
1420 importing commits from emails or in the gitk graphical history
1421 browser (and possibly at other places in the future or in other
1422 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1423
1424 i18n.logOutputEncoding::
1425 Character encoding the commit messages are converted to when
1426 running 'git log' and friends.
1427
1428 imap::
1429 The configuration variables in the 'imap' section are described
1430 in linkgit:git-imap-send[1].
1431
1432 init.templatedir::
1433 Specify the directory from which templates will be copied.
1434 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1435
1436 instaweb.browser::
1437 Specify the program that will be used to browse your working
1438 repository in gitweb. See linkgit:git-instaweb[1].
1439
1440 instaweb.httpd::
1441 The HTTP daemon command-line to start gitweb on your working
1442 repository. See linkgit:git-instaweb[1].
1443
1444 instaweb.local::
1445 If true the web server started by linkgit:git-instaweb[1] will
1446 be bound to the local IP (127.0.0.1).
1447
1448 instaweb.modulepath::
1449 The default module path for linkgit:git-instaweb[1] to use
1450 instead of /usr/lib/apache2/modules. Only used if httpd
1451 is Apache.
1452
1453 instaweb.port::
1454 The port number to bind the gitweb httpd to. See
1455 linkgit:git-instaweb[1].
1456
1457 interactive.singlekey::
1458 In interactive commands, allow the user to provide one-letter
1459 input with a single key (i.e., without hitting enter).
1460 Currently this is used by the `--patch` mode of
1461 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1462 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1463 setting is silently ignored if portable keystroke input
1464 is not available.
1465
1466 log.abbrevCommit::
1467 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1468 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1469 override this option with `--no-abbrev-commit`.
1470
1471 log.date::
1472 Set the default date-time mode for the 'log' command.
1473 Setting a value for log.date is similar to using 'git log''s
1474 `--date` option. Possible values are `relative`, `local`,
1475 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1476 for details.
1477
1478 log.decorate::
1479 Print out the ref names of any commits that are shown by the log
1480 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1481 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1482 specified, the full ref name (including prefix) will be printed.
1483 This is the same as the log commands '--decorate' option.
1484
1485 log.showroot::
1486 If true, the initial commit will be shown as a big creation event.
1487 This is equivalent to a diff against an empty tree.
1488 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1489 normally hide the root commit will now show it. True by default.
1490
1491 mailmap.file::
1492 The location of an augmenting mailmap file. The default
1493 mailmap, located in the root of the repository, is loaded
1494 first, then the mailmap file pointed to by this variable.
1495 The location of the mailmap file may be in a repository
1496 subdirectory, or somewhere outside of the repository itself.
1497 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1498
1499 man.viewer::
1500 Specify the programs that may be used to display help in the
1501 'man' format. See linkgit:git-help[1].
1502
1503 man.<tool>.cmd::
1504 Specify the command to invoke the specified man viewer. The
1505 specified command is evaluated in shell with the man page
1506 passed as argument. (See linkgit:git-help[1].)
1507
1508 man.<tool>.path::
1509 Override the path for the given tool that may be used to
1510 display help in the 'man' format. See linkgit:git-help[1].
1511
1512 include::merge-config.txt[]
1513
1514 mergetool.<tool>.path::
1515 Override the path for the given tool. This is useful in case
1516 your tool is not in the PATH.
1517
1518 mergetool.<tool>.cmd::
1519 Specify the command to invoke the specified merge tool. The
1520 specified command is evaluated in shell with the following
1521 variables available: 'BASE' is the name of a temporary file
1522 containing the common base of the files to be merged, if available;
1523 'LOCAL' is the name of a temporary file containing the contents of
1524 the file on the current branch; 'REMOTE' is the name of a temporary
1525 file containing the contents of the file from the branch being
1526 merged; 'MERGED' contains the name of the file to which the merge
1527 tool should write the results of a successful merge.
1528
1529 mergetool.<tool>.trustExitCode::
1530 For a custom merge command, specify whether the exit code of
1531 the merge command can be used to determine whether the merge was
1532 successful. If this is not set to true then the merge target file
1533 timestamp is checked and the merge assumed to have been successful
1534 if the file has been updated, otherwise the user is prompted to
1535 indicate the success of the merge.
1536
1537 mergetool.keepBackup::
1538 After performing a merge, the original file with conflict markers
1539 can be saved as a file with a `.orig` extension. If this variable
1540 is set to `false` then this file is not preserved. Defaults to
1541 `true` (i.e. keep the backup files).
1542
1543 mergetool.keepTemporaries::
1544 When invoking a custom merge tool, git uses a set of temporary
1545 files to pass to the tool. If the tool returns an error and this
1546 variable is set to `true`, then these temporary files will be
1547 preserved, otherwise they will be removed after the tool has
1548 exited. Defaults to `false`.
1549
1550 mergetool.prompt::
1551 Prompt before each invocation of the merge resolution program.
1552
1553 notes.displayRef::
1554 The (fully qualified) refname from which to show notes when
1555 showing commit messages. The value of this variable can be set
1556 to a glob, in which case notes from all matching refs will be
1557 shown. You may also specify this configuration variable
1558 several times. A warning will be issued for refs that do not
1559 exist, but a glob that does not match any refs is silently
1560 ignored.
1561 +
1562 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1563 environment variable, which must be a colon separated list of refs or
1564 globs.
1565 +
1566 The effective value of "core.notesRef" (possibly overridden by
1567 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1568 displayed.
1569
1570 notes.rewrite.<command>::
1571 When rewriting commits with <command> (currently `amend` or
1572 `rebase`) and this variable is set to `true`, git
1573 automatically copies your notes from the original to the
1574 rewritten commit. Defaults to `true`, but see
1575 "notes.rewriteRef" below.
1576
1577 notes.rewriteMode::
1578 When copying notes during a rewrite (see the
1579 "notes.rewrite.<command>" option), determines what to do if
1580 the target commit already has a note. Must be one of
1581 `overwrite`, `concatenate`, or `ignore`. Defaults to
1582 `concatenate`.
1583 +
1584 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1585 environment variable.
1586
1587 notes.rewriteRef::
1588 When copying notes during a rewrite, specifies the (fully
1589 qualified) ref whose notes should be copied. The ref may be a
1590 glob, in which case notes in all matching refs will be copied.
1591 You may also specify this configuration several times.
1592 +
1593 Does not have a default value; you must configure this variable to
1594 enable note rewriting. Set it to `refs/notes/commits` to enable
1595 rewriting for the default commit notes.
1596 +
1597 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1598 environment variable, which must be a colon separated list of refs or
1599 globs.
1600
1601 pack.window::
1602 The size of the window used by linkgit:git-pack-objects[1] when no
1603 window size is given on the command line. Defaults to 10.
1604
1605 pack.depth::
1606 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1607 maximum depth is given on the command line. Defaults to 50.
1608
1609 pack.windowMemory::
1610 The window memory size limit used by linkgit:git-pack-objects[1]
1611 when no limit is given on the command line. The value can be
1612 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1613 limit.
1614
1615 pack.compression::
1616 An integer -1..9, indicating the compression level for objects
1617 in a pack file. -1 is the zlib default. 0 means no
1618 compression, and 1..9 are various speed/size tradeoffs, 9 being
1619 slowest. If not set, defaults to core.compression. If that is
1620 not set, defaults to -1, the zlib default, which is "a default
1621 compromise between speed and compression (currently equivalent
1622 to level 6)."
1623 +
1624 Note that changing the compression level will not automatically recompress
1625 all existing objects. You can force recompression by passing the -F option
1626 to linkgit:git-repack[1].
1627
1628 pack.deltaCacheSize::
1629 The maximum memory in bytes used for caching deltas in
1630 linkgit:git-pack-objects[1] before writing them out to a pack.
1631 This cache is used to speed up the writing object phase by not
1632 having to recompute the final delta result once the best match
1633 for all objects is found. Repacking large repositories on machines
1634 which are tight with memory might be badly impacted by this though,
1635 especially if this cache pushes the system into swapping.
1636 A value of 0 means no limit. The smallest size of 1 byte may be
1637 used to virtually disable this cache. Defaults to 256 MiB.
1638
1639 pack.deltaCacheLimit::
1640 The maximum size of a delta, that is cached in
1641 linkgit:git-pack-objects[1]. This cache is used to speed up the
1642 writing object phase by not having to recompute the final delta
1643 result once the best match for all objects is found. Defaults to 1000.
1644
1645 pack.threads::
1646 Specifies the number of threads to spawn when searching for best
1647 delta matches. This requires that linkgit:git-pack-objects[1]
1648 be compiled with pthreads otherwise this option is ignored with a
1649 warning. This is meant to reduce packing time on multiprocessor
1650 machines. The required amount of memory for the delta search window
1651 is however multiplied by the number of threads.
1652 Specifying 0 will cause git to auto-detect the number of CPU's
1653 and set the number of threads accordingly.
1654
1655 pack.indexVersion::
1656 Specify the default pack index version. Valid values are 1 for
1657 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1658 the new pack index with capabilities for packs larger than 4 GB
1659 as well as proper protection against the repacking of corrupted
1660 packs. Version 2 is the default. Note that version 2 is enforced
1661 and this config option ignored whenever the corresponding pack is
1662 larger than 2 GB.
1663 +
1664 If you have an old git that does not understand the version 2 `*.idx` file,
1665 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1666 that will copy both `*.pack` file and corresponding `*.idx` file from the
1667 other side may give you a repository that cannot be accessed with your
1668 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1669 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1670 the `*.idx` file.
1671
1672 pack.packSizeLimit::
1673 The maximum size of a pack. This setting only affects
1674 packing to a file when repacking, i.e. the git:// protocol
1675 is unaffected. It can be overridden by the `--max-pack-size`
1676 option of linkgit:git-repack[1]. The minimum size allowed is
1677 limited to 1 MiB. The default is unlimited.
1678 Common unit suffixes of 'k', 'm', or 'g' are
1679 supported.
1680
1681 pager.<cmd>::
1682 If the value is boolean, turns on or off pagination of the
1683 output of a particular git subcommand when writing to a tty.
1684 Otherwise, turns on pagination for the subcommand using the
1685 pager specified by the value of `pager.<cmd>`. If `--paginate`
1686 or `--no-pager` is specified on the command line, it takes
1687 precedence over this option. To disable pagination for all
1688 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1689
1690 pretty.<name>::
1691 Alias for a --pretty= format string, as specified in
1692 linkgit:git-log[1]. Any aliases defined here can be used just
1693 as the built-in pretty formats could. For example,
1694 running `git config pretty.changelog "format:* %H %s"`
1695 would cause the invocation `git log --pretty=changelog`
1696 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1697 Note that an alias with the same name as a built-in format
1698 will be silently ignored.
1699
1700 pull.rebase::
1701 When true, rebase branches on top of the fetched branch, instead
1702 of merging the default branch from the default remote when "git
1703 pull" is run. See "branch.<name>.rebase" for setting this on a
1704 per-branch basis.
1705 +
1706 *NOTE*: this is a possibly dangerous operation; do *not* use
1707 it unless you understand the implications (see linkgit:git-rebase[1]
1708 for details).
1709
1710 pull.octopus::
1711 The default merge strategy to use when pulling multiple branches
1712 at once.
1713
1714 pull.twohead::
1715 The default merge strategy to use when pulling a single branch.
1716
1717 push.default::
1718 Defines the action git push should take if no refspec is given
1719 on the command line, no refspec is configured in the remote, and
1720 no refspec is implied by any of the options given on the command
1721 line. Possible values are:
1722 +
1723 * `nothing` - do not push anything.
1724 * `matching` - push all branches having the same name in both ends.
1725 This is for those who prepare all the branches into a publishable
1726 shape and then push them out with a single command. It is not
1727 appropriate for pushing into a repository shared by multiple users,
1728 since locally stalled branches will attempt a non-fast forward push
1729 if other users updated the branch.
1730 +
1731 This is currently the default, but Git 2.0 will change the default
1732 to `simple`.
1733 * `upstream` - push the current branch to its upstream branch.
1734 With this, `git push` will update the same remote ref as the one which
1735 is merged by `git pull`, making `push` and `pull` symmetrical.
1736 See "branch.<name>.merge" for how to configure the upstream branch.
1737 * `simple` - like `upstream`, but refuses to push if the upstream
1738 branch's name is different from the local one. This is the safest
1739 option and is well-suited for beginners. It will become the default
1740 in Git 2.0.
1741 * `current` - push the current branch to a branch of the same name.
1742 +
1743 The `simple`, `current` and `upstream` modes are for those who want to
1744 push out a single branch after finishing work, even when the other
1745 branches are not yet ready to be pushed out. If you are working with
1746 other people to push into the same shared repository, you would want
1747 to use one of these.
1748
1749 rebase.stat::
1750 Whether to show a diffstat of what changed upstream since the last
1751 rebase. False by default.
1752
1753 rebase.autosquash::
1754 If set to true enable '--autosquash' option by default.
1755
1756 receive.autogc::
1757 By default, git-receive-pack will run "git-gc --auto" after
1758 receiving data from git-push and updating refs. You can stop
1759 it by setting this variable to false.
1760
1761 receive.fsckObjects::
1762 If it is set to true, git-receive-pack will check all received
1763 objects. It will abort in the case of a malformed object or a
1764 broken link. The result of an abort are only dangling objects.
1765 Defaults to false. If not set, the value of `transfer.fsckObjects`
1766 is used instead.
1767
1768 receive.unpackLimit::
1769 If the number of objects received in a push is below this
1770 limit then the objects will be unpacked into loose object
1771 files. However if the number of received objects equals or
1772 exceeds this limit then the received pack will be stored as
1773 a pack, after adding any missing delta bases. Storing the
1774 pack from a push can make the push operation complete faster,
1775 especially on slow filesystems. If not set, the value of
1776 `transfer.unpackLimit` is used instead.
1777
1778 receive.denyDeletes::
1779 If set to true, git-receive-pack will deny a ref update that deletes
1780 the ref. Use this to prevent such a ref deletion via a push.
1781
1782 receive.denyDeleteCurrent::
1783 If set to true, git-receive-pack will deny a ref update that
1784 deletes the currently checked out branch of a non-bare repository.
1785
1786 receive.denyCurrentBranch::
1787 If set to true or "refuse", git-receive-pack will deny a ref update
1788 to the currently checked out branch of a non-bare repository.
1789 Such a push is potentially dangerous because it brings the HEAD
1790 out of sync with the index and working tree. If set to "warn",
1791 print a warning of such a push to stderr, but allow the push to
1792 proceed. If set to false or "ignore", allow such pushes with no
1793 message. Defaults to "refuse".
1794
1795 receive.denyNonFastForwards::
1796 If set to true, git-receive-pack will deny a ref update which is
1797 not a fast-forward. Use this to prevent such an update via a push,
1798 even if that push is forced. This configuration variable is
1799 set when initializing a shared repository.
1800
1801 receive.updateserverinfo::
1802 If set to true, git-receive-pack will run git-update-server-info
1803 after receiving data from git-push and updating refs.
1804
1805 remote.<name>.url::
1806 The URL of a remote repository. See linkgit:git-fetch[1] or
1807 linkgit:git-push[1].
1808
1809 remote.<name>.pushurl::
1810 The push URL of a remote repository. See linkgit:git-push[1].
1811
1812 remote.<name>.proxy::
1813 For remotes that require curl (http, https and ftp), the URL to
1814 the proxy to use for that remote. Set to the empty string to
1815 disable proxying for that remote.
1816
1817 remote.<name>.fetch::
1818 The default set of "refspec" for linkgit:git-fetch[1]. See
1819 linkgit:git-fetch[1].
1820
1821 remote.<name>.push::
1822 The default set of "refspec" for linkgit:git-push[1]. See
1823 linkgit:git-push[1].
1824
1825 remote.<name>.mirror::
1826 If true, pushing to this remote will automatically behave
1827 as if the `--mirror` option was given on the command line.
1828
1829 remote.<name>.skipDefaultUpdate::
1830 If true, this remote will be skipped by default when updating
1831 using linkgit:git-fetch[1] or the `update` subcommand of
1832 linkgit:git-remote[1].
1833
1834 remote.<name>.skipFetchAll::
1835 If true, this remote will be skipped by default when updating
1836 using linkgit:git-fetch[1] or the `update` subcommand of
1837 linkgit:git-remote[1].
1838
1839 remote.<name>.receivepack::
1840 The default program to execute on the remote side when pushing. See
1841 option \--receive-pack of linkgit:git-push[1].
1842
1843 remote.<name>.uploadpack::
1844 The default program to execute on the remote side when fetching. See
1845 option \--upload-pack of linkgit:git-fetch-pack[1].
1846
1847 remote.<name>.tagopt::
1848 Setting this value to \--no-tags disables automatic tag following when
1849 fetching from remote <name>. Setting it to \--tags will fetch every
1850 tag from remote <name>, even if they are not reachable from remote
1851 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1852 override this setting. See options \--tags and \--no-tags of
1853 linkgit:git-fetch[1].
1854
1855 remote.<name>.vcs::
1856 Setting this to a value <vcs> will cause git to interact with
1857 the remote with the git-remote-<vcs> helper.
1858
1859 remotes.<group>::
1860 The list of remotes which are fetched by "git remote update
1861 <group>". See linkgit:git-remote[1].
1862
1863 repack.usedeltabaseoffset::
1864 By default, linkgit:git-repack[1] creates packs that use
1865 delta-base offset. If you need to share your repository with
1866 git older than version 1.4.4, either directly or via a dumb
1867 protocol such as http, then you need to set this option to
1868 "false" and repack. Access from old git versions over the
1869 native protocol are unaffected by this option.
1870
1871 rerere.autoupdate::
1872 When set to true, `git-rerere` updates the index with the
1873 resulting contents after it cleanly resolves conflicts using
1874 previously recorded resolution. Defaults to false.
1875
1876 rerere.enabled::
1877 Activate recording of resolved conflicts, so that identical
1878 conflict hunks can be resolved automatically, should they be
1879 encountered again. By default, linkgit:git-rerere[1] is
1880 enabled if there is an `rr-cache` directory under the
1881 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1882 repository.
1883
1884 sendemail.identity::
1885 A configuration identity. When given, causes values in the
1886 'sendemail.<identity>' subsection to take precedence over
1887 values in the 'sendemail' section. The default identity is
1888 the value of 'sendemail.identity'.
1889
1890 sendemail.smtpencryption::
1891 See linkgit:git-send-email[1] for description. Note that this
1892 setting is not subject to the 'identity' mechanism.
1893
1894 sendemail.smtpssl::
1895 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1896
1897 sendemail.<identity>.*::
1898 Identity-specific versions of the 'sendemail.*' parameters
1899 found below, taking precedence over those when the this
1900 identity is selected, through command-line or
1901 'sendemail.identity'.
1902
1903 sendemail.aliasesfile::
1904 sendemail.aliasfiletype::
1905 sendemail.bcc::
1906 sendemail.cc::
1907 sendemail.cccmd::
1908 sendemail.chainreplyto::
1909 sendemail.confirm::
1910 sendemail.envelopesender::
1911 sendemail.from::
1912 sendemail.multiedit::
1913 sendemail.signedoffbycc::
1914 sendemail.smtppass::
1915 sendemail.suppresscc::
1916 sendemail.suppressfrom::
1917 sendemail.to::
1918 sendemail.smtpdomain::
1919 sendemail.smtpserver::
1920 sendemail.smtpserverport::
1921 sendemail.smtpserveroption::
1922 sendemail.smtpuser::
1923 sendemail.thread::
1924 sendemail.validate::
1925 See linkgit:git-send-email[1] for description.
1926
1927 sendemail.signedoffcc::
1928 Deprecated alias for 'sendemail.signedoffbycc'.
1929
1930 showbranch.default::
1931 The default set of branches for linkgit:git-show-branch[1].
1932 See linkgit:git-show-branch[1].
1933
1934 status.relativePaths::
1935 By default, linkgit:git-status[1] shows paths relative to the
1936 current directory. Setting this variable to `false` shows paths
1937 relative to the repository root (this was the default for git
1938 prior to v1.5.4).
1939
1940 status.showUntrackedFiles::
1941 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1942 files which are not currently tracked by Git. Directories which
1943 contain only untracked files, are shown with the directory name
1944 only. Showing untracked files means that Git needs to lstat() all
1945 all the files in the whole repository, which might be slow on some
1946 systems. So, this variable controls how the commands displays
1947 the untracked files. Possible values are:
1948 +
1949 --
1950 * `no` - Show no untracked files.
1951 * `normal` - Show untracked files and directories.
1952 * `all` - Show also individual files in untracked directories.
1953 --
1954 +
1955 If this variable is not specified, it defaults to 'normal'.
1956 This variable can be overridden with the -u|--untracked-files option
1957 of linkgit:git-status[1] and linkgit:git-commit[1].
1958
1959 status.submodulesummary::
1960 Defaults to false.
1961 If this is set to a non zero number or true (identical to -1 or an
1962 unlimited number), the submodule summary will be enabled and a
1963 summary of commits for modified submodules will be shown (see
1964 --summary-limit option of linkgit:git-submodule[1]).
1965
1966 submodule.<name>.path::
1967 submodule.<name>.url::
1968 submodule.<name>.update::
1969 The path within this project, URL, and the updating strategy
1970 for a submodule. These variables are initially populated
1971 by 'git submodule init'; edit them to override the
1972 URL and other values found in the `.gitmodules` file. See
1973 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1974
1975 submodule.<name>.fetchRecurseSubmodules::
1976 This option can be used to control recursive fetching of this
1977 submodule. It can be overridden by using the --[no-]recurse-submodules
1978 command line option to "git fetch" and "git pull".
1979 This setting will override that from in the linkgit:gitmodules[5]
1980 file.
1981
1982 submodule.<name>.ignore::
1983 Defines under what circumstances "git status" and the diff family show
1984 a submodule as modified. When set to "all", it will never be considered
1985 modified, "dirty" will ignore all changes to the submodules work tree and
1986 takes only differences between the HEAD of the submodule and the commit
1987 recorded in the superproject into account. "untracked" will additionally
1988 let submodules with modified tracked files in their work tree show up.
1989 Using "none" (the default when this option is not set) also shows
1990 submodules that have untracked files in their work tree as changed.
1991 This setting overrides any setting made in .gitmodules for this submodule,
1992 both settings can be overridden on the command line by using the
1993 "--ignore-submodules" option.
1994
1995 tar.umask::
1996 This variable can be used to restrict the permission bits of
1997 tar archive entries. The default is 0002, which turns off the
1998 world write bit. The special value "user" indicates that the
1999 archiving user's umask will be used instead. See umask(2) and
2000 linkgit:git-archive[1].
2001
2002 transfer.fsckObjects::
2003 When `fetch.fsckObjects` or `receive.fsckObjects` are
2004 not set, the value of this variable is used instead.
2005 Defaults to false.
2006
2007 transfer.unpackLimit::
2008 When `fetch.unpackLimit` or `receive.unpackLimit` are
2009 not set, the value of this variable is used instead.
2010 The default value is 100.
2011
2012 url.<base>.insteadOf::
2013 Any URL that starts with this value will be rewritten to
2014 start, instead, with <base>. In cases where some site serves a
2015 large number of repositories, and serves them with multiple
2016 access methods, and some users need to use different access
2017 methods, this feature allows people to specify any of the
2018 equivalent URLs and have git automatically rewrite the URL to
2019 the best alternative for the particular user, even for a
2020 never-before-seen repository on the site. When more than one
2021 insteadOf strings match a given URL, the longest match is used.
2022
2023 url.<base>.pushInsteadOf::
2024 Any URL that starts with this value will not be pushed to;
2025 instead, it will be rewritten to start with <base>, and the
2026 resulting URL will be pushed to. In cases where some site serves
2027 a large number of repositories, and serves them with multiple
2028 access methods, some of which do not allow push, this feature
2029 allows people to specify a pull-only URL and have git
2030 automatically use an appropriate URL to push, even for a
2031 never-before-seen repository on the site. When more than one
2032 pushInsteadOf strings match a given URL, the longest match is
2033 used. If a remote has an explicit pushurl, git will ignore this
2034 setting for that remote.
2035
2036 user.email::
2037 Your email address to be recorded in any newly created commits.
2038 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2039 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2040
2041 user.name::
2042 Your full name to be recorded in any newly created commits.
2043 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2044 environment variables. See linkgit:git-commit-tree[1].
2045
2046 user.signingkey::
2047 If linkgit:git-tag[1] is not selecting the key you want it to
2048 automatically when creating a signed tag, you can override the
2049 default selection with this variable. This option is passed
2050 unchanged to gpg's --local-user parameter, so you may specify a key
2051 using any method that gpg supports.
2052
2053 web.browser::
2054 Specify a web browser that may be used by some commands.
2055 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2056 may use it.