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