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