676c39bb8436f35e1471b8dd50fd888ae1ac5c6b
[git/git.git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. `.git/config` file for each repository
6 is used to store the information for that repository, and
7 `$HOME/.gitconfig` is used to store per user information to give
8 fallback values for `.git/config` file. The file `/etc/gitconfig`
9 can be used to store system-wide defaults.
10
11 They can be used by both the git plumbing
12 and the porcelains. The variables are divided into sections, where
13 in the fully qualified variable name the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
17
18 Syntax
19 ~~~~~~
20
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
24
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, '`-`' and '`.`' are allowed in section names. Each variable
29 must belong to some section, which means that there must be section
30 header before first setting of a variable.
31
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in example below:
35
36 --------
37 [section "subsection"]
38
39 --------
40
41 Subsection names can contain any characters except newline (doublequote
42 '`"`' and backslash have to be escaped as '`\"`' and '`\\`',
43 respectively) and are case sensitive. Section header cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
47
48 There is also (case insensitive) alternative `[section.subsection]` syntax.
49 In this syntax subsection names follow the same restrictions as for section
50 name.
51
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.
58
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
61
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 or true/false. 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".
67
68 String values may be entirely or partially enclosed in double quotes.
69 You need to enclose variable value in double quotes if you want to
70 preserve leading or trailing whitespace, or if variable value contains
71 beginning of comment characters (if it contains '#' or ';').
72 Double quote '`"`' and backslash '`\`' characters in variable value must
73 be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
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.
79
80 Variable value ending in a '`\`' is continued on the next line in the
81 customary UNIX fashion.
82
83 Some variables may require special value format.
84
85 Example
86 ~~~~~~~
87
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
92
93 # Our diff algorithm
94 [diff]
95 external = /usr/local/bin/diff-wrapper
96 renames = true
97
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
101
102 # Proxy settings
103 [core]
104 gitProxy="ssh" for "kernel.org"
105 gitProxy=default-proxy ; for the rest
106
107 Variables
108 ~~~~~~~~~
109
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.
114
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.
119
120 core.trustctime::
121 If false, the ctime differences between the index and the
122 working copy are ignored; useful when the inode change time
123 is regularly modified by something outside Git (file system
124 crawlers and some backup systems).
125 See linkgit:git-update-index[1]. True by default.
126
127 core.quotepath::
128 The commands that output paths (e.g. 'ls-files',
129 'diff'), when not given the `-z` option, will quote
130 "unusual" characters in the pathname by enclosing the
131 pathname in a double-quote pair and with backslashes the
132 same way strings in C source code are quoted. If this
133 variable is set to false, the bytes higher than 0x80 are
134 not quoted but output as verbatim. Note that double
135 quote, backslash and control characters are always
136 quoted without `-z` regardless of the setting of this
137 variable.
138
139 core.autocrlf::
140 If true, makes git convert `CRLF` at the end of lines in text files to
141 `LF` when reading from the filesystem, and convert in reverse when
142 writing to the filesystem. The variable can be set to
143 'input', in which case the conversion happens only while
144 reading from the filesystem but files are written out with
145 `LF` at the end of lines. Currently, which paths to consider
146 "text" (i.e. be subjected to the autocrlf mechanism) is
147 decided purely based on the contents.
148
149 core.safecrlf::
150 If true, makes git check if converting `CRLF` as controlled by
151 `core.autocrlf` is reversible. Git will verify if a command
152 modifies a file in the work tree either directly or indirectly.
153 For example, committing a file followed by checking out the
154 same file should yield the original file in the work tree. If
155 this is not the case for the current setting of
156 `core.autocrlf`, git will reject the file. The variable can
157 be set to "warn", in which case git will only warn about an
158 irreversible conversion but continue the operation.
159 +
160 CRLF conversion bears a slight chance of corrupting data.
161 autocrlf=true will convert CRLF to LF during commit and LF to
162 CRLF during checkout. A file that contains a mixture of LF and
163 CRLF before the commit cannot be recreated by git. For text
164 files this is the right thing to do: it corrects line endings
165 such that we have only LF line endings in the repository.
166 But for binary files that are accidentally classified as text the
167 conversion can corrupt data.
168 +
169 If you recognize such corruption early you can easily fix it by
170 setting the conversion type explicitly in .gitattributes. Right
171 after committing you still have the original file in your work
172 tree and this file is not yet corrupted. You can explicitly tell
173 git that this file is binary and git will handle the file
174 appropriately.
175 +
176 Unfortunately, the desired effect of cleaning up text files with
177 mixed line endings and the undesired effect of corrupting binary
178 files cannot be distinguished. In both cases CRLFs are removed
179 in an irreversible way. For text files this is the right thing
180 to do because CRLFs are line endings, while for binary files
181 converting CRLFs corrupts data.
182 +
183 Note, this safety check does not mean that a checkout will generate a
184 file identical to the original file for a different setting of
185 `core.autocrlf`, but only for the current one. For example, a text
186 file with `LF` would be accepted with `core.autocrlf=input` and could
187 later be checked out with `core.autocrlf=true`, in which case the
188 resulting file would contain `CRLF`, although the original file
189 contained `LF`. However, in both work trees the line endings would be
190 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
191 file with mixed line endings would be reported by the `core.safecrlf`
192 mechanism.
193
194 core.symlinks::
195 If false, symbolic links are checked out as small plain files that
196 contain the link text. linkgit:git-update-index[1] and
197 linkgit:git-add[1] will not change the recorded type to regular
198 file. Useful on filesystems like FAT that do not support
199 symbolic links. True by default.
200
201 core.gitProxy::
202 A "proxy command" to execute (as 'command host port') instead
203 of establishing direct connection to the remote server when
204 using the git protocol for fetching. If the variable value is
205 in the "COMMAND for DOMAIN" format, the command is applied only
206 on hostnames ending with the specified domain string. This variable
207 may be set multiple times and is matched in the given order;
208 the first match wins.
209 +
210 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
211 (which always applies universally, without the special "for"
212 handling).
213
214 core.ignoreStat::
215 If true, commands which modify both the working tree and the index
216 will mark the updated paths with the "assume unchanged" bit in the
217 index. These marked files are then assumed to stay unchanged in the
218 working copy, until you mark them otherwise manually - Git will not
219 detect the file changes by lstat() calls. This is useful on systems
220 where those are very slow, such as Microsoft Windows.
221 See linkgit:git-update-index[1].
222 False by default.
223
224 core.preferSymlinkRefs::
225 Instead of the default "symref" format for HEAD
226 and other symbolic reference files, use symbolic links.
227 This is sometimes needed to work with old scripts that
228 expect HEAD to be a symbolic link.
229
230 core.bare::
231 If true this repository is assumed to be 'bare' and has no
232 working directory associated with it. If this is the case a
233 number of commands that require a working directory will be
234 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
235 +
236 This setting is automatically guessed by linkgit:git-clone[1] or
237 linkgit:git-init[1] when the repository was created. By default a
238 repository that ends in "/.git" is assumed to be not bare (bare =
239 false), while all other repositories are assumed to be bare (bare
240 = true).
241
242 core.worktree::
243 Set the path to the working tree. The value will not be
244 used in combination with repositories found automatically in
245 a .git directory (i.e. $GIT_DIR is not set).
246 This can be overridden by the GIT_WORK_TREE environment
247 variable and the '--work-tree' command line option. It can be
248 a absolute path or relative path to the directory specified by
249 --git-dir or GIT_DIR.
250 Note: If --git-dir or GIT_DIR are specified but none of
251 --work-tree, GIT_WORK_TREE and core.worktree is specified,
252 the current working directory is regarded as the top directory
253 of your working tree.
254
255 core.logAllRefUpdates::
256 Enable the reflog. Updates to a ref <ref> is logged to the file
257 "$GIT_DIR/logs/<ref>", by appending the new and old
258 SHA1, the date/time and the reason of the update, but
259 only when the file exists. If this configuration
260 variable is set to true, missing "$GIT_DIR/logs/<ref>"
261 file is automatically created for branch heads.
262 +
263 This information can be used to determine what commit
264 was the tip of a branch "2 days ago".
265 +
266 This value is true by default in a repository that has
267 a working directory associated with it, and false by
268 default in a bare repository.
269
270 core.repositoryFormatVersion::
271 Internal variable identifying the repository format and layout
272 version.
273
274 core.sharedRepository::
275 When 'group' (or 'true'), the repository is made shareable between
276 several users in a group (making sure all the files and objects are
277 group-writable). When 'all' (or 'world' or 'everybody'), the
278 repository will be readable by all users, additionally to being
279 group-shareable. When 'umask' (or 'false'), git will use permissions
280 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
281 files in the repository will have this mode value. '0xxx' will override
282 user's umask value, and thus, users with a safe umask (0077) can use
283 this option. Examples: '0660' is equivalent to 'group'. '0640' is a
284 repository that is group-readable but not group-writable.
285 See linkgit:git-init[1]. False by default.
286
287 core.warnAmbiguousRefs::
288 If true, git will warn you if the ref name you passed it is ambiguous
289 and might match multiple refs in the .git/refs/ tree. True by default.
290
291 core.compression::
292 An integer -1..9, indicating a default compression level.
293 -1 is the zlib default. 0 means no compression,
294 and 1..9 are various speed/size tradeoffs, 9 being slowest.
295 If set, this provides a default to other compression variables,
296 such as 'core.loosecompression' and 'pack.compression'.
297
298 core.loosecompression::
299 An integer -1..9, indicating the compression level for objects that
300 are not in a pack file. -1 is the zlib default. 0 means no
301 compression, and 1..9 are various speed/size tradeoffs, 9 being
302 slowest. If not set, defaults to core.compression. If that is
303 not set, defaults to 1 (best speed).
304
305 core.packedGitWindowSize::
306 Number of bytes of a pack file to map into memory in a
307 single mapping operation. Larger window sizes may allow
308 your system to process a smaller number of large pack files
309 more quickly. Smaller window sizes will negatively affect
310 performance due to increased calls to the operating system's
311 memory manager, but may improve performance when accessing
312 a large number of large pack files.
313 +
314 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
315 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
316 be reasonable for all users/operating systems. You probably do
317 not need to adjust this value.
318 +
319 Common unit suffixes of 'k', 'm', or 'g' are supported.
320
321 core.packedGitLimit::
322 Maximum number of bytes to map simultaneously into memory
323 from pack files. If Git needs to access more than this many
324 bytes at once to complete an operation it will unmap existing
325 regions to reclaim virtual address space within the process.
326 +
327 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
328 This should be reasonable for all users/operating systems, except on
329 the largest projects. You probably do not need to adjust this value.
330 +
331 Common unit suffixes of 'k', 'm', or 'g' are supported.
332
333 core.deltaBaseCacheLimit::
334 Maximum number of bytes to reserve for caching base objects
335 that multiple deltafied objects reference. By storing the
336 entire decompressed base objects in a cache Git is able
337 to avoid unpacking and decompressing frequently used base
338 objects multiple times.
339 +
340 Default is 16 MiB on all platforms. This should be reasonable
341 for all users/operating systems, except on the largest projects.
342 You probably do not need to adjust this value.
343 +
344 Common unit suffixes of 'k', 'm', or 'g' are supported.
345
346 core.excludesfile::
347 In addition to '.gitignore' (per-directory) and
348 '.git/info/exclude', git looks into this file for patterns
349 of files which are not meant to be tracked. See
350 linkgit:gitignore[5].
351
352 core.editor::
353 Commands such as `commit` and `tag` that lets you edit
354 messages by launching an editor uses the value of this
355 variable when it is set, and the environment variable
356 `GIT_EDITOR` is not set. The order of preference is
357 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
358 `EDITOR` environment variables and then finally `vi`.
359
360 core.pager::
361 The command that git will use to paginate output. Can be overridden
362 with the `GIT_PAGER` environment variable.
363
364 core.whitespace::
365 A comma separated list of common whitespace problems to
366 notice. 'git-diff' will use `color.diff.whitespace` to
367 highlight them, and 'git-apply --whitespace=error' will
368 consider them as errors. You can prefix `-` to disable
369 any of them (e.g. `-trailing-space`):
370 +
371 * `trailing-space` treats trailing whitespaces at the end of the line
372 as an error (enabled by default).
373 * `space-before-tab` treats a space character that appears immediately
374 before a tab character in the initial indent part of the line as an
375 error (enabled by default).
376 * `indent-with-non-tab` treats a line that is indented with 8 or more
377 space characters as an error (not enabled by default).
378 * `cr-at-eol` treats a carriage-return at the end of line as
379 part of the line terminator, i.e. with it, `trailing-space`
380 does not trigger if the character before such a carriage-return
381 is not a whitespace (not enabled by default).
382
383 core.fsyncobjectfiles::
384 This boolean will enable 'fsync()' when writing object files.
385 +
386 This is a total waste of time and effort on a filesystem that orders
387 data writes properly, but can be useful for filesystems that do not use
388 journalling (traditional UNIX filesystems) or that only journal metadata
389 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
390
391 alias.*::
392 Command aliases for the linkgit:git[1] command wrapper - e.g.
393 after defining "alias.last = cat-file commit HEAD", the invocation
394 "git last" is equivalent to "git cat-file commit HEAD". To avoid
395 confusion and troubles with script usage, aliases that
396 hide existing git commands are ignored. Arguments are split by
397 spaces, the usual shell quoting and escaping is supported.
398 quote pair and a backslash can be used to quote them.
399 +
400 If the alias expansion is prefixed with an exclamation point,
401 it will be treated as a shell command. For example, defining
402 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
403 "git new" is equivalent to running the shell command
404 "gitk --all --not ORIG_HEAD".
405
406 apply.whitespace::
407 Tells 'git-apply' how to handle whitespaces, in the same way
408 as the '--whitespace' option. See linkgit:git-apply[1].
409
410 branch.autosetupmerge::
411 Tells 'git-branch' and 'git-checkout' to setup new branches
412 so that linkgit:git-pull[1] will appropriately merge from the
413 starting point branch. Note that even if this option is not set,
414 this behavior can be chosen per-branch using the `--track`
415 and `--no-track` options. The valid settings are: `false` -- no
416 automatic setup is done; `true` -- automatic setup is done when the
417 starting point is a remote branch; `always` -- automatic setup is
418 done when the starting point is either a local branch or remote
419 branch. This option defaults to true.
420
421 branch.autosetuprebase::
422 When a new branch is created with 'git-branch' or 'git-checkout'
423 that tracks another branch, this variable tells git to set
424 up pull to rebase instead of merge (see "branch.<name>.rebase").
425 When `never`, rebase is never automatically set to true.
426 When `local`, rebase is set to true for tracked branches of
427 other local branches.
428 When `remote`, rebase is set to true for tracked branches of
429 remote branches.
430 When `always`, rebase will be set to true for all tracking
431 branches.
432 See "branch.autosetupmerge" for details on how to set up a
433 branch to track another branch.
434 This option defaults to never.
435
436 branch.<name>.remote::
437 When in branch <name>, it tells 'git-fetch' which remote to fetch.
438 If this option is not given, 'git-fetch' defaults to remote "origin".
439
440 branch.<name>.merge::
441 When in branch <name>, it tells 'git-fetch' the default
442 refspec to be marked for merging in FETCH_HEAD. The value is
443 handled like the remote part of a refspec, and must match a
444 ref which is fetched from the remote given by
445 "branch.<name>.remote".
446 The merge information is used by 'git-pull' (which at first calls
447 'git-fetch') to lookup the default branch for merging. Without
448 this option, 'git-pull' defaults to merge the first refspec fetched.
449 Specify multiple values to get an octopus merge.
450 If you wish to setup 'git-pull' so that it merges into <name> from
451 another branch in the local repository, you can point
452 branch.<name>.merge to the desired branch, and use the special setting
453 `.` (a period) for branch.<name>.remote.
454
455 branch.<name>.mergeoptions::
456 Sets default options for merging into branch <name>. The syntax and
457 supported options are equal to that of linkgit:git-merge[1], but
458 option values containing whitespace characters are currently not
459 supported.
460
461 branch.<name>.rebase::
462 When true, rebase the branch <name> on top of the fetched branch,
463 instead of merging the default branch from the default remote when
464 "git pull" is run.
465 *NOTE*: this is a possibly dangerous operation; do *not* use
466 it unless you understand the implications (see linkgit:git-rebase[1]
467 for details).
468
469 browser.<tool>.cmd::
470 Specify the command to invoke the specified browser. The
471 specified command is evaluated in shell with the URLs passed
472 as arguments. (See linkgit:git-web--browse[1].)
473
474 browser.<tool>.path::
475 Override the path for the given tool that may be used to
476 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
477 working repository in gitweb (see linkgit:git-instaweb[1]).
478
479 clean.requireForce::
480 A boolean to make git-clean do nothing unless given -f
481 or -n. Defaults to true.
482
483 color.branch::
484 A boolean to enable/disable color in the output of
485 linkgit:git-branch[1]. May be set to `always`,
486 `false` (or `never`) or `auto` (or `true`), in which case colors are used
487 only when the output is to a terminal. Defaults to false.
488
489 color.branch.<slot>::
490 Use customized color for branch coloration. `<slot>` is one of
491 `current` (the current branch), `local` (a local branch),
492 `remote` (a tracking branch in refs/remotes/), `plain` (other
493 refs).
494 +
495 The value for these configuration variables is a list of colors (at most
496 two) and attributes (at most one), separated by spaces. The colors
497 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
498 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
499 `blink` and `reverse`. The first color given is the foreground; the
500 second is the background. The position of the attribute, if any,
501 doesn't matter.
502
503 color.diff::
504 When set to `always`, always use colors in patch.
505 When false (or `never`), never. When set to `true` or `auto`, use
506 colors only when the output is to the terminal. Defaults to false.
507
508 color.diff.<slot>::
509 Use customized color for diff colorization. `<slot>` specifies
510 which part of the patch to use the specified color, and is one
511 of `plain` (context text), `meta` (metainformation), `frag`
512 (hunk header), `old` (removed lines), `new` (added lines),
513 `commit` (commit headers), or `whitespace` (highlighting
514 whitespace errors). The values of these variables may be specified as
515 in color.branch.<slot>.
516
517 color.interactive::
518 When set to `always`, always use colors for interactive prompts
519 and displays (such as those used by "git-add --interactive").
520 When false (or `never`), never. When set to `true` or `auto`, use
521 colors only when the output is to the terminal. Defaults to false.
522
523 color.interactive.<slot>::
524 Use customized color for 'git-add --interactive'
525 output. `<slot>` may be `prompt`, `header`, or `help`, for
526 three distinct types of normal output from interactive
527 programs. The values of these variables may be specified as
528 in color.branch.<slot>.
529
530 color.pager::
531 A boolean to enable/disable colored output when the pager is in
532 use (default is true).
533
534 color.status::
535 A boolean to enable/disable color in the output of
536 linkgit:git-status[1]. May be set to `always`,
537 `false` (or `never`) or `auto` (or `true`), in which case colors are used
538 only when the output is to a terminal. Defaults to false.
539
540 color.status.<slot>::
541 Use customized color for status colorization. `<slot>` is
542 one of `header` (the header text of the status message),
543 `added` or `updated` (files which are added but not committed),
544 `changed` (files which are changed but not added in the index),
545 `untracked` (files which are not tracked by git), or
546 `nobranch` (the color the 'no branch' warning is shown in, defaulting
547 to red). The values of these variables may be specified as in
548 color.branch.<slot>.
549
550 commit.template::
551 Specify a file to use as the template for new commit messages.
552
553 color.ui::
554 When set to `always`, always use colors in all git commands which
555 are capable of colored output. When false (or `never`), never. When
556 set to `true` or `auto`, use colors only when the output is to the
557 terminal. When more specific variables of color.* are set, they always
558 take precedence over this setting. Defaults to false.
559
560 diff.autorefreshindex::
561 When using 'git-diff' to compare with work tree
562 files, do not consider stat-only change as changed.
563 Instead, silently run `git update-index --refresh` to
564 update the cached stat information for paths whose
565 contents in the work tree match the contents in the
566 index. This option defaults to true. Note that this
567 affects only 'git-diff' Porcelain, and not lower level
568 'diff' commands, such as 'git-diff-files'.
569
570 diff.external::
571 If this config variable is set, diff generation is not
572 performed using the internal diff machinery, but using the
573 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
574 environment variable. The command is called with parameters
575 as described under "git Diffs" in linkgit:git[1]. Note: if
576 you want to use an external diff program only on a subset of
577 your files, you might want to use linkgit:gitattributes[5] instead.
578
579 diff.renameLimit::
580 The number of files to consider when performing the copy/rename
581 detection; equivalent to the 'git-diff' option '-l'.
582
583 diff.renames::
584 Tells git to detect renames. If set to any boolean value, it
585 will enable basic rename detection. If set to "copies" or
586 "copy", it will detect copies, as well.
587
588 fetch.unpackLimit::
589 If the number of objects fetched over the git native
590 transfer is below this
591 limit, then the objects will be unpacked into loose object
592 files. However if the number of received objects equals or
593 exceeds this limit then the received pack will be stored as
594 a pack, after adding any missing delta bases. Storing the
595 pack from a push can make the push operation complete faster,
596 especially on slow filesystems. If not set, the value of
597 `transfer.unpackLimit` is used instead.
598
599 format.numbered::
600 A boolean which can enable sequence numbers in patch subjects.
601 Setting this option to "auto" will enable it only if there is
602 more than one patch. See --numbered option in
603 linkgit:git-format-patch[1].
604
605 format.headers::
606 Additional email headers to include in a patch to be submitted
607 by mail. See linkgit:git-format-patch[1].
608
609 format.suffix::
610 The default for format-patch is to output files with the suffix
611 `.patch`. Use this variable to change that suffix (make sure to
612 include the dot if you want it).
613
614 format.pretty::
615 The default pretty format for log/show/whatchanged command,
616 See linkgit:git-log[1], linkgit:git-show[1],
617 linkgit:git-whatchanged[1].
618
619 gc.aggressiveWindow::
620 The window size parameter used in the delta compression
621 algorithm used by 'git-gc --aggressive'. This defaults
622 to 10.
623
624 gc.auto::
625 When there are approximately more than this many loose
626 objects in the repository, `git gc --auto` will pack them.
627 Some Porcelain commands use this command to perform a
628 light-weight garbage collection from time to time. The
629 default value is 6700. Setting this to 0 disables it.
630
631 gc.autopacklimit::
632 When there are more than this many packs that are not
633 marked with `*.keep` file in the repository, `git gc
634 --auto` consolidates them into one larger pack. The
635 default value is 50. Setting this to 0 disables it.
636
637 gc.packrefs::
638 'git-gc' does not run `git pack-refs` in a bare repository by
639 default so that older dumb-transport clients can still fetch
640 from the repository. Setting this to `true` lets 'git-gc'
641 to run `git pack-refs`. Setting this to `false` tells
642 'git-gc' never to run `git pack-refs`. The default setting is
643 `notbare`. Enable it only when you know you do not have to
644 support such clients. The default setting will change to `true`
645 at some stage, and setting this to `false` will continue to
646 prevent `git pack-refs` from being run from 'git-gc'.
647
648 gc.pruneexpire::
649 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
650 Override the grace period with this config variable.
651
652 gc.reflogexpire::
653 'git-reflog expire' removes reflog entries older than
654 this time; defaults to 90 days.
655
656 gc.reflogexpireunreachable::
657 'git-reflog expire' removes reflog entries older than
658 this time and are not reachable from the current tip;
659 defaults to 30 days.
660
661 gc.rerereresolved::
662 Records of conflicted merge you resolved earlier are
663 kept for this many days when 'git-rerere gc' is run.
664 The default is 60 days. See linkgit:git-rerere[1].
665
666 gc.rerereunresolved::
667 Records of conflicted merge you have not resolved are
668 kept for this many days when 'git-rerere gc' is run.
669 The default is 15 days. See linkgit:git-rerere[1].
670
671 rerere.autoupdate::
672 When set to true, `git-rerere` updates the index with the
673 resulting contents after it cleanly resolves conflicts using
674 previously recorded resolution. Defaults to false.
675
676 rerere.enabled::
677 Activate recording of resolved conflicts, so that identical
678 conflict hunks can be resolved automatically, should they
679 be encountered again. linkgit:git-rerere[1] command is by
680 default enabled if you create `rr-cache` directory under
681 `$GIT_DIR`, but can be disabled by setting this option to false.
682
683 gitcvs.enabled::
684 Whether the CVS server interface is enabled for this repository.
685 See linkgit:git-cvsserver[1].
686
687 gitcvs.logfile::
688 Path to a log file where the CVS server interface well... logs
689 various stuff. See linkgit:git-cvsserver[1].
690
691 gitcvs.usecrlfattr
692 If true, the server will look up the `crlf` attribute for
693 files to determine the '-k' modes to use. If `crlf` is set,
694 the '-k' mode will be left blank, so cvs clients will
695 treat it as text. If `crlf` is explicitly unset, the file
696 will be set with '-kb' mode, which suppresses any newline munging
697 the client might otherwise do. If `crlf` is not specified,
698 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
699
700 gitcvs.allbinary::
701 This is used if 'gitcvs.usecrlfattr' does not resolve
702 the correct '-kb' mode to use. If true, all
703 unresolved files are sent to the client in
704 mode '-kb'. This causes the client to treat them
705 as binary files, which suppresses any newline munging it
706 otherwise might do. Alternatively, if it is set to "guess",
707 then the contents of the file are examined to decide if
708 it is binary, similar to 'core.autocrlf'.
709
710 gitcvs.dbname::
711 Database used by git-cvsserver to cache revision information
712 derived from the git repository. The exact meaning depends on the
713 used database driver, for SQLite (which is the default driver) this
714 is a filename. Supports variable substitution (see
715 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
716 Default: '%Ggitcvs.%m.sqlite'
717
718 gitcvs.dbdriver::
719 Used Perl DBI driver. You can specify any available driver
720 for this here, but it might not work. git-cvsserver is tested
721 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
722 reported *not* to work with 'DBD::mysql'. Experimental feature.
723 May not contain double colons (`:`). Default: 'SQLite'.
724 See linkgit:git-cvsserver[1].
725
726 gitcvs.dbuser, gitcvs.dbpass::
727 Database user and password. Only useful if setting 'gitcvs.dbdriver',
728 since SQLite has no concept of database users and/or passwords.
729 'gitcvs.dbuser' supports variable substitution (see
730 linkgit:git-cvsserver[1] for details).
731
732 gitcvs.dbTableNamePrefix::
733 Database table name prefix. Prepended to the names of any
734 database tables used, allowing a single database to be used
735 for several repositories. Supports variable substitution (see
736 linkgit:git-cvsserver[1] for details). Any non-alphabetic
737 characters will be replaced with underscores.
738
739 All gitcvs variables except for 'gitcvs.usecrlfattr' and
740 'gitcvs.allbinary' can also be specified as
741 'gitcvs.<access_method>.<varname>' (where 'access_method'
742 is one of "ext" and "pserver") to make them apply only for the given
743 access method.
744
745 gui.commitmsgwidth::
746 Defines how wide the commit message window is in the
747 linkgit:git-gui[1]. "75" is the default.
748
749 gui.diffcontext::
750 Specifies how many context lines should be used in calls to diff
751 made by the linkgit:git-gui[1]. The default is "5".
752
753 gui.matchtrackingbranch::
754 Determines if new branches created with linkgit:git-gui[1] should
755 default to tracking remote branches with matching names or
756 not. Default: "false".
757
758 gui.newbranchtemplate::
759 Is used as suggested name when creating new branches using the
760 linkgit:git-gui[1].
761
762 gui.pruneduringfetch::
763 "true" if linkgit:git-gui[1] should prune tracking branches when
764 performing a fetch. The default value is "false".
765
766 gui.trustmtime::
767 Determines if linkgit:git-gui[1] should trust the file modification
768 timestamp or not. By default the timestamps are not trusted.
769
770 gui.spellingdictionary::
771 Specifies the dictionary used for spell checking commit messages in
772 the linkgit:git-gui[1]. When set to "none" spell checking is turned
773 off.
774
775 help.browser::
776 Specify the browser that will be used to display help in the
777 'web' format. See linkgit:git-help[1].
778
779 help.format::
780 Override the default help format used by linkgit:git-help[1].
781 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
782 the default. 'web' and 'html' are the same.
783
784 http.proxy::
785 Override the HTTP proxy, normally configured using the 'http_proxy'
786 environment variable (see linkgit:curl[1]). This can be overridden
787 on a per-remote basis; see remote.<name>.proxy
788
789 http.sslVerify::
790 Whether to verify the SSL certificate when fetching or pushing
791 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
792 variable.
793
794 http.sslCert::
795 File containing the SSL certificate when fetching or pushing
796 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
797 variable.
798
799 http.sslKey::
800 File containing the SSL private key when fetching or pushing
801 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
802 variable.
803
804 http.sslCAInfo::
805 File containing the certificates to verify the peer with when
806 fetching or pushing over HTTPS. Can be overridden by the
807 'GIT_SSL_CAINFO' environment variable.
808
809 http.sslCAPath::
810 Path containing files with the CA certificates to verify the peer
811 with when fetching or pushing over HTTPS. Can be overridden
812 by the 'GIT_SSL_CAPATH' environment variable.
813
814 http.maxRequests::
815 How many HTTP requests to launch in parallel. Can be overridden
816 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
817
818 http.lowSpeedLimit, http.lowSpeedTime::
819 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
820 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
821 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
822 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
823
824 http.noEPSV::
825 A boolean which disables using of EPSV ftp command by curl.
826 This can helpful with some "poor" ftp servers which don't
827 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
828 environment variable. Default is false (curl will use EPSV).
829
830 i18n.commitEncoding::
831 Character encoding the commit messages are stored in; git itself
832 does not care per se, but this information is necessary e.g. when
833 importing commits from emails or in the gitk graphical history
834 browser (and possibly at other places in the future or in other
835 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
836
837 i18n.logOutputEncoding::
838 Character encoding the commit messages are converted to when
839 running 'git-log' and friends.
840
841 instaweb.browser::
842 Specify the program that will be used to browse your working
843 repository in gitweb. See linkgit:git-instaweb[1].
844
845 instaweb.httpd::
846 The HTTP daemon command-line to start gitweb on your working
847 repository. See linkgit:git-instaweb[1].
848
849 instaweb.local::
850 If true the web server started by linkgit:git-instaweb[1] will
851 be bound to the local IP (127.0.0.1).
852
853 instaweb.modulepath::
854 The module path for an apache httpd used by linkgit:git-instaweb[1].
855
856 instaweb.port::
857 The port number to bind the gitweb httpd to. See
858 linkgit:git-instaweb[1].
859
860 log.date::
861 Set default date-time mode for the log command. Setting log.date
862 value is similar to using 'git-log'\'s --date option. The value is one of the
863 following alternatives: {relative,local,default,iso,rfc,short}.
864 See linkgit:git-log[1].
865
866 log.showroot::
867 If true, the initial commit will be shown as a big creation event.
868 This is equivalent to a diff against an empty tree.
869 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
870 normally hide the root commit will now show it. True by default.
871
872 man.viewer::
873 Specify the programs that may be used to display help in the
874 'man' format. See linkgit:git-help[1].
875
876 include::merge-config.txt[]
877
878 man.<tool>.cmd::
879 Specify the command to invoke the specified man viewer. The
880 specified command is evaluated in shell with the man page
881 passed as argument. (See linkgit:git-help[1].)
882
883 man.<tool>.path::
884 Override the path for the given tool that may be used to
885 display help in the 'man' format. See linkgit:git-help[1].
886
887 mergetool.<tool>.path::
888 Override the path for the given tool. This is useful in case
889 your tool is not in the PATH.
890
891 mergetool.<tool>.cmd::
892 Specify the command to invoke the specified merge tool. The
893 specified command is evaluated in shell with the following
894 variables available: 'BASE' is the name of a temporary file
895 containing the common base of the files to be merged, if available;
896 'LOCAL' is the name of a temporary file containing the contents of
897 the file on the current branch; 'REMOTE' is the name of a temporary
898 file containing the contents of the file from the branch being
899 merged; 'MERGED' contains the name of the file to which the merge
900 tool should write the results of a successful merge.
901
902 mergetool.<tool>.trustExitCode::
903 For a custom merge command, specify whether the exit code of
904 the merge command can be used to determine whether the merge was
905 successful. If this is not set to true then the merge target file
906 timestamp is checked and the merge assumed to have been successful
907 if the file has been updated, otherwise the user is prompted to
908 indicate the success of the merge.
909
910 mergetool.keepBackup::
911 After performing a merge, the original file with conflict markers
912 can be saved as a file with a `.orig` extension. If this variable
913 is set to `false` then this file is not preserved. Defaults to
914 `true` (i.e. keep the backup files).
915
916 pack.window::
917 The size of the window used by linkgit:git-pack-objects[1] when no
918 window size is given on the command line. Defaults to 10.
919
920 pack.depth::
921 The maximum delta depth used by linkgit:git-pack-objects[1] when no
922 maximum depth is given on the command line. Defaults to 50.
923
924 pack.windowMemory::
925 The window memory size limit used by linkgit:git-pack-objects[1]
926 when no limit is given on the command line. The value can be
927 suffixed with "k", "m", or "g". Defaults to 0, meaning no
928 limit.
929
930 pack.compression::
931 An integer -1..9, indicating the compression level for objects
932 in a pack file. -1 is the zlib default. 0 means no
933 compression, and 1..9 are various speed/size tradeoffs, 9 being
934 slowest. If not set, defaults to core.compression. If that is
935 not set, defaults to -1, the zlib default, which is "a default
936 compromise between speed and compression (currently equivalent
937 to level 6)."
938
939 pack.deltaCacheSize::
940 The maximum memory in bytes used for caching deltas in
941 linkgit:git-pack-objects[1].
942 A value of 0 means no limit. Defaults to 0.
943
944 pack.deltaCacheLimit::
945 The maximum size of a delta, that is cached in
946 linkgit:git-pack-objects[1]. Defaults to 1000.
947
948 pack.threads::
949 Specifies the number of threads to spawn when searching for best
950 delta matches. This requires that linkgit:git-pack-objects[1]
951 be compiled with pthreads otherwise this option is ignored with a
952 warning. This is meant to reduce packing time on multiprocessor
953 machines. The required amount of memory for the delta search window
954 is however multiplied by the number of threads.
955 Specifying 0 will cause git to auto-detect the number of CPU's
956 and set the number of threads accordingly.
957
958 pack.indexVersion::
959 Specify the default pack index version. Valid values are 1 for
960 legacy pack index used by Git versions prior to 1.5.2, and 2 for
961 the new pack index with capabilities for packs larger than 4 GB
962 as well as proper protection against the repacking of corrupted
963 packs. Version 2 is the default. Note that version 2 is enforced
964 and this config option ignored whenever the corresponding pack is
965 larger than 2 GB.
966 +
967 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
968 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
969 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
970 other side may give you a repository that cannot be accessed with your
971 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
972 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
973 the `{asterisk}.idx` file.
974
975 pack.packSizeLimit::
976 The default maximum size of a pack. This setting only affects
977 packing to a file, i.e. the git:// protocol is unaffected. It
978 can be overridden by the `\--max-pack-size` option of
979 linkgit:git-repack[1].
980
981 pager.<cmd>::
982 Allows to set your own pager preferences for each command, overriding
983 the default. If `\--pager` or `\--no-pager` is specified on the command
984 line, it takes precedence over this option.
985
986 pull.octopus::
987 The default merge strategy to use when pulling multiple branches
988 at once.
989
990 pull.twohead::
991 The default merge strategy to use when pulling a single branch.
992
993 remote.<name>.url::
994 The URL of a remote repository. See linkgit:git-fetch[1] or
995 linkgit:git-push[1].
996
997 remote.<name>.proxy::
998 For remotes that require curl (http, https and ftp), the URL to
999 the proxy to use for that remote. Set to the empty string to
1000 disable proxying for that remote.
1001
1002 remote.<name>.fetch::
1003 The default set of "refspec" for linkgit:git-fetch[1]. See
1004 linkgit:git-fetch[1].
1005
1006 remote.<name>.push::
1007 The default set of "refspec" for linkgit:git-push[1]. See
1008 linkgit:git-push[1].
1009
1010 remote.<name>.mirror::
1011 If true, pushing to this remote will automatically behave
1012 as if the `\--mirror` option was given on the command line.
1013
1014 remote.<name>.skipDefaultUpdate::
1015 If true, this remote will be skipped by default when updating
1016 using the update subcommand of linkgit:git-remote[1].
1017
1018 remote.<name>.receivepack::
1019 The default program to execute on the remote side when pushing. See
1020 option \--receive-pack of linkgit:git-push[1].
1021
1022 remote.<name>.uploadpack::
1023 The default program to execute on the remote side when fetching. See
1024 option \--upload-pack of linkgit:git-fetch-pack[1].
1025
1026 remote.<name>.tagopt::
1027 Setting this value to \--no-tags disables automatic tag following when
1028 fetching from remote <name>
1029
1030 remotes.<group>::
1031 The list of remotes which are fetched by "git remote update
1032 <group>". See linkgit:git-remote[1].
1033
1034 repack.usedeltabaseoffset::
1035 By default, linkgit:git-repack[1] creates packs that use
1036 delta-base offset. If you need to share your repository with
1037 git older than version 1.4.4, either directly or via a dumb
1038 protocol such as http, then you need to set this option to
1039 "false" and repack. Access from old git versions over the
1040 native protocol are unaffected by this option.
1041
1042 showbranch.default::
1043 The default set of branches for linkgit:git-show-branch[1].
1044 See linkgit:git-show-branch[1].
1045
1046 status.relativePaths::
1047 By default, linkgit:git-status[1] shows paths relative to the
1048 current directory. Setting this variable to `false` shows paths
1049 relative to the repository root (this was the default for git
1050 prior to v1.5.4).
1051
1052 status.showUntrackedFiles::
1053 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1054 files which are not currently tracked by Git. Directories which
1055 contain only untracked files, are shown with the directory name
1056 only. Showing untracked files means that Git needs to lstat() all
1057 all the files in the whole repository, which might be slow on some
1058 systems. So, this variable controls how the commands displays
1059 the untracked files. Possible values are:
1060 +
1061 --
1062 - 'no' - Show no untracked files
1063 - 'normal' - Shows untracked files and directories
1064 - 'all' - Shows also individual files in untracked directories.
1065 --
1066 +
1067 If this variable is not specified, it defaults to 'normal'.
1068 This variable can be overridden with the -u|--untracked-files option
1069 of linkgit:git-status[1] and linkgit:git-commit[1].
1070
1071 tar.umask::
1072 This variable can be used to restrict the permission bits of
1073 tar archive entries. The default is 0002, which turns off the
1074 world write bit. The special value "user" indicates that the
1075 archiving user's umask will be used instead. See umask(2) and
1076 linkgit:git-archive[1].
1077
1078 url.<base>.insteadOf::
1079 Any URL that starts with this value will be rewritten to
1080 start, instead, with <base>. In cases where some site serves a
1081 large number of repositories, and serves them with multiple
1082 access methods, and some users need to use different access
1083 methods, this feature allows people to specify any of the
1084 equivalent URLs and have git automatically rewrite the URL to
1085 the best alternative for the particular user, even for a
1086 never-before-seen repository on the site. When more than one
1087 insteadOf strings match a given URL, the longest match is used.
1088
1089 user.email::
1090 Your email address to be recorded in any newly created commits.
1091 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1092 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1093
1094 user.name::
1095 Your full name to be recorded in any newly created commits.
1096 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1097 environment variables. See linkgit:git-commit-tree[1].
1098
1099 user.signingkey::
1100 If linkgit:git-tag[1] is not selecting the key you want it to
1101 automatically when creating a signed tag, you can override the
1102 default selection with this variable. This option is passed
1103 unchanged to gpg's --local-user parameter, so you may specify a key
1104 using any method that gpg supports.
1105
1106 imap::
1107 The configuration variables in the 'imap' section are described
1108 in linkgit:git-imap-send[1].
1109
1110 receive.fsckObjects::
1111 If it is set to true, git-receive-pack will check all received
1112 objects. It will abort in the case of a malformed object or a
1113 broken link. The result of an abort are only dangling objects.
1114 Defaults to false.
1115
1116 receive.unpackLimit::
1117 If the number of objects received in a push is below this
1118 limit then the objects will be unpacked into loose object
1119 files. However if the number of received objects equals or
1120 exceeds this limit then the received pack will be stored as
1121 a pack, after adding any missing delta bases. Storing the
1122 pack from a push can make the push operation complete faster,
1123 especially on slow filesystems. If not set, the value of
1124 `transfer.unpackLimit` is used instead.
1125
1126 receive.denyNonFastForwards::
1127 If set to true, git-receive-pack will deny a ref update which is
1128 not a fast forward. Use this to prevent such an update via a push,
1129 even if that push is forced. This configuration variable is
1130 set when initializing a shared repository.
1131
1132 transfer.unpackLimit::
1133 When `fetch.unpackLimit` or `receive.unpackLimit` are
1134 not set, the value of this variable is used instead.
1135 The default value is 100.
1136
1137 web.browser::
1138 Specify a web browser that may be used by some commands.
1139 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1140 may use it.