Merge branch 'maint-1.6.1' into maint
[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.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.
130
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.
137
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.
149
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.
159
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.
204
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.
211
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 core.ignoreStat::
226 If true, commands which modify both the working tree and the index
227 will mark the updated paths with the "assume unchanged" bit in the
228 index. These marked files are then assumed to stay unchanged in the
229 working copy, until you mark them otherwise manually - Git will not
230 detect the file changes by lstat() calls. This is useful on systems
231 where those are very slow, such as Microsoft Windows.
232 See linkgit:git-update-index[1].
233 False by default.
234
235 core.preferSymlinkRefs::
236 Instead of the default "symref" format for HEAD
237 and other symbolic reference files, use symbolic links.
238 This is sometimes needed to work with old scripts that
239 expect HEAD to be a symbolic link.
240
241 core.bare::
242 If true this repository is assumed to be 'bare' and has no
243 working directory associated with it. If this is the case a
244 number of commands that require a working directory will be
245 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
246 +
247 This setting is automatically guessed by linkgit:git-clone[1] or
248 linkgit:git-init[1] when the repository was created. By default a
249 repository that ends in "/.git" is assumed to be not bare (bare =
250 false), while all other repositories are assumed to be bare (bare
251 = true).
252
253 core.worktree::
254 Set the path to the working tree. The value will not be
255 used in combination with repositories found automatically in
256 a .git directory (i.e. $GIT_DIR is not set).
257 This can be overridden by the GIT_WORK_TREE environment
258 variable and the '--work-tree' command line option. It can be
259 a absolute path or relative path to the directory specified by
260 --git-dir or GIT_DIR.
261 Note: If --git-dir or GIT_DIR are specified but none of
262 --work-tree, GIT_WORK_TREE and core.worktree is specified,
263 the current working directory is regarded as the top directory
264 of your working tree.
265
266 core.logAllRefUpdates::
267 Enable the reflog. Updates to a ref <ref> is logged to the file
268 "$GIT_DIR/logs/<ref>", by appending the new and old
269 SHA1, the date/time and the reason of the update, but
270 only when the file exists. If this configuration
271 variable is set to true, missing "$GIT_DIR/logs/<ref>"
272 file is automatically created for branch heads.
273 +
274 This information can be used to determine what commit
275 was the tip of a branch "2 days ago".
276 +
277 This value is true by default in a repository that has
278 a working directory associated with it, and false by
279 default in a bare repository.
280
281 core.repositoryFormatVersion::
282 Internal variable identifying the repository format and layout
283 version.
284
285 core.sharedRepository::
286 When 'group' (or 'true'), the repository is made shareable between
287 several users in a group (making sure all the files and objects are
288 group-writable). When 'all' (or 'world' or 'everybody'), the
289 repository will be readable by all users, additionally to being
290 group-shareable. When 'umask' (or 'false'), git will use permissions
291 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
292 files in the repository will have this mode value. '0xxx' will override
293 user's umask value (whereas the other options will only override
294 requested parts of the user's umask value). Examples: '0660' will make
295 the repo read/write-able for the owner and group, but inaccessible to
296 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
297 repository that is group-readable but not group-writable.
298 See linkgit:git-init[1]. False by default.
299
300 core.warnAmbiguousRefs::
301 If true, git will warn you if the ref name you passed it is ambiguous
302 and might match multiple refs in the .git/refs/ tree. True by default.
303
304 core.compression::
305 An integer -1..9, indicating a default compression level.
306 -1 is the zlib default. 0 means no compression,
307 and 1..9 are various speed/size tradeoffs, 9 being slowest.
308 If set, this provides a default to other compression variables,
309 such as 'core.loosecompression' and 'pack.compression'.
310
311 core.loosecompression::
312 An integer -1..9, indicating the compression level for objects that
313 are not in a pack file. -1 is the zlib default. 0 means no
314 compression, and 1..9 are various speed/size tradeoffs, 9 being
315 slowest. If not set, defaults to core.compression. If that is
316 not set, defaults to 1 (best speed).
317
318 core.packedGitWindowSize::
319 Number of bytes of a pack file to map into memory in a
320 single mapping operation. Larger window sizes may allow
321 your system to process a smaller number of large pack files
322 more quickly. Smaller window sizes will negatively affect
323 performance due to increased calls to the operating system's
324 memory manager, but may improve performance when accessing
325 a large number of large pack files.
326 +
327 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
328 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
329 be reasonable for all users/operating systems. You probably do
330 not need to adjust this value.
331 +
332 Common unit suffixes of 'k', 'm', or 'g' are supported.
333
334 core.packedGitLimit::
335 Maximum number of bytes to map simultaneously into memory
336 from pack files. If Git needs to access more than this many
337 bytes at once to complete an operation it will unmap existing
338 regions to reclaim virtual address space within the process.
339 +
340 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
341 This should be reasonable for all users/operating systems, except on
342 the largest projects. You probably do not need to adjust this value.
343 +
344 Common unit suffixes of 'k', 'm', or 'g' are supported.
345
346 core.deltaBaseCacheLimit::
347 Maximum number of bytes to reserve for caching base objects
348 that multiple deltafied objects reference. By storing the
349 entire decompressed base objects in a cache Git is able
350 to avoid unpacking and decompressing frequently used base
351 objects multiple times.
352 +
353 Default is 16 MiB on all platforms. This should be reasonable
354 for all users/operating systems, except on the largest projects.
355 You probably do not need to adjust this value.
356 +
357 Common unit suffixes of 'k', 'm', or 'g' are supported.
358
359 core.excludesfile::
360 In addition to '.gitignore' (per-directory) and
361 '.git/info/exclude', git looks into this file for patterns
362 of files which are not meant to be tracked. See
363 linkgit:gitignore[5].
364
365 core.editor::
366 Commands such as `commit` and `tag` that lets you edit
367 messages by launching an editor uses the value of this
368 variable when it is set, and the environment variable
369 `GIT_EDITOR` is not set. The order of preference is
370 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
371 `EDITOR` environment variables and then finally `vi`.
372
373 core.pager::
374 The command that git will use to paginate output. Can
375 be overridden with the `GIT_PAGER` environment
376 variable. Note that git sets the `LESS` environment
377 variable to `FRSX` if it is unset when it runs the
378 pager. One can change these settings by setting the
379 `LESS` variable to some other value. Alternately,
380 these settings can be overridden on a project or
381 global basis by setting the `core.pager` option.
382 Setting `core.pager` has no affect on the `LESS`
383 environment variable behaviour above, so if you want
384 to override git's default settings this way, you need
385 to be explicit. For example, to disable the S option
386 in a backward compatible manner, set `core.pager`
387 to "`less -+$LESS -FRX`". This will be passed to the
388 shell by git, which will translate the final command to
389 "`LESS=FRSX less -+FRSX -FRX`".
390
391 core.whitespace::
392 A comma separated list of common whitespace problems to
393 notice. 'git-diff' will use `color.diff.whitespace` to
394 highlight them, and 'git-apply --whitespace=error' will
395 consider them as errors. You can prefix `-` to disable
396 any of them (e.g. `-trailing-space`):
397 +
398 * `trailing-space` treats trailing whitespaces at the end of the line
399 as an error (enabled by default).
400 * `space-before-tab` treats a space character that appears immediately
401 before a tab character in the initial indent part of the line as an
402 error (enabled by default).
403 * `indent-with-non-tab` treats a line that is indented with 8 or more
404 space characters as an error (not enabled by default).
405 * `cr-at-eol` treats a carriage-return at the end of line as
406 part of the line terminator, i.e. with it, `trailing-space`
407 does not trigger if the character before such a carriage-return
408 is not a whitespace (not enabled by default).
409
410 core.fsyncobjectfiles::
411 This boolean will enable 'fsync()' when writing object files.
412 +
413 This is a total waste of time and effort on a filesystem that orders
414 data writes properly, but can be useful for filesystems that do not use
415 journalling (traditional UNIX filesystems) or that only journal metadata
416 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
417
418 core.preloadindex::
419 Enable parallel index preload for operations like 'git diff'
420 +
421 This can speed up operations like 'git diff' and 'git status' especially
422 on filesystems like NFS that have weak caching semantics and thus
423 relatively high IO latencies. With this set to 'true', git will do the
424 index comparison to the filesystem data in parallel, allowing
425 overlapping IO's.
426
427 alias.*::
428 Command aliases for the linkgit:git[1] command wrapper - e.g.
429 after defining "alias.last = cat-file commit HEAD", the invocation
430 "git last" is equivalent to "git cat-file commit HEAD". To avoid
431 confusion and troubles with script usage, aliases that
432 hide existing git commands are ignored. Arguments are split by
433 spaces, the usual shell quoting and escaping is supported.
434 quote pair and a backslash can be used to quote them.
435 +
436 If the alias expansion is prefixed with an exclamation point,
437 it will be treated as a shell command. For example, defining
438 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
439 "git new" is equivalent to running the shell command
440 "gitk --all --not ORIG_HEAD".
441
442 apply.whitespace::
443 Tells 'git-apply' how to handle whitespaces, in the same way
444 as the '--whitespace' option. See linkgit:git-apply[1].
445
446 branch.autosetupmerge::
447 Tells 'git-branch' and 'git-checkout' to setup new branches
448 so that linkgit:git-pull[1] will appropriately merge from the
449 starting point branch. Note that even if this option is not set,
450 this behavior can be chosen per-branch using the `--track`
451 and `--no-track` options. The valid settings are: `false` -- no
452 automatic setup is done; `true` -- automatic setup is done when the
453 starting point is a remote branch; `always` -- automatic setup is
454 done when the starting point is either a local branch or remote
455 branch. This option defaults to true.
456
457 branch.autosetuprebase::
458 When a new branch is created with 'git-branch' or 'git-checkout'
459 that tracks another branch, this variable tells git to set
460 up pull to rebase instead of merge (see "branch.<name>.rebase").
461 When `never`, rebase is never automatically set to true.
462 When `local`, rebase is set to true for tracked branches of
463 other local branches.
464 When `remote`, rebase is set to true for tracked branches of
465 remote branches.
466 When `always`, rebase will be set to true for all tracking
467 branches.
468 See "branch.autosetupmerge" for details on how to set up a
469 branch to track another branch.
470 This option defaults to never.
471
472 branch.<name>.remote::
473 When in branch <name>, it tells 'git-fetch' which remote to fetch.
474 If this option is not given, 'git-fetch' defaults to remote "origin".
475
476 branch.<name>.merge::
477 When in branch <name>, it tells 'git-fetch' the default
478 refspec to be marked for merging in FETCH_HEAD. The value is
479 handled like the remote part of a refspec, and must match a
480 ref which is fetched from the remote given by
481 "branch.<name>.remote".
482 The merge information is used by 'git-pull' (which at first calls
483 'git-fetch') to lookup the default branch for merging. Without
484 this option, 'git-pull' defaults to merge the first refspec fetched.
485 Specify multiple values to get an octopus merge.
486 If you wish to setup 'git-pull' so that it merges into <name> from
487 another branch in the local repository, you can point
488 branch.<name>.merge to the desired branch, and use the special setting
489 `.` (a period) for branch.<name>.remote.
490
491 branch.<name>.mergeoptions::
492 Sets default options for merging into branch <name>. The syntax and
493 supported options are equal to that of linkgit:git-merge[1], but
494 option values containing whitespace characters are currently not
495 supported.
496
497 branch.<name>.rebase::
498 When true, rebase the branch <name> on top of the fetched branch,
499 instead of merging the default branch from the default remote when
500 "git pull" is run.
501 *NOTE*: this is a possibly dangerous operation; do *not* use
502 it unless you understand the implications (see linkgit:git-rebase[1]
503 for details).
504
505 browser.<tool>.cmd::
506 Specify the command to invoke the specified browser. The
507 specified command is evaluated in shell with the URLs passed
508 as arguments. (See linkgit:git-web--browse[1].)
509
510 browser.<tool>.path::
511 Override the path for the given tool that may be used to
512 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
513 working repository in gitweb (see linkgit:git-instaweb[1]).
514
515 clean.requireForce::
516 A boolean to make git-clean do nothing unless given -f
517 or -n. Defaults to true.
518
519 color.branch::
520 A boolean to enable/disable color in the output of
521 linkgit:git-branch[1]. May be set to `always`,
522 `false` (or `never`) or `auto` (or `true`), in which case colors are used
523 only when the output is to a terminal. Defaults to false.
524
525 color.branch.<slot>::
526 Use customized color for branch coloration. `<slot>` is one of
527 `current` (the current branch), `local` (a local branch),
528 `remote` (a tracking branch in refs/remotes/), `plain` (other
529 refs).
530 +
531 The value for these configuration variables is a list of colors (at most
532 two) and attributes (at most one), separated by spaces. The colors
533 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
534 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
535 `blink` and `reverse`. The first color given is the foreground; the
536 second is the background. The position of the attribute, if any,
537 doesn't matter.
538
539 color.diff::
540 When set to `always`, always use colors in patch.
541 When false (or `never`), never. When set to `true` or `auto`, use
542 colors only when the output is to the terminal. Defaults to false.
543
544 color.diff.<slot>::
545 Use customized color for diff colorization. `<slot>` specifies
546 which part of the patch to use the specified color, and is one
547 of `plain` (context text), `meta` (metainformation), `frag`
548 (hunk header), `old` (removed lines), `new` (added lines),
549 `commit` (commit headers), or `whitespace` (highlighting
550 whitespace errors). The values of these variables may be specified as
551 in color.branch.<slot>.
552
553 color.interactive::
554 When set to `always`, always use colors for interactive prompts
555 and displays (such as those used by "git-add --interactive").
556 When false (or `never`), never. When set to `true` or `auto`, use
557 colors only when the output is to the terminal. Defaults to false.
558
559 color.interactive.<slot>::
560 Use customized color for 'git-add --interactive'
561 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
562 four distinct types of normal output from interactive
563 programs. The values of these variables may be specified as
564 in color.branch.<slot>.
565
566 color.pager::
567 A boolean to enable/disable colored output when the pager is in
568 use (default is true).
569
570 color.status::
571 A boolean to enable/disable color in the output of
572 linkgit:git-status[1]. May be set to `always`,
573 `false` (or `never`) or `auto` (or `true`), in which case colors are used
574 only when the output is to a terminal. Defaults to false.
575
576 color.status.<slot>::
577 Use customized color for status colorization. `<slot>` is
578 one of `header` (the header text of the status message),
579 `added` or `updated` (files which are added but not committed),
580 `changed` (files which are changed but not added in the index),
581 `untracked` (files which are not tracked by git), or
582 `nobranch` (the color the 'no branch' warning is shown in, defaulting
583 to red). The values of these variables may be specified as in
584 color.branch.<slot>.
585
586 color.ui::
587 When set to `always`, always use colors in all git commands which
588 are capable of colored output. When false (or `never`), never. When
589 set to `true` or `auto`, use colors only when the output is to the
590 terminal. When more specific variables of color.* are set, they always
591 take precedence over this setting. Defaults to false.
592
593 commit.template::
594 Specify a file to use as the template for new commit messages.
595
596 diff.autorefreshindex::
597 When using 'git-diff' to compare with work tree
598 files, do not consider stat-only change as changed.
599 Instead, silently run `git update-index --refresh` to
600 update the cached stat information for paths whose
601 contents in the work tree match the contents in the
602 index. This option defaults to true. Note that this
603 affects only 'git-diff' Porcelain, and not lower level
604 'diff' commands, such as 'git-diff-files'.
605
606 diff.external::
607 If this config variable is set, diff generation is not
608 performed using the internal diff machinery, but using the
609 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
610 environment variable. The command is called with parameters
611 as described under "git Diffs" in linkgit:git[1]. Note: if
612 you want to use an external diff program only on a subset of
613 your files, you might want to use linkgit:gitattributes[5] instead.
614
615 diff.mnemonicprefix::
616 If set, 'git-diff' uses a prefix pair that is different from the
617 standard "a/" and "b/" depending on what is being compared. When
618 this configuration is in effect, reverse diff output also swaps
619 the order of the prefixes:
620 'git-diff';;
621 compares the (i)ndex and the (w)ork tree;
622 'git-diff HEAD';;
623 compares a (c)ommit and the (w)ork tree;
624 'git diff --cached';;
625 compares a (c)ommit and the (i)ndex;
626 'git-diff HEAD:file1 file2';;
627 compares an (o)bject and a (w)ork tree entity;
628 'git diff --no-index a b';;
629 compares two non-git things (1) and (2).
630
631 diff.renameLimit::
632 The number of files to consider when performing the copy/rename
633 detection; equivalent to the 'git-diff' option '-l'.
634
635 diff.renames::
636 Tells git to detect renames. If set to any boolean value, it
637 will enable basic rename detection. If set to "copies" or
638 "copy", it will detect copies, as well.
639
640 diff.suppressBlankEmpty::
641 A boolean to inhibit the standard behavior of printing a space
642 before each empty output line. Defaults to false.
643
644 diff.wordRegex::
645 A POSIX Extended Regular Expression used to determine what is a "word"
646 when performing word-by-word difference calculations. Character
647 sequences that match the regular expression are "words", all other
648 characters are *ignorable* whitespace.
649
650 fetch.unpackLimit::
651 If the number of objects fetched over the git native
652 transfer is below this
653 limit, then the objects will be unpacked into loose object
654 files. However if the number of received objects equals or
655 exceeds this limit then the received pack will be stored as
656 a pack, after adding any missing delta bases. Storing the
657 pack from a push can make the push operation complete faster,
658 especially on slow filesystems. If not set, the value of
659 `transfer.unpackLimit` is used instead.
660
661 format.numbered::
662 A boolean which can enable or disable sequence numbers in patch
663 subjects. It defaults to "auto" which enables it only if there
664 is more than one patch. It can be enabled or disabled for all
665 messages by setting it to "true" or "false". See --numbered
666 option in linkgit:git-format-patch[1].
667
668 format.headers::
669 Additional email headers to include in a patch to be submitted
670 by mail. See linkgit:git-format-patch[1].
671
672 format.suffix::
673 The default for format-patch is to output files with the suffix
674 `.patch`. Use this variable to change that suffix (make sure to
675 include the dot if you want it).
676
677 format.pretty::
678 The default pretty format for log/show/whatchanged command,
679 See linkgit:git-log[1], linkgit:git-show[1],
680 linkgit:git-whatchanged[1].
681
682 gc.aggressiveWindow::
683 The window size parameter used in the delta compression
684 algorithm used by 'git-gc --aggressive'. This defaults
685 to 10.
686
687 gc.auto::
688 When there are approximately more than this many loose
689 objects in the repository, `git gc --auto` will pack them.
690 Some Porcelain commands use this command to perform a
691 light-weight garbage collection from time to time. The
692 default value is 6700. Setting this to 0 disables it.
693
694 gc.autopacklimit::
695 When there are more than this many packs that are not
696 marked with `*.keep` file in the repository, `git gc
697 --auto` consolidates them into one larger pack. The
698 default value is 50. Setting this to 0 disables it.
699
700 gc.packrefs::
701 'git-gc' does not run `git pack-refs` in a bare repository by
702 default so that older dumb-transport clients can still fetch
703 from the repository. Setting this to `true` lets 'git-gc'
704 to run `git pack-refs`. Setting this to `false` tells
705 'git-gc' never to run `git pack-refs`. The default setting is
706 `notbare`. Enable it only when you know you do not have to
707 support such clients. The default setting will change to `true`
708 at some stage, and setting this to `false` will continue to
709 prevent `git pack-refs` from being run from 'git-gc'.
710
711 gc.pruneexpire::
712 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
713 Override the grace period with this config variable. The value
714 "now" may be used to disable this grace period and always prune
715 unreachable objects immediately.
716
717 gc.reflogexpire::
718 'git-reflog expire' removes reflog entries older than
719 this time; defaults to 90 days.
720
721 gc.reflogexpireunreachable::
722 'git-reflog expire' removes reflog entries older than
723 this time and are not reachable from the current tip;
724 defaults to 30 days.
725
726 gc.rerereresolved::
727 Records of conflicted merge you resolved earlier are
728 kept for this many days when 'git-rerere gc' is run.
729 The default is 60 days. See linkgit:git-rerere[1].
730
731 gc.rerereunresolved::
732 Records of conflicted merge you have not resolved are
733 kept for this many days when 'git-rerere gc' is run.
734 The default is 15 days. See linkgit:git-rerere[1].
735
736 gitcvs.commitmsgannotation::
737 Append this string to each commit message. Set to empty string
738 to disable this feature. Defaults to "via git-CVS emulator".
739
740 gitcvs.enabled::
741 Whether the CVS server interface is enabled for this repository.
742 See linkgit:git-cvsserver[1].
743
744 gitcvs.logfile::
745 Path to a log file where the CVS server interface well... logs
746 various stuff. See linkgit:git-cvsserver[1].
747
748 gitcvs.usecrlfattr::
749 If true, the server will look up the `crlf` attribute for
750 files to determine the '-k' modes to use. If `crlf` is set,
751 the '-k' mode will be left blank, so cvs clients will
752 treat it as text. If `crlf` is explicitly unset, the file
753 will be set with '-kb' mode, which suppresses any newline munging
754 the client might otherwise do. If `crlf` is not specified,
755 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
756
757 gitcvs.allbinary::
758 This is used if 'gitcvs.usecrlfattr' does not resolve
759 the correct '-kb' mode to use. If true, all
760 unresolved files are sent to the client in
761 mode '-kb'. This causes the client to treat them
762 as binary files, which suppresses any newline munging it
763 otherwise might do. Alternatively, if it is set to "guess",
764 then the contents of the file are examined to decide if
765 it is binary, similar to 'core.autocrlf'.
766
767 gitcvs.dbname::
768 Database used by git-cvsserver to cache revision information
769 derived from the git repository. The exact meaning depends on the
770 used database driver, for SQLite (which is the default driver) this
771 is a filename. Supports variable substitution (see
772 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
773 Default: '%Ggitcvs.%m.sqlite'
774
775 gitcvs.dbdriver::
776 Used Perl DBI driver. You can specify any available driver
777 for this here, but it might not work. git-cvsserver is tested
778 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
779 reported *not* to work with 'DBD::mysql'. Experimental feature.
780 May not contain double colons (`:`). Default: 'SQLite'.
781 See linkgit:git-cvsserver[1].
782
783 gitcvs.dbuser, gitcvs.dbpass::
784 Database user and password. Only useful if setting 'gitcvs.dbdriver',
785 since SQLite has no concept of database users and/or passwords.
786 'gitcvs.dbuser' supports variable substitution (see
787 linkgit:git-cvsserver[1] for details).
788
789 gitcvs.dbTableNamePrefix::
790 Database table name prefix. Prepended to the names of any
791 database tables used, allowing a single database to be used
792 for several repositories. Supports variable substitution (see
793 linkgit:git-cvsserver[1] for details). Any non-alphabetic
794 characters will be replaced with underscores.
795
796 All gitcvs variables except for 'gitcvs.usecrlfattr' and
797 'gitcvs.allbinary' can also be specified as
798 'gitcvs.<access_method>.<varname>' (where 'access_method'
799 is one of "ext" and "pserver") to make them apply only for the given
800 access method.
801
802 gui.commitmsgwidth::
803 Defines how wide the commit message window is in the
804 linkgit:git-gui[1]. "75" is the default.
805
806 gui.diffcontext::
807 Specifies how many context lines should be used in calls to diff
808 made by the linkgit:git-gui[1]. The default is "5".
809
810 gui.encoding::
811 Specifies the default encoding to use for displaying of
812 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
813 It can be overridden by setting the 'encoding' attribute
814 for relevant files (see linkgit:gitattributes[5]).
815 If this option is not set, the tools default to the
816 locale encoding.
817
818 gui.matchtrackingbranch::
819 Determines if new branches created with linkgit:git-gui[1] should
820 default to tracking remote branches with matching names or
821 not. Default: "false".
822
823 gui.newbranchtemplate::
824 Is used as suggested name when creating new branches using the
825 linkgit:git-gui[1].
826
827 gui.pruneduringfetch::
828 "true" if linkgit:git-gui[1] should prune tracking branches when
829 performing a fetch. The default value is "false".
830
831 gui.trustmtime::
832 Determines if linkgit:git-gui[1] should trust the file modification
833 timestamp or not. By default the timestamps are not trusted.
834
835 gui.spellingdictionary::
836 Specifies the dictionary used for spell checking commit messages in
837 the linkgit:git-gui[1]. When set to "none" spell checking is turned
838 off.
839
840 gui.fastcopyblame::
841 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
842 location detection. It makes blame significantly faster on huge
843 repositories at the expense of less thorough copy detection.
844
845 gui.copyblamethreshold::
846 Specifies the threshold to use in 'git gui blame' original location
847 detection, measured in alphanumeric characters. See the
848 linkgit:git-blame[1] manual for more information on copy detection.
849
850 gui.blamehistoryctx::
851 Specifies the radius of history context in days to show in
852 linkgit:gitk[1] for the selected commit, when the `Show History
853 Context` menu item is invoked from 'git gui blame'. If this
854 variable is set to zero, the whole history is shown.
855
856 guitool.<name>.cmd::
857 Specifies the shell command line to execute when the corresponding item
858 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
859 mandatory for every tool. The command is executed from the root of
860 the working directory, and in the environment it receives the name of
861 the tool as 'GIT_GUITOOL', the name of the currently selected file as
862 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
863 the head is detached, 'CUR_BRANCH' is empty).
864
865 guitool.<name>.needsfile::
866 Run the tool only if a diff is selected in the GUI. It guarantees
867 that 'FILENAME' is not empty.
868
869 guitool.<name>.noconsole::
870 Run the command silently, without creating a window to display its
871 output.
872
873 guitool.<name>.norescan::
874 Don't rescan the working directory for changes after the tool
875 finishes execution.
876
877 guitool.<name>.confirm::
878 Show a confirmation dialog before actually running the tool.
879
880 guitool.<name>.argprompt::
881 Request a string argument from the user, and pass it to the tool
882 through the 'ARGS' environment variable. Since requesting an
883 argument implies confirmation, the 'confirm' option has no effect
884 if this is enabled. If the option is set to 'true', 'yes', or '1',
885 the dialog uses a built-in generic prompt; otherwise the exact
886 value of the variable is used.
887
888 guitool.<name>.revprompt::
889 Request a single valid revision from the user, and set the
890 'REVISION' environment variable. In other aspects this option
891 is similar to 'argprompt', and can be used together with it.
892
893 guitool.<name>.revunmerged::
894 Show only unmerged branches in the 'revprompt' subdialog.
895 This is useful for tools similar to merge or rebase, but not
896 for things like checkout or reset.
897
898 guitool.<name>.title::
899 Specifies the title to use for the prompt dialog. The default
900 is the tool name.
901
902 guitool.<name>.prompt::
903 Specifies the general prompt string to display at the top of
904 the dialog, before subsections for 'argprompt' and 'revprompt'.
905 The default value includes the actual command.
906
907 help.browser::
908 Specify the browser that will be used to display help in the
909 'web' format. See linkgit:git-help[1].
910
911 help.format::
912 Override the default help format used by linkgit:git-help[1].
913 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
914 the default. 'web' and 'html' are the same.
915
916 help.autocorrect::
917 Automatically correct and execute mistyped commands after
918 waiting for the given number of deciseconds (0.1 sec). If more
919 than one command can be deduced from the entered text, nothing
920 will be executed. If the value of this option is negative,
921 the corrected command will be executed immediately. If the
922 value is 0 - the command will be just shown but not executed.
923 This is the default.
924
925 http.proxy::
926 Override the HTTP proxy, normally configured using the 'http_proxy'
927 environment variable (see linkgit:curl[1]). This can be overridden
928 on a per-remote basis; see remote.<name>.proxy
929
930 http.sslVerify::
931 Whether to verify the SSL certificate when fetching or pushing
932 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
933 variable.
934
935 http.sslCert::
936 File containing the SSL certificate when fetching or pushing
937 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
938 variable.
939
940 http.sslKey::
941 File containing the SSL private key when fetching or pushing
942 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
943 variable.
944
945 http.sslCAInfo::
946 File containing the certificates to verify the peer with when
947 fetching or pushing over HTTPS. Can be overridden by the
948 'GIT_SSL_CAINFO' environment variable.
949
950 http.sslCAPath::
951 Path containing files with the CA certificates to verify the peer
952 with when fetching or pushing over HTTPS. Can be overridden
953 by the 'GIT_SSL_CAPATH' environment variable.
954
955 http.maxRequests::
956 How many HTTP requests to launch in parallel. Can be overridden
957 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
958
959 http.lowSpeedLimit, http.lowSpeedTime::
960 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
961 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
962 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
963 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
964
965 http.noEPSV::
966 A boolean which disables using of EPSV ftp command by curl.
967 This can helpful with some "poor" ftp servers which don't
968 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
969 environment variable. Default is false (curl will use EPSV).
970
971 i18n.commitEncoding::
972 Character encoding the commit messages are stored in; git itself
973 does not care per se, but this information is necessary e.g. when
974 importing commits from emails or in the gitk graphical history
975 browser (and possibly at other places in the future or in other
976 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
977
978 i18n.logOutputEncoding::
979 Character encoding the commit messages are converted to when
980 running 'git-log' and friends.
981
982 imap::
983 The configuration variables in the 'imap' section are described
984 in linkgit:git-imap-send[1].
985
986 instaweb.browser::
987 Specify the program that will be used to browse your working
988 repository in gitweb. See linkgit:git-instaweb[1].
989
990 instaweb.httpd::
991 The HTTP daemon command-line to start gitweb on your working
992 repository. See linkgit:git-instaweb[1].
993
994 instaweb.local::
995 If true the web server started by linkgit:git-instaweb[1] will
996 be bound to the local IP (127.0.0.1).
997
998 instaweb.modulepath::
999 The module path for an apache httpd used by linkgit:git-instaweb[1].
1000
1001 instaweb.port::
1002 The port number to bind the gitweb httpd to. See
1003 linkgit:git-instaweb[1].
1004
1005 interactive.singlekey::
1006 In interactive programs, allow the user to provide one-letter
1007 input with a single key (i.e., without hitting enter).
1008 Currently this is used only by the `\--patch` mode of
1009 linkgit:git-add[1]. Note that this setting is silently
1010 ignored if portable keystroke input is not available.
1011
1012 log.date::
1013 Set default date-time mode for the log command. Setting log.date
1014 value is similar to using 'git-log'\'s --date option. The value is one of the
1015 following alternatives: {relative,local,default,iso,rfc,short}.
1016 See linkgit:git-log[1].
1017
1018 log.showroot::
1019 If true, the initial commit will be shown as a big creation event.
1020 This is equivalent to a diff against an empty tree.
1021 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1022 normally hide the root commit will now show it. True by default.
1023
1024 mailmap.file::
1025 The location of an augmenting mailmap file. The default
1026 mailmap, located in the root of the repository, is loaded
1027 first, then the mailmap file pointed to by this variable.
1028 The location of the mailmap file may be in a repository
1029 subdirectory, or somewhere outside of the repository itself.
1030 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1031
1032 man.viewer::
1033 Specify the programs that may be used to display help in the
1034 'man' format. See linkgit:git-help[1].
1035
1036 man.<tool>.cmd::
1037 Specify the command to invoke the specified man viewer. The
1038 specified command is evaluated in shell with the man page
1039 passed as argument. (See linkgit:git-help[1].)
1040
1041 man.<tool>.path::
1042 Override the path for the given tool that may be used to
1043 display help in the 'man' format. See linkgit:git-help[1].
1044
1045 include::merge-config.txt[]
1046
1047 mergetool.<tool>.path::
1048 Override the path for the given tool. This is useful in case
1049 your tool is not in the PATH.
1050
1051 mergetool.<tool>.cmd::
1052 Specify the command to invoke the specified merge tool. The
1053 specified command is evaluated in shell with the following
1054 variables available: 'BASE' is the name of a temporary file
1055 containing the common base of the files to be merged, if available;
1056 'LOCAL' is the name of a temporary file containing the contents of
1057 the file on the current branch; 'REMOTE' is the name of a temporary
1058 file containing the contents of the file from the branch being
1059 merged; 'MERGED' contains the name of the file to which the merge
1060 tool should write the results of a successful merge.
1061
1062 mergetool.<tool>.trustExitCode::
1063 For a custom merge command, specify whether the exit code of
1064 the merge command can be used to determine whether the merge was
1065 successful. If this is not set to true then the merge target file
1066 timestamp is checked and the merge assumed to have been successful
1067 if the file has been updated, otherwise the user is prompted to
1068 indicate the success of the merge.
1069
1070 mergetool.keepBackup::
1071 After performing a merge, the original file with conflict markers
1072 can be saved as a file with a `.orig` extension. If this variable
1073 is set to `false` then this file is not preserved. Defaults to
1074 `true` (i.e. keep the backup files).
1075
1076 mergetool.keepTemporaries::
1077 When invoking a custom merge tool, git uses a set of temporary
1078 files to pass to the tool. If the tool returns an error and this
1079 variable is set to `true`, then these temporary files will be
1080 preserved, otherwise they will be removed after the tool has
1081 exited. Defaults to `false`.
1082
1083 mergetool.prompt::
1084 Prompt before each invocation of the merge resolution program.
1085
1086 pack.window::
1087 The size of the window used by linkgit:git-pack-objects[1] when no
1088 window size is given on the command line. Defaults to 10.
1089
1090 pack.depth::
1091 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1092 maximum depth is given on the command line. Defaults to 50.
1093
1094 pack.windowMemory::
1095 The window memory size limit used by linkgit:git-pack-objects[1]
1096 when no limit is given on the command line. The value can be
1097 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1098 limit.
1099
1100 pack.compression::
1101 An integer -1..9, indicating the compression level for objects
1102 in a pack file. -1 is the zlib default. 0 means no
1103 compression, and 1..9 are various speed/size tradeoffs, 9 being
1104 slowest. If not set, defaults to core.compression. If that is
1105 not set, defaults to -1, the zlib default, which is "a default
1106 compromise between speed and compression (currently equivalent
1107 to level 6)."
1108
1109 pack.deltaCacheSize::
1110 The maximum memory in bytes used for caching deltas in
1111 linkgit:git-pack-objects[1].
1112 A value of 0 means no limit. Defaults to 0.
1113
1114 pack.deltaCacheLimit::
1115 The maximum size of a delta, that is cached in
1116 linkgit:git-pack-objects[1]. Defaults to 1000.
1117
1118 pack.threads::
1119 Specifies the number of threads to spawn when searching for best
1120 delta matches. This requires that linkgit:git-pack-objects[1]
1121 be compiled with pthreads otherwise this option is ignored with a
1122 warning. This is meant to reduce packing time on multiprocessor
1123 machines. The required amount of memory for the delta search window
1124 is however multiplied by the number of threads.
1125 Specifying 0 will cause git to auto-detect the number of CPU's
1126 and set the number of threads accordingly.
1127
1128 pack.indexVersion::
1129 Specify the default pack index version. Valid values are 1 for
1130 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1131 the new pack index with capabilities for packs larger than 4 GB
1132 as well as proper protection against the repacking of corrupted
1133 packs. Version 2 is the default. Note that version 2 is enforced
1134 and this config option ignored whenever the corresponding pack is
1135 larger than 2 GB.
1136 +
1137 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1138 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1139 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1140 other side may give you a repository that cannot be accessed with your
1141 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1142 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1143 the `{asterisk}.idx` file.
1144
1145 pack.packSizeLimit::
1146 The default maximum size of a pack. This setting only affects
1147 packing to a file, i.e. the git:// protocol is unaffected. It
1148 can be overridden by the `\--max-pack-size` option of
1149 linkgit:git-repack[1].
1150
1151 pager.<cmd>::
1152 Allows turning on or off pagination of the output of a
1153 particular git subcommand when writing to a tty. If
1154 `\--paginate` or `\--no-pager` is specified on the command line,
1155 it takes precedence over this option. To disable pagination for
1156 all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".
1157
1158 pull.octopus::
1159 The default merge strategy to use when pulling multiple branches
1160 at once.
1161
1162 pull.twohead::
1163 The default merge strategy to use when pulling a single branch.
1164
1165 receive.fsckObjects::
1166 If it is set to true, git-receive-pack will check all received
1167 objects. It will abort in the case of a malformed object or a
1168 broken link. The result of an abort are only dangling objects.
1169 Defaults to false.
1170
1171 receive.unpackLimit::
1172 If the number of objects received in a push is below this
1173 limit then the objects will be unpacked into loose object
1174 files. However if the number of received objects equals or
1175 exceeds this limit then the received pack will be stored as
1176 a pack, after adding any missing delta bases. Storing the
1177 pack from a push can make the push operation complete faster,
1178 especially on slow filesystems. If not set, the value of
1179 `transfer.unpackLimit` is used instead.
1180
1181 receive.denyDeletes::
1182 If set to true, git-receive-pack will deny a ref update that deletes
1183 the ref. Use this to prevent such a ref deletion via a push.
1184
1185 receive.denyCurrentBranch::
1186 If set to true or "refuse", receive-pack will deny a ref update
1187 to the currently checked out branch of a non-bare repository.
1188 Such a push is potentially dangerous because it brings the HEAD
1189 out of sync with the index and working tree. If set to "warn",
1190 print a warning of such a push to stderr, but allow the push to
1191 proceed. If set to false or "ignore", allow such pushes with no
1192 message. Defaults to "warn".
1193
1194 receive.denyNonFastForwards::
1195 If set to true, git-receive-pack will deny a ref update which is
1196 not a fast forward. Use this to prevent such an update via a push,
1197 even if that push is forced. This configuration variable is
1198 set when initializing a shared repository.
1199
1200 remote.<name>.url::
1201 The URL of a remote repository. See linkgit:git-fetch[1] or
1202 linkgit:git-push[1].
1203
1204 remote.<name>.proxy::
1205 For remotes that require curl (http, https and ftp), the URL to
1206 the proxy to use for that remote. Set to the empty string to
1207 disable proxying for that remote.
1208
1209 remote.<name>.fetch::
1210 The default set of "refspec" for linkgit:git-fetch[1]. See
1211 linkgit:git-fetch[1].
1212
1213 remote.<name>.push::
1214 The default set of "refspec" for linkgit:git-push[1]. See
1215 linkgit:git-push[1].
1216
1217 remote.<name>.mirror::
1218 If true, pushing to this remote will automatically behave
1219 as if the `\--mirror` option was given on the command line.
1220
1221 remote.<name>.skipDefaultUpdate::
1222 If true, this remote will be skipped by default when updating
1223 using the update subcommand of linkgit:git-remote[1].
1224
1225 remote.<name>.receivepack::
1226 The default program to execute on the remote side when pushing. See
1227 option \--receive-pack of linkgit:git-push[1].
1228
1229 remote.<name>.uploadpack::
1230 The default program to execute on the remote side when fetching. See
1231 option \--upload-pack of linkgit:git-fetch-pack[1].
1232
1233 remote.<name>.tagopt::
1234 Setting this value to \--no-tags disables automatic tag following when
1235 fetching from remote <name>
1236
1237 remotes.<group>::
1238 The list of remotes which are fetched by "git remote update
1239 <group>". See linkgit:git-remote[1].
1240
1241 repack.usedeltabaseoffset::
1242 By default, linkgit:git-repack[1] creates packs that use
1243 delta-base offset. If you need to share your repository with
1244 git older than version 1.4.4, either directly or via a dumb
1245 protocol such as http, then you need to set this option to
1246 "false" and repack. Access from old git versions over the
1247 native protocol are unaffected by this option.
1248
1249 rerere.autoupdate::
1250 When set to true, `git-rerere` updates the index with the
1251 resulting contents after it cleanly resolves conflicts using
1252 previously recorded resolution. Defaults to false.
1253
1254 rerere.enabled::
1255 Activate recording of resolved conflicts, so that identical
1256 conflict hunks can be resolved automatically, should they
1257 be encountered again. linkgit:git-rerere[1] command is by
1258 default enabled if you create `rr-cache` directory under
1259 `$GIT_DIR`, but can be disabled by setting this option to false.
1260
1261 showbranch.default::
1262 The default set of branches for linkgit:git-show-branch[1].
1263 See linkgit:git-show-branch[1].
1264
1265 status.relativePaths::
1266 By default, linkgit:git-status[1] shows paths relative to the
1267 current directory. Setting this variable to `false` shows paths
1268 relative to the repository root (this was the default for git
1269 prior to v1.5.4).
1270
1271 status.showUntrackedFiles::
1272 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1273 files which are not currently tracked by Git. Directories which
1274 contain only untracked files, are shown with the directory name
1275 only. Showing untracked files means that Git needs to lstat() all
1276 all the files in the whole repository, which might be slow on some
1277 systems. So, this variable controls how the commands displays
1278 the untracked files. Possible values are:
1279 +
1280 --
1281 - 'no' - Show no untracked files
1282 - 'normal' - Shows untracked files and directories
1283 - 'all' - Shows also individual files in untracked directories.
1284 --
1285 +
1286 If this variable is not specified, it defaults to 'normal'.
1287 This variable can be overridden with the -u|--untracked-files option
1288 of linkgit:git-status[1] and linkgit:git-commit[1].
1289
1290 tar.umask::
1291 This variable can be used to restrict the permission bits of
1292 tar archive entries. The default is 0002, which turns off the
1293 world write bit. The special value "user" indicates that the
1294 archiving user's umask will be used instead. See umask(2) and
1295 linkgit:git-archive[1].
1296
1297 transfer.unpackLimit::
1298 When `fetch.unpackLimit` or `receive.unpackLimit` are
1299 not set, the value of this variable is used instead.
1300 The default value is 100.
1301
1302 url.<base>.insteadOf::
1303 Any URL that starts with this value will be rewritten to
1304 start, instead, with <base>. In cases where some site serves a
1305 large number of repositories, and serves them with multiple
1306 access methods, and some users need to use different access
1307 methods, this feature allows people to specify any of the
1308 equivalent URLs and have git automatically rewrite the URL to
1309 the best alternative for the particular user, even for a
1310 never-before-seen repository on the site. When more than one
1311 insteadOf strings match a given URL, the longest match is used.
1312
1313 user.email::
1314 Your email address to be recorded in any newly created commits.
1315 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1316 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1317
1318 user.name::
1319 Your full name to be recorded in any newly created commits.
1320 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1321 environment variables. See linkgit:git-commit-tree[1].
1322
1323 user.signingkey::
1324 If linkgit:git-tag[1] is not selecting the key you want it to
1325 automatically when creating a signed tag, you can override the
1326 default selection with this variable. This option is passed
1327 unchanged to gpg's --local-user parameter, so you may specify a key
1328 using any method that gpg supports.
1329
1330 web.browser::
1331 Specify a web browser that may be used by some commands.
1332 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1333 may use it.