summaryrefslogtreecommitdiff
path: root/Documentation/git-difftool.txt
blob: a5bce6278b6570e9feb94cfbe0f67f3814a36aa5 (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
106
107
108
109
110
111
112
113
114
git-difftool(1)
===============
 
NAME
----
git-difftool - Show changes using common diff tools
 
SYNOPSIS
--------
'git difftool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<'git diff' options>]
 
DESCRIPTION
-----------
'git-difftool' is a git command that allows you to compare and edit files
between revisions using common diff tools.  'git difftool' is a frontend
to 'git-diff' and accepts the same options and arguments.
 
OPTIONS
-------
-y::
--no-prompt::
	Do not prompt before launching a diff tool.
 
--prompt::
	Prompt before each invocation of the diff tool.
	This is the default behaviour; the option is provided to
	override any configuration settings.
 
-t <tool>::
--tool=<tool>::
	Use the diff tool specified by <tool>.
	Valid merge tools are:
	kdiff3, kompare, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff,
	ecmerge, diffuse, opendiff, p4merge and araxis.
+
If a diff tool is not specified, 'git-difftool'
will use the configuration variable `diff.tool`.  If the
configuration variable `diff.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 `difftool.<tool>.path`. For example, you
can configure the absolute path to kdiff3 by setting
`difftool.kdiff3.path`. Otherwise, 'git-difftool' assumes the
tool is available in PATH.
+
Instead of running one of the known diff tools,
'git-difftool' can be customized to run an alternative program
by specifying the command line to invoke in a configuration
variable `difftool.<tool>.cmd`.
+
When 'git-difftool' is invoked with this tool (either through the
`-t` or `--tool` option or the `diff.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`.
 
-g::
--gui::
	When 'git-difftool' is invoked with the `-g` or `--gui` option
	the default diff tool will be read from the configured
	`diff.guitool` variable instead of `diff.tool`.
 
See linkgit:git-diff[1] for the full list of supported options.
 
CONFIG VARIABLES
----------------
'git-difftool' falls back to 'git-mergetool' config variables when the
difftool equivalents have not been defined.
 
diff.tool::
	The default diff tool to use.
 
diff.guitool::
	The default diff tool to use when `--gui` is specified.
 
difftool.<tool>.path::
	Override the path for the given tool.  This is useful in case
	your tool is not in the PATH.
 
difftool.<tool>.cmd::
	Specify the command to invoke the specified diff tool.
+
See the `--tool=<tool>` option above for more details.
 
difftool.prompt::
	Prompt before each invocation of the diff tool.
 
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