Code

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