<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.8" />
<title>git-mergetool(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
git-mergetool(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-mergetool -
Run merge conflict resolution tools to resolve merge conflicts
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>git mergetool</em> [--tool=<tool>] [-y | --[no-]prompt] [<file>…]</pre>
<div class="attribution">
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Use <code>git mergetool</code> to run one of several merge utilities to resolve
merge conflicts. It is typically run after <em>git merge</em>.</p></div>
<div class="paragraph"><p>If one or more <file> parameters are given, the merge tool program will
be run to resolve differences on each file (skipping those without
conflicts). Specifying a directory will include all unresolved files in
that path. If no <file> names are specified, <em>git mergetool</em> will run
the merge tool program on every file with merge conflicts.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-t <tool>
</dt>
<dt class="hdlist1">
--tool=<tool>
</dt>
<dd>
<p>
Use the merge resolution program specified by <tool>.
Valid values include emerge, gvimdiff, kdiff3,
meld, vimdiff, and tortoisemerge. Run <code>git mergetool --tool-help</code>
for the list of valid <tool> settings.
</p>
<div class="paragraph"><p>If a merge resolution program is not specified, <em>git mergetool</em>
will use the configuration variable <code>merge.tool</code>. If the
configuration variable <code>merge.tool</code> is not set, <em>git mergetool</em>
will pick a suitable default.</p></div>
<div class="paragraph"><p>You can explicitly provide a full path to the tool by setting the
configuration variable <code>mergetool.<tool>.path</code>. For example, you
can configure the absolute path to kdiff3 by setting
<code>mergetool.kdiff3.path</code>. Otherwise, <em>git mergetool</em> assumes the
tool is available in PATH.</p></div>
<div class="paragraph"><p>Instead of running one of the known merge tool programs,
<em>git mergetool</em> can be customized to run an alternative program
by specifying the command line to invoke in a configuration
variable <code>mergetool.<tool>.cmd</code>.</p></div>
<div class="paragraph"><p>When <em>git mergetool</em> is invoked with this tool (either through the
<code>-t</code> or <code>--tool</code> option or the <code>merge.tool</code> configuration
variable) the configured command line will be invoked with <code>$BASE</code>
set to the name of a temporary file containing the common base for
the merge, if available; <code>$LOCAL</code> set to the name of a temporary
file containing the contents of the file on the current branch;
<code>$REMOTE</code> set to the name of a temporary file containing the
contents of the file to be merged, and <code>$MERGED</code> set to the name
of the file to which the merge tool should write the result of the
merge resolution.</p></div>
<div class="paragraph"><p>If the custom merge tool correctly indicates the success of a
merge resolution with its exit code, then the configuration
variable <code>mergetool.<tool>.trustExitCode</code> can be set to <code>true</code>.
Otherwise, <em>git mergetool</em> will prompt the user to indicate the
success of the resolution after the custom tool has exited.</p></div>
</dd>
<dt class="hdlist1">
--tool-help
</dt>
<dd>
<p>
Print a list of merge tools that may be used with <code>--tool</code>.
</p>
</dd>
<dt class="hdlist1">
-y
</dt>
<dt class="hdlist1">
--no-prompt
</dt>
<dd>
<p>
Don’t prompt before each invocation of the merge resolution
program.
This is the default if the merge resolution program is
explicitly specified with the <code>--tool</code> option or with the
<code>merge.tool</code> configuration variable.
</p>
</dd>
<dt class="hdlist1">
--prompt
</dt>
<dd>
<p>
Prompt before each invocation of the merge resolution program
to give the user a chance to skip the path.
</p>
</dd>
<dt class="hdlist1">
-g
</dt>
<dt class="hdlist1">
--gui
</dt>
<dd>
<p>
When <em>git-mergetool</em> is invoked with the <code>-g</code> or <code>--gui</code> option
the default merge tool will be read from the configured
<code>merge.guitool</code> variable instead of <code>merge.tool</code>. If
<code>merge.guitool</code> is not set, we will fallback to the tool
configured under <code>merge.tool</code>.
</p>
</dd>
<dt class="hdlist1">
--no-gui
</dt>
<dd>
<p>
This overrides a previous <code>-g</code> or <code>--gui</code> setting and reads the
default merge tool will be read from the configured <code>merge.tool</code>
variable.
</p>
</dd>
<dt class="hdlist1">
-O<orderfile>
</dt>
<dd>
<p>
Process files in the order specified in the
<orderfile>, which has one shell glob pattern per line.
This overrides the <code>diff.orderFile</code> configuration variable
(see <a href="git-config.html">git-config(1)</a>). To cancel <code>diff.orderFile</code>,
use <code>-O/dev/null</code>.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration">CONFIGURATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Everything below this line in this section is selectively included
from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
as what’s found there:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
mergetool.<tool>.path
</dt>
<dd>
<p>
Override the path for the given tool. This is useful in case
your tool is not in the PATH.
</p>
</dd>
<dt class="hdlist1">
mergetool.<tool>.cmd
</dt>
<dd>
<p>
Specify the command to invoke the specified merge tool. The
specified command is evaluated in shell with the following
variables available: <em>BASE</em> is the name of a temporary file
containing the common base of the files to be merged, if available;
<em>LOCAL</em> is the name of a temporary file containing the contents of
the file on the current branch; <em>REMOTE</em> is the name of a temporary
file containing the contents of the file from the branch being
merged; <em>MERGED</em> contains the name of the file to which the merge
tool should write the results of a successful merge.
</p>
</dd>
<dt class="hdlist1">
mergetool.<tool>.hideResolved
</dt>
<dd>
<p>
Allows the user to override the global <code>mergetool.hideResolved</code> value
for a specific tool. See <code>mergetool.hideResolved</code> for the full
description.
</p>
</dd>
<dt class="hdlist1">
mergetool.<tool>.trustExitCode
</dt>
<dd>
<p>
For a custom merge command, specify whether the exit code of
the merge command can be used to determine whether the merge was
successful. If this is not set to true then the merge target file
timestamp is checked and the merge assumed to have been successful
if the file has been updated, otherwise the user is prompted to
indicate the success of the merge.
</p>
</dd>
<dt class="hdlist1">
mergetool.meld.hasOutput
</dt>
<dd>
<p>
Older versions of <code>meld</code> do not support the <code>--output</code> option.
Git will attempt to detect whether <code>meld</code> supports <code>--output</code>
by inspecting the output of <code>meld --help</code>. Configuring
<code>mergetool.meld.hasOutput</code> will make Git skip these checks and
use the configured value instead. Setting <code>mergetool.meld.hasOutput</code>
to <code>true</code> tells Git to unconditionally use the <code>--output</code> option,
and <code>false</code> avoids using <code>--output</code>.
</p>
</dd>
<dt class="hdlist1">
mergetool.meld.useAutoMerge
</dt>
<dd>
<p>
When the <code>--auto-merge</code> is given, meld will merge all non-conflicting
parts automatically, highlight the conflicting parts and wait for
user decision. Setting <code>mergetool.meld.useAutoMerge</code> to <code>true</code> tells
Git to unconditionally use the <code>--auto-merge</code> option with <code>meld</code>.
Setting this value to <code>auto</code> makes git detect whether <code>--auto-merge</code>
is supported and will only use <code>--auto-merge</code> when available. A
value of <code>false</code> avoids using <code>--auto-merge</code> altogether, and is the
default value.
</p>
</dd>
<dt class="hdlist1">
mergetool.vimdiff.layout
</dt>
<dd>
<p>
The vimdiff backend uses this variable to control how its split
windows look like. Applies even if you are using Neovim (<code>nvim</code>) or
gVim (<code>gvim</code>) as the merge tool. See BACKEND SPECIFIC HINTS section
for details.
</p>
</dd>
<dt class="hdlist1">
mergetool.hideResolved
</dt>
<dd>
<p>
During a merge Git will automatically resolve as many conflicts as
possible and write the <em>MERGED</em> file containing conflict markers around
any conflicts that it cannot resolve; <em>LOCAL</em> and <em>REMOTE</em> normally
represent the versions of the file from before Git’s conflict
resolution. This flag causes <em>LOCAL</em> and <em>REMOTE</em> to be overwritten so
that only the unresolved conflicts are presented to the merge tool. Can
be configured per-tool via the <code>mergetool.<tool>.hideResolved</code>
configuration variable. Defaults to <code>false</code>.
</p>
</dd>
<dt class="hdlist1">
mergetool.keepBackup
</dt>
<dd>
<p>
After performing a merge, the original file with conflict markers
can be saved as a file with a <code>.orig</code> extension. If this variable
is set to <code>false</code> then this file is not preserved. Defaults to
<code>true</code> (i.e. keep the backup files).
</p>
</dd>
<dt class="hdlist1">
mergetool.keepTemporaries
</dt>
<dd>
<p>
When invoking a custom merge tool, Git uses a set of temporary
files to pass to the tool. If the tool returns an error and this
variable is set to <code>true</code>, then these temporary files will be
preserved, otherwise they will be removed after the tool has
exited. Defaults to <code>false</code>.
</p>
</dd>
<dt class="hdlist1">
mergetool.writeToTemp
</dt>
<dd>
<p>
Git writes temporary <em>BASE</em>, <em>LOCAL</em>, and <em>REMOTE</em> versions of
conflicting files in the worktree by default. Git will attempt
to use a temporary directory for these files when set <code>true</code>.
Defaults to <code>false</code>.
</p>
</dd>
<dt class="hdlist1">
mergetool.prompt
</dt>
<dd>
<p>
Prompt before each invocation of the merge resolution program.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_temporary_files">TEMPORARY FILES</h2>
<div class="sectionbody">
<div class="paragraph"><p><code>git mergetool</code> creates <code>*.orig</code> backup files while resolving merges.
These are safe to remove once a file has been merged and its
<code>git mergetool</code> session has completed.</p></div>
<div class="paragraph"><p>Setting the <code>mergetool.keepBackup</code> configuration variable to <code>false</code>
causes <code>git mergetool</code> to automatically remove the backup as files
are successfully merged.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_backend_specific_hints">BACKEND SPECIFIC HINTS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_vimdiff">vimdiff</h3>
<div class="sect3">
<h4 id="_description_2">Description</h4>
<div class="paragraph"><p>When specifying <code>--tool=vimdiff</code> in <code>git mergetool</code> Git will open Vim with a 4
windows layout distributed in the following way:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| | | |
| LOCAL | BASE | REMOTE |
| | | |
------------------------------------------
| |
| MERGED |
| |
------------------------------------------</code></pre>
</div></div>
<div class="paragraph"><p><code>LOCAL</code>, <code>BASE</code> and <code>REMOTE</code> are read-only buffers showing the contents of the
conflicting file in specific commits ("commit you are merging into", "common
ancestor commit" and "commit you are merging from" respectively)</p></div>
<div class="paragraph"><p><code>MERGED</code> is a writable buffer where you have to resolve the conflicts (using the
other read-only buffers as a reference). Once you are done, save and exit Vim as
usual (<code>:wq</code>) or, if you want to abort, exit using <code>:cq</code>.</p></div>
</div>
<div class="sect3">
<h4 id="_layout_configuration">Layout configuration</h4>
<div class="paragraph"><p>You can change the windows layout used by Vim by setting configuration variable
<code>mergetool.vimdiff.layout</code> which accepts a string where the following separators
have special meaning:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>+</code> is used to "open a new tab"
</p>
</li>
<li>
<p>
<code>,</code> is used to "open a new vertical split"
</p>
</li>
<li>
<p>
<code>/</code> is used to "open a new horizontal split"
</p>
</li>
<li>
<p>
<code>@</code> is used to indicate which is the file containing the final version after
solving the conflicts. If not present, <code>MERGED</code> will be used by default.
</p>
</li>
</ul></div>
<div class="paragraph"><p>The precedence of the operators is this one (you can use parentheses to change
it):</p></div>
<div class="literalblock">
<div class="content">
<pre><code>`@` > `+` > `/` > `,`</code></pre>
</div></div>
<div class="paragraph"><p>Let’s see some examples to understand how it works:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>layout = "(LOCAL,BASE,REMOTE)/MERGED"</code>
</p>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>This is exactly the same as the default layout we have already seen.</p></div>
<div class="paragraph"><p>Note that <code>/</code> has precedence over <code>,</code> and thus the parenthesis are not
needed in this case. The next layout definition is equivalent:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>layout = "LOCAL,BASE,REMOTE / MERGED"</code></pre>
</div></div>
</div></div>
</li>
<li>
<p>
<code>layout = "LOCAL,MERGED,REMOTE"</code>
</p>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>If, for some reason, we are not interested in the <code>BASE</code> buffer.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| | | |
| | | |
| LOCAL | MERGED | REMOTE |
| | | |
| | | |
------------------------------------------</code></pre>
</div></div>
</div></div>
</li>
<li>
<p>
<code>layout = "MERGED"</code>
</p>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>Only the <code>MERGED</code> buffer will be shown. Note, however, that all the other
ones are still loaded in vim, and you can access them with the "buffers"
command.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| |
| |
| MERGED |
| |
| |
------------------------------------------</code></pre>
</div></div>
</div></div>
</li>
<li>
<p>
<code>layout = "@LOCAL,REMOTE"</code>
</p>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>When <code>MERGED</code> is not present in the layout, you must "mark" one of the
buffers with an asterisk. That will become the buffer you need to edit and
save after resolving the conflicts.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| | |
| | |
| | |
| LOCAL | REMOTE |
| | |
| | |
| | |
------------------------------------------</code></pre>
</div></div>
</div></div>
</li>
<li>
<p>
<code>layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE"</code>
</p>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>Three tabs will open: the first one is a copy of the default layout, while
the other two only show the differences between (<code>BASE</code> and <code>LOCAL</code>) and
(<code>BASE</code> and <code>REMOTE</code>) respectively.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| <TAB #1> | TAB #2 | TAB #3 | |
------------------------------------------
| | | |
| LOCAL | BASE | REMOTE |
| | | |
------------------------------------------
| |
| MERGED |
| |
------------------------------------------</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| TAB #1 | <TAB #2> | TAB #3 | |
------------------------------------------
| | |
| | |
| | |
| BASE | LOCAL |
| | |
| | |
| | |
------------------------------------------</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>------------------------------------------
| TAB #1 | TAB #2 | <TAB #3> | |
------------------------------------------
| | |
| | |
| | |
| BASE | REMOTE |
| | |
| | |
| | |
------------------------------------------</code></pre>
</div></div>
</div></div>
</li>
<li>
<p>
<code>layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE + (LOCAL/BASE/REMOTE),MERGED"</code>
</p>
<div class="openblock">
<div class="content">
<div class="paragraph"><p>Same as the previous example, but adds a fourth tab with the same
information as the first tab, with a different layout.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>---------------------------------------------
| TAB #1 | TAB #2 | TAB #3 | <TAB #4> |
---------------------------------------------
| LOCAL | |
|---------------------| |
| BASE | MERGED |
|---------------------| |
| REMOTE | |
---------------------------------------------</code></pre>
</div></div>
<div class="paragraph"><p>Note how in the third tab definition we need to use parenthesis to make <code>,</code>
have precedence over <code>/</code>.</p></div>
</div></div>
</li>
</ul></div>
</div>
<div class="sect3">
<h4 id="_variants">Variants</h4>
<div class="paragraph"><p>Instead of <code>--tool=vimdiff</code>, you can also use one of these other variants:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>--tool=gvimdiff</code>, to open gVim instead of Vim.
</p>
</li>
<li>
<p>
<code>--tool=nvimdiff</code>, to open Neovim instead of Vim.
</p>
</li>
</ul></div>
<div class="paragraph"><p>When using these variants, in order to specify a custom layout you will have to
set configuration variables <code>mergetool.gvimdiff.layout</code> and
<code>mergetool.nvimdiff.layout</code> instead of <code>mergetool.vimdiff.layout</code></p></div>
<div class="paragraph"><p>In addition, for backwards compatibility with previous Git versions, you can
also append <code>1</code>, <code>2</code> or <code>3</code> to either <code>vimdiff</code> or any of the variants (ex:
<code>vimdiff3</code>, <code>nvimdiff1</code>, etc…) to use a predefined layout.
In other words, using <code>--tool=[g,n,]vimdiffx</code> is the same as using
<code>--tool=[g,n,]vimdiff</code> and setting configuration variable
<code>mergetool.[g,n,]vimdiff.layout</code> to…</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>x=1</code>: <code>"@LOCAL, REMOTE"</code>
</p>
</li>
<li>
<p>
<code>x=2</code>: <code>"LOCAL, MERGED, REMOTE"</code>
</p>
</li>
<li>
<p>
<code>x=3</code>: <code>"MERGED"</code>
</p>
</li>
</ul></div>
<div class="paragraph"><p>Example: using <code>--tool=gvimdiff2</code> will open <code>gvim</code> with three columns (LOCAL,
MERGED and REMOTE).</p></div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2023-02-07 22:43:37 UTC
</div>
</div>
</body>
</html>
@KyuuKazami