Code

Be more user-friendly when refusing to do something because of conflict.
[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         resolveConflict::
134                 Advices shown by various commands when conflicts
135                 prevent the operation from being performed.
136                 Default: true.
137 --
139 core.fileMode::
140         If false, the executable bit differences between the index and
141         the working copy are ignored; useful on broken filesystems like FAT.
142         See linkgit:git-update-index[1].
144 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
145 will probe and set core.fileMode false if appropriate when the
146 repository is created.
148 core.ignoreCygwinFSTricks::
149         This option is only used by Cygwin implementation of Git. If false,
150         the Cygwin stat() and lstat() functions are used. This may be useful
151         if your repository consists of a few separate directories joined in
152         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
153         whenever it is possible and falls back to Cygwin functions only to
154         handle symbol links. The native mode is more than twice faster than
155         normal Cygwin l/stat() functions. True by default, unless core.filemode
156         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
157         POSIX emulation is required to support core.filemode.
159 core.ignorecase::
160         If true, this option enables various workarounds to enable
161         git to work better on filesystems that are not case sensitive,
162         like FAT. For example, if a directory listing finds
163         "makefile" when git expects "Makefile", git will assume
164         it is really the same file, and continue to remember it as
165         "Makefile".
167 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
168 will probe and set core.ignorecase true if appropriate when the repository
169 is created.
171 core.trustctime::
172         If false, the ctime differences between the index and the
173         working copy are ignored; useful when the inode change time
174         is regularly modified by something outside Git (file system
175         crawlers and some backup systems).
176         See linkgit:git-update-index[1]. True by default.
178 core.quotepath::
179         The commands that output paths (e.g. 'ls-files',
180         'diff'), when not given the `-z` option, will quote
181         "unusual" characters in the pathname by enclosing the
182         pathname in a double-quote pair and with backslashes the
183         same way strings in C source code are quoted.  If this
184         variable is set to false, the bytes higher than 0x80 are
185         not quoted but output as verbatim.  Note that double
186         quote, backslash and control characters are always
187         quoted without `-z` regardless of the setting of this
188         variable.
190 core.autocrlf::
191         If true, makes git convert `CRLF` at the end of lines in text files to
192         `LF` when reading from the filesystem, and convert in reverse when
193         writing to the filesystem.  The variable can be set to
194         'input', in which case the conversion happens only while
195         reading from the filesystem but files are written out with
196         `LF` at the end of lines.  A file is considered
197         "text" (i.e. be subjected to the autocrlf mechanism) based on
198         the file's `crlf` attribute, or if `crlf` is unspecified,
199         based on the file's contents.  See linkgit:gitattributes[5].
201 core.safecrlf::
202         If true, makes git check if converting `CRLF` as controlled by
203         `core.autocrlf` is reversible.  Git will verify if a command
204         modifies a file in the work tree either directly or indirectly.
205         For example, committing a file followed by checking out the
206         same file should yield the original file in the work tree.  If
207         this is not the case for the current setting of
208         `core.autocrlf`, git will reject the file.  The variable can
209         be set to "warn", in which case git will only warn about an
210         irreversible conversion but continue the operation.
212 CRLF conversion bears a slight chance of corrupting data.
213 autocrlf=true will convert CRLF to LF during commit and LF to
214 CRLF during checkout.  A file that contains a mixture of LF and
215 CRLF before the commit cannot be recreated by git.  For text
216 files this is the right thing to do: it corrects line endings
217 such that we have only LF line endings in the repository.
218 But for binary files that are accidentally classified as text the
219 conversion can corrupt data.
221 If you recognize such corruption early you can easily fix it by
222 setting the conversion type explicitly in .gitattributes.  Right
223 after committing you still have the original file in your work
224 tree and this file is not yet corrupted.  You can explicitly tell
225 git that this file is binary and git will handle the file
226 appropriately.
228 Unfortunately, the desired effect of cleaning up text files with
229 mixed line endings and the undesired effect of corrupting binary
230 files cannot be distinguished.  In both cases CRLFs are removed
231 in an irreversible way.  For text files this is the right thing
232 to do because CRLFs are line endings, while for binary files
233 converting CRLFs corrupts data.
235 Note, this safety check does not mean that a checkout will generate a
236 file identical to the original file for a different setting of
237 `core.autocrlf`, but only for the current one.  For example, a text
238 file with `LF` would be accepted with `core.autocrlf=input` and could
239 later be checked out with `core.autocrlf=true`, in which case the
240 resulting file would contain `CRLF`, although the original file
241 contained `LF`.  However, in both work trees the line endings would be
242 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
243 file with mixed line endings would be reported by the `core.safecrlf`
244 mechanism.
246 core.symlinks::
247         If false, symbolic links are checked out as small plain files that
248         contain the link text. linkgit:git-update-index[1] and
249         linkgit:git-add[1] will not change the recorded type to regular
250         file. Useful on filesystems like FAT that do not support
251         symbolic links.
253 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
254 will probe and set core.symlinks false if appropriate when the repository
255 is created.
257 core.gitProxy::
258         A "proxy command" to execute (as 'command host port') instead
259         of establishing direct connection to the remote server when
260         using the git protocol for fetching. If the variable value is
261         in the "COMMAND for DOMAIN" format, the command is applied only
262         on hostnames ending with the specified domain string. This variable
263         may be set multiple times and is matched in the given order;
264         the first match wins.
266 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
267 (which always applies universally, without the special "for"
268 handling).
270 The special string `none` can be used as the proxy command to
271 specify that no proxy be used for a given domain pattern.
272 This is useful for excluding servers inside a firewall from
273 proxy use, while defaulting to a common proxy for external domains.
275 core.ignoreStat::
276         If true, commands which modify both the working tree and the index
277         will mark the updated paths with the "assume unchanged" bit in the
278         index. These marked files are then assumed to stay unchanged in the
279         working copy, until you mark them otherwise manually - Git will not
280         detect the file changes by lstat() calls. This is useful on systems
281         where those are very slow, such as Microsoft Windows.
282         See linkgit:git-update-index[1].
283         False by default.
285 core.preferSymlinkRefs::
286         Instead of the default "symref" format for HEAD
287         and other symbolic reference files, use symbolic links.
288         This is sometimes needed to work with old scripts that
289         expect HEAD to be a symbolic link.
291 core.bare::
292         If true this repository is assumed to be 'bare' and has no
293         working directory associated with it.  If this is the case a
294         number of commands that require a working directory will be
295         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
297 This setting is automatically guessed by linkgit:git-clone[1] or
298 linkgit:git-init[1] when the repository was created.  By default a
299 repository that ends in "/.git" is assumed to be not bare (bare =
300 false), while all other repositories are assumed to be bare (bare
301 = true).
303 core.worktree::
304         Set the path to the working tree.  The value will not be
305         used in combination with repositories found automatically in
306         a .git directory (i.e. $GIT_DIR is not set).
307         This can be overridden by the GIT_WORK_TREE environment
308         variable and the '--work-tree' command line option. It can be
309         a absolute path or relative path to the directory specified by
310         --git-dir or GIT_DIR.
311         Note: If --git-dir or GIT_DIR are specified but none of
312         --work-tree, GIT_WORK_TREE and core.worktree is specified,
313         the current working directory is regarded as the top directory
314         of your working tree.
316 core.logAllRefUpdates::
317         Enable the reflog. Updates to a ref <ref> is logged to the file
318         "$GIT_DIR/logs/<ref>", by appending the new and old
319         SHA1, the date/time and the reason of the update, but
320         only when the file exists.  If this configuration
321         variable is set to true, missing "$GIT_DIR/logs/<ref>"
322         file is automatically created for branch heads.
324 This information can be used to determine what commit
325 was the tip of a branch "2 days ago".
327 This value is true by default in a repository that has
328 a working directory associated with it, and false by
329 default in a bare repository.
331 core.repositoryFormatVersion::
332         Internal variable identifying the repository format and layout
333         version.
335 core.sharedRepository::
336         When 'group' (or 'true'), the repository is made shareable between
337         several users in a group (making sure all the files and objects are
338         group-writable). When 'all' (or 'world' or 'everybody'), the
339         repository will be readable by all users, additionally to being
340         group-shareable. When 'umask' (or 'false'), git will use permissions
341         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
342         files in the repository will have this mode value. '0xxx' will override
343         user's umask value (whereas the other options will only override
344         requested parts of the user's umask value). Examples: '0660' will make
345         the repo read/write-able for the owner and group, but inaccessible to
346         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
347         repository that is group-readable but not group-writable.
348         See linkgit:git-init[1]. False by default.
350 core.warnAmbiguousRefs::
351         If true, git will warn you if the ref name you passed it is ambiguous
352         and might match multiple refs in the .git/refs/ tree. True by default.
354 core.compression::
355         An integer -1..9, indicating a default compression level.
356         -1 is the zlib default. 0 means no compression,
357         and 1..9 are various speed/size tradeoffs, 9 being slowest.
358         If set, this provides a default to other compression variables,
359         such as 'core.loosecompression' and 'pack.compression'.
361 core.loosecompression::
362         An integer -1..9, indicating the compression level for objects that
363         are not in a pack file. -1 is the zlib default. 0 means no
364         compression, and 1..9 are various speed/size tradeoffs, 9 being
365         slowest.  If not set,  defaults to core.compression.  If that is
366         not set,  defaults to 1 (best speed).
368 core.packedGitWindowSize::
369         Number of bytes of a pack file to map into memory in a
370         single mapping operation.  Larger window sizes may allow
371         your system to process a smaller number of large pack files
372         more quickly.  Smaller window sizes will negatively affect
373         performance due to increased calls to the operating system's
374         memory manager, but may improve performance when accessing
375         a large number of large pack files.
377 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
378 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
379 be reasonable for all users/operating systems.  You probably do
380 not need to adjust this value.
382 Common unit suffixes of 'k', 'm', or 'g' are supported.
384 core.packedGitLimit::
385         Maximum number of bytes to map simultaneously into memory
386         from pack files.  If Git needs to access more than this many
387         bytes at once to complete an operation it will unmap existing
388         regions to reclaim virtual address space within the process.
390 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
391 This should be reasonable for all users/operating systems, except on
392 the largest projects.  You probably do not need to adjust this value.
394 Common unit suffixes of 'k', 'm', or 'g' are supported.
396 core.deltaBaseCacheLimit::
397         Maximum number of bytes to reserve for caching base objects
398         that multiple deltafied objects reference.  By storing the
399         entire decompressed base objects in a cache Git is able
400         to avoid unpacking and decompressing frequently used base
401         objects multiple times.
403 Default is 16 MiB on all platforms.  This should be reasonable
404 for all users/operating systems, except on the largest projects.
405 You probably do not need to adjust this value.
407 Common unit suffixes of 'k', 'm', or 'g' are supported.
409 core.excludesfile::
410         In addition to '.gitignore' (per-directory) and
411         '.git/info/exclude', git looks into this file for patterns
412         of files which are not meant to be tracked.  "{tilde}/" is expanded
413         to the value of `$HOME` and "{tilde}user/" to the specified user's
414         home directory.  See linkgit:gitignore[5].
416 core.editor::
417         Commands such as `commit` and `tag` that lets you edit
418         messages by launching an editor uses the value of this
419         variable when it is set, and the environment variable
420         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
422 core.pager::
423         The command that git will use to paginate output.  Can
424         be overridden with the `GIT_PAGER` environment
425         variable.  Note that git sets the `LESS` environment
426         variable to `FRSX` if it is unset when it runs the
427         pager.  One can change these settings by setting the
428         `LESS` variable to some other value.  Alternately,
429         these settings can be overridden on a project or
430         global basis by setting the `core.pager` option.
431         Setting `core.pager` has no affect on the `LESS`
432         environment variable behaviour above, so if you want
433         to override git's default settings this way, you need
434         to be explicit.  For example, to disable the S option
435         in a backward compatible manner, set `core.pager`
436         to `less -+$LESS -FRX`.  This will be passed to the
437         shell by git, which will translate the final command to
438         `LESS=FRSX less -+FRSX -FRX`.
440 core.whitespace::
441         A comma separated list of common whitespace problems to
442         notice.  'git-diff' will use `color.diff.whitespace` to
443         highlight them, and 'git-apply --whitespace=error' will
444         consider them as errors.  You can prefix `-` to disable
445         any of them (e.g. `-trailing-space`):
447 * `blank-at-eol` treats trailing whitespaces at the end of the line
448   as an error (enabled by default).
449 * `space-before-tab` treats a space character that appears immediately
450   before a tab character in the initial indent part of the line as an
451   error (enabled by default).
452 * `indent-with-non-tab` treats a line that is indented with 8 or more
453   space characters as an error (not enabled by default).
454 * `blank-at-eof` treats blank lines added at the end of file as an error
455   (enabled by default).
456 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
457   `blank-at-eof`.
458 * `cr-at-eol` treats a carriage-return at the end of line as
459   part of the line terminator, i.e. with it, `trailing-space`
460   does not trigger if the character before such a carriage-return
461   is not a whitespace (not enabled by default).
463 core.fsyncobjectfiles::
464         This boolean will enable 'fsync()' when writing object files.
466 This is a total waste of time and effort on a filesystem that orders
467 data writes properly, but can be useful for filesystems that do not use
468 journalling (traditional UNIX filesystems) or that only journal metadata
469 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
471 core.preloadindex::
472         Enable parallel index preload for operations like 'git diff'
474 This can speed up operations like 'git diff' and 'git status' especially
475 on filesystems like NFS that have weak caching semantics and thus
476 relatively high IO latencies.  With this set to 'true', git will do the
477 index comparison to the filesystem data in parallel, allowing
478 overlapping IO's.
480 core.createObject::
481         You can set this to 'link', in which case a hardlink followed by
482         a delete of the source are used to make sure that object creation
483         will not overwrite existing objects.
485 On some file system/operating system combinations, this is unreliable.
486 Set this config setting to 'rename' there; However, This will remove the
487 check that makes sure that existing object files will not get overwritten.
489 core.notesRef::
490         When showing commit messages, also show notes which are stored in
491         the given ref.  This ref is expected to contain files named
492         after the full SHA-1 of the commit they annotate.
494 If such a file exists in the given ref, the referenced blob is read, and
495 appended to the commit message, separated by a "Notes:" line.  If the
496 given ref itself does not exist, it is not an error, but means that no
497 notes should be printed.
499 This setting defaults to "refs/notes/commits", and can be overridden by
500 the `GIT_NOTES_REF` environment variable.
502 add.ignore-errors::
503         Tells 'git-add' to continue adding files when some files cannot be
504         added due to indexing errors. Equivalent to the '--ignore-errors'
505         option of linkgit:git-add[1].
507 alias.*::
508         Command aliases for the linkgit:git[1] command wrapper - e.g.
509         after defining "alias.last = cat-file commit HEAD", the invocation
510         "git last" is equivalent to "git cat-file commit HEAD". To avoid
511         confusion and troubles with script usage, aliases that
512         hide existing git commands are ignored. Arguments are split by
513         spaces, the usual shell quoting and escaping is supported.
514         quote pair and a backslash can be used to quote them.
516 If the alias expansion is prefixed with an exclamation point,
517 it will be treated as a shell command.  For example, defining
518 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
519 "git new" is equivalent to running the shell command
520 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
521 executed from the top-level directory of a repository, which may
522 not necessarily be the current directory.
524 apply.ignorewhitespace::
525         When set to 'change', tells 'git-apply' to ignore changes in
526         whitespace, in the same way as the '--ignore-space-change'
527         option.
528         When set to one of: no, none, never, false tells 'git-apply' to
529         respect all whitespace differences.
530         See linkgit:git-apply[1].
532 apply.whitespace::
533         Tells 'git-apply' how to handle whitespaces, in the same way
534         as the '--whitespace' option. See linkgit:git-apply[1].
536 branch.autosetupmerge::
537         Tells 'git-branch' and 'git-checkout' to setup new branches
538         so that linkgit:git-pull[1] will appropriately merge from the
539         starting point branch. Note that even if this option is not set,
540         this behavior can be chosen per-branch using the `--track`
541         and `--no-track` options. The valid settings are: `false` -- no
542         automatic setup is done; `true` -- automatic setup is done when the
543         starting point is a remote branch; `always` -- automatic setup is
544         done when the starting point is either a local branch or remote
545         branch. This option defaults to true.
547 branch.autosetuprebase::
548         When a new branch is created with 'git-branch' or 'git-checkout'
549         that tracks another branch, this variable tells git to set
550         up pull to rebase instead of merge (see "branch.<name>.rebase").
551         When `never`, rebase is never automatically set to true.
552         When `local`, rebase is set to true for tracked branches of
553         other local branches.
554         When `remote`, rebase is set to true for tracked branches of
555         remote branches.
556         When `always`, rebase will be set to true for all tracking
557         branches.
558         See "branch.autosetupmerge" for details on how to set up a
559         branch to track another branch.
560         This option defaults to never.
562 branch.<name>.remote::
563         When in branch <name>, it tells 'git-fetch' and 'git-push' which
564         remote to fetch from/push to.  It defaults to `origin` if no remote is
565         configured. `origin` is also used if you are not on any branch.
567 branch.<name>.merge::
568         Defines, together with branch.<name>.remote, the upstream branch
569         for the given branch. It tells 'git-fetch'/'git-pull' which
570         branch to merge and can also affect 'git-push' (see push.default).
571         When in branch <name>, it tells 'git-fetch' the default
572         refspec to be marked for merging in FETCH_HEAD. The value is
573         handled like the remote part of a refspec, and must match a
574         ref which is fetched from the remote given by
575         "branch.<name>.remote".
576         The merge information is used by 'git-pull' (which at first calls
577         'git-fetch') to lookup the default branch for merging. Without
578         this option, 'git-pull' defaults to merge the first refspec fetched.
579         Specify multiple values to get an octopus merge.
580         If you wish to setup 'git-pull' so that it merges into <name> from
581         another branch in the local repository, you can point
582         branch.<name>.merge to the desired branch, and use the special setting
583         `.` (a period) for branch.<name>.remote.
585 branch.<name>.mergeoptions::
586         Sets default options for merging into branch <name>. The syntax and
587         supported options are the same as those of linkgit:git-merge[1], but
588         option values containing whitespace characters are currently not
589         supported.
591 branch.<name>.rebase::
592         When true, rebase the branch <name> on top of the fetched branch,
593         instead of merging the default branch from the default remote when
594         "git pull" is run.
595         *NOTE*: this is a possibly dangerous operation; do *not* use
596         it unless you understand the implications (see linkgit:git-rebase[1]
597         for details).
599 browser.<tool>.cmd::
600         Specify the command to invoke the specified browser. The
601         specified command is evaluated in shell with the URLs passed
602         as arguments. (See linkgit:git-web--browse[1].)
604 browser.<tool>.path::
605         Override the path for the given tool that may be used to
606         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
607         working repository in gitweb (see linkgit:git-instaweb[1]).
609 clean.requireForce::
610         A boolean to make git-clean do nothing unless given -f
611         or -n.   Defaults to true.
613 color.branch::
614         A boolean to enable/disable color in the output of
615         linkgit:git-branch[1]. May be set to `always`,
616         `false` (or `never`) or `auto` (or `true`), in which case colors are used
617         only when the output is to a terminal. Defaults to false.
619 color.branch.<slot>::
620         Use customized color for branch coloration. `<slot>` is one of
621         `current` (the current branch), `local` (a local branch),
622         `remote` (a tracking branch in refs/remotes/), `plain` (other
623         refs).
625 The value for these configuration variables is a list of colors (at most
626 two) and attributes (at most one), separated by spaces.  The colors
627 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
628 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
629 `blink` and `reverse`.  The first color given is the foreground; the
630 second is the background.  The position of the attribute, if any,
631 doesn't matter.
633 color.diff::
634         When set to `always`, always use colors in patch.
635         When false (or `never`), never.  When set to `true` or `auto`, use
636         colors only when the output is to the terminal. Defaults to false.
638 color.diff.<slot>::
639         Use customized color for diff colorization.  `<slot>` specifies
640         which part of the patch to use the specified color, and is one
641         of `plain` (context text), `meta` (metainformation), `frag`
642         (hunk header), 'func' (function in hunk header), `old` (removed lines),
643         `new` (added lines), `commit` (commit headers), or `whitespace`
644         (highlighting whitespace errors). The values of these variables may be
645         specified as in color.branch.<slot>.
647 color.grep::
648         When set to `always`, always highlight matches.  When `false` (or
649         `never`), never.  When set to `true` or `auto`, use color only
650         when the output is written to the terminal.  Defaults to `false`.
652 color.grep.external::
653         The string value of this variable is passed to an external 'grep'
654         command as a command line option if match highlighting is turned
655         on.  If set to an empty string, no option is passed at all,
656         turning off coloring for external 'grep' calls; this is the default.
657         For GNU grep, set it to `--color=always` to highlight matches even
658         when a pager is used.
660 color.grep.match::
661         Use customized color for matches.  The value of this variable
662         may be specified as in color.branch.<slot>.  It is passed using
663         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
664         calling an external 'grep'.
666 color.interactive::
667         When set to `always`, always use colors for interactive prompts
668         and displays (such as those used by "git-add --interactive").
669         When false (or `never`), never.  When set to `true` or `auto`, use
670         colors only when the output is to the terminal. Defaults to false.
672 color.interactive.<slot>::
673         Use customized color for 'git-add --interactive'
674         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
675         four distinct types of normal output from interactive
676         commands.  The values of these variables may be specified as
677         in color.branch.<slot>.
679 color.pager::
680         A boolean to enable/disable colored output when the pager is in
681         use (default is true).
683 color.showbranch::
684         A boolean to enable/disable color in the output of
685         linkgit:git-show-branch[1]. May be set to `always`,
686         `false` (or `never`) or `auto` (or `true`), in which case colors are used
687         only when the output is to a terminal. Defaults to false.
689 color.status::
690         A boolean to enable/disable color in the output of
691         linkgit:git-status[1]. May be set to `always`,
692         `false` (or `never`) or `auto` (or `true`), in which case colors are used
693         only when the output is to a terminal. Defaults to false.
695 color.status.<slot>::
696         Use customized color for status colorization. `<slot>` is
697         one of `header` (the header text of the status message),
698         `added` or `updated` (files which are added but not committed),
699         `changed` (files which are changed but not added in the index),
700         `untracked` (files which are not tracked by git), or
701         `nobranch` (the color the 'no branch' warning is shown in, defaulting
702         to red). The values of these variables may be specified as in
703         color.branch.<slot>.
705 color.ui::
706         When set to `always`, always use colors in all git commands which
707         are capable of colored output. When false (or `never`), never. When
708         set to `true` or `auto`, use colors only when the output is to the
709         terminal. When more specific variables of color.* are set, they always
710         take precedence over this setting. Defaults to false.
712 commit.template::
713         Specify a file to use as the template for new commit messages.
714         "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
715         specified user's home directory.
717 diff.autorefreshindex::
718         When using 'git-diff' to compare with work tree
719         files, do not consider stat-only change as changed.
720         Instead, silently run `git update-index --refresh` to
721         update the cached stat information for paths whose
722         contents in the work tree match the contents in the
723         index.  This option defaults to true.  Note that this
724         affects only 'git-diff' Porcelain, and not lower level
725         'diff' commands, such as 'git-diff-files'.
727 diff.external::
728         If this config variable is set, diff generation is not
729         performed using the internal diff machinery, but using the
730         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
731         environment variable.  The command is called with parameters
732         as described under "git Diffs" in linkgit:git[1].  Note: if
733         you want to use an external diff program only on a subset of
734         your files, you might want to use linkgit:gitattributes[5] instead.
736 diff.mnemonicprefix::
737         If set, 'git-diff' uses a prefix pair that is different from the
738         standard "a/" and "b/" depending on what is being compared.  When
739         this configuration is in effect, reverse diff output also swaps
740         the order of the prefixes:
741 'git-diff';;
742         compares the (i)ndex and the (w)ork tree;
743 'git-diff HEAD';;
744          compares a (c)ommit and the (w)ork tree;
745 'git diff --cached';;
746         compares a (c)ommit and the (i)ndex;
747 'git-diff HEAD:file1 file2';;
748         compares an (o)bject and a (w)ork tree entity;
749 'git diff --no-index a b';;
750         compares two non-git things (1) and (2).
752 diff.renameLimit::
753         The number of files to consider when performing the copy/rename
754         detection; equivalent to the 'git-diff' option '-l'.
756 diff.renames::
757         Tells git to detect renames.  If set to any boolean value, it
758         will enable basic rename detection.  If set to "copies" or
759         "copy", it will detect copies, as well.
761 diff.suppressBlankEmpty::
762         A boolean to inhibit the standard behavior of printing a space
763         before each empty output line. Defaults to false.
765 diff.tool::
766         Controls which diff tool is used.  `diff.tool` overrides
767         `merge.tool` when used by linkgit:git-difftool[1] and has
768         the same valid values as `merge.tool` minus "tortoisemerge"
769         and plus "kompare".
771 difftool.<tool>.path::
772         Override the path for the given tool.  This is useful in case
773         your tool is not in the PATH.
775 difftool.<tool>.cmd::
776         Specify the command to invoke the specified diff tool.
777         The specified command is evaluated in shell with the following
778         variables available:  'LOCAL' is set to the name of the temporary
779         file containing the contents of the diff pre-image and 'REMOTE'
780         is set to the name of the temporary file containing the contents
781         of the diff post-image.
783 difftool.prompt::
784         Prompt before each invocation of the diff tool.
786 diff.wordRegex::
787         A POSIX Extended Regular Expression used to determine what is a "word"
788         when performing word-by-word difference calculations.  Character
789         sequences that match the regular expression are "words", all other
790         characters are *ignorable* whitespace.
792 fetch.unpackLimit::
793         If the number of objects fetched over the git native
794         transfer is below this
795         limit, then the objects will be unpacked into loose object
796         files. However if the number of received objects equals or
797         exceeds this limit then the received pack will be stored as
798         a pack, after adding any missing delta bases.  Storing the
799         pack from a push can make the push operation complete faster,
800         especially on slow filesystems.  If not set, the value of
801         `transfer.unpackLimit` is used instead.
803 format.attach::
804         Enable multipart/mixed attachments as the default for
805         'format-patch'.  The value can also be a double quoted string
806         which will enable attachments as the default and set the
807         value as the boundary.  See the --attach option in
808         linkgit:git-format-patch[1].
810 format.numbered::
811         A boolean which can enable or disable sequence numbers in patch
812         subjects.  It defaults to "auto" which enables it only if there
813         is more than one patch.  It can be enabled or disabled for all
814         messages by setting it to "true" or "false".  See --numbered
815         option in linkgit:git-format-patch[1].
817 format.headers::
818         Additional email headers to include in a patch to be submitted
819         by mail.  See linkgit:git-format-patch[1].
821 format.cc::
822         Additional "Cc:" headers to include in a patch to be submitted
823         by mail.  See the --cc option in linkgit:git-format-patch[1].
825 format.subjectprefix::
826         The default for format-patch is to output files with the '[PATCH]'
827         subject prefix. Use this variable to change that prefix.
829 format.suffix::
830         The default for format-patch is to output files with the suffix
831         `.patch`. Use this variable to change that suffix (make sure to
832         include the dot if you want it).
834 format.pretty::
835         The default pretty format for log/show/whatchanged command,
836         See linkgit:git-log[1], linkgit:git-show[1],
837         linkgit:git-whatchanged[1].
839 format.thread::
840         The default threading style for 'git-format-patch'.  Can be
841         either a boolean value, `shallow` or `deep`.  `shallow`
842         threading makes every mail a reply to the head of the series,
843         where the head is chosen from the cover letter, the
844         `\--in-reply-to`, and the first patch mail, in this order.
845         `deep` threading makes every mail a reply to the previous one.
846         A true boolean value is the same as `shallow`, and a false
847         value disables threading.
849 format.signoff::
850     A boolean value which lets you enable the `-s/--signoff` option of
851     format-patch by default. *Note:* Adding the Signed-off-by: line to a
852     patch should be a conscious act and means that you certify you have
853     the rights to submit this work under the same open source license.
854     Please see the 'SubmittingPatches' document for further discussion.
856 gc.aggressiveWindow::
857         The window size parameter used in the delta compression
858         algorithm used by 'git-gc --aggressive'.  This defaults
859         to 10.
861 gc.auto::
862         When there are approximately more than this many loose
863         objects in the repository, `git gc --auto` will pack them.
864         Some Porcelain commands use this command to perform a
865         light-weight garbage collection from time to time.  The
866         default value is 6700.  Setting this to 0 disables it.
868 gc.autopacklimit::
869         When there are more than this many packs that are not
870         marked with `*.keep` file in the repository, `git gc
871         --auto` consolidates them into one larger pack.  The
872         default value is 50.  Setting this to 0 disables it.
874 gc.packrefs::
875         'git-gc' does not run `git pack-refs` in a bare repository by
876         default so that older dumb-transport clients can still fetch
877         from the repository.  Setting this to `true` lets 'git-gc'
878         to run `git pack-refs`.  Setting this to `false` tells
879         'git-gc' never to run `git pack-refs`. The default setting is
880         `notbare`. Enable it only when you know you do not have to
881         support such clients.  The default setting will change to `true`
882         at some stage, and setting this to `false` will continue to
883         prevent `git pack-refs` from being run from 'git-gc'.
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.postBuffer::
1140         Maximum size in bytes of the buffer used by smart HTTP
1141         transports when POSTing data to the remote system.
1142         For requests larger than this buffer size, HTTP/1.1 and
1143         Transfer-Encoding: chunked is used to avoid creating a
1144         massive pack file locally.  Default is 1 MiB, which is
1145         sufficient for most requests.
1147 http.lowSpeedLimit, http.lowSpeedTime::
1148         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1149         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1150         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1151         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1153 http.noEPSV::
1154         A boolean which disables using of EPSV ftp command by curl.
1155         This can helpful with some "poor" ftp servers which don't
1156         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1157         environment variable. Default is false (curl will use EPSV).
1159 i18n.commitEncoding::
1160         Character encoding the commit messages are stored in; git itself
1161         does not care per se, but this information is necessary e.g. when
1162         importing commits from emails or in the gitk graphical history
1163         browser (and possibly at other places in the future or in other
1164         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1166 i18n.logOutputEncoding::
1167         Character encoding the commit messages are converted to when
1168         running 'git-log' and friends.
1170 imap::
1171         The configuration variables in the 'imap' section are described
1172         in linkgit:git-imap-send[1].
1174 instaweb.browser::
1175         Specify the program that will be used to browse your working
1176         repository in gitweb. See linkgit:git-instaweb[1].
1178 instaweb.httpd::
1179         The HTTP daemon command-line to start gitweb on your working
1180         repository. See linkgit:git-instaweb[1].
1182 instaweb.local::
1183         If true the web server started by linkgit:git-instaweb[1] will
1184         be bound to the local IP (127.0.0.1).
1186 instaweb.modulepath::
1187         The module path for an apache httpd used by linkgit:git-instaweb[1].
1189 instaweb.port::
1190         The port number to bind the gitweb httpd to. See
1191         linkgit:git-instaweb[1].
1193 interactive.singlekey::
1194         In interactive commands, allow the user to provide one-letter
1195         input with a single key (i.e., without hitting enter).
1196         Currently this is used only by the `\--patch` mode of
1197         linkgit:git-add[1].  Note that this setting is silently
1198         ignored if portable keystroke input is not available.
1200 log.date::
1201         Set default date-time mode for the log command. Setting log.date
1202         value is similar to using 'git-log'\'s --date option. The value is one of the
1203         following alternatives: {relative,local,default,iso,rfc,short}.
1204         See linkgit:git-log[1].
1206 log.showroot::
1207         If true, the initial commit will be shown as a big creation event.
1208         This is equivalent to a diff against an empty tree.
1209         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1210         normally hide the root commit will now show it. True by default.
1212 mailmap.file::
1213         The location of an augmenting mailmap file. The default
1214         mailmap, located in the root of the repository, is loaded
1215         first, then the mailmap file pointed to by this variable.
1216         The location of the mailmap file may be in a repository
1217         subdirectory, or somewhere outside of the repository itself.
1218         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1220 man.viewer::
1221         Specify the programs that may be used to display help in the
1222         'man' format. See linkgit:git-help[1].
1224 man.<tool>.cmd::
1225         Specify the command to invoke the specified man viewer. The
1226         specified command is evaluated in shell with the man page
1227         passed as argument. (See linkgit:git-help[1].)
1229 man.<tool>.path::
1230         Override the path for the given tool that may be used to
1231         display help in the 'man' format. See linkgit:git-help[1].
1233 include::merge-config.txt[]
1235 mergetool.<tool>.path::
1236         Override the path for the given tool.  This is useful in case
1237         your tool is not in the PATH.
1239 mergetool.<tool>.cmd::
1240         Specify the command to invoke the specified merge tool.  The
1241         specified command is evaluated in shell with the following
1242         variables available: 'BASE' is the name of a temporary file
1243         containing the common base of the files to be merged, if available;
1244         'LOCAL' is the name of a temporary file containing the contents of
1245         the file on the current branch; 'REMOTE' is the name of a temporary
1246         file containing the contents of the file from the branch being
1247         merged; 'MERGED' contains the name of the file to which the merge
1248         tool should write the results of a successful merge.
1250 mergetool.<tool>.trustExitCode::
1251         For a custom merge command, specify whether the exit code of
1252         the merge command can be used to determine whether the merge was
1253         successful.  If this is not set to true then the merge target file
1254         timestamp is checked and the merge assumed to have been successful
1255         if the file has been updated, otherwise the user is prompted to
1256         indicate the success of the merge.
1258 mergetool.keepBackup::
1259         After performing a merge, the original file with conflict markers
1260         can be saved as a file with a `.orig` extension.  If this variable
1261         is set to `false` then this file is not preserved.  Defaults to
1262         `true` (i.e. keep the backup files).
1264 mergetool.keepTemporaries::
1265         When invoking a custom merge tool, git uses a set of temporary
1266         files to pass to the tool. If the tool returns an error and this
1267         variable is set to `true`, then these temporary files will be
1268         preserved, otherwise they will be removed after the tool has
1269         exited. Defaults to `false`.
1271 mergetool.prompt::
1272         Prompt before each invocation of the merge resolution program.
1274 pack.window::
1275         The size of the window used by linkgit:git-pack-objects[1] when no
1276         window size is given on the command line. Defaults to 10.
1278 pack.depth::
1279         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1280         maximum depth is given on the command line. Defaults to 50.
1282 pack.windowMemory::
1283         The window memory size limit used by linkgit:git-pack-objects[1]
1284         when no limit is given on the command line.  The value can be
1285         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1286         limit.
1288 pack.compression::
1289         An integer -1..9, indicating the compression level for objects
1290         in a pack file. -1 is the zlib default. 0 means no
1291         compression, and 1..9 are various speed/size tradeoffs, 9 being
1292         slowest.  If not set,  defaults to core.compression.  If that is
1293         not set,  defaults to -1, the zlib default, which is "a default
1294         compromise between speed and compression (currently equivalent
1295         to level 6)."
1297 pack.deltaCacheSize::
1298         The maximum memory in bytes used for caching deltas in
1299         linkgit:git-pack-objects[1] before writing them out to a pack.
1300         This cache is used to speed up the writing object phase by not
1301         having to recompute the final delta result once the best match
1302         for all objects is found.  Repacking large repositories on machines
1303         which are tight with memory might be badly impacted by this though,
1304         especially if this cache pushes the system into swapping.
1305         A value of 0 means no limit. The smallest size of 1 byte may be
1306         used to virtually disable this cache. Defaults to 256 MiB.
1308 pack.deltaCacheLimit::
1309         The maximum size of a delta, that is cached in
1310         linkgit:git-pack-objects[1]. This cache is used to speed up the
1311         writing object phase by not having to recompute the final delta
1312         result once the best match for all objects is found. Defaults to 1000.
1314 pack.threads::
1315         Specifies the number of threads to spawn when searching for best
1316         delta matches.  This requires that linkgit:git-pack-objects[1]
1317         be compiled with pthreads otherwise this option is ignored with a
1318         warning. This is meant to reduce packing time on multiprocessor
1319         machines. The required amount of memory for the delta search window
1320         is however multiplied by the number of threads.
1321         Specifying 0 will cause git to auto-detect the number of CPU's
1322         and set the number of threads accordingly.
1324 pack.indexVersion::
1325         Specify the default pack index version.  Valid values are 1 for
1326         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1327         the new pack index with capabilities for packs larger than 4 GB
1328         as well as proper protection against the repacking of corrupted
1329         packs.  Version 2 is the default.  Note that version 2 is enforced
1330         and this config option ignored whenever the corresponding pack is
1331         larger than 2 GB.
1333 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1334 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1335 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1336 other side may give you a repository that cannot be accessed with your
1337 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1338 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1339 the `{asterisk}.idx` file.
1341 pack.packSizeLimit::
1342         The default maximum size of a pack.  This setting only affects
1343         packing to a file, i.e. the git:// protocol is unaffected.  It
1344         can be overridden by the `\--max-pack-size` option of
1345         linkgit:git-repack[1].
1347 pager.<cmd>::
1348         Allows turning on or off pagination of the output of a
1349         particular git subcommand when writing to a tty.  If
1350         `\--paginate` or `\--no-pager` is specified on the command line,
1351         it takes precedence over this option.  To disable pagination for
1352         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1354 pull.octopus::
1355         The default merge strategy to use when pulling multiple branches
1356         at once.
1358 pull.twohead::
1359         The default merge strategy to use when pulling a single branch.
1361 push.default::
1362         Defines the action git push should take if no refspec is given
1363         on the command line, no refspec is configured in the remote, and
1364         no refspec is implied by any of the options given on the command
1365         line. Possible values are:
1367 * `nothing` do not push anything.
1368 * `matching` push all matching branches.
1369   All branches having the same name in both ends are considered to be
1370   matching. This is the default.
1371 * `tracking` push the current branch to its upstream branch.
1372 * `current` push the current branch to a branch of the same name.
1374 rebase.stat::
1375         Whether to show a diffstat of what changed upstream since the last
1376         rebase. False by default.
1378 receive.autogc::
1379         By default, git-receive-pack will run "git-gc --auto" after
1380         receiving data from git-push and updating refs.  You can stop
1381         it by setting this variable to false.
1383 receive.fsckObjects::
1384         If it is set to true, git-receive-pack will check all received
1385         objects. It will abort in the case of a malformed object or a
1386         broken link. The result of an abort are only dangling objects.
1387         Defaults to false.
1389 receive.unpackLimit::
1390         If the number of objects received in a push is below this
1391         limit then the objects will be unpacked into loose object
1392         files. However if the number of received objects equals or
1393         exceeds this limit then the received pack will be stored as
1394         a pack, after adding any missing delta bases.  Storing the
1395         pack from a push can make the push operation complete faster,
1396         especially on slow filesystems.  If not set, the value of
1397         `transfer.unpackLimit` is used instead.
1399 receive.denyDeletes::
1400         If set to true, git-receive-pack will deny a ref update that deletes
1401         the ref. Use this to prevent such a ref deletion via a push.
1403 receive.denyCurrentBranch::
1404         If set to true or "refuse", receive-pack will deny a ref update
1405         to the currently checked out branch of a non-bare repository.
1406         Such a push is potentially dangerous because it brings the HEAD
1407         out of sync with the index and working tree. If set to "warn",
1408         print a warning of such a push to stderr, but allow the push to
1409         proceed. If set to false or "ignore", allow such pushes with no
1410         message. Defaults to "warn".
1412 receive.denyNonFastForwards::
1413         If set to true, git-receive-pack will deny a ref update which is
1414         not a fast-forward. Use this to prevent such an update via a push,
1415         even if that push is forced. This configuration variable is
1416         set when initializing a shared repository.
1418 receive.updateserverinfo::
1419         If set to true, git-receive-pack will run git-update-server-info
1420         after receiving data from git-push and updating refs.
1422 remote.<name>.url::
1423         The URL of a remote repository.  See linkgit:git-fetch[1] or
1424         linkgit:git-push[1].
1426 remote.<name>.pushurl::
1427         The push URL of a remote repository.  See linkgit:git-push[1].
1429 remote.<name>.proxy::
1430         For remotes that require curl (http, https and ftp), the URL to
1431         the proxy to use for that remote.  Set to the empty string to
1432         disable proxying for that remote.
1434 remote.<name>.fetch::
1435         The default set of "refspec" for linkgit:git-fetch[1]. See
1436         linkgit:git-fetch[1].
1438 remote.<name>.push::
1439         The default set of "refspec" for linkgit:git-push[1]. See
1440         linkgit:git-push[1].
1442 remote.<name>.mirror::
1443         If true, pushing to this remote will automatically behave
1444         as if the `\--mirror` option was given on the command line.
1446 remote.<name>.skipDefaultUpdate::
1447         If true, this remote will be skipped by default when updating
1448         using linkgit:git-fetch[1] or the `update` subcommand of
1449         linkgit:git-remote[1].
1451 remote.<name>.skipFetchAll::
1452         If true, this remote will be skipped by default when updating
1453         using linkgit:git-fetch[1] or the `update` subcommand of
1454         linkgit:git-remote[1].
1456 remote.<name>.receivepack::
1457         The default program to execute on the remote side when pushing.  See
1458         option \--receive-pack of linkgit:git-push[1].
1460 remote.<name>.uploadpack::
1461         The default program to execute on the remote side when fetching.  See
1462         option \--upload-pack of linkgit:git-fetch-pack[1].
1464 remote.<name>.tagopt::
1465         Setting this value to \--no-tags disables automatic tag following when
1466         fetching from remote <name>
1468 remotes.<group>::
1469         The list of remotes which are fetched by "git remote update
1470         <group>".  See linkgit:git-remote[1].
1472 repack.usedeltabaseoffset::
1473         By default, linkgit:git-repack[1] creates packs that use
1474         delta-base offset. If you need to share your repository with
1475         git older than version 1.4.4, either directly or via a dumb
1476         protocol such as http, then you need to set this option to
1477         "false" and repack. Access from old git versions over the
1478         native protocol are unaffected by this option.
1480 rerere.autoupdate::
1481         When set to true, `git-rerere` updates the index with the
1482         resulting contents after it cleanly resolves conflicts using
1483         previously recorded resolution.  Defaults to false.
1485 rerere.enabled::
1486         Activate recording of resolved conflicts, so that identical
1487         conflict hunks can be resolved automatically, should they
1488         be encountered again.  linkgit:git-rerere[1] command is by
1489         default enabled if you create `rr-cache` directory under
1490         `$GIT_DIR`, but can be disabled by setting this option to false.
1492 sendemail.identity::
1493         A configuration identity. When given, causes values in the
1494         'sendemail.<identity>' subsection to take precedence over
1495         values in the 'sendemail' section. The default identity is
1496         the value of 'sendemail.identity'.
1498 sendemail.smtpencryption::
1499         See linkgit:git-send-email[1] for description.  Note that this
1500         setting is not subject to the 'identity' mechanism.
1502 sendemail.smtpssl::
1503         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1505 sendemail.<identity>.*::
1506         Identity-specific versions of the 'sendemail.*' parameters
1507         found below, taking precedence over those when the this
1508         identity is selected, through command-line or
1509         'sendemail.identity'.
1511 sendemail.aliasesfile::
1512 sendemail.aliasfiletype::
1513 sendemail.bcc::
1514 sendemail.cc::
1515 sendemail.cccmd::
1516 sendemail.chainreplyto::
1517 sendemail.confirm::
1518 sendemail.envelopesender::
1519 sendemail.from::
1520 sendemail.multiedit::
1521 sendemail.signedoffbycc::
1522 sendemail.smtppass::
1523 sendemail.suppresscc::
1524 sendemail.suppressfrom::
1525 sendemail.to::
1526 sendemail.smtpserver::
1527 sendemail.smtpserverport::
1528 sendemail.smtpuser::
1529 sendemail.thread::
1530 sendemail.validate::
1531         See linkgit:git-send-email[1] for description.
1533 sendemail.signedoffcc::
1534         Deprecated alias for 'sendemail.signedoffbycc'.
1536 showbranch.default::
1537         The default set of branches for linkgit:git-show-branch[1].
1538         See linkgit:git-show-branch[1].
1540 status.relativePaths::
1541         By default, linkgit:git-status[1] shows paths relative to the
1542         current directory. Setting this variable to `false` shows paths
1543         relative to the repository root (this was the default for git
1544         prior to v1.5.4).
1546 status.showUntrackedFiles::
1547         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1548         files which are not currently tracked by Git. Directories which
1549         contain only untracked files, are shown with the directory name
1550         only. Showing untracked files means that Git needs to lstat() all
1551         all the files in the whole repository, which might be slow on some
1552         systems. So, this variable controls how the commands displays
1553         the untracked files. Possible values are:
1555 --
1556         - 'no'     - Show no untracked files
1557         - 'normal' - Shows untracked files and directories
1558         - 'all'    - Shows also individual files in untracked directories.
1559 --
1561 If this variable is not specified, it defaults to 'normal'.
1562 This variable can be overridden with the -u|--untracked-files option
1563 of linkgit:git-status[1] and linkgit:git-commit[1].
1565 tar.umask::
1566         This variable can be used to restrict the permission bits of
1567         tar archive entries.  The default is 0002, which turns off the
1568         world write bit.  The special value "user" indicates that the
1569         archiving user's umask will be used instead.  See umask(2) and
1570         linkgit:git-archive[1].
1572 transfer.unpackLimit::
1573         When `fetch.unpackLimit` or `receive.unpackLimit` are
1574         not set, the value of this variable is used instead.
1575         The default value is 100.
1577 url.<base>.insteadOf::
1578         Any URL that starts with this value will be rewritten to
1579         start, instead, with <base>. In cases where some site serves a
1580         large number of repositories, and serves them with multiple
1581         access methods, and some users need to use different access
1582         methods, this feature allows people to specify any of the
1583         equivalent URLs and have git automatically rewrite the URL to
1584         the best alternative for the particular user, even for a
1585         never-before-seen repository on the site.  When more than one
1586         insteadOf strings match a given URL, the longest match is used.
1588 url.<base>.pushInsteadOf::
1589         Any URL that starts with this value will not be pushed to;
1590         instead, it will be rewritten to start with <base>, and the
1591         resulting URL will be pushed to. In cases where some site serves
1592         a large number of repositories, and serves them with multiple
1593         access methods, some of which do not allow push, this feature
1594         allows people to specify a pull-only URL and have git
1595         automatically use an appropriate URL to push, even for a
1596         never-before-seen repository on the site.  When more than one
1597         pushInsteadOf strings match a given URL, the longest match is
1598         used.  If a remote has an explicit pushurl, git will ignore this
1599         setting for that remote.
1601 user.email::
1602         Your email address to be recorded in any newly created commits.
1603         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1604         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1606 user.name::
1607         Your full name to be recorded in any newly created commits.
1608         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1609         environment variables.  See linkgit:git-commit-tree[1].
1611 user.signingkey::
1612         If linkgit:git-tag[1] is not selecting the key you want it to
1613         automatically when creating a signed tag, you can override the
1614         default selection with this variable.  This option is passed
1615         unchanged to gpg's --local-user parameter, so you may specify a key
1616         using any method that gpg supports.
1618 web.browser::
1619         Specify a web browser that may be used by some commands.
1620         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1621         may use it.