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