summaryrefslogtreecommitdiff
path: root/contrib/difftool/git-difftool.txt
blob: 6e2610cda6d2721eb4fb9ac063bb47ef80bfbae3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
git-difftool(1)
===============

NAME
----
git-difftool - compare changes using common merge tools

SYNOPSIS
--------
'git difftool' [--tool=<tool>] [--no-prompt] ['git diff' options]

DESCRIPTION
-----------
'git-difftool' is a git command that allows you to compare and edit files
between revisions using common merge tools.  At its most basic level,
'git-difftool' does what 'git-mergetool' does but its use is for non-merge
situations such as when preparing commits or comparing changes against
the index.

'git difftool' is a frontend to 'git diff' and accepts the same
arguments and options.

See linkgit:git-diff[1] for the full list of supported options.

OPTIONS
-------
-t <tool>::
--tool=<tool>::
	Use the merge resolution program specified by <tool>.
	Valid merge tools are:
	kdiff3, kompare, tkdiff, meld, xxdiff, emerge,
	vimdiff, gvimdiff, ecmerge, and opendiff
+
If a merge resolution program is not specified, 'git-difftool'
will use the configuration variable `merge.tool`.  If the
configuration variable `merge.tool` is not set, 'git difftool'
will pick a suitable default.
+
You can explicitly provide a full path to the tool by setting the
configuration variable `mergetool.<tool>.path`. For example, you
can configure the absolute path to kdiff3 by setting
`mergetool.kdiff3.path`. Otherwise, 'git-difftool' assumes the
tool is available in PATH.
+
Instead of running one of the known merge tool programs,
'git-difftool' can be customized to run an alternative program
by specifying the command line to invoke in a configuration
variable `mergetool.<tool>.cmd`.
+
When 'git-difftool' is invoked with this tool (either through the
`-t` or `--tool` option or the `merge.tool` configuration variable)
the configured command line will be invoked with the following
variables available: `$LOCAL` is set to the name of the temporary
file containing the contents of the diff pre-image and `$REMOTE`
is set to the name of the temporary file containing the contents
of the diff post-image.  `$BASE` is provided for compatibility
with custom merge tool commands and has the same value as `$LOCAL`.

--no-prompt::
	Do not prompt before launching a diff tool.

CONFIG VARIABLES
----------------
merge.tool::
	The default merge tool to use.
+
See the `--tool=<tool>` option above for more details.

merge.keepBackup::
	The original, unedited file content can be saved to a file with
	a `.orig` extension.  Defaults to `true` (i.e. keep the backup files).

mergetool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.

mergetool.<tool>.cmd::
	Specify the command to invoke the specified merge tool.
+
See the `--tool=<tool>` option above for more details.


SEE ALSO
--------
linkgit:git-diff[1]::
	 Show changes between commits, commit and working tree, etc

linkgit:git-mergetool[1]::
	Run merge conflict resolution tools to resolve merge conflicts

linkgit:git-config[1]::
	 Get and set repository or global options


AUTHOR
------
Written by David Aguilar <davvid@gmail.com>.

Documentation
--------------
Documentation by David Aguilar and the git-list <git@vger.kernel.org>.

GIT
---
Part of the linkgit:git[1] suite