Code

merge: use editor by default in interactive sessions
[git.git] / Documentation / git-mergetool.txt
1 git-mergetool(1)
2 ================
4 NAME
5 ----
6 git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
8 SYNOPSIS
9 --------
10 [verse]
11 'git mergetool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<file>...]
13 DESCRIPTION
14 -----------
16 Use `git mergetool` to run one of several merge utilities to resolve
17 merge conflicts.  It is typically run after 'git merge'.
19 If one or more <file> parameters are given, the merge tool program will
20 be run to resolve differences on each file (skipping those without
21 conflicts).  Specifying a directory will include all unresolved files in
22 that path.  If no <file> names are specified, 'git mergetool' will run
23 the merge tool program on every file with merge conflicts.
25 OPTIONS
26 -------
27 -t <tool>::
28 --tool=<tool>::
29         Use the merge resolution program specified by <tool>.
30         Valid merge tools are:
31         araxis, bc3, diffuse, ecmerge, emerge, gvimdiff, kdiff3,
32         meld, opendiff, p4merge, tkdiff, tortoisemerge, vimdiff and xxdiff.
33 +
34 If a merge resolution program is not specified, 'git mergetool'
35 will use the configuration variable `merge.tool`.  If the
36 configuration variable `merge.tool` is not set, 'git mergetool'
37 will pick a suitable default.
38 +
39 You can explicitly provide a full path to the tool by setting the
40 configuration variable `mergetool.<tool>.path`. For example, you
41 can configure the absolute path to kdiff3 by setting
42 `mergetool.kdiff3.path`. Otherwise, 'git mergetool' assumes the
43 tool is available in PATH.
44 +
45 Instead of running one of the known merge tool programs,
46 'git mergetool' can be customized to run an alternative program
47 by specifying the command line to invoke in a configuration
48 variable `mergetool.<tool>.cmd`.
49 +
50 When 'git mergetool' is invoked with this tool (either through the
51 `-t` or `--tool` option or the `merge.tool` configuration
52 variable) the configured command line will be invoked with `$BASE`
53 set to the name of a temporary file containing the common base for
54 the merge, if available; `$LOCAL` set to the name of a temporary
55 file containing the contents of the file on the current branch;
56 `$REMOTE` set to the name of a temporary file containing the
57 contents of the file to be merged, and `$MERGED` set to the name
58 of the file to which the merge tool should write the result of the
59 merge resolution.
60 +
61 If the custom merge tool correctly indicates the success of a
62 merge resolution with its exit code, then the configuration
63 variable `mergetool.<tool>.trustExitCode` can be set to `true`.
64 Otherwise, 'git mergetool' will prompt the user to indicate the
65 success of the resolution after the custom tool has exited.
67 -y::
68 --no-prompt::
69         Don't prompt before each invocation of the merge resolution
70         program.
72 --prompt::
73         Prompt before each invocation of the merge resolution program.
74         This is the default behaviour; the option is provided to
75         override any configuration settings.
77 TEMPORARY FILES
78 ---------------
79 `git mergetool` creates `*.orig` backup files while resolving merges.
80 These are safe to remove once a file has been merged and its
81 `git mergetool` session has completed.
83 Setting the `mergetool.keepBackup` configuration variable to `false`
84 causes `git mergetool` to automatically remove the backup as files
85 are successfully merged.
87 GIT
88 ---
89 Part of the linkgit:git[1] suite