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