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