Merge branch 'nd/sparse'
[git/git.git] / Documentation / config.txt
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
18 Syntax
19 ~~~~~~
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.
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.
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:
36 --------
37 [section "subsection"]
39 --------
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.
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 0/1, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git-config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
86 Example
87 ~~~~~~~
89 # Core variables
90 [core]
91 ; Don't trust file modes
92 filemode = false
94 # Our diff algorithm
95 [diff]
96 external = /usr/local/bin/diff-wrapper
97 renames = true
99 [branch "devel"]
100 remote = origin
101 merge = refs/heads/devel
103 # Proxy settings
104 [core]
105 gitProxy="ssh" for ""
106 gitProxy=default-proxy ; for the rest
108 Variables
109 ~~~~~~~~~
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
116 advice.*::
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
119 are:
120 +
121 --
122 pushNonFastForward::
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
125 statusHints::
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
129 commitBeforeMerge::
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwritting local changes.
132 Default: true.
133 --
135 core.fileMode::
136 If false, the executable bit differences between the index and
137 the working copy are ignored; useful on broken filesystems like FAT.
138 See linkgit:git-update-index[1].
139 +
140 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
141 will probe and set core.fileMode false if appropriate when the
142 repository is created.
144 core.ignoreCygwinFSTricks::
145 This option is only used by Cygwin implementation of Git. If false,
146 the Cygwin stat() and lstat() functions are used. This may be useful
147 if your repository consists of a few separate directories joined in
148 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
149 whenever it is possible and falls back to Cygwin functions only to
150 handle symbol links. The native mode is more than twice faster than
151 normal Cygwin l/stat() functions. True by default, unless core.filemode
152 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
153 POSIX emulation is required to support core.filemode.
155 core.ignorecase::
156 If true, this option enables various workarounds to enable
157 git to work better on filesystems that are not case sensitive,
158 like FAT. For example, if a directory listing finds
159 "makefile" when git expects "Makefile", git will assume
160 it is really the same file, and continue to remember it as
161 "Makefile".
162 +
163 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
164 will probe and set core.ignorecase true if appropriate when the repository
165 is created.
167 core.trustctime::
168 If false, the ctime differences between the index and the
169 working copy are ignored; useful when the inode change time
170 is regularly modified by something outside Git (file system
171 crawlers and some backup systems).
172 See linkgit:git-update-index[1]. True by default.
174 core.quotepath::
175 The commands that output paths (e.g. 'ls-files',
176 'diff'), when not given the `-z` option, will quote
177 "unusual" characters in the pathname by enclosing the
178 pathname in a double-quote pair and with backslashes the
179 same way strings in C source code are quoted. If this
180 variable is set to false, the bytes higher than 0x80 are
181 not quoted but output as verbatim. Note that double
182 quote, backslash and control characters are always
183 quoted without `-z` regardless of the setting of this
184 variable.
186 core.autocrlf::
187 If true, makes git convert `CRLF` at the end of lines in text files to
188 `LF` when reading from the filesystem, and convert in reverse when
189 writing to the filesystem. The variable can be set to
190 'input', in which case the conversion happens only while
191 reading from the filesystem but files are written out with
192 `LF` at the end of lines. A file is considered
193 "text" (i.e. be subjected to the autocrlf mechanism) based on
194 the file's `crlf` attribute, or if `crlf` is unspecified,
195 based on the file's contents. See linkgit:gitattributes[5].
197 core.safecrlf::
198 If true, makes git check if converting `CRLF` as controlled by
199 `core.autocrlf` is reversible. Git will verify if a command
200 modifies a file in the work tree either directly or indirectly.
201 For example, committing a file followed by checking out the
202 same file should yield the original file in the work tree. If
203 this is not the case for the current setting of
204 `core.autocrlf`, git will reject the file. The variable can
205 be set to "warn", in which case git will only warn about an
206 irreversible conversion but continue the operation.
207 +
208 CRLF conversion bears a slight chance of corrupting data.
209 autocrlf=true will convert CRLF to LF during commit and LF to
210 CRLF during checkout. A file that contains a mixture of LF and
211 CRLF before the commit cannot be recreated by git. For text
212 files this is the right thing to do: it corrects line endings
213 such that we have only LF line endings in the repository.
214 But for binary files that are accidentally classified as text the
215 conversion can corrupt data.
216 +
217 If you recognize such corruption early you can easily fix it by
218 setting the conversion type explicitly in .gitattributes. Right
219 after committing you still have the original file in your work
220 tree and this file is not yet corrupted. You can explicitly tell
221 git that this file is binary and git will handle the file
222 appropriately.
223 +
224 Unfortunately, the desired effect of cleaning up text files with
225 mixed line endings and the undesired effect of corrupting binary
226 files cannot be distinguished. In both cases CRLFs are removed
227 in an irreversible way. For text files this is the right thing
228 to do because CRLFs are line endings, while for binary files
229 converting CRLFs corrupts data.
230 +
231 Note, this safety check does not mean that a checkout will generate a
232 file identical to the original file for a different setting of
233 `core.autocrlf`, but only for the current one. For example, a text
234 file with `LF` would be accepted with `core.autocrlf=input` and could
235 later be checked out with `core.autocrlf=true`, in which case the
236 resulting file would contain `CRLF`, although the original file
237 contained `LF`. However, in both work trees the line endings would be
238 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
239 file with mixed line endings would be reported by the `core.safecrlf`
240 mechanism.
242 core.symlinks::
243 If false, symbolic links are checked out as small plain files that
244 contain the link text. linkgit:git-update-index[1] and
245 linkgit:git-add[1] will not change the recorded type to regular
246 file. Useful on filesystems like FAT that do not support
247 symbolic links.
248 +
249 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
250 will probe and set core.symlinks false if appropriate when the repository
251 is created.
253 core.gitProxy::
254 A "proxy command" to execute (as 'command host port') instead
255 of establishing direct connection to the remote server when
256 using the git protocol for fetching. If the variable value is
257 in the "COMMAND for DOMAIN" format, the command is applied only
258 on hostnames ending with the specified domain string. This variable
259 may be set multiple times and is matched in the given order;
260 the first match wins.
261 +
262 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
263 (which always applies universally, without the special "for"
264 handling).
265 +
266 The special string `none` can be used as the proxy command to
267 specify that no proxy be used for a given domain pattern.
268 This is useful for excluding servers inside a firewall from
269 proxy use, while defaulting to a common proxy for external domains.
271 core.ignoreStat::
272 If true, commands which modify both the working tree and the index
273 will mark the updated paths with the "assume unchanged" bit in the
274 index. These marked files are then assumed to stay unchanged in the
275 working copy, until you mark them otherwise manually - Git will not
276 detect the file changes by lstat() calls. This is useful on systems
277 where those are very slow, such as Microsoft Windows.
278 See linkgit:git-update-index[1].
279 False by default.
281 core.preferSymlinkRefs::
282 Instead of the default "symref" format for HEAD
283 and other symbolic reference files, use symbolic links.
284 This is sometimes needed to work with old scripts that
285 expect HEAD to be a symbolic link.
287 core.bare::
288 If true this repository is assumed to be 'bare' and has no
289 working directory associated with it. If this is the case a
290 number of commands that require a working directory will be
291 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
292 +
293 This setting is automatically guessed by linkgit:git-clone[1] or
294 linkgit:git-init[1] when the repository was created. By default a
295 repository that ends in "/.git" is assumed to be not bare (bare =
296 false), while all other repositories are assumed to be bare (bare
297 = true).
299 core.worktree::
300 Set the path to the root of the work tree.
301 This can be overridden by the GIT_WORK_TREE environment
302 variable and the '--work-tree' command line option. It can be
303 an absolute path or a relative path to the .git directory,
304 either specified by --git-dir or GIT_DIR, or automatically
305 discovered.
306 If --git-dir or GIT_DIR are specified but none of
307 --work-tree, GIT_WORK_TREE and core.worktree is specified,
308 the current working directory is regarded as the root of the
309 work tree.
310 +
311 Note that this variable is honored even when set in a configuration
312 file in a ".git" subdirectory of a directory, and its value differs
313 from the latter directory (e.g. "/path/to/.git/config" has
314 core.worktree set to "/different/path"), which is most likely a
315 misconfiguration. Running git commands in "/path/to" directory will
316 still use "/different/path" as the root of the work tree and can cause
317 great confusion to the users.
319 core.logAllRefUpdates::
320 Enable the reflog. Updates to a ref <ref> is logged to the file
321 "$GIT_DIR/logs/<ref>", by appending the new and old
322 SHA1, the date/time and the reason of the update, but
323 only when the file exists. If this configuration
324 variable is set to true, missing "$GIT_DIR/logs/<ref>"
325 file is automatically created for branch heads.
326 +
327 This information can be used to determine what commit
328 was the tip of a branch "2 days ago".
329 +
330 This value is true by default in a repository that has
331 a working directory associated with it, and false by
332 default in a bare repository.
334 core.repositoryFormatVersion::
335 Internal variable identifying the repository format and layout
336 version.
338 core.sharedRepository::
339 When 'group' (or 'true'), the repository is made shareable between
340 several users in a group (making sure all the files and objects are
341 group-writable). When 'all' (or 'world' or 'everybody'), the
342 repository will be readable by all users, additionally to being
343 group-shareable. When 'umask' (or 'false'), git will use permissions
344 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
345 files in the repository will have this mode value. '0xxx' will override
346 user's umask value (whereas the other options will only override
347 requested parts of the user's umask value). Examples: '0660' will make
348 the repo read/write-able for the owner and group, but inaccessible to
349 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
350 repository that is group-readable but not group-writable.
351 See linkgit:git-init[1]. False by default.
353 core.warnAmbiguousRefs::
354 If true, git will warn you if the ref name you passed it is ambiguous
355 and might match multiple refs in the .git/refs/ tree. True by default.
357 core.compression::
358 An integer -1..9, indicating a default compression level.
359 -1 is the zlib default. 0 means no compression,
360 and 1..9 are various speed/size tradeoffs, 9 being slowest.
361 If set, this provides a default to other compression variables,
362 such as 'core.loosecompression' and 'pack.compression'.
364 core.loosecompression::
365 An integer -1..9, indicating the compression level for objects that
366 are not in a pack file. -1 is the zlib default. 0 means no
367 compression, and 1..9 are various speed/size tradeoffs, 9 being
368 slowest. If not set, defaults to core.compression. If that is
369 not set, defaults to 1 (best speed).
371 core.packedGitWindowSize::
372 Number of bytes of a pack file to map into memory in a
373 single mapping operation. Larger window sizes may allow
374 your system to process a smaller number of large pack files
375 more quickly. Smaller window sizes will negatively affect
376 performance due to increased calls to the operating system's
377 memory manager, but may improve performance when accessing
378 a large number of large pack files.
379 +
380 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
381 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
382 be reasonable for all users/operating systems. You probably do
383 not need to adjust this value.
384 +
385 Common unit suffixes of 'k', 'm', or 'g' are supported.
387 core.packedGitLimit::
388 Maximum number of bytes to map simultaneously into memory
389 from pack files. If Git needs to access more than this many
390 bytes at once to complete an operation it will unmap existing
391 regions to reclaim virtual address space within the process.
392 +
393 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
394 This should be reasonable for all users/operating systems, except on
395 the largest projects. You probably do not need to adjust this value.
396 +
397 Common unit suffixes of 'k', 'm', or 'g' are supported.
399 core.deltaBaseCacheLimit::
400 Maximum number of bytes to reserve for caching base objects
401 that multiple deltafied objects reference. By storing the
402 entire decompressed base objects in a cache Git is able
403 to avoid unpacking and decompressing frequently used base
404 objects multiple times.
405 +
406 Default is 16 MiB on all platforms. This should be reasonable
407 for all users/operating systems, except on the largest projects.
408 You probably do not need to adjust this value.
409 +
410 Common unit suffixes of 'k', 'm', or 'g' are supported.
412 core.excludesfile::
413 In addition to '.gitignore' (per-directory) and
414 '.git/info/exclude', git looks into this file for patterns
415 of files which are not meant to be tracked. "{tilde}/" is expanded
416 to the value of `$HOME` and "{tilde}user/" to the specified user's
417 home directory. See linkgit:gitignore[5].
419 core.editor::
420 Commands such as `commit` and `tag` that lets you edit
421 messages by launching an editor uses the value of this
422 variable when it is set, and the environment variable
423 `GIT_EDITOR` is not set. See linkgit:git-var[1].
425 core.pager::
426 The command that git will use to paginate output. Can
427 be overridden with the `GIT_PAGER` environment
428 variable. Note that git sets the `LESS` environment
429 variable to `FRSX` if it is unset when it runs the
430 pager. One can change these settings by setting the
431 `LESS` variable to some other value. Alternately,
432 these settings can be overridden on a project or
433 global basis by setting the `core.pager` option.
434 Setting `core.pager` has no affect on the `LESS`
435 environment variable behaviour above, so if you want
436 to override git's default settings this way, you need
437 to be explicit. For example, to disable the S option
438 in a backward compatible manner, set `core.pager`
439 to `less -+$LESS -FRX`. This will be passed to the
440 shell by git, which will translate the final command to
441 `LESS=FRSX less -+FRSX -FRX`.
443 core.whitespace::
444 A comma separated list of common whitespace problems to
445 notice. 'git-diff' will use `color.diff.whitespace` to
446 highlight them, and 'git-apply --whitespace=error' will
447 consider them as errors. You can prefix `-` to disable
448 any of them (e.g. `-trailing-space`):
449 +
450 * `blank-at-eol` treats trailing whitespaces at the end of the line
451 as an error (enabled by default).
452 * `space-before-tab` treats a space character that appears immediately
453 before a tab character in the initial indent part of the line as an
454 error (enabled by default).
455 * `indent-with-non-tab` treats a line that is indented with 8 or more
456 space characters as an error (not enabled by default).
457 * `blank-at-eof` treats blank lines added at the end of file as an error
458 (enabled by default).
459 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
460 `blank-at-eof`.
461 * `cr-at-eol` treats a carriage-return at the end of line as
462 part of the line terminator, i.e. with it, `trailing-space`
463 does not trigger if the character before such a carriage-return
464 is not a whitespace (not enabled by default).
466 core.fsyncobjectfiles::
467 This boolean will enable 'fsync()' when writing object files.
468 +
469 This is a total waste of time and effort on a filesystem that orders
470 data writes properly, but can be useful for filesystems that do not use
471 journalling (traditional UNIX filesystems) or that only journal metadata
472 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
474 core.preloadindex::
475 Enable parallel index preload for operations like 'git diff'
476 +
477 This can speed up operations like 'git diff' and 'git status' especially
478 on filesystems like NFS that have weak caching semantics and thus
479 relatively high IO latencies. With this set to 'true', git will do the
480 index comparison to the filesystem data in parallel, allowing
481 overlapping IO's.
483 core.createObject::
484 You can set this to 'link', in which case a hardlink followed by
485 a delete of the source are used to make sure that object creation
486 will not overwrite existing objects.
487 +
488 On some file system/operating system combinations, this is unreliable.
489 Set this config setting to 'rename' there; However, This will remove the
490 check that makes sure that existing object files will not get overwritten.
492 core.notesRef::
493 When showing commit messages, also show notes which are stored in
494 the given ref. This ref is expected to contain files named
495 after the full SHA-1 of the commit they annotate.
496 +
497 If such a file exists in the given ref, the referenced blob is read, and
498 appended to the commit message, separated by a "Notes:" line. If the
499 given ref itself does not exist, it is not an error, but means that no
500 notes should be printed.
501 +
502 This setting defaults to "refs/notes/commits", and can be overridden by
503 the `GIT_NOTES_REF` environment variable.
505 core.sparseCheckout::
506 Enable "sparse checkout" feature. See section "Sparse checkout" in
507 linkgit:git-read-tree[1] for more information.
509 add.ignore-errors::
510 Tells 'git-add' to continue adding files when some files cannot be
511 added due to indexing errors. Equivalent to the '--ignore-errors'
512 option of linkgit:git-add[1].
514 alias.*::
515 Command aliases for the linkgit:git[1] command wrapper - e.g.
516 after defining "alias.last = cat-file commit HEAD", the invocation
517 "git last" is equivalent to "git cat-file commit HEAD". To avoid
518 confusion and troubles with script usage, aliases that
519 hide existing git commands are ignored. Arguments are split by
520 spaces, the usual shell quoting and escaping is supported.
521 quote pair and a backslash can be used to quote them.
522 +
523 If the alias expansion is prefixed with an exclamation point,
524 it will be treated as a shell command. For example, defining
525 " = !gitk --all --not ORIG_HEAD", the invocation
526 "git new" is equivalent to running the shell command
527 "gitk --all --not ORIG_HEAD". Note that shell commands will be
528 executed from the top-level directory of a repository, which may
529 not necessarily be the current directory.
531 apply.ignorewhitespace::
532 When set to 'change', tells 'git-apply' to ignore changes in
533 whitespace, in the same way as the '--ignore-space-change'
534 option.
535 When set to one of: no, none, never, false tells 'git-apply' to
536 respect all whitespace differences.
537 See linkgit:git-apply[1].
539 apply.whitespace::
540 Tells 'git-apply' how to handle whitespaces, in the same way
541 as the '--whitespace' option. See linkgit:git-apply[1].
543 branch.autosetupmerge::
544 Tells 'git-branch' and 'git-checkout' to set up new branches
545 so that linkgit:git-pull[1] will appropriately merge from the
546 starting point branch. Note that even if this option is not set,
547 this behavior can be chosen per-branch using the `--track`
548 and `--no-track` options. The valid settings are: `false` -- no
549 automatic setup is done; `true` -- automatic setup is done when the
550 starting point is a remote branch; `always` -- automatic setup is
551 done when the starting point is either a local branch or remote
552 branch. This option defaults to true.
554 branch.autosetuprebase::
555 When a new branch is created with 'git-branch' or 'git-checkout'
556 that tracks another branch, this variable tells git to set
557 up pull to rebase instead of merge (see "branch.<name>.rebase").
558 When `never`, rebase is never automatically set to true.
559 When `local`, rebase is set to true for tracked branches of
560 other local branches.
561 When `remote`, rebase is set to true for tracked branches of
562 remote branches.
563 When `always`, rebase will be set to true for all tracking
564 branches.
565 See "branch.autosetupmerge" for details on how to set up a
566 branch to track another branch.
567 This option defaults to never.
569 branch.<name>.remote::
570 When in branch <name>, it tells 'git-fetch' and 'git-push' which
571 remote to fetch from/push to. It defaults to `origin` if no remote is
572 configured. `origin` is also used if you are not on any branch.
574 branch.<name>.merge::
575 Defines, together with branch.<name>.remote, the upstream branch
576 for the given branch. It tells 'git-fetch'/'git-pull' which
577 branch to merge and can also affect 'git-push' (see push.default).
578 When in branch <name>, it tells 'git-fetch' the default
579 refspec to be marked for merging in FETCH_HEAD. The value is
580 handled like the remote part of a refspec, and must match a
581 ref which is fetched from the remote given by
582 "branch.<name>.remote".
583 The merge information is used by 'git-pull' (which at first calls
584 'git-fetch') to lookup the default branch for merging. Without
585 this option, 'git-pull' defaults to merge the first refspec fetched.
586 Specify multiple values to get an octopus merge.
587 If you wish to setup 'git-pull' so that it merges into <name> from
588 another branch in the local repository, you can point
589 branch.<name>.merge to the desired branch, and use the special setting
590 `.` (a period) for branch.<name>.remote.
592 branch.<name>.mergeoptions::
593 Sets default options for merging into branch <name>. The syntax and
594 supported options are the same as those of linkgit:git-merge[1], but
595 option values containing whitespace characters are currently not
596 supported.
598 branch.<name>.rebase::
599 When true, rebase the branch <name> on top of the fetched branch,
600 instead of merging the default branch from the default remote when
601 "git pull" is run.
602 *NOTE*: this is a possibly dangerous operation; do *not* use
603 it unless you understand the implications (see linkgit:git-rebase[1]
604 for details).
606 browser.<tool>.cmd::
607 Specify the command to invoke the specified browser. The
608 specified command is evaluated in shell with the URLs passed
609 as arguments. (See linkgit:git-web--browse[1].)
611 browser.<tool>.path::
612 Override the path for the given tool that may be used to
613 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
614 working repository in gitweb (see linkgit:git-instaweb[1]).
616 clean.requireForce::
617 A boolean to make git-clean do nothing unless given -f
618 or -n. Defaults to true.
620 color.branch::
621 A boolean to enable/disable color in the output of
622 linkgit:git-branch[1]. May be set to `always`,
623 `false` (or `never`) or `auto` (or `true`), in which case colors are used
624 only when the output is to a terminal. Defaults to false.
626 color.branch.<slot>::
627 Use customized color for branch coloration. `<slot>` is one of
628 `current` (the current branch), `local` (a local branch),
629 `remote` (a tracking branch in refs/remotes/), `plain` (other
630 refs).
631 +
632 The value for these configuration variables is a list of colors (at most
633 two) and attributes (at most one), separated by spaces. The colors
634 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
635 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
636 `blink` and `reverse`. The first color given is the foreground; the
637 second is the background. The position of the attribute, if any,
638 doesn't matter.
640 color.diff::
641 When set to `always`, always use colors in patch.
642 When false (or `never`), never. When set to `true` or `auto`, use
643 colors only when the output is to the terminal. Defaults to false.
645 color.diff.<slot>::
646 Use customized color for diff colorization. `<slot>` specifies
647 which part of the patch to use the specified color, and is one
648 of `plain` (context text), `meta` (metainformation), `frag`
649 (hunk header), 'func' (function in hunk header), `old` (removed lines),
650 `new` (added lines), `commit` (commit headers), or `whitespace`
651 (highlighting whitespace errors). The values of these variables may be
652 specified as in color.branch.<slot>.
654 color.grep::
655 When set to `always`, always highlight matches. When `false` (or
656 `never`), never. When set to `true` or `auto`, use color only
657 when the output is written to the terminal. Defaults to `false`.
659 color.grep.external::
660 The string value of this variable is passed to an external 'grep'
661 command as a command line option if match highlighting is turned
662 on. If set to an empty string, no option is passed at all,
663 turning off coloring for external 'grep' calls; this is the default.
664 For GNU grep, set it to `--color=always` to highlight matches even
665 when a pager is used.
667 color.grep.match::
668 Use customized color for matches. The value of this variable
669 may be specified as in color.branch.<slot>. It is passed using
670 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
671 calling an external 'grep'.
673 color.interactive::
674 When set to `always`, always use colors for interactive prompts
675 and displays (such as those used by "git-add --interactive").
676 When false (or `never`), never. When set to `true` or `auto`, use
677 colors only when the output is to the terminal. Defaults to false.
679 color.interactive.<slot>::
680 Use customized color for 'git-add --interactive'
681 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
682 four distinct types of normal output from interactive
683 commands. The values of these variables may be specified as
684 in color.branch.<slot>.
686 color.pager::
687 A boolean to enable/disable colored output when the pager is in
688 use (default is true).
690 color.showbranch::
691 A boolean to enable/disable color in the output of
692 linkgit:git-show-branch[1]. May be set to `always`,
693 `false` (or `never`) or `auto` (or `true`), in which case colors are used
694 only when the output is to a terminal. Defaults to false.
696 color.status::
697 A boolean to enable/disable color in the output of
698 linkgit:git-status[1]. May be set to `always`,
699 `false` (or `never`) or `auto` (or `true`), in which case colors are used
700 only when the output is to a terminal. Defaults to false.
702 color.status.<slot>::
703 Use customized color for status colorization. `<slot>` is
704 one of `header` (the header text of the status message),
705 `added` or `updated` (files which are added but not committed),
706 `changed` (files which are changed but not added in the index),
707 `untracked` (files which are not tracked by git), or
708 `nobranch` (the color the 'no branch' warning is shown in, defaulting
709 to red). The values of these variables may be specified as in
710 color.branch.<slot>.
712 color.ui::
713 When set to `always`, always use colors in all git commands which
714 are capable of colored output. When false (or `never`), never. When
715 set to `true` or `auto`, use colors only when the output is to the
716 terminal. When more specific variables of color.* are set, they always
717 take precedence over this setting. Defaults to false.
719 commit.template::
720 Specify a file to use as the template for new commit messages.
721 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
722 specified user's home directory.
724 diff.autorefreshindex::
725 When using 'git-diff' to compare with work tree
726 files, do not consider stat-only change as changed.
727 Instead, silently run `git update-index --refresh` to
728 update the cached stat information for paths whose
729 contents in the work tree match the contents in the
730 index. This option defaults to true. Note that this
731 affects only 'git-diff' Porcelain, and not lower level
732 'diff' commands such as 'git-diff-files'.
734 diff.external::
735 If this config variable is set, diff generation is not
736 performed using the internal diff machinery, but using the
737 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
738 environment variable. The command is called with parameters
739 as described under "git Diffs" in linkgit:git[1]. Note: if
740 you want to use an external diff program only on a subset of
741 your files, you might want to use linkgit:gitattributes[5] instead.
743 diff.mnemonicprefix::
744 If set, 'git-diff' uses a prefix pair that is different from the
745 standard "a/" and "b/" depending on what is being compared. When
746 this configuration is in effect, reverse diff output also swaps
747 the order of the prefixes:
748 'git-diff';;
749 compares the (i)ndex and the (w)ork tree;
750 'git-diff HEAD';;
751 compares a (c)ommit and the (w)ork tree;
752 'git diff --cached';;
753 compares a (c)ommit and the (i)ndex;
754 'git-diff HEAD:file1 file2';;
755 compares an (o)bject and a (w)ork tree entity;
756 'git diff --no-index a b';;
757 compares two non-git things (1) and (2).
759 diff.renameLimit::
760 The number of files to consider when performing the copy/rename
761 detection; equivalent to the 'git-diff' option '-l'.
763 diff.renames::
764 Tells git to detect renames. If set to any boolean value, it
765 will enable basic rename detection. If set to "copies" or
766 "copy", it will detect copies, as well.
768 diff.suppressBlankEmpty::
769 A boolean to inhibit the standard behavior of printing a space
770 before each empty output line. Defaults to false.
772 diff.tool::
773 Controls which diff tool is used. `diff.tool` overrides
774 `merge.tool` when used by linkgit:git-difftool[1] and has
775 the same valid values as `merge.tool` minus "tortoisemerge"
776 and plus "kompare".
778 difftool.<tool>.path::
779 Override the path for the given tool. This is useful in case
780 your tool is not in the PATH.
782 difftool.<tool>.cmd::
783 Specify the command to invoke the specified diff tool.
784 The specified command is evaluated in shell with the following
785 variables available: 'LOCAL' is set to the name of the temporary
786 file containing the contents of the diff pre-image and 'REMOTE'
787 is set to the name of the temporary file containing the contents
788 of the diff post-image.
790 difftool.prompt::
791 Prompt before each invocation of the diff tool.
793 diff.wordRegex::
794 A POSIX Extended Regular Expression used to determine what is a "word"
795 when performing word-by-word difference calculations. Character
796 sequences that match the regular expression are "words", all other
797 characters are *ignorable* whitespace.
799 fetch.unpackLimit::
800 If the number of objects fetched over the git native
801 transfer is below this
802 limit, then the objects will be unpacked into loose object
803 files. However if the number of received objects equals or
804 exceeds this limit then the received pack will be stored as
805 a pack, after adding any missing delta bases. Storing the
806 pack from a push can make the push operation complete faster,
807 especially on slow filesystems. If not set, the value of
808 `transfer.unpackLimit` is used instead.
810 format.attach::
811 Enable multipart/mixed attachments as the default for
812 'format-patch'. The value can also be a double quoted string
813 which will enable attachments as the default and set the
814 value as the boundary. See the --attach option in
815 linkgit:git-format-patch[1].
817 format.numbered::
818 A boolean which can enable or disable sequence numbers in patch
819 subjects. It defaults to "auto" which enables it only if there
820 is more than one patch. It can be enabled or disabled for all
821 messages by setting it to "true" or "false". See --numbered
822 option in linkgit:git-format-patch[1].
824 format.headers::
825 Additional email headers to include in a patch to be submitted
826 by mail. See linkgit:git-format-patch[1].
829 Additional "Cc:" headers to include in a patch to be submitted
830 by mail. See the --cc option in linkgit:git-format-patch[1].
832 format.subjectprefix::
833 The default for format-patch is to output files with the '[PATCH]'
834 subject prefix. Use this variable to change that prefix.
836 format.suffix::
837 The default for format-patch is to output files with the suffix
838 `.patch`. Use this variable to change that suffix (make sure to
839 include the dot if you want it).
841 format.pretty::
842 The default pretty format for log/show/whatchanged command,
843 See linkgit:git-log[1], linkgit:git-show[1],
844 linkgit:git-whatchanged[1].
846 format.thread::
847 The default threading style for 'git-format-patch'. Can be
848 a boolean value, or `shallow` or `deep`. `shallow` threading
849 makes every mail a reply to the head of the series,
850 where the head is chosen from the cover letter, the
851 `\--in-reply-to`, and the first patch mail, in this order.
852 `deep` threading makes every mail a reply to the previous one.
853 A true boolean value is the same as `shallow`, and a false
854 value disables threading.
856 format.signoff::
857 A boolean value which lets you enable the `-s/--signoff` option of
858 format-patch by default. *Note:* Adding the Signed-off-by: line to a
859 patch should be a conscious act and means that you certify you have
860 the rights to submit this work under the same open source license.
861 Please see the 'SubmittingPatches' document for further discussion.
863 gc.aggressiveWindow::
864 The window size parameter used in the delta compression
865 algorithm used by 'git-gc --aggressive'. This defaults
866 to 10.
869 When there are approximately more than this many loose
870 objects in the repository, `git gc --auto` will pack them.
871 Some Porcelain commands use this command to perform a
872 light-weight garbage collection from time to time. The
873 default value is 6700. Setting this to 0 disables it.
875 gc.autopacklimit::
876 When there are more than this many packs that are not
877 marked with `*.keep` file in the repository, `git gc
878 --auto` consolidates them into one larger pack. The
879 default value is 50. Setting this to 0 disables it.
881 gc.packrefs::
882 Running `git pack-refs` in a repository renders it
883 unclonable by Git versions prior to over dumb
884 transports such as HTTP. This variable determines whether
885 'git gc' runs `git pack-refs`. This can be set to "nobare"
886 to enable it within all non-bare repos or it can be set to a
887 boolean value. The default is `true`.
889 gc.pruneexpire::
890 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
891 Override the grace period with this config variable. The value
892 "now" may be used to disable this grace period and always prune
893 unreachable objects immediately.
895 gc.reflogexpire::
896 'git-reflog expire' removes reflog entries older than
897 this time; defaults to 90 days.
899 gc.reflogexpireunreachable::
900 'git-reflog expire' removes reflog entries older than
901 this time and are not reachable from the current tip;
902 defaults to 30 days.
904 gc.rerereresolved::
905 Records of conflicted merge you resolved earlier are
906 kept for this many days when 'git-rerere gc' is run.
907 The default is 60 days. See linkgit:git-rerere[1].
909 gc.rerereunresolved::
910 Records of conflicted merge you have not resolved are
911 kept for this many days when 'git-rerere gc' is run.
912 The default is 15 days. See linkgit:git-rerere[1].
914 gitcvs.commitmsgannotation::
915 Append this string to each commit message. Set to empty string
916 to disable this feature. Defaults to "via git-CVS emulator".
918 gitcvs.enabled::
919 Whether the CVS server interface is enabled for this repository.
920 See linkgit:git-cvsserver[1].
922 gitcvs.logfile::
923 Path to a log file where the CVS server interface well... logs
924 various stuff. See linkgit:git-cvsserver[1].
926 gitcvs.usecrlfattr::
927 If true, the server will look up the `crlf` attribute for
928 files to determine the '-k' modes to use. If `crlf` is set,
929 the '-k' mode will be left blank, so cvs clients will
930 treat it as text. If `crlf` is explicitly unset, the file
931 will be set with '-kb' mode, which suppresses any newline munging
932 the client might otherwise do. If `crlf` is not specified,
933 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
935 gitcvs.allbinary::
936 This is used if 'gitcvs.usecrlfattr' does not resolve
937 the correct '-kb' mode to use. If true, all
938 unresolved files are sent to the client in
939 mode '-kb'. This causes the client to treat them
940 as binary files, which suppresses any newline munging it
941 otherwise might do. Alternatively, if it is set to "guess",
942 then the contents of the file are examined to decide if
943 it is binary, similar to 'core.autocrlf'.
945 gitcvs.dbname::
946 Database used by git-cvsserver to cache revision information
947 derived from the git repository. The exact meaning depends on the
948 used database driver, for SQLite (which is the default driver) this
949 is a filename. Supports variable substitution (see
950 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
951 Default: '%Ggitcvs.%m.sqlite'
953 gitcvs.dbdriver::
954 Used Perl DBI driver. You can specify any available driver
955 for this here, but it might not work. git-cvsserver is tested
956 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
957 reported *not* to work with 'DBD::mysql'. Experimental feature.
958 May not contain double colons (`:`). Default: 'SQLite'.
959 See linkgit:git-cvsserver[1].
961 gitcvs.dbuser, gitcvs.dbpass::
962 Database user and password. Only useful if setting 'gitcvs.dbdriver',
963 since SQLite has no concept of database users and/or passwords.
964 'gitcvs.dbuser' supports variable substitution (see
965 linkgit:git-cvsserver[1] for details).
967 gitcvs.dbTableNamePrefix::
968 Database table name prefix. Prepended to the names of any
969 database tables used, allowing a single database to be used
970 for several repositories. Supports variable substitution (see
971 linkgit:git-cvsserver[1] for details). Any non-alphabetic
972 characters will be replaced with underscores.
974 All gitcvs variables except for 'gitcvs.usecrlfattr' and
975 'gitcvs.allbinary' can also be specified as
976 'gitcvs.<access_method>.<varname>' (where 'access_method'
977 is one of "ext" and "pserver") to make them apply only for the given
978 access method.
980 gui.commitmsgwidth::
981 Defines how wide the commit message window is in the
982 linkgit:git-gui[1]. "75" is the default.
984 gui.diffcontext::
985 Specifies how many context lines should be used in calls to diff
986 made by the linkgit:git-gui[1]. The default is "5".
988 gui.encoding::
989 Specifies the default encoding to use for displaying of
990 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
991 It can be overridden by setting the 'encoding' attribute
992 for relevant files (see linkgit:gitattributes[5]).
993 If this option is not set, the tools default to the
994 locale encoding.
996 gui.matchtrackingbranch::
997 Determines if new branches created with linkgit:git-gui[1] should
998 default to tracking remote branches with matching names or
999 not. Default: "false".
1001 gui.newbranchtemplate::
1002 Is used as suggested name when creating new branches using the
1003 linkgit:git-gui[1].
1005 gui.pruneduringfetch::
1006 "true" if linkgit:git-gui[1] should prune tracking branches when
1007 performing a fetch. The default value is "false".
1009 gui.trustmtime::
1010 Determines if linkgit:git-gui[1] should trust the file modification
1011 timestamp or not. By default the timestamps are not trusted.
1013 gui.spellingdictionary::
1014 Specifies the dictionary used for spell checking commit messages in
1015 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1016 off.
1018 gui.fastcopyblame::
1019 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
1020 location detection. It makes blame significantly faster on huge
1021 repositories at the expense of less thorough copy detection.
1023 gui.copyblamethreshold::
1024 Specifies the threshold to use in 'git gui blame' original location
1025 detection, measured in alphanumeric characters. See the
1026 linkgit:git-blame[1] manual for more information on copy detection.
1028 gui.blamehistoryctx::
1029 Specifies the radius of history context in days to show in
1030 linkgit:gitk[1] for the selected commit, when the `Show History
1031 Context` menu item is invoked from 'git gui blame'. If this
1032 variable is set to zero, the whole history is shown.
1034 guitool.<name>.cmd::
1035 Specifies the shell command line to execute when the corresponding item
1036 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1037 mandatory for every tool. The command is executed from the root of
1038 the working directory, and in the environment it receives the name of
1039 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1040 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1041 the head is detached, 'CUR_BRANCH' is empty).
1043 guitool.<name>.needsfile::
1044 Run the tool only if a diff is selected in the GUI. It guarantees
1045 that 'FILENAME' is not empty.
1047 guitool.<name>.noconsole::
1048 Run the command silently, without creating a window to display its
1049 output.
1051 guitool.<name>.norescan::
1052 Don't rescan the working directory for changes after the tool
1053 finishes execution.
1055 guitool.<name>.confirm::
1056 Show a confirmation dialog before actually running the tool.
1058 guitool.<name>.argprompt::
1059 Request a string argument from the user, and pass it to the tool
1060 through the 'ARGS' environment variable. Since requesting an
1061 argument implies confirmation, the 'confirm' option has no effect
1062 if this is enabled. If the option is set to 'true', 'yes', or '1',
1063 the dialog uses a built-in generic prompt; otherwise the exact
1064 value of the variable is used.
1066 guitool.<name>.revprompt::
1067 Request a single valid revision from the user, and set the
1068 'REVISION' environment variable. In other aspects this option
1069 is similar to 'argprompt', and can be used together with it.
1071 guitool.<name>.revunmerged::
1072 Show only unmerged branches in the 'revprompt' subdialog.
1073 This is useful for tools similar to merge or rebase, but not
1074 for things like checkout or reset.
1076 guitool.<name>.title::
1077 Specifies the title to use for the prompt dialog. The default
1078 is the tool name.
1080 guitool.<name>.prompt::
1081 Specifies the general prompt string to display at the top of
1082 the dialog, before subsections for 'argprompt' and 'revprompt'.
1083 The default value includes the actual command.
1085 help.browser::
1086 Specify the browser that will be used to display help in the
1087 'web' format. See linkgit:git-help[1].
1089 help.format::
1090 Override the default help format used by linkgit:git-help[1].
1091 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1092 the default. 'web' and 'html' are the same.
1094 help.autocorrect::
1095 Automatically correct and execute mistyped commands after
1096 waiting for the given number of deciseconds (0.1 sec). If more
1097 than one command can be deduced from the entered text, nothing
1098 will be executed. If the value of this option is negative,
1099 the corrected command will be executed immediately. If the
1100 value is 0 - the command will be just shown but not executed.
1101 This is the default.
1103 http.proxy::
1104 Override the HTTP proxy, normally configured using the 'http_proxy'
1105 environment variable (see linkgit:curl[1]). This can be overridden
1106 on a per-remote basis; see remote.<name>.proxy
1108 http.sslVerify::
1109 Whether to verify the SSL certificate when fetching or pushing
1110 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1111 variable.
1113 http.sslCert::
1114 File containing the SSL certificate when fetching or pushing
1115 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1116 variable.
1118 http.sslKey::
1119 File containing the SSL private key when fetching or pushing
1120 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1121 variable.
1123 http.sslCertPasswordProtected::
1124 Enable git's password prompt for the SSL certificate. Otherwise
1125 OpenSSL will prompt the user, possibly many times, if the
1126 certificate or private key is encrypted. Can be overridden by the
1127 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1129 http.sslCAInfo::
1130 File containing the certificates to verify the peer with when
1131 fetching or pushing over HTTPS. Can be overridden by the
1132 'GIT_SSL_CAINFO' environment variable.
1134 http.sslCAPath::
1135 Path containing files with the CA certificates to verify the peer
1136 with when fetching or pushing over HTTPS. Can be overridden
1137 by the 'GIT_SSL_CAPATH' environment variable.
1139 http.maxRequests::
1140 How many HTTP requests to launch in parallel. Can be overridden
1141 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1143 http.minSessions::
1144 The number of curl sessions (counted across slots) to be kept across
1145 requests. They will not be ended with curl_easy_cleanup() until
1146 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1147 value will be capped at 1. Defaults to 1.
1149 http.postBuffer::
1150 Maximum size in bytes of the buffer used by smart HTTP
1151 transports when POSTing data to the remote system.
1152 For requests larger than this buffer size, HTTP/1.1 and
1153 Transfer-Encoding: chunked is used to avoid creating a
1154 massive pack file locally. Default is 1 MiB, which is
1155 sufficient for most requests.
1157 http.lowSpeedLimit, http.lowSpeedTime::
1158 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1159 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1160 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1161 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1163 http.noEPSV::
1164 A boolean which disables using of EPSV ftp command by curl.
1165 This can helpful with some "poor" ftp servers which don't
1166 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1167 environment variable. Default is false (curl will use EPSV).
1169 i18n.commitEncoding::
1170 Character encoding the commit messages are stored in; git itself
1171 does not care per se, but this information is necessary e.g. when
1172 importing commits from emails or in the gitk graphical history
1173 browser (and possibly at other places in the future or in other
1174 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1176 i18n.logOutputEncoding::
1177 Character encoding the commit messages are converted to when
1178 running 'git-log' and friends.
1180 imap::
1181 The configuration variables in the 'imap' section are described
1182 in linkgit:git-imap-send[1].
1184 instaweb.browser::
1185 Specify the program that will be used to browse your working
1186 repository in gitweb. See linkgit:git-instaweb[1].
1188 instaweb.httpd::
1189 The HTTP daemon command-line to start gitweb on your working
1190 repository. See linkgit:git-instaweb[1].
1192 instaweb.local::
1193 If true the web server started by linkgit:git-instaweb[1] will
1194 be bound to the local IP (
1196 instaweb.modulepath::
1197 The module path for an apache httpd used by linkgit:git-instaweb[1].
1199 instaweb.port::
1200 The port number to bind the gitweb httpd to. See
1201 linkgit:git-instaweb[1].
1203 interactive.singlekey::
1204 In interactive commands, allow the user to provide one-letter
1205 input with a single key (i.e., without hitting enter).
1206 Currently this is used only by the `\--patch` mode of
1207 linkgit:git-add[1]. Note that this setting is silently
1208 ignored if portable keystroke input is not available.
1211 Set default date-time mode for the log command. Setting
1212 value is similar to using 'git-log'\'s --date option. The value is one of the
1213 following alternatives: {relative,local,default,iso,rfc,short}.
1214 See linkgit:git-log[1].
1216 log.showroot::
1217 If true, the initial commit will be shown as a big creation event.
1218 This is equivalent to a diff against an empty tree.
1219 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1220 normally hide the root commit will now show it. True by default.
1222 mailmap.file::
1223 The location of an augmenting mailmap file. The default
1224 mailmap, located in the root of the repository, is loaded
1225 first, then the mailmap file pointed to by this variable.
1226 The location of the mailmap file may be in a repository
1227 subdirectory, or somewhere outside of the repository itself.
1228 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1230 man.viewer::
1231 Specify the programs that may be used to display help in the
1232 'man' format. See linkgit:git-help[1].
1234 man.<tool>.cmd::
1235 Specify the command to invoke the specified man viewer. The
1236 specified command is evaluated in shell with the man page
1237 passed as argument. (See linkgit:git-help[1].)
1239 man.<tool>.path::
1240 Override the path for the given tool that may be used to
1241 display help in the 'man' format. See linkgit:git-help[1].
1243 include::merge-config.txt[]
1245 mergetool.<tool>.path::
1246 Override the path for the given tool. This is useful in case
1247 your tool is not in the PATH.
1249 mergetool.<tool>.cmd::
1250 Specify the command to invoke the specified merge tool. The
1251 specified command is evaluated in shell with the following
1252 variables available: 'BASE' is the name of a temporary file
1253 containing the common base of the files to be merged, if available;
1254 'LOCAL' is the name of a temporary file containing the contents of
1255 the file on the current branch; 'REMOTE' is the name of a temporary
1256 file containing the contents of the file from the branch being
1257 merged; 'MERGED' contains the name of the file to which the merge
1258 tool should write the results of a successful merge.
1260 mergetool.<tool>.trustExitCode::
1261 For a custom merge command, specify whether the exit code of
1262 the merge command can be used to determine whether the merge was
1263 successful. If this is not set to true then the merge target file
1264 timestamp is checked and the merge assumed to have been successful
1265 if the file has been updated, otherwise the user is prompted to
1266 indicate the success of the merge.
1268 mergetool.keepBackup::
1269 After performing a merge, the original file with conflict markers
1270 can be saved as a file with a `.orig` extension. If this variable
1271 is set to `false` then this file is not preserved. Defaults to
1272 `true` (i.e. keep the backup files).
1274 mergetool.keepTemporaries::
1275 When invoking a custom merge tool, git uses a set of temporary
1276 files to pass to the tool. If the tool returns an error and this
1277 variable is set to `true`, then these temporary files will be
1278 preserved, otherwise they will be removed after the tool has
1279 exited. Defaults to `false`.
1281 mergetool.prompt::
1282 Prompt before each invocation of the merge resolution program.
1284 pack.window::
1285 The size of the window used by linkgit:git-pack-objects[1] when no
1286 window size is given on the command line. Defaults to 10.
1288 pack.depth::
1289 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1290 maximum depth is given on the command line. Defaults to 50.
1292 pack.windowMemory::
1293 The window memory size limit used by linkgit:git-pack-objects[1]
1294 when no limit is given on the command line. The value can be
1295 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1296 limit.
1298 pack.compression::
1299 An integer -1..9, indicating the compression level for objects
1300 in a pack file. -1 is the zlib default. 0 means no
1301 compression, and 1..9 are various speed/size tradeoffs, 9 being
1302 slowest. If not set, defaults to core.compression. If that is
1303 not set, defaults to -1, the zlib default, which is "a default
1304 compromise between speed and compression (currently equivalent
1305 to level 6)."
1307 pack.deltaCacheSize::
1308 The maximum memory in bytes used for caching deltas in
1309 linkgit:git-pack-objects[1] before writing them out to a pack.
1310 This cache is used to speed up the writing object phase by not
1311 having to recompute the final delta result once the best match
1312 for all objects is found. Repacking large repositories on machines
1313 which are tight with memory might be badly impacted by this though,
1314 especially if this cache pushes the system into swapping.
1315 A value of 0 means no limit. The smallest size of 1 byte may be
1316 used to virtually disable this cache. Defaults to 256 MiB.
1318 pack.deltaCacheLimit::
1319 The maximum size of a delta, that is cached in
1320 linkgit:git-pack-objects[1]. This cache is used to speed up the
1321 writing object phase by not having to recompute the final delta
1322 result once the best match for all objects is found. Defaults to 1000.
1324 pack.threads::
1325 Specifies the number of threads to spawn when searching for best
1326 delta matches. This requires that linkgit:git-pack-objects[1]
1327 be compiled with pthreads otherwise this option is ignored with a
1328 warning. This is meant to reduce packing time on multiprocessor
1329 machines. The required amount of memory for the delta search window
1330 is however multiplied by the number of threads.
1331 Specifying 0 will cause git to auto-detect the number of CPU's
1332 and set the number of threads accordingly.
1334 pack.indexVersion::
1335 Specify the default pack index version. Valid values are 1 for
1336 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1337 the new pack index with capabilities for packs larger than 4 GB
1338 as well as proper protection against the repacking of corrupted
1339 packs. Version 2 is the default. Note that version 2 is enforced
1340 and this config option ignored whenever the corresponding pack is
1341 larger than 2 GB.
1342 +
1343 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1344 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1345 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1346 other side may give you a repository that cannot be accessed with your
1347 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1348 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1349 the `{asterisk}.idx` file.
1351 pack.packSizeLimit::
1352 The default maximum size of a pack. This setting only affects
1353 packing to a file, i.e. the git:// protocol is unaffected. It
1354 can be overridden by the `\--max-pack-size` option of
1355 linkgit:git-repack[1].
1357 pager.<cmd>::
1358 Allows turning on or off pagination of the output of a
1359 particular git subcommand when writing to a tty. If
1360 `\--paginate` or `\--no-pager` is specified on the command line,
1361 it takes precedence over this option. To disable pagination for
1362 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1364 pull.octopus::
1365 The default merge strategy to use when pulling multiple branches
1366 at once.
1368 pull.twohead::
1369 The default merge strategy to use when pulling a single branch.
1371 push.default::
1372 Defines the action git push should take if no refspec is given
1373 on the command line, no refspec is configured in the remote, and
1374 no refspec is implied by any of the options given on the command
1375 line. Possible values are:
1376 +
1377 * `nothing` do not push anything.
1378 * `matching` push all matching branches.
1379 All branches having the same name in both ends are considered to be
1380 matching. This is the default.
1381 * `tracking` push the current branch to its upstream branch.
1382 * `current` push the current branch to a branch of the same name.
1384 rebase.stat::
1385 Whether to show a diffstat of what changed upstream since the last
1386 rebase. False by default.
1388 receive.autogc::
1389 By default, git-receive-pack will run "git-gc --auto" after
1390 receiving data from git-push and updating refs. You can stop
1391 it by setting this variable to false.
1393 receive.fsckObjects::
1394 If it is set to true, git-receive-pack will check all received
1395 objects. It will abort in the case of a malformed object or a
1396 broken link. The result of an abort are only dangling objects.
1397 Defaults to false.
1399 receive.unpackLimit::
1400 If the number of objects received in a push is below this
1401 limit then the objects will be unpacked into loose object
1402 files. However if the number of received objects equals or
1403 exceeds this limit then the received pack will be stored as
1404 a pack, after adding any missing delta bases. Storing the
1405 pack from a push can make the push operation complete faster,
1406 especially on slow filesystems. If not set, the value of
1407 `transfer.unpackLimit` is used instead.
1409 receive.denyDeletes::
1410 If set to true, git-receive-pack will deny a ref update that deletes
1411 the ref. Use this to prevent such a ref deletion via a push.
1413 receive.denyCurrentBranch::
1414 If set to true or "refuse", receive-pack will deny a ref update
1415 to the currently checked out branch of a non-bare repository.
1416 Such a push is potentially dangerous because it brings the HEAD
1417 out of sync with the index and working tree. If set to "warn",
1418 print a warning of such a push to stderr, but allow the push to
1419 proceed. If set to false or "ignore", allow such pushes with no
1420 message. Defaults to "warn".
1422 receive.denyNonFastForwards::
1423 If set to true, git-receive-pack will deny a ref update which is
1424 not a fast-forward. Use this to prevent such an update via a push,
1425 even if that push is forced. This configuration variable is
1426 set when initializing a shared repository.
1428 receive.updateserverinfo::
1429 If set to true, git-receive-pack will run git-update-server-info
1430 after receiving data from git-push and updating refs.
1432 remote.<name>.url::
1433 The URL of a remote repository. See linkgit:git-fetch[1] or
1434 linkgit:git-push[1].
1436 remote.<name>.pushurl::
1437 The push URL of a remote repository. See linkgit:git-push[1].
1439 remote.<name>.proxy::
1440 For remotes that require curl (http, https and ftp), the URL to
1441 the proxy to use for that remote. Set to the empty string to
1442 disable proxying for that remote.
1444 remote.<name>.fetch::
1445 The default set of "refspec" for linkgit:git-fetch[1]. See
1446 linkgit:git-fetch[1].
1448 remote.<name>.push::
1449 The default set of "refspec" for linkgit:git-push[1]. See
1450 linkgit:git-push[1].
1452 remote.<name>.mirror::
1453 If true, pushing to this remote will automatically behave
1454 as if the `\--mirror` option was given on the command line.
1456 remote.<name>.skipDefaultUpdate::
1457 If true, this remote will be skipped by default when updating
1458 using linkgit:git-fetch[1] or the `update` subcommand of
1459 linkgit:git-remote[1].
1461 remote.<name>.skipFetchAll::
1462 If true, this remote will be skipped by default when updating
1463 using linkgit:git-fetch[1] or the `update` subcommand of
1464 linkgit:git-remote[1].
1466 remote.<name>.receivepack::
1467 The default program to execute on the remote side when pushing. See
1468 option \--receive-pack of linkgit:git-push[1].
1470 remote.<name>.uploadpack::
1471 The default program to execute on the remote side when fetching. See
1472 option \--upload-pack of linkgit:git-fetch-pack[1].
1474 remote.<name>.tagopt::
1475 Setting this value to \--no-tags disables automatic tag following when
1476 fetching from remote <name>
1478 remote.<name>.vcs::
1479 Setting this to a value <vcs> will cause git to interact with
1480 the remote with the git-remote-<vcs> helper.
1482 remotes.<group>::
1483 The list of remotes which are fetched by "git remote update
1484 <group>". See linkgit:git-remote[1].
1486 repack.usedeltabaseoffset::
1487 By default, linkgit:git-repack[1] creates packs that use
1488 delta-base offset. If you need to share your repository with
1489 git older than version 1.4.4, either directly or via a dumb
1490 protocol such as http, then you need to set this option to
1491 "false" and repack. Access from old git versions over the
1492 native protocol are unaffected by this option.
1494 rerere.autoupdate::
1495 When set to true, `git-rerere` updates the index with the
1496 resulting contents after it cleanly resolves conflicts using
1497 previously recorded resolution. Defaults to false.
1499 rerere.enabled::
1500 Activate recording of resolved conflicts, so that identical
1501 conflict hunks can be resolved automatically, should they
1502 be encountered again. linkgit:git-rerere[1] command is by
1503 default enabled if you create `rr-cache` directory under
1504 `$GIT_DIR`, but can be disabled by setting this option to false.
1506 sendemail.identity::
1507 A configuration identity. When given, causes values in the
1508 'sendemail.<identity>' subsection to take precedence over
1509 values in the 'sendemail' section. The default identity is
1510 the value of 'sendemail.identity'.
1512 sendemail.smtpencryption::
1513 See linkgit:git-send-email[1] for description. Note that this
1514 setting is not subject to the 'identity' mechanism.
1516 sendemail.smtpssl::
1517 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1519 sendemail.<identity>.*::
1520 Identity-specific versions of the 'sendemail.*' parameters
1521 found below, taking precedence over those when the this
1522 identity is selected, through command-line or
1523 'sendemail.identity'.
1525 sendemail.aliasesfile::
1526 sendemail.aliasfiletype::
1527 sendemail.bcc::
1529 sendemail.cccmd::
1530 sendemail.chainreplyto::
1531 sendemail.confirm::
1532 sendemail.envelopesender::
1533 sendemail.from::
1534 sendemail.multiedit::
1535 sendemail.signedoffbycc::
1536 sendemail.smtppass::
1537 sendemail.suppresscc::
1538 sendemail.suppressfrom::
1540 sendemail.smtpserver::
1541 sendemail.smtpserverport::
1542 sendemail.smtpuser::
1543 sendemail.thread::
1544 sendemail.validate::
1545 See linkgit:git-send-email[1] for description.
1547 sendemail.signedoffcc::
1548 Deprecated alias for 'sendemail.signedoffbycc'.
1550 showbranch.default::
1551 The default set of branches for linkgit:git-show-branch[1].
1552 See linkgit:git-show-branch[1].
1554 status.relativePaths::
1555 By default, linkgit:git-status[1] shows paths relative to the
1556 current directory. Setting this variable to `false` shows paths
1557 relative to the repository root (this was the default for git
1558 prior to v1.5.4).
1560 status.showUntrackedFiles::
1561 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1562 files which are not currently tracked by Git. Directories which
1563 contain only untracked files, are shown with the directory name
1564 only. Showing untracked files means that Git needs to lstat() all
1565 all the files in the whole repository, which might be slow on some
1566 systems. So, this variable controls how the commands displays
1567 the untracked files. Possible values are:
1568 +
1569 --
1570 - 'no' - Show no untracked files
1571 - 'normal' - Shows untracked files and directories
1572 - 'all' - Shows also individual files in untracked directories.
1573 --
1574 +
1575 If this variable is not specified, it defaults to 'normal'.
1576 This variable can be overridden with the -u|--untracked-files option
1577 of linkgit:git-status[1] and linkgit:git-commit[1].
1579 tar.umask::
1580 This variable can be used to restrict the permission bits of
1581 tar archive entries. The default is 0002, which turns off the
1582 world write bit. The special value "user" indicates that the
1583 archiving user's umask will be used instead. See umask(2) and
1584 linkgit:git-archive[1].
1586 transfer.unpackLimit::
1587 When `fetch.unpackLimit` or `receive.unpackLimit` are
1588 not set, the value of this variable is used instead.
1589 The default value is 100.
1591 url.<base>.insteadOf::
1592 Any URL that starts with this value will be rewritten to
1593 start, instead, with <base>. In cases where some site serves a
1594 large number of repositories, and serves them with multiple
1595 access methods, and some users need to use different access
1596 methods, this feature allows people to specify any of the
1597 equivalent URLs and have git automatically rewrite the URL to
1598 the best alternative for the particular user, even for a
1599 never-before-seen repository on the site. When more than one
1600 insteadOf strings match a given URL, the longest match is used.
1602 url.<base>.pushInsteadOf::
1603 Any URL that starts with this value will not be pushed to;
1604 instead, it will be rewritten to start with <base>, and the
1605 resulting URL will be pushed to. In cases where some site serves
1606 a large number of repositories, and serves them with multiple
1607 access methods, some of which do not allow push, this feature
1608 allows people to specify a pull-only URL and have git
1609 automatically use an appropriate URL to push, even for a
1610 never-before-seen repository on the site. When more than one
1611 pushInsteadOf strings match a given URL, the longest match is
1612 used. If a remote has an explicit pushurl, git will ignore this
1613 setting for that remote.
1616 Your email address to be recorded in any newly created commits.
1617 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1618 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1621 Your full name to be recorded in any newly created commits.
1622 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1623 environment variables. See linkgit:git-commit-tree[1].
1625 user.signingkey::
1626 If linkgit:git-tag[1] is not selecting the key you want it to
1627 automatically when creating a signed tag, you can override the
1628 default selection with this variable. This option is passed
1629 unchanged to gpg's --local-user parameter, so you may specify a key
1630 using any method that gpg supports.
1632 web.browser::
1633 Specify a web browser that may be used by some commands.
1634 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1635 may use it.