Merge branch 'mh/show-branch-color' into sb/show-branch-parse-options
[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 are recognized as setting variables, in the form
53 'name = value'. If there is no equal sign on the line, the entire line
54 is taken as 'name' and the variable is recognized as boolean "true".
55 The variable names are case-insensitive and only alphanumeric
56 characters and `-` are allowed. There can be more than one value
57 for a given variable; we say then that variable is multivalued.
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
62 The values following the equals sign in variable assign are all either
63 a string, an integer, or a boolean. Boolean values may be given as yes/no,
64 0/1, true/false or on/off. Case is not significant in boolean values, when
65 converting value to the canonical form using '--bool' type specifier;
66 'git-config' will ensure that the output is "true" or "false".
68 String values may be entirely or partially enclosed in double quotes.
69 You need to enclose variable values in double quotes if you want to
70 preserve leading or trailing whitespace, or if the variable value contains
71 comment characters (i.e. it contains '#' or ';').
72 Double quote `"` and backslash `\` characters in variable values must
73 be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). No other char escape sequence, nor octal
78 char sequences are valid.
80 Variable values ending in a `\` are continued on the next line in the
81 customary UNIX fashion.
83 Some variables may require a special value format.
85 Example
86 ~~~~~~~
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
93 # Our diff algorithm
94 [diff]
95 external = /usr/local/bin/diff-wrapper
96 renames = true
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
102 # Proxy settings
103 [core]
104 gitProxy="ssh" for ""
105 gitProxy=default-proxy ; for the rest
107 Variables
108 ~~~~~~~~~
110 Note that this list is non-comprehensive and not necessarily complete.
111 For command-specific variables, you will find a more detailed description
112 in the appropriate manual page. You will find a description of non-core
113 porcelain configuration variables in the respective porcelain documentation.
115 core.fileMode::
116 If false, the executable bit differences between the index and
117 the working copy are ignored; useful on broken filesystems like FAT.
118 See linkgit:git-update-index[1]. True by default.
120 core.ignoreCygwinFSTricks::
121 This option is only used by Cygwin implementation of Git. If false,
122 the Cygwin stat() and lstat() functions are used. This may be useful
123 if your repository consists of a few separate directories joined in
124 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125 whenever it is possible and falls back to Cygwin functions only to
126 handle symbol links. The native mode is more than twice faster than
127 normal Cygwin l/stat() functions. True by default, unless core.filemode
128 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129 POSIX emulation is required to support core.filemode.
131 core.trustctime::
132 If false, the ctime differences between the index and the
133 working copy are ignored; useful when the inode change time
134 is regularly modified by something outside Git (file system
135 crawlers and some backup systems).
136 See linkgit:git-update-index[1]. True by default.
138 core.quotepath::
139 The commands that output paths (e.g. 'ls-files',
140 'diff'), when not given the `-z` option, will quote
141 "unusual" characters in the pathname by enclosing the
142 pathname in a double-quote pair and with backslashes the
143 same way strings in C source code are quoted. If this
144 variable is set to false, the bytes higher than 0x80 are
145 not quoted but output as verbatim. Note that double
146 quote, backslash and control characters are always
147 quoted without `-z` regardless of the setting of this
148 variable.
150 core.autocrlf::
151 If true, makes git convert `CRLF` at the end of lines in text files to
152 `LF` when reading from the filesystem, and convert in reverse when
153 writing to the filesystem. The variable can be set to
154 'input', in which case the conversion happens only while
155 reading from the filesystem but files are written out with
156 `LF` at the end of lines. Currently, which paths to consider
157 "text" (i.e. be subjected to the autocrlf mechanism) is
158 decided purely based on the contents.
160 core.safecrlf::
161 If true, makes git check if converting `CRLF` as controlled by
162 `core.autocrlf` is reversible. Git will verify if a command
163 modifies a file in the work tree either directly or indirectly.
164 For example, committing a file followed by checking out the
165 same file should yield the original file in the work tree. If
166 this is not the case for the current setting of
167 `core.autocrlf`, git will reject the file. The variable can
168 be set to "warn", in which case git will only warn about an
169 irreversible conversion but continue the operation.
170 +
171 CRLF conversion bears a slight chance of corrupting data.
172 autocrlf=true will convert CRLF to LF during commit and LF to
173 CRLF during checkout. A file that contains a mixture of LF and
174 CRLF before the commit cannot be recreated by git. For text
175 files this is the right thing to do: it corrects line endings
176 such that we have only LF line endings in the repository.
177 But for binary files that are accidentally classified as text the
178 conversion can corrupt data.
179 +
180 If you recognize such corruption early you can easily fix it by
181 setting the conversion type explicitly in .gitattributes. Right
182 after committing you still have the original file in your work
183 tree and this file is not yet corrupted. You can explicitly tell
184 git that this file is binary and git will handle the file
185 appropriately.
186 +
187 Unfortunately, the desired effect of cleaning up text files with
188 mixed line endings and the undesired effect of corrupting binary
189 files cannot be distinguished. In both cases CRLFs are removed
190 in an irreversible way. For text files this is the right thing
191 to do because CRLFs are line endings, while for binary files
192 converting CRLFs corrupts data.
193 +
194 Note, this safety check does not mean that a checkout will generate a
195 file identical to the original file for a different setting of
196 `core.autocrlf`, but only for the current one. For example, a text
197 file with `LF` would be accepted with `core.autocrlf=input` and could
198 later be checked out with `core.autocrlf=true`, in which case the
199 resulting file would contain `CRLF`, although the original file
200 contained `LF`. However, in both work trees the line endings would be
201 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
202 file with mixed line endings would be reported by the `core.safecrlf`
203 mechanism.
205 core.symlinks::
206 If false, symbolic links are checked out as small plain files that
207 contain the link text. linkgit:git-update-index[1] and
208 linkgit:git-add[1] will not change the recorded type to regular
209 file. Useful on filesystems like FAT that do not support
210 symbolic links. True by default.
212 core.gitProxy::
213 A "proxy command" to execute (as 'command host port') instead
214 of establishing direct connection to the remote server when
215 using the git protocol for fetching. If the variable value is
216 in the "COMMAND for DOMAIN" format, the command is applied only
217 on hostnames ending with the specified domain string. This variable
218 may be set multiple times and is matched in the given order;
219 the first match wins.
220 +
221 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222 (which always applies universally, without the special "for"
223 handling).
224 +
225 The special string `none` can be used as the proxy command to
226 specify that no proxy be used for a given domain pattern.
227 This is useful for excluding servers inside a firewall from
228 proxy use, while defaulting to a common proxy for external domains.
230 core.ignoreStat::
231 If true, commands which modify both the working tree and the index
232 will mark the updated paths with the "assume unchanged" bit in the
233 index. These marked files are then assumed to stay unchanged in the
234 working copy, until you mark them otherwise manually - Git will not
235 detect the file changes by lstat() calls. This is useful on systems
236 where those are very slow, such as Microsoft Windows.
237 See linkgit:git-update-index[1].
238 False by default.
240 core.preferSymlinkRefs::
241 Instead of the default "symref" format for HEAD
242 and other symbolic reference files, use symbolic links.
243 This is sometimes needed to work with old scripts that
244 expect HEAD to be a symbolic link.
246 core.bare::
247 If true this repository is assumed to be 'bare' and has no
248 working directory associated with it. If this is the case a
249 number of commands that require a working directory will be
250 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
251 +
252 This setting is automatically guessed by linkgit:git-clone[1] or
253 linkgit:git-init[1] when the repository was created. By default a
254 repository that ends in "/.git" is assumed to be not bare (bare =
255 false), while all other repositories are assumed to be bare (bare
256 = true).
258 core.worktree::
259 Set the path to the working tree. The value will not be
260 used in combination with repositories found automatically in
261 a .git directory (i.e. $GIT_DIR is not set).
262 This can be overridden by the GIT_WORK_TREE environment
263 variable and the '--work-tree' command line option. It can be
264 a absolute path or relative path to the directory specified by
265 --git-dir or GIT_DIR.
266 Note: If --git-dir or GIT_DIR are specified but none of
267 --work-tree, GIT_WORK_TREE and core.worktree is specified,
268 the current working directory is regarded as the top directory
269 of your working tree.
271 core.logAllRefUpdates::
272 Enable the reflog. Updates to a ref <ref> is logged to the file
273 "$GIT_DIR/logs/<ref>", by appending the new and old
274 SHA1, the date/time and the reason of the update, but
275 only when the file exists. If this configuration
276 variable is set to true, missing "$GIT_DIR/logs/<ref>"
277 file is automatically created for branch heads.
278 +
279 This information can be used to determine what commit
280 was the tip of a branch "2 days ago".
281 +
282 This value is true by default in a repository that has
283 a working directory associated with it, and false by
284 default in a bare repository.
286 core.repositoryFormatVersion::
287 Internal variable identifying the repository format and layout
288 version.
290 core.sharedRepository::
291 When 'group' (or 'true'), the repository is made shareable between
292 several users in a group (making sure all the files and objects are
293 group-writable). When 'all' (or 'world' or 'everybody'), the
294 repository will be readable by all users, additionally to being
295 group-shareable. When 'umask' (or 'false'), git will use permissions
296 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
297 files in the repository will have this mode value. '0xxx' will override
298 user's umask value (whereas the other options will only override
299 requested parts of the user's umask value). Examples: '0660' will make
300 the repo read/write-able for the owner and group, but inaccessible to
301 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
302 repository that is group-readable but not group-writable.
303 See linkgit:git-init[1]. False by default.
305 core.warnAmbiguousRefs::
306 If true, git will warn you if the ref name you passed it is ambiguous
307 and might match multiple refs in the .git/refs/ tree. True by default.
309 core.compression::
310 An integer -1..9, indicating a default compression level.
311 -1 is the zlib default. 0 means no compression,
312 and 1..9 are various speed/size tradeoffs, 9 being slowest.
313 If set, this provides a default to other compression variables,
314 such as 'core.loosecompression' and 'pack.compression'.
316 core.loosecompression::
317 An integer -1..9, indicating the compression level for objects that
318 are not in a pack file. -1 is the zlib default. 0 means no
319 compression, and 1..9 are various speed/size tradeoffs, 9 being
320 slowest. If not set, defaults to core.compression. If that is
321 not set, defaults to 1 (best speed).
323 core.packedGitWindowSize::
324 Number of bytes of a pack file to map into memory in a
325 single mapping operation. Larger window sizes may allow
326 your system to process a smaller number of large pack files
327 more quickly. Smaller window sizes will negatively affect
328 performance due to increased calls to the operating system's
329 memory manager, but may improve performance when accessing
330 a large number of large pack files.
331 +
332 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
333 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
334 be reasonable for all users/operating systems. You probably do
335 not need to adjust this value.
336 +
337 Common unit suffixes of 'k', 'm', or 'g' are supported.
339 core.packedGitLimit::
340 Maximum number of bytes to map simultaneously into memory
341 from pack files. If Git needs to access more than this many
342 bytes at once to complete an operation it will unmap existing
343 regions to reclaim virtual address space within the process.
344 +
345 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
346 This should be reasonable for all users/operating systems, except on
347 the largest projects. You probably do not need to adjust this value.
348 +
349 Common unit suffixes of 'k', 'm', or 'g' are supported.
351 core.deltaBaseCacheLimit::
352 Maximum number of bytes to reserve for caching base objects
353 that multiple deltafied objects reference. By storing the
354 entire decompressed base objects in a cache Git is able
355 to avoid unpacking and decompressing frequently used base
356 objects multiple times.
357 +
358 Default is 16 MiB on all platforms. This should be reasonable
359 for all users/operating systems, except on the largest projects.
360 You probably do not need to adjust this value.
361 +
362 Common unit suffixes of 'k', 'm', or 'g' are supported.
364 core.excludesfile::
365 In addition to '.gitignore' (per-directory) and
366 '.git/info/exclude', git looks into this file for patterns
367 of files which are not meant to be tracked. See
368 linkgit:gitignore[5].
370 core.editor::
371 Commands such as `commit` and `tag` that lets you edit
372 messages by launching an editor uses the value of this
373 variable when it is set, and the environment variable
374 `GIT_EDITOR` is not set. The order of preference is
375 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
376 `EDITOR` environment variables and then finally `vi`.
378 core.pager::
379 The command that git will use to paginate output. Can
380 be overridden with the `GIT_PAGER` environment
381 variable. Note that git sets the `LESS` environment
382 variable to `FRSX` if it is unset when it runs the
383 pager. One can change these settings by setting the
384 `LESS` variable to some other value. Alternately,
385 these settings can be overridden on a project or
386 global basis by setting the `core.pager` option.
387 Setting `core.pager` has no affect on the `LESS`
388 environment variable behaviour above, so if you want
389 to override git's default settings this way, you need
390 to be explicit. For example, to disable the S option
391 in a backward compatible manner, set `core.pager`
392 to `less -+$LESS -FRX`. This will be passed to the
393 shell by git, which will translate the final command to
394 `LESS=FRSX less -+FRSX -FRX`.
396 core.whitespace::
397 A comma separated list of common whitespace problems to
398 notice. 'git-diff' will use `color.diff.whitespace` to
399 highlight them, and 'git-apply --whitespace=error' will
400 consider them as errors. You can prefix `-` to disable
401 any of them (e.g. `-trailing-space`):
402 +
403 * `trailing-space` treats trailing whitespaces at the end of the line
404 as an error (enabled by default).
405 * `space-before-tab` treats a space character that appears immediately
406 before a tab character in the initial indent part of the line as an
407 error (enabled by default).
408 * `indent-with-non-tab` treats a line that is indented with 8 or more
409 space characters as an error (not enabled by default).
410 * `cr-at-eol` treats a carriage-return at the end of line as
411 part of the line terminator, i.e. with it, `trailing-space`
412 does not trigger if the character before such a carriage-return
413 is not a whitespace (not enabled by default).
415 core.fsyncobjectfiles::
416 This boolean will enable 'fsync()' when writing object files.
417 +
418 This is a total waste of time and effort on a filesystem that orders
419 data writes properly, but can be useful for filesystems that do not use
420 journalling (traditional UNIX filesystems) or that only journal metadata
421 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
423 core.preloadindex::
424 Enable parallel index preload for operations like 'git diff'
425 +
426 This can speed up operations like 'git diff' and 'git status' especially
427 on filesystems like NFS that have weak caching semantics and thus
428 relatively high IO latencies. With this set to 'true', git will do the
429 index comparison to the filesystem data in parallel, allowing
430 overlapping IO's.
432 core.createObject::
433 You can set this to 'link', in which case a hardlink followed by
434 a delete of the source are used to make sure that object creation
435 will not overwrite existing objects.
436 +
437 On some file system/operating system combinations, this is unreliable.
438 Set this config setting to 'rename' there; However, This will remove the
439 check that makes sure that existing object files will not get overwritten.
441 alias.*::
442 Command aliases for the linkgit:git[1] command wrapper - e.g.
443 after defining "alias.last = cat-file commit HEAD", the invocation
444 "git last" is equivalent to "git cat-file commit HEAD". To avoid
445 confusion and troubles with script usage, aliases that
446 hide existing git commands are ignored. Arguments are split by
447 spaces, the usual shell quoting and escaping is supported.
448 quote pair and a backslash can be used to quote them.
449 +
450 If the alias expansion is prefixed with an exclamation point,
451 it will be treated as a shell command. For example, defining
452 " = !gitk --all --not ORIG_HEAD", the invocation
453 "git new" is equivalent to running the shell command
454 "gitk --all --not ORIG_HEAD".
456 apply.whitespace::
457 Tells 'git-apply' how to handle whitespaces, in the same way
458 as the '--whitespace' option. See linkgit:git-apply[1].
460 branch.autosetupmerge::
461 Tells 'git-branch' and 'git-checkout' to setup new branches
462 so that linkgit:git-pull[1] will appropriately merge from the
463 starting point branch. Note that even if this option is not set,
464 this behavior can be chosen per-branch using the `--track`
465 and `--no-track` options. The valid settings are: `false` -- no
466 automatic setup is done; `true` -- automatic setup is done when the
467 starting point is a remote branch; `always` -- automatic setup is
468 done when the starting point is either a local branch or remote
469 branch. This option defaults to true.
471 branch.autosetuprebase::
472 When a new branch is created with 'git-branch' or 'git-checkout'
473 that tracks another branch, this variable tells git to set
474 up pull to rebase instead of merge (see "branch.<name>.rebase").
475 When `never`, rebase is never automatically set to true.
476 When `local`, rebase is set to true for tracked branches of
477 other local branches.
478 When `remote`, rebase is set to true for tracked branches of
479 remote branches.
480 When `always`, rebase will be set to true for all tracking
481 branches.
482 See "branch.autosetupmerge" for details on how to set up a
483 branch to track another branch.
484 This option defaults to never.
486 branch.<name>.remote::
487 When in branch <name>, it tells 'git-fetch' and 'git-push' which
488 remote to fetch from/push to. It defaults to `origin` if no remote is
489 configured. `origin` is also used if you are not on any branch.
491 branch.<name>.merge::
492 Defines, together with branch.<name>.remote, the upstream branch
493 for the given branch. It tells 'git-fetch'/'git-pull' which
494 branch to merge and can also affect 'git-push' (see push.default).
495 When in branch <name>, it tells 'git-fetch' the default
496 refspec to be marked for merging in FETCH_HEAD. The value is
497 handled like the remote part of a refspec, and must match a
498 ref which is fetched from the remote given by
499 "branch.<name>.remote".
500 The merge information is used by 'git-pull' (which at first calls
501 'git-fetch') to lookup the default branch for merging. Without
502 this option, 'git-pull' defaults to merge the first refspec fetched.
503 Specify multiple values to get an octopus merge.
504 If you wish to setup 'git-pull' so that it merges into <name> from
505 another branch in the local repository, you can point
506 branch.<name>.merge to the desired branch, and use the special setting
507 `.` (a period) for branch.<name>.remote.
509 branch.<name>.mergeoptions::
510 Sets default options for merging into branch <name>. The syntax and
511 supported options are equal to that of linkgit:git-merge[1], but
512 option values containing whitespace characters are currently not
513 supported.
515 branch.<name>.rebase::
516 When true, rebase the branch <name> on top of the fetched branch,
517 instead of merging the default branch from the default remote when
518 "git pull" is run.
519 *NOTE*: this is a possibly dangerous operation; do *not* use
520 it unless you understand the implications (see linkgit:git-rebase[1]
521 for details).
523 browser.<tool>.cmd::
524 Specify the command to invoke the specified browser. The
525 specified command is evaluated in shell with the URLs passed
526 as arguments. (See linkgit:git-web--browse[1].)
528 browser.<tool>.path::
529 Override the path for the given tool that may be used to
530 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
531 working repository in gitweb (see linkgit:git-instaweb[1]).
533 clean.requireForce::
534 A boolean to make git-clean do nothing unless given -f
535 or -n. Defaults to true.
537 color.branch::
538 A boolean to enable/disable color in the output of
539 linkgit:git-branch[1]. May be set to `always`,
540 `false` (or `never`) or `auto` (or `true`), in which case colors are used
541 only when the output is to a terminal. Defaults to false.
543 color.branch.<slot>::
544 Use customized color for branch coloration. `<slot>` is one of
545 `current` (the current branch), `local` (a local branch),
546 `remote` (a tracking branch in refs/remotes/), `plain` (other
547 refs).
548 +
549 The value for these configuration variables is a list of colors (at most
550 two) and attributes (at most one), separated by spaces. The colors
551 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
552 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
553 `blink` and `reverse`. The first color given is the foreground; the
554 second is the background. The position of the attribute, if any,
555 doesn't matter.
557 color.diff::
558 When set to `always`, always use colors in patch.
559 When false (or `never`), never. When set to `true` or `auto`, use
560 colors only when the output is to the terminal. Defaults to false.
562 color.diff.<slot>::
563 Use customized color for diff colorization. `<slot>` specifies
564 which part of the patch to use the specified color, and is one
565 of `plain` (context text), `meta` (metainformation), `frag`
566 (hunk header), `old` (removed lines), `new` (added lines),
567 `commit` (commit headers), or `whitespace` (highlighting
568 whitespace errors). The values of these variables may be specified as
569 in color.branch.<slot>.
571 color.grep::
572 When set to `always`, always highlight matches. When `false` (or
573 `never`), never. When set to `true` or `auto`, use color only
574 when the output is written to the terminal. Defaults to `false`.
576 color.grep.external::
577 The string value of this variable is passed to an external 'grep'
578 command as a command line option if match highlighting is turned
579 on. If set to an empty string, no option is passed at all,
580 turning off coloring for external 'grep' calls; this is the default.
581 For GNU grep, set it to `--color=always` to highlight matches even
582 when a pager is used.
584 color.grep.match::
585 Use customized color for matches. The value of this variable
586 may be specified as in color.branch.<slot>. It is passed using
587 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
588 calling an external 'grep'.
590 color.interactive::
591 When set to `always`, always use colors for interactive prompts
592 and displays (such as those used by "git-add --interactive").
593 When false (or `never`), never. When set to `true` or `auto`, use
594 colors only when the output is to the terminal. Defaults to false.
596 color.interactive.<slot>::
597 Use customized color for 'git-add --interactive'
598 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
599 four distinct types of normal output from interactive
600 programs. The values of these variables may be specified as
601 in color.branch.<slot>.
603 color.pager::
604 A boolean to enable/disable colored output when the pager is in
605 use (default is true).
607 color.showbranch::
608 A boolean to enable/disable color in the output of
609 linkgit:git-show-branch[1]. May be set to `always`,
610 `false` (or `never`) or `auto` (or `true`), in which case colors are used
611 only when the output is to a terminal. Defaults to false.
613 color.status::
614 A boolean to enable/disable color in the output of
615 linkgit:git-status[1]. May be set to `always`,
616 `false` (or `never`) or `auto` (or `true`), in which case colors are used
617 only when the output is to a terminal. Defaults to false.
619 color.status.<slot>::
620 Use customized color for status colorization. `<slot>` is
621 one of `header` (the header text of the status message),
622 `added` or `updated` (files which are added but not committed),
623 `changed` (files which are changed but not added in the index),
624 `untracked` (files which are not tracked by git), or
625 `nobranch` (the color the 'no branch' warning is shown in, defaulting
626 to red). The values of these variables may be specified as in
627 color.branch.<slot>.
629 color.ui::
630 When set to `always`, always use colors in all git commands which
631 are capable of colored output. When false (or `never`), never. When
632 set to `true` or `auto`, use colors only when the output is to the
633 terminal. When more specific variables of color.* are set, they always
634 take precedence over this setting. Defaults to false.
636 commit.template::
637 Specify a file to use as the template for new commit messages.
639 diff.autorefreshindex::
640 When using 'git-diff' to compare with work tree
641 files, do not consider stat-only change as changed.
642 Instead, silently run `git update-index --refresh` to
643 update the cached stat information for paths whose
644 contents in the work tree match the contents in the
645 index. This option defaults to true. Note that this
646 affects only 'git-diff' Porcelain, and not lower level
647 'diff' commands, such as 'git-diff-files'.
649 diff.external::
650 If this config variable is set, diff generation is not
651 performed using the internal diff machinery, but using the
652 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
653 environment variable. The command is called with parameters
654 as described under "git Diffs" in linkgit:git[1]. Note: if
655 you want to use an external diff program only on a subset of
656 your files, you might want to use linkgit:gitattributes[5] instead.
658 diff.mnemonicprefix::
659 If set, 'git-diff' uses a prefix pair that is different from the
660 standard "a/" and "b/" depending on what is being compared. When
661 this configuration is in effect, reverse diff output also swaps
662 the order of the prefixes:
663 'git-diff';;
664 compares the (i)ndex and the (w)ork tree;
665 'git-diff HEAD';;
666 compares a (c)ommit and the (w)ork tree;
667 'git diff --cached';;
668 compares a (c)ommit and the (i)ndex;
669 'git-diff HEAD:file1 file2';;
670 compares an (o)bject and a (w)ork tree entity;
671 'git diff --no-index a b';;
672 compares two non-git things (1) and (2).
674 diff.renameLimit::
675 The number of files to consider when performing the copy/rename
676 detection; equivalent to the 'git-diff' option '-l'.
678 diff.renames::
679 Tells git to detect renames. If set to any boolean value, it
680 will enable basic rename detection. If set to "copies" or
681 "copy", it will detect copies, as well.
683 diff.suppressBlankEmpty::
684 A boolean to inhibit the standard behavior of printing a space
685 before each empty output line. Defaults to false.
687 diff.tool::
688 Controls which diff tool is used. `diff.tool` overrides
689 `merge.tool` when used by linkgit:git-difftool[1] and has
690 the same valid values as `merge.tool` minus "tortoisemerge"
691 and plus "kompare".
693 difftool.<tool>.path::
694 Override the path for the given tool. This is useful in case
695 your tool is not in the PATH.
697 difftool.<tool>.cmd::
698 Specify the command to invoke the specified diff tool.
699 The specified command is evaluated in shell with the following
700 variables available: 'LOCAL' is set to the name of the temporary
701 file containing the contents of the diff pre-image and 'REMOTE'
702 is set to the name of the temporary file containing the contents
703 of the diff post-image.
705 difftool.prompt::
706 Prompt before each invocation of the diff tool.
708 diff.wordRegex::
709 A POSIX Extended Regular Expression used to determine what is a "word"
710 when performing word-by-word difference calculations. Character
711 sequences that match the regular expression are "words", all other
712 characters are *ignorable* whitespace.
714 fetch.unpackLimit::
715 If the number of objects fetched over the git native
716 transfer is below this
717 limit, then the objects will be unpacked into loose object
718 files. However if the number of received objects equals or
719 exceeds this limit then the received pack will be stored as
720 a pack, after adding any missing delta bases. Storing the
721 pack from a push can make the push operation complete faster,
722 especially on slow filesystems. If not set, the value of
723 `transfer.unpackLimit` is used instead.
725 format.attach::
726 Enable multipart/mixed attachments as the default for
727 'format-patch'. The value can also be a double quoted string
728 which will enable attachments as the default and set the
729 value as the boundary. See the --attach option in
730 linkgit:git-format-patch[1].
732 format.numbered::
733 A boolean which can enable or disable sequence numbers in patch
734 subjects. It defaults to "auto" which enables it only if there
735 is more than one patch. It can be enabled or disabled for all
736 messages by setting it to "true" or "false". See --numbered
737 option in linkgit:git-format-patch[1].
739 format.headers::
740 Additional email headers to include in a patch to be submitted
741 by mail. See linkgit:git-format-patch[1].
744 Additional "Cc:" headers to include in a patch to be submitted
745 by mail. See the --cc option in linkgit:git-format-patch[1].
747 format.subjectprefix::
748 The default for format-patch is to output files with the '[PATCH]'
749 subject prefix. Use this variable to change that prefix.
751 format.suffix::
752 The default for format-patch is to output files with the suffix
753 `.patch`. Use this variable to change that suffix (make sure to
754 include the dot if you want it).
756 format.pretty::
757 The default pretty format for log/show/whatchanged command,
758 See linkgit:git-log[1], linkgit:git-show[1],
759 linkgit:git-whatchanged[1].
761 format.thread::
762 The default threading style for 'git-format-patch'. Can be
763 either a boolean value, `shallow` or `deep`. `shallow`
764 threading makes every mail a reply to the head of the series,
765 where the head is chosen from the cover letter, the
766 `\--in-reply-to`, and the first patch mail, in this order.
767 `deep` threading makes every mail a reply to the previous one.
768 A true boolean value is the same as `shallow`, and a false
769 value disables threading.
771 format.signoff::
772 A boolean value which lets you enable the `-s/--signoff` option of
773 format-patch by default. *Note:* Adding the Signed-off-by: line to a
774 patch should be a conscious act and means that you certify you have
775 the rights to submit this work under the same open source license.
776 Please see the 'SubmittingPatches' document for further discussion.
778 gc.aggressiveWindow::
779 The window size parameter used in the delta compression
780 algorithm used by 'git-gc --aggressive'. This defaults
781 to 10.
784 When there are approximately more than this many loose
785 objects in the repository, `git gc --auto` will pack them.
786 Some Porcelain commands use this command to perform a
787 light-weight garbage collection from time to time. The
788 default value is 6700. Setting this to 0 disables it.
790 gc.autopacklimit::
791 When there are more than this many packs that are not
792 marked with `*.keep` file in the repository, `git gc
793 --auto` consolidates them into one larger pack. The
794 default value is 50. Setting this to 0 disables it.
796 gc.packrefs::
797 'git-gc' does not run `git pack-refs` in a bare repository by
798 default so that older dumb-transport clients can still fetch
799 from the repository. Setting this to `true` lets 'git-gc'
800 to run `git pack-refs`. Setting this to `false` tells
801 'git-gc' never to run `git pack-refs`. The default setting is
802 `notbare`. Enable it only when you know you do not have to
803 support such clients. The default setting will change to `true`
804 at some stage, and setting this to `false` will continue to
805 prevent `git pack-refs` from being run from 'git-gc'.
807 gc.pruneexpire::
808 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
809 Override the grace period with this config variable. The value
810 "now" may be used to disable this grace period and always prune
811 unreachable objects immediately.
813 gc.reflogexpire::
814 'git-reflog expire' removes reflog entries older than
815 this time; defaults to 90 days.
817 gc.reflogexpireunreachable::
818 'git-reflog expire' removes reflog entries older than
819 this time and are not reachable from the current tip;
820 defaults to 30 days.
822 gc.rerereresolved::
823 Records of conflicted merge you resolved earlier are
824 kept for this many days when 'git-rerere gc' is run.
825 The default is 60 days. See linkgit:git-rerere[1].
827 gc.rerereunresolved::
828 Records of conflicted merge you have not resolved are
829 kept for this many days when 'git-rerere gc' is run.
830 The default is 15 days. See linkgit:git-rerere[1].
832 gitcvs.commitmsgannotation::
833 Append this string to each commit message. Set to empty string
834 to disable this feature. Defaults to "via git-CVS emulator".
836 gitcvs.enabled::
837 Whether the CVS server interface is enabled for this repository.
838 See linkgit:git-cvsserver[1].
840 gitcvs.logfile::
841 Path to a log file where the CVS server interface well... logs
842 various stuff. See linkgit:git-cvsserver[1].
844 gitcvs.usecrlfattr::
845 If true, the server will look up the `crlf` attribute for
846 files to determine the '-k' modes to use. If `crlf` is set,
847 the '-k' mode will be left blank, so cvs clients will
848 treat it as text. If `crlf` is explicitly unset, the file
849 will be set with '-kb' mode, which suppresses any newline munging
850 the client might otherwise do. If `crlf` is not specified,
851 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
853 gitcvs.allbinary::
854 This is used if 'gitcvs.usecrlfattr' does not resolve
855 the correct '-kb' mode to use. If true, all
856 unresolved files are sent to the client in
857 mode '-kb'. This causes the client to treat them
858 as binary files, which suppresses any newline munging it
859 otherwise might do. Alternatively, if it is set to "guess",
860 then the contents of the file are examined to decide if
861 it is binary, similar to 'core.autocrlf'.
863 gitcvs.dbname::
864 Database used by git-cvsserver to cache revision information
865 derived from the git repository. The exact meaning depends on the
866 used database driver, for SQLite (which is the default driver) this
867 is a filename. Supports variable substitution (see
868 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
869 Default: '%Ggitcvs.%m.sqlite'
871 gitcvs.dbdriver::
872 Used Perl DBI driver. You can specify any available driver
873 for this here, but it might not work. git-cvsserver is tested
874 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
875 reported *not* to work with 'DBD::mysql'. Experimental feature.
876 May not contain double colons (`:`). Default: 'SQLite'.
877 See linkgit:git-cvsserver[1].
879 gitcvs.dbuser, gitcvs.dbpass::
880 Database user and password. Only useful if setting 'gitcvs.dbdriver',
881 since SQLite has no concept of database users and/or passwords.
882 'gitcvs.dbuser' supports variable substitution (see
883 linkgit:git-cvsserver[1] for details).
885 gitcvs.dbTableNamePrefix::
886 Database table name prefix. Prepended to the names of any
887 database tables used, allowing a single database to be used
888 for several repositories. Supports variable substitution (see
889 linkgit:git-cvsserver[1] for details). Any non-alphabetic
890 characters will be replaced with underscores.
892 All gitcvs variables except for 'gitcvs.usecrlfattr' and
893 'gitcvs.allbinary' can also be specified as
894 'gitcvs.<access_method>.<varname>' (where 'access_method'
895 is one of "ext" and "pserver") to make them apply only for the given
896 access method.
898 gui.commitmsgwidth::
899 Defines how wide the commit message window is in the
900 linkgit:git-gui[1]. "75" is the default.
902 gui.diffcontext::
903 Specifies how many context lines should be used in calls to diff
904 made by the linkgit:git-gui[1]. The default is "5".
906 gui.encoding::
907 Specifies the default encoding to use for displaying of
908 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
909 It can be overridden by setting the 'encoding' attribute
910 for relevant files (see linkgit:gitattributes[5]).
911 If this option is not set, the tools default to the
912 locale encoding.
914 gui.matchtrackingbranch::
915 Determines if new branches created with linkgit:git-gui[1] should
916 default to tracking remote branches with matching names or
917 not. Default: "false".
919 gui.newbranchtemplate::
920 Is used as suggested name when creating new branches using the
921 linkgit:git-gui[1].
923 gui.pruneduringfetch::
924 "true" if linkgit:git-gui[1] should prune tracking branches when
925 performing a fetch. The default value is "false".
927 gui.trustmtime::
928 Determines if linkgit:git-gui[1] should trust the file modification
929 timestamp or not. By default the timestamps are not trusted.
931 gui.spellingdictionary::
932 Specifies the dictionary used for spell checking commit messages in
933 the linkgit:git-gui[1]. When set to "none" spell checking is turned
934 off.
936 gui.fastcopyblame::
937 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
938 location detection. It makes blame significantly faster on huge
939 repositories at the expense of less thorough copy detection.
941 gui.copyblamethreshold::
942 Specifies the threshold to use in 'git gui blame' original location
943 detection, measured in alphanumeric characters. See the
944 linkgit:git-blame[1] manual for more information on copy detection.
946 gui.blamehistoryctx::
947 Specifies the radius of history context in days to show in
948 linkgit:gitk[1] for the selected commit, when the `Show History
949 Context` menu item is invoked from 'git gui blame'. If this
950 variable is set to zero, the whole history is shown.
952 guitool.<name>.cmd::
953 Specifies the shell command line to execute when the corresponding item
954 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
955 mandatory for every tool. The command is executed from the root of
956 the working directory, and in the environment it receives the name of
957 the tool as 'GIT_GUITOOL', the name of the currently selected file as
958 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
959 the head is detached, 'CUR_BRANCH' is empty).
961 guitool.<name>.needsfile::
962 Run the tool only if a diff is selected in the GUI. It guarantees
963 that 'FILENAME' is not empty.
965 guitool.<name>.noconsole::
966 Run the command silently, without creating a window to display its
967 output.
969 guitool.<name>.norescan::
970 Don't rescan the working directory for changes after the tool
971 finishes execution.
973 guitool.<name>.confirm::
974 Show a confirmation dialog before actually running the tool.
976 guitool.<name>.argprompt::
977 Request a string argument from the user, and pass it to the tool
978 through the 'ARGS' environment variable. Since requesting an
979 argument implies confirmation, the 'confirm' option has no effect
980 if this is enabled. If the option is set to 'true', 'yes', or '1',
981 the dialog uses a built-in generic prompt; otherwise the exact
982 value of the variable is used.
984 guitool.<name>.revprompt::
985 Request a single valid revision from the user, and set the
986 'REVISION' environment variable. In other aspects this option
987 is similar to 'argprompt', and can be used together with it.
989 guitool.<name>.revunmerged::
990 Show only unmerged branches in the 'revprompt' subdialog.
991 This is useful for tools similar to merge or rebase, but not
992 for things like checkout or reset.
994 guitool.<name>.title::
995 Specifies the title to use for the prompt dialog. The default
996 is the tool name.
998 guitool.<name>.prompt::
999 Specifies the general prompt string to display at the top of
1000 the dialog, before subsections for 'argprompt' and 'revprompt'.
1001 The default value includes the actual command.
1003 help.browser::
1004 Specify the browser that will be used to display help in the
1005 'web' format. See linkgit:git-help[1].
1007 help.format::
1008 Override the default help format used by linkgit:git-help[1].
1009 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1010 the default. 'web' and 'html' are the same.
1012 help.autocorrect::
1013 Automatically correct and execute mistyped commands after
1014 waiting for the given number of deciseconds (0.1 sec). If more
1015 than one command can be deduced from the entered text, nothing
1016 will be executed. If the value of this option is negative,
1017 the corrected command will be executed immediately. If the
1018 value is 0 - the command will be just shown but not executed.
1019 This is the default.
1021 http.proxy::
1022 Override the HTTP proxy, normally configured using the 'http_proxy'
1023 environment variable (see linkgit:curl[1]). This can be overridden
1024 on a per-remote basis; see remote.<name>.proxy
1026 http.sslVerify::
1027 Whether to verify the SSL certificate when fetching or pushing
1028 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1029 variable.
1031 http.sslCert::
1032 File containing the SSL certificate when fetching or pushing
1033 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1034 variable.
1036 http.sslKey::
1037 File containing the SSL private key when fetching or pushing
1038 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1039 variable.
1041 http.sslCAInfo::
1042 File containing the certificates to verify the peer with when
1043 fetching or pushing over HTTPS. Can be overridden by the
1044 'GIT_SSL_CAINFO' environment variable.
1046 http.sslCAPath::
1047 Path containing files with the CA certificates to verify the peer
1048 with when fetching or pushing over HTTPS. Can be overridden
1049 by the 'GIT_SSL_CAPATH' environment variable.
1051 http.maxRequests::
1052 How many HTTP requests to launch in parallel. Can be overridden
1053 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1055 http.lowSpeedLimit, http.lowSpeedTime::
1056 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1057 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1058 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1059 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1061 http.noEPSV::
1062 A boolean which disables using of EPSV ftp command by curl.
1063 This can helpful with some "poor" ftp servers which don't
1064 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1065 environment variable. Default is false (curl will use EPSV).
1067 i18n.commitEncoding::
1068 Character encoding the commit messages are stored in; git itself
1069 does not care per se, but this information is necessary e.g. when
1070 importing commits from emails or in the gitk graphical history
1071 browser (and possibly at other places in the future or in other
1072 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1074 i18n.logOutputEncoding::
1075 Character encoding the commit messages are converted to when
1076 running 'git-log' and friends.
1078 imap::
1079 The configuration variables in the 'imap' section are described
1080 in linkgit:git-imap-send[1].
1082 instaweb.browser::
1083 Specify the program that will be used to browse your working
1084 repository in gitweb. See linkgit:git-instaweb[1].
1086 instaweb.httpd::
1087 The HTTP daemon command-line to start gitweb on your working
1088 repository. See linkgit:git-instaweb[1].
1090 instaweb.local::
1091 If true the web server started by linkgit:git-instaweb[1] will
1092 be bound to the local IP (
1094 instaweb.modulepath::
1095 The module path for an apache httpd used by linkgit:git-instaweb[1].
1097 instaweb.port::
1098 The port number to bind the gitweb httpd to. See
1099 linkgit:git-instaweb[1].
1101 interactive.singlekey::
1102 In interactive programs, allow the user to provide one-letter
1103 input with a single key (i.e., without hitting enter).
1104 Currently this is used only by the `\--patch` mode of
1105 linkgit:git-add[1]. Note that this setting is silently
1106 ignored if portable keystroke input is not available.
1109 Set default date-time mode for the log command. Setting
1110 value is similar to using 'git-log'\'s --date option. The value is one of the
1111 following alternatives: {relative,local,default,iso,rfc,short}.
1112 See linkgit:git-log[1].
1114 log.showroot::
1115 If true, the initial commit will be shown as a big creation event.
1116 This is equivalent to a diff against an empty tree.
1117 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1118 normally hide the root commit will now show it. True by default.
1120 mailmap.file::
1121 The location of an augmenting mailmap file. The default
1122 mailmap, located in the root of the repository, is loaded
1123 first, then the mailmap file pointed to by this variable.
1124 The location of the mailmap file may be in a repository
1125 subdirectory, or somewhere outside of the repository itself.
1126 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1128 man.viewer::
1129 Specify the programs that may be used to display help in the
1130 'man' format. See linkgit:git-help[1].
1132 man.<tool>.cmd::
1133 Specify the command to invoke the specified man viewer. The
1134 specified command is evaluated in shell with the man page
1135 passed as argument. (See linkgit:git-help[1].)
1137 man.<tool>.path::
1138 Override the path for the given tool that may be used to
1139 display help in the 'man' format. See linkgit:git-help[1].
1141 include::merge-config.txt[]
1143 mergetool.<tool>.path::
1144 Override the path for the given tool. This is useful in case
1145 your tool is not in the PATH.
1147 mergetool.<tool>.cmd::
1148 Specify the command to invoke the specified merge tool. The
1149 specified command is evaluated in shell with the following
1150 variables available: 'BASE' is the name of a temporary file
1151 containing the common base of the files to be merged, if available;
1152 'LOCAL' is the name of a temporary file containing the contents of
1153 the file on the current branch; 'REMOTE' is the name of a temporary
1154 file containing the contents of the file from the branch being
1155 merged; 'MERGED' contains the name of the file to which the merge
1156 tool should write the results of a successful merge.
1158 mergetool.<tool>.trustExitCode::
1159 For a custom merge command, specify whether the exit code of
1160 the merge command can be used to determine whether the merge was
1161 successful. If this is not set to true then the merge target file
1162 timestamp is checked and the merge assumed to have been successful
1163 if the file has been updated, otherwise the user is prompted to
1164 indicate the success of the merge.
1166 mergetool.keepBackup::
1167 After performing a merge, the original file with conflict markers
1168 can be saved as a file with a `.orig` extension. If this variable
1169 is set to `false` then this file is not preserved. Defaults to
1170 `true` (i.e. keep the backup files).
1172 mergetool.keepTemporaries::
1173 When invoking a custom merge tool, git uses a set of temporary
1174 files to pass to the tool. If the tool returns an error and this
1175 variable is set to `true`, then these temporary files will be
1176 preserved, otherwise they will be removed after the tool has
1177 exited. Defaults to `false`.
1179 mergetool.prompt::
1180 Prompt before each invocation of the merge resolution program.
1182 pack.window::
1183 The size of the window used by linkgit:git-pack-objects[1] when no
1184 window size is given on the command line. Defaults to 10.
1186 pack.depth::
1187 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1188 maximum depth is given on the command line. Defaults to 50.
1190 pack.windowMemory::
1191 The window memory size limit used by linkgit:git-pack-objects[1]
1192 when no limit is given on the command line. The value can be
1193 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1194 limit.
1196 pack.compression::
1197 An integer -1..9, indicating the compression level for objects
1198 in a pack file. -1 is the zlib default. 0 means no
1199 compression, and 1..9 are various speed/size tradeoffs, 9 being
1200 slowest. If not set, defaults to core.compression. If that is
1201 not set, defaults to -1, the zlib default, which is "a default
1202 compromise between speed and compression (currently equivalent
1203 to level 6)."
1205 pack.deltaCacheSize::
1206 The maximum memory in bytes used for caching deltas in
1207 linkgit:git-pack-objects[1].
1208 A value of 0 means no limit. Defaults to 0.
1210 pack.deltaCacheLimit::
1211 The maximum size of a delta, that is cached in
1212 linkgit:git-pack-objects[1]. Defaults to 1000.
1214 pack.threads::
1215 Specifies the number of threads to spawn when searching for best
1216 delta matches. This requires that linkgit:git-pack-objects[1]
1217 be compiled with pthreads otherwise this option is ignored with a
1218 warning. This is meant to reduce packing time on multiprocessor
1219 machines. The required amount of memory for the delta search window
1220 is however multiplied by the number of threads.
1221 Specifying 0 will cause git to auto-detect the number of CPU's
1222 and set the number of threads accordingly.
1224 pack.indexVersion::
1225 Specify the default pack index version. Valid values are 1 for
1226 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1227 the new pack index with capabilities for packs larger than 4 GB
1228 as well as proper protection against the repacking of corrupted
1229 packs. Version 2 is the default. Note that version 2 is enforced
1230 and this config option ignored whenever the corresponding pack is
1231 larger than 2 GB.
1232 +
1233 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1234 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1235 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1236 other side may give you a repository that cannot be accessed with your
1237 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1238 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1239 the `{asterisk}.idx` file.
1241 pack.packSizeLimit::
1242 The default maximum size of a pack. This setting only affects
1243 packing to a file, i.e. the git:// protocol is unaffected. It
1244 can be overridden by the `\--max-pack-size` option of
1245 linkgit:git-repack[1].
1247 pager.<cmd>::
1248 Allows turning on or off pagination of the output of a
1249 particular git subcommand when writing to a tty. If
1250 `\--paginate` or `\--no-pager` is specified on the command line,
1251 it takes precedence over this option. To disable pagination for
1252 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1254 pull.octopus::
1255 The default merge strategy to use when pulling multiple branches
1256 at once.
1258 pull.twohead::
1259 The default merge strategy to use when pulling a single branch.
1261 push.default::
1262 Defines the action git push should take if no refspec is given
1263 on the command line, no refspec is configured in the remote, and
1264 no refspec is implied by any of the options given on the command
1265 line. Possible values are:
1266 +
1267 * `nothing` do not push anything.
1268 * `matching` push all matching branches.
1269 All branches having the same name in both ends are considered to be
1270 matching. This is the default.
1271 * `tracking` push the current branch to its upstream branch.
1272 * `current` push the current branch to a branch of the same name.
1274 rebase.stat::
1275 Whether to show a diffstat of what changed upstream since the last
1276 rebase. False by default.
1278 receive.fsckObjects::
1279 If it is set to true, git-receive-pack will check all received
1280 objects. It will abort in the case of a malformed object or a
1281 broken link. The result of an abort are only dangling objects.
1282 Defaults to false.
1284 receive.unpackLimit::
1285 If the number of objects received in a push is below this
1286 limit then the objects will be unpacked into loose object
1287 files. However if the number of received objects equals or
1288 exceeds this limit then the received pack will be stored as
1289 a pack, after adding any missing delta bases. Storing the
1290 pack from a push can make the push operation complete faster,
1291 especially on slow filesystems. If not set, the value of
1292 `transfer.unpackLimit` is used instead.
1294 receive.denyDeletes::
1295 If set to true, git-receive-pack will deny a ref update that deletes
1296 the ref. Use this to prevent such a ref deletion via a push.
1298 receive.denyCurrentBranch::
1299 If set to true or "refuse", receive-pack will deny a ref update
1300 to the currently checked out branch of a non-bare repository.
1301 Such a push is potentially dangerous because it brings the HEAD
1302 out of sync with the index and working tree. If set to "warn",
1303 print a warning of such a push to stderr, but allow the push to
1304 proceed. If set to false or "ignore", allow such pushes with no
1305 message. Defaults to "warn".
1307 receive.denyNonFastForwards::
1308 If set to true, git-receive-pack will deny a ref update which is
1309 not a fast forward. Use this to prevent such an update via a push,
1310 even if that push is forced. This configuration variable is
1311 set when initializing a shared repository.
1313 remote.<name>.url::
1314 The URL of a remote repository. See linkgit:git-fetch[1] or
1315 linkgit:git-push[1].
1317 remote.<name>.proxy::
1318 For remotes that require curl (http, https and ftp), the URL to
1319 the proxy to use for that remote. Set to the empty string to
1320 disable proxying for that remote.
1322 remote.<name>.fetch::
1323 The default set of "refspec" for linkgit:git-fetch[1]. See
1324 linkgit:git-fetch[1].
1326 remote.<name>.push::
1327 The default set of "refspec" for linkgit:git-push[1]. See
1328 linkgit:git-push[1].
1330 remote.<name>.mirror::
1331 If true, pushing to this remote will automatically behave
1332 as if the `\--mirror` option was given on the command line.
1334 remote.<name>.skipDefaultUpdate::
1335 If true, this remote will be skipped by default when updating
1336 using the update subcommand of linkgit:git-remote[1].
1338 remote.<name>.receivepack::
1339 The default program to execute on the remote side when pushing. See
1340 option \--receive-pack of linkgit:git-push[1].
1342 remote.<name>.uploadpack::
1343 The default program to execute on the remote side when fetching. See
1344 option \--upload-pack of linkgit:git-fetch-pack[1].
1346 remote.<name>.tagopt::
1347 Setting this value to \--no-tags disables automatic tag following when
1348 fetching from remote <name>
1350 remotes.<group>::
1351 The list of remotes which are fetched by "git remote update
1352 <group>". See linkgit:git-remote[1].
1354 repack.usedeltabaseoffset::
1355 By default, linkgit:git-repack[1] creates packs that use
1356 delta-base offset. If you need to share your repository with
1357 git older than version 1.4.4, either directly or via a dumb
1358 protocol such as http, then you need to set this option to
1359 "false" and repack. Access from old git versions over the
1360 native protocol are unaffected by this option.
1362 rerere.autoupdate::
1363 When set to true, `git-rerere` updates the index with the
1364 resulting contents after it cleanly resolves conflicts using
1365 previously recorded resolution. Defaults to false.
1367 rerere.enabled::
1368 Activate recording of resolved conflicts, so that identical
1369 conflict hunks can be resolved automatically, should they
1370 be encountered again. linkgit:git-rerere[1] command is by
1371 default enabled if you create `rr-cache` directory under
1372 `$GIT_DIR`, but can be disabled by setting this option to false.
1374 showbranch.default::
1375 The default set of branches for linkgit:git-show-branch[1].
1376 See linkgit:git-show-branch[1].
1378 status.relativePaths::
1379 By default, linkgit:git-status[1] shows paths relative to the
1380 current directory. Setting this variable to `false` shows paths
1381 relative to the repository root (this was the default for git
1382 prior to v1.5.4).
1384 status.showUntrackedFiles::
1385 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1386 files which are not currently tracked by Git. Directories which
1387 contain only untracked files, are shown with the directory name
1388 only. Showing untracked files means that Git needs to lstat() all
1389 all the files in the whole repository, which might be slow on some
1390 systems. So, this variable controls how the commands displays
1391 the untracked files. Possible values are:
1392 +
1393 --
1394 - 'no' - Show no untracked files
1395 - 'normal' - Shows untracked files and directories
1396 - 'all' - Shows also individual files in untracked directories.
1397 --
1398 +
1399 If this variable is not specified, it defaults to 'normal'.
1400 This variable can be overridden with the -u|--untracked-files option
1401 of linkgit:git-status[1] and linkgit:git-commit[1].
1403 tar.umask::
1404 This variable can be used to restrict the permission bits of
1405 tar archive entries. The default is 0002, which turns off the
1406 world write bit. The special value "user" indicates that the
1407 archiving user's umask will be used instead. See umask(2) and
1408 linkgit:git-archive[1].
1410 transfer.unpackLimit::
1411 When `fetch.unpackLimit` or `receive.unpackLimit` are
1412 not set, the value of this variable is used instead.
1413 The default value is 100.
1415 url.<base>.insteadOf::
1416 Any URL that starts with this value will be rewritten to
1417 start, instead, with <base>. In cases where some site serves a
1418 large number of repositories, and serves them with multiple
1419 access methods, and some users need to use different access
1420 methods, this feature allows people to specify any of the
1421 equivalent URLs and have git automatically rewrite the URL to
1422 the best alternative for the particular user, even for a
1423 never-before-seen repository on the site. When more than one
1424 insteadOf strings match a given URL, the longest match is used.
1427 Your email address to be recorded in any newly created commits.
1428 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1429 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1432 Your full name to be recorded in any newly created commits.
1433 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1434 environment variables. See linkgit:git-commit-tree[1].
1436 user.signingkey::
1437 If linkgit:git-tag[1] is not selecting the key you want it to
1438 automatically when creating a signed tag, you can override the
1439 default selection with this variable. This option is passed
1440 unchanged to gpg's --local-user parameter, so you may specify a key
1441 using any method that gpg supports.
1443 web.browser::
1444 Specify a web browser that may be used by some commands.
1445 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1446 may use it.