Documentation/git-difftool.txt

   1 git-difftool(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-difftool - Show changes using common diff tools
   7
   8 SYNOPSIS
   9 --------
  10 'git difftool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<'git diff' options>]
  11
  12 DESCRIPTION
  13 -----------
  14 'git-difftool' is a git command that allows you to compare and edit files
  15 between revisions using common diff tools.  'git difftool' is a frontend
  16 to 'git-diff' and accepts the same options and arguments.
  17
  18 OPTIONS
  19 -------
  20 -y::
  21 --no-prompt::
  22         Do not prompt before launching a diff tool.
  23
  24 --prompt::
  25         Prompt before each invocation of the diff tool.
  26         This is the default behaviour; the option is provided to
  27         override any configuration settings.
  28
  29 -t <tool>::
  30 --tool=<tool>::
  31         Use the diff tool specified by <tool>.
  32         Valid merge tools are:
  33         kdiff3, kompare, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff,
  34         ecmerge, diffuse, opendiff, p4merge and araxis.
  35 +
  36 If a diff tool is not specified, 'git-difftool'
  37 will use the configuration variable `diff.tool`.  If the
  38 configuration variable `diff.tool` is not set, 'git-difftool'
  39 will pick a suitable default.
  40 +
  41 You can explicitly provide a full path to the tool by setting the
  42 configuration variable `difftool.<tool>.path`. For example, you
  43 can configure the absolute path to kdiff3 by setting
  44 `difftool.kdiff3.path`. Otherwise, 'git-difftool' assumes the
  45 tool is available in PATH.
  46 +
  47 Instead of running one of the known diff tools,
  48 'git-difftool' can be customized to run an alternative program
  49 by specifying the command line to invoke in a configuration
  50 variable `difftool.<tool>.cmd`.
  51 +
  52 When 'git-difftool' is invoked with this tool (either through the
  53 `-t` or `--tool` option or the `diff.tool` configuration variable)
  54 the configured command line will be invoked with the following
  55 variables available: `$LOCAL` is set to the name of the temporary
  56 file containing the contents of the diff pre-image and `$REMOTE`
  57 is set to the name of the temporary file containing the contents
  58 of the diff post-image.  `$BASE` is provided for compatibility
  59 with custom merge tool commands and has the same value as `$LOCAL`.
  60
  61 --extcmd=<command>::
  62         Specify a custom command for viewing diffs.
  63         'git-difftool' ignores the configured defaults and runs
  64         `$command $LOCAL $REMOTE` when this option is specified.
  65
  66 -g::
  67 --gui::
  68         When 'git-difftool' is invoked with the `-g` or `--gui` option
  69         the default diff tool will be read from the configured
  70         `diff.guitool` variable instead of `diff.tool`.
  71
  72 See linkgit:git-diff[1] for the full list of supported options.
  73
  74 CONFIG VARIABLES
  75 ----------------
  76 'git-difftool' falls back to 'git-mergetool' config variables when the
  77 difftool equivalents have not been defined.
  78
  79 diff.tool::
  80         The default diff tool to use.
  81
  82 diff.guitool::
  83         The default diff tool to use when `--gui` is specified.
  84
  85 difftool.<tool>.path::
  86         Override the path for the given tool.  This is useful in case
  87         your tool is not in the PATH.
  88
  89 difftool.<tool>.cmd::
  90         Specify the command to invoke the specified diff tool.
  91 +
  92 See the `--tool=<tool>` option above for more details.
  93
  94 difftool.prompt::
  95         Prompt before each invocation of the diff tool.
  96
  97 SEE ALSO
  98 --------
  99 linkgit:git-diff[1]::
 100          Show changes between commits, commit and working tree, etc
 101
 102 linkgit:git-mergetool[1]::
 103         Run merge conflict resolution tools to resolve merge conflicts
 104
 105 linkgit:git-config[1]::
 106          Get and set repository or global options
 107
 108
 109 AUTHOR
 110 ------
 111 Written by David Aguilar <davvid@gmail.com>.
 112
 113 Documentation
 114 --------------
 115 Documentation by David Aguilar and the git-list <git@vger.kernel.org>.
 116
 117 GIT
 118 ---
 119 Part of the linkgit:git[1] suite