]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-difftool.txt
Merge branch 'js/t3404-typofix' into maint
[thirdparty/git.git] / Documentation / git-difftool.txt
CommitLineData
5c38ea31
DA
1git-difftool(1)
2===============
3
4NAME
5----
8b733222 6git-difftool - Show changes using common diff tools
5c38ea31
DA
7
8SYNOPSIS
9--------
7791a1d9 10[verse]
9edb8a0f 11'git difftool' [<options>] [<commit> [<commit>]] [--] [<path>...]
5c38ea31
DA
12
13DESCRIPTION
14-----------
2de9b711 15'git difftool' is a Git command that allows you to compare and edit files
8b733222 16between revisions using common diff tools. 'git difftool' is a frontend
49bd56a5
JK
17to 'git diff' and accepts the same options and arguments. See
18linkgit:git-diff[1].
5c38ea31
DA
19
20OPTIONS
21-------
7e0abcec
TH
22-d::
23--dir-diff::
24 Copy the modified files to a temporary location and perform
25 a directory diff on them. This mode never prompts before
26 launching the diff tool.
27
8b733222
DA
28-y::
29--no-prompt::
30 Do not prompt before launching a diff tool.
31
a904392e
DA
32--prompt::
33 Prompt before each invocation of the diff tool.
34 This is the default behaviour; the option is provided to
35 override any configuration settings.
36
5c38ea31
DA
37-t <tool>::
38--tool=<tool>::
bf73fc21
TH
39 Use the diff tool specified by <tool>. Valid values include
40 emerge, kompare, meld, and vimdiff. Run `git difftool --tool-help`
41 for the list of valid <tool> settings.
5c38ea31 42+
0b444cdb 43If a diff tool is not specified, 'git difftool'
2464456a 44will use the configuration variable `diff.tool`. If the
0b444cdb 45configuration variable `diff.tool` is not set, 'git difftool'
5c38ea31
DA
46will pick a suitable default.
47+
48You can explicitly provide a full path to the tool by setting the
2464456a 49configuration variable `difftool.<tool>.path`. For example, you
5c38ea31 50can configure the absolute path to kdiff3 by setting
0b444cdb 51`difftool.kdiff3.path`. Otherwise, 'git difftool' assumes the
5c38ea31
DA
52tool is available in PATH.
53+
8b733222 54Instead of running one of the known diff tools,
0b444cdb 55'git difftool' can be customized to run an alternative program
5c38ea31 56by specifying the command line to invoke in a configuration
2464456a 57variable `difftool.<tool>.cmd`.
5c38ea31 58+
0b444cdb 59When 'git difftool' is invoked with this tool (either through the
2464456a 60`-t` or `--tool` option or the `diff.tool` configuration variable)
5c38ea31
DA
61the configured command line will be invoked with the following
62variables available: `$LOCAL` is set to the name of the temporary
63file containing the contents of the diff pre-image and `$REMOTE`
64is set to the name of the temporary file containing the contents
51baceee
MG
65of the diff post-image. `$MERGED` is the name of the file which is
66being compared. `$BASE` is provided for compatibility
67with custom merge tool commands and has the same value as `$MERGED`.
5c38ea31 68
7a30747f
DA
69--tool-help::
70 Print a list of diff tools that may be used with `--tool`.
71
0460ed2c 72--[no-]symlinks::
1f229345 73 'git difftool''s default behavior is create symlinks to the
02c56314
JK
74 working tree when run in `--dir-diff` mode and the right-hand
75 side of the comparison yields the same content as the file in
76 the working tree.
1f229345 77+
8aa10d4a
JK
78Specifying `--no-symlinks` instructs 'git difftool' to create copies
79instead. `--no-symlinks` is the default on Windows.
1f229345 80
f47f1e2c 81-x <command>::
1c6f5b52
DA
82--extcmd=<command>::
83 Specify a custom command for viewing diffs.
84 'git-difftool' ignores the configured defaults and runs
85 `$command $LOCAL $REMOTE` when this option is specified.
4a689afb 86 Additionally, `$BASE` is set in the environment.
1c6f5b52 87
4cefa495 88-g::
56c2da57 89--[no-]gui::
4cefa495
DA
90 When 'git-difftool' is invoked with the `-g` or `--gui` option
91 the default diff tool will be read from the configured
56c2da57 92 `diff.guitool` variable instead of `diff.tool`. The `--no-gui`
6c22d715
DL
93 option can be used to override this setting. If `diff.guitool`
94 is not set, we will fallback in the order of `merge.guitool`,
95 `diff.tool`, `merge.tool` until a tool is found.
4cefa495 96
2b52123f
DA
97--[no-]trust-exit-code::
98 'git-difftool' invokes a diff tool individually on each file.
99 Errors reported by the diff tool are ignored by default.
100 Use `--trust-exit-code` to make 'git-difftool' exit when an
101 invoked diff tool returns a non-zero exit code.
102+
103'git-difftool' will forward the exit code of the invoked tool when
bcf9626a 104`--trust-exit-code` is used.
2b52123f 105
8b733222 106See linkgit:git-diff[1] for the full list of supported options.
5c38ea31
DA
107
108CONFIG VARIABLES
109----------------
0b444cdb 110'git difftool' falls back to 'git mergetool' config variables when the
2464456a 111difftool equivalents have not been defined.
5c38ea31 112
2464456a 113diff.tool::
8b733222 114 The default diff tool to use.
5c38ea31 115
4cefa495
DA
116diff.guitool::
117 The default diff tool to use when `--gui` is specified.
118
2464456a 119difftool.<tool>.path::
5c38ea31
DA
120 Override the path for the given tool. This is useful in case
121 your tool is not in the PATH.
122
2464456a 123difftool.<tool>.cmd::
8b733222 124 Specify the command to invoke the specified diff tool.
5c38ea31
DA
125+
126See the `--tool=<tool>` option above for more details.
127
a904392e
DA
128difftool.prompt::
129 Prompt before each invocation of the diff tool.
130
2b52123f
DA
131difftool.trustExitCode::
132 Exit difftool if the invoked diff tool returns a non-zero exit status.
133+
134See the `--trust-exit-code` option above for more details.
135
5c38ea31
DA
136SEE ALSO
137--------
507cfcbd 138linkgit:git-diff[1]::
5c38ea31
DA
139 Show changes between commits, commit and working tree, etc
140
141linkgit:git-mergetool[1]::
142 Run merge conflict resolution tools to resolve merge conflicts
143
507cfcbd 144linkgit:git-config[1]::
5c38ea31
DA
145 Get and set repository or global options
146
5c38ea31
DA
147GIT
148---
149Part of the linkgit:git[1] suite