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