man1/git-difftool.1

   1 '\" t
   2 .\"     Title: git-difftool
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-20
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.603.g94b60adee3
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-DIFFTOOL" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-difftool \- Show changes using common diff tools
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit difftool\fR [<options>] [<commit> [<commit>]] [\-\-] [<path>\&...\:]
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 \fIgit difftool\fR is a Git command that allows you to compare and edit files between revisions using common diff tools\&. \fIgit difftool\fR is a frontend to \fIgit diff\fR and accepts the same options and arguments\&. See \fBgit-diff\fR(1)\&.
  40 .SH "OPTIONS"
  41 .PP
  42 \-d, \-\-dir\-diff
  43 .RS 4
  44 Copy the modified files to a temporary location and perform a directory diff on them\&. This mode never prompts before launching the diff tool\&.
  45 .RE
  46 .PP
  47 \-y, \-\-no\-prompt
  48 .RS 4
  49 Do not prompt before launching a diff tool\&.
  50 .RE
  51 .PP
  52 \-\-prompt
  53 .RS 4
  54 Prompt before each invocation of the diff tool\&. This is the default behaviour; the option is provided to override any configuration settings\&.
  55 .RE
  56 .PP
  57 \-\-rotate\-to=<file>
  58 .RS 4
  59 Start showing the diff for the given path, the paths before it will move to the end and output\&.
  60 .RE
  61 .PP
  62 \-\-skip\-to=<file>
  63 .RS 4
  64 Start showing the diff for the given path, skipping all the paths before it\&.
  65 .RE
  66 .PP
  67 \-t <tool>, \-\-tool=<tool>
  68 .RS 4
  69 Use the diff tool specified by <tool>\&. Valid values include emerge, kompare, meld, and vimdiff\&. Run
  70 \fBgit difftool \-\-tool\-help\fR
  71 for the list of valid <tool> settings\&.
  72 .sp
  73 If a diff tool is not specified,
  74 \fIgit difftool\fR
  75 will use the configuration variable
  76 \fBdiff\&.tool\fR\&. If the configuration variable
  77 \fBdiff\&.tool\fR
  78 is not set,
  79 \fIgit difftool\fR
  80 will pick a suitable default\&.
  81 .sp
  82 You can explicitly provide a full path to the tool by setting the configuration variable
  83 \fBdifftool\&.<tool>\&.path\fR\&. For example, you can configure the absolute path to kdiff3 by setting
  84 \fBdifftool\&.kdiff3\&.path\fR\&. Otherwise,
  85 \fIgit difftool\fR
  86 assumes the tool is available in PATH\&.
  87 .sp
  88 Instead of running one of the known diff tools,
  89 \fIgit difftool\fR
  90 can be customized to run an alternative program by specifying the command line to invoke in a configuration variable
  91 \fBdifftool\&.<tool>\&.cmd\fR\&.
  92 .sp
  93 When
  94 \fIgit difftool\fR
  95 is invoked with this tool (either through the
  96 \fB\-t\fR
  97 or
  98 \fB\-\-tool\fR
  99 option or the
 100 \fBdiff\&.tool\fR
 101 configuration variable) the configured command line will be invoked with the following variables available:
 102 \fB$LOCAL\fR
 103 is set to the name of the temporary file containing the contents of the diff pre\-image and
 104 \fB$REMOTE\fR
 105 is set to the name of the temporary file containing the contents of the diff post\-image\&.
 106 \fB$MERGED\fR
 107 is the name of the file which is being compared\&.
 108 \fB$BASE\fR
 109 is provided for compatibility with custom merge tool commands and has the same value as
 110 \fB$MERGED\fR\&.
 111 .RE
 112 .PP
 113 \-\-tool\-help
 114 .RS 4
 115 Print a list of diff tools that may be used with
 116 \fB\-\-tool\fR\&.
 117 .RE
 118 .PP
 119 \-\-[no\-]symlinks
 120 .RS 4
 121 \fIgit difftool\fR\*(Aqs default behavior is to create symlinks to the working tree when run in
 122 \fB\-\-dir\-diff\fR
 123 mode and the right\-hand side of the comparison yields the same content as the file in the working tree\&.
 124 .sp
 125 Specifying
 126 \fB\-\-no\-symlinks\fR
 127 instructs
 128 \fIgit difftool\fR
 129 to create copies instead\&.
 130 \fB\-\-no\-symlinks\fR
 131 is the default on Windows\&.
 132 .RE
 133 .PP
 134 \-x <command>, \-\-extcmd=<command>
 135 .RS 4
 136 Specify a custom command for viewing diffs\&.
 137 \fIgit\-difftool\fR
 138 ignores the configured defaults and runs
 139 \fB<command> $LOCAL $REMOTE\fR
 140 when this option is specified\&. Additionally,
 141 \fB$BASE\fR
 142 is set in the environment\&.
 143 .RE
 144 .PP
 145 \-g, \-\-[no\-]gui
 146 .RS 4
 147 When
 148 \fIgit\-difftool\fR
 149 is invoked with the
 150 \fB\-g\fR
 151 or
 152 \fB\-\-gui\fR
 153 option the default diff tool will be read from the configured
 154 \fBdiff\&.guitool\fR
 155 variable instead of
 156 \fBdiff\&.tool\fR\&. This may be selected automatically using the configuration variable
 157 \fBdifftool\&.guiDefault\fR\&. The
 158 \fB\-\-no\-gui\fR
 159 option can be used to override these settings\&. If
 160 \fBdiff\&.guitool\fR
 161 is not set, we will fallback in the order of
 162 \fBmerge\&.guitool\fR,
 163 \fBdiff\&.tool\fR,
 164 \fBmerge\&.tool\fR
 165 until a tool is found\&.
 166 .RE
 167 .PP
 168 \-\-[no\-]trust\-exit\-code
 169 .RS 4
 170 Errors reported by the diff tool are ignored by default\&. Use
 171 \fB\-\-trust\-exit\-code\fR
 172 to make
 173 \fIgit\-difftool\fR
 174 exit when an invoked diff tool returns a non\-zero exit code\&.
 175 .sp
 176 \fIgit\-difftool\fR
 177 will forward the exit code of the invoked tool when
 178 \fB\-\-trust\-exit\-code\fR
 179 is used\&.
 180 .RE
 181 .sp
 182 See \fBgit-diff\fR(1) for the full list of supported options\&.
 183 .SH "CONFIGURATION"
 184 .sp
 185 \fIgit difftool\fR falls back to \fIgit mergetool\fR config variables when the difftool equivalents have not been defined\&.
 186 .sp
 187 Everything above this line in this section isn\(cqt included from the \fBgit-config\fR(1) documentation\&. The content that follows is the same as what\(cqs found there:
 188 .PP
 189 diff\&.tool
 190 .RS 4
 191 Controls which diff tool is used by
 192 \fBgit-difftool\fR(1)\&. This variable overrides the value configured in
 193 \fBmerge\&.tool\fR\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom diff tool and requires that a corresponding difftool\&.<tool>\&.cmd variable is defined\&.
 194 .RE
 195 .PP
 196 diff\&.guitool
 197 .RS 4
 198 Controls which diff tool is used by
 199 \fBgit-difftool\fR(1)
 200 when the \-g/\-\-gui flag is specified\&. This variable overrides the value configured in
 201 \fBmerge\&.guitool\fR\&. The list below shows the valid built\-in values\&. Any other value is treated as a custom diff tool and requires that a corresponding difftool\&.<guitool>\&.cmd variable is defined\&.
 202 .RE
 203 .PP
 204 difftool\&.<tool>\&.cmd
 205 .RS 4
 206 Specify the command to invoke the specified diff tool\&. The specified command is evaluated in shell with the following variables available:
 207 \fILOCAL\fR
 208 is set to the name of the temporary file containing the contents of the diff pre\-image and
 209 \fIREMOTE\fR
 210 is set to the name of the temporary file containing the contents of the diff post\-image\&.
 211 .sp
 212 See the
 213 \fB\-\-tool=<tool>\fR
 214 option in
 215 \fBgit-difftool\fR(1)
 216 for more details\&.
 217 .RE
 218 .PP
 219 difftool\&.<tool>\&.path
 220 .RS 4
 221 Override the path for the given tool\&. This is useful in case your tool is not in the PATH\&.
 222 .RE
 223 .PP
 224 difftool\&.trustExitCode
 225 .RS 4
 226 Exit difftool if the invoked diff tool returns a non\-zero exit status\&.
 227 .sp
 228 See the
 229 \fB\-\-trust\-exit\-code\fR
 230 option in
 231 \fBgit-difftool\fR(1)
 232 for more details\&.
 233 .RE
 234 .PP
 235 difftool\&.prompt
 236 .RS 4
 237 Prompt before each invocation of the diff tool\&.
 238 .RE
 239 .PP
 240 difftool\&.guiDefault
 241 .RS 4
 242 Set
 243 \fBtrue\fR
 244 to use the
 245 \fBdiff\&.guitool\fR
 246 by default (equivalent to specifying the
 247 \fB\-\-gui\fR
 248 argument), or
 249 \fBauto\fR
 250 to select
 251 \fBdiff\&.guitool\fR
 252 or
 253 \fBdiff\&.tool\fR
 254 depending on the presence of a
 255 \fBDISPLAY\fR
 256 environment variable value\&. The default is
 257 \fBfalse\fR, where the
 258 \fB\-\-gui\fR
 259 argument must be provided explicitly for the
 260 \fBdiff\&.guitool\fR
 261 to be used\&.
 262 .RE
 263 .SH "SEE ALSO"
 264 .PP
 265 \fBgit-diff\fR(1)
 266 .RS 4
 267 Show changes between commits, commit and working tree, etc
 268 .RE
 269 .PP
 270 \fBgit-mergetool\fR(1)
 271 .RS 4
 272 Run merge conflict resolution tools to resolve merge conflicts
 273 .RE
 274 .PP
 275 \fBgit-config\fR(1)
 276 .RS 4
 277 Get and set repository or global options
 278 .RE
 279 .SH "GIT"
 280 .sp
 281 Part of the \fBgit\fR(1) suite