| blob | 3b4f5036d1bd3d4d1958868a700f634862888286 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE appendix SYSTEM "../../dtd/dblite.dtd">\r
3 <appendix id="tgit-automation">\r
4 <title>Automating TortoiseGit</title>\r
5 <simplesect>\r
6 <para>\r
7 Since all commands for TortoiseGit are controlled through command\r
8 line parameters, you can automate it with batch scripts or start specific\r
9 commands and dialogs from other programs (e.g. your favourite text editor).\r
10 </para>\r
11 <important>\r
12 <para>\r
13 Remember that TortoiseGit is a GUI client, and this automation guide\r
14 shows you how to make the TortoiseGit dialogs appear to collect user\r
15 input. If you want to write a script which requires no input, you should\r
16 use the official Git command line client instead.\r
17 </para>\r
18 </important>\r
19 </simplesect>\r
20 <!-- ================================================================= -->\r
21 <!-- ======================== SECTION 1 ============================== -->\r
22 <!-- ================================================================= -->\r
23 <sect1 id="tgit-automation-basics">\r
24 <title>TortoiseGit Commands</title>\r
25 <indexterm>\r
26 <primary>automation</primary>\r
27 </indexterm>\r
28 <indexterm>\r
29 <primary>command line</primary>\r
30 </indexterm>\r
31 <para>\r
32 The TortoiseGit GUI program is called <literal>TortoiseGitProc.exe</literal>.\r
33 All commands are specified with the parameter <option>/command:abcd</option>\r
34 where <literal>abcd</literal> is the required command name. Most of these\r
35 commands need at least one path argument, which is given with \r
36 <option>/path:"some\path"</option>. In the following table the command \r
37 refers to the <option>/command:abcd</option> parameter and the path\r
38 refers to the <option>/path:"some\path"</option> parameter.\r
39 </para>\r
40 <para>\r
41 Since some of the commands can take a list of target paths (e.g. committing\r
42 several specific files) the <option>/path</option> parameter can take\r
43 several paths, separated by a <literal>*</literal> character.\r
44 </para>\r
45 <para>\r
46 TortoiseGit uses temporary files to pass multiple arguments between\r
47 the shell extension and the main program. From TortoiseGit 1.5.0 on and later,\r
48 <option>/notempfile</option> parameter is obsolete and there is no need\r
49 to add it anymore.\r
50 </para>\r
51 <para>\r
52 The progress dialog which is used for commits, updates and many more git.exe commands\r
53 usually stays open after the command has finished until the user presses\r
54 the <guibutton>OK</guibutton> button. This can be changed in the settings dialog.\r
55 You may use <option>/closeonend</option> parameter to override the this setting\r
56 from your batch file.\r
57 </para>\r
58 <para>\r
59 To specify a different location of the configuration file, use the parameter\r
60 <option>/configdir:"path\to\config\directory"</option>.\r
61 This will override the default path, including any registry setting.\r
62 </para>\r
63 <!--\r
64 <para>\r
65 To close the progress dialog at the end of a command automatically without\r
66 using the permanent setting you can pass the <option>/closeonend</option>\r
67 parameter.\r
68 <itemizedlist>\r
69 <listitem>\r
70 <para>\r
71 <option>/closeonend:0</option> don't close the dialog automatically\r
72 </para>\r
73 </listitem>\r
74 <listitem>\r
75 <para>\r
76 <option>/closeonend:1</option> auto close if no errors\r
77 </para>\r
78 </listitem>\r
79 <listitem>\r
80 <para>\r
81 <option>/closeonend:2</option> auto close if no errors and conflicts\r
82 </para>\r
83 </listitem>\r
84 <listitem>\r
85 <para>\r
86 <option>/closeonend:3</option> auto close if no errors, conflicts and merges\r
87 </para>\r
88 </listitem>\r
89 <listitem>\r
90 <para>\r
91 <option>/closeonend:4</option> auto close if no errors, conflicts and merges\r
92 for local operations\r
93 </para>\r
94 </listitem>\r
95 </itemizedlist>\r
96 </para>\r
97 -->\r
98 <para>\r
99 The table below lists all the commands which can be accessed\r
100 using the TortoiseGitProc.exe command line. As described above,\r
101 these should be used in the form <literal>/command:abcd</literal>.\r
102 In the table, the <literal>/command</literal> prefix is omitted\r
103 to save space.\r
104 </para>\r
105 <!--\r
106 ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION\r
107 Don't touch these lines:\r
108 <entry condition="pot">:about</entry>\r
109 \r
110 The condition="pot" prevents the strings from being extracted into\r
111 the .pot file, so nobody translates them.\r
112 The colons in front of the command have to stay there to prevent these strings\r
113 from being translated if the po file "by chance" contains a matching translation.\r
114 -->\r
115 <para>\r
116 <table id="tgit-automation-1-table">\r
117 <title>List of available commands and options</title>\r
118 <tgroup cols="2">\r
119 <colspec colnum="1" colwidth="2*"/>\r
120 <colspec colnum="2" colwidth="6*"/>\r
121 <thead>\r
122 <row>\r
123 <entry>Command</entry>\r
124 <entry>Description</entry>\r
125 </row>\r
126 </thead>\r
127 <tbody>\r
128 <row>\r
129 <entry condition="pot">:about</entry>\r
130 <entry>\r
131 Shows the about dialog. This is also shown if no\r
132 command is given.\r
133 </entry>\r
134 </row>\r
135 <row>\r
136 <entry condition="pot">:bisect</entry>\r
137 <entry>\r
138 Allows to control the bisect logic of TortoiseGit.\r
139 Use the <option>/start</option> parameter to start a bisect you can specify <option>/good:REF</option> and <option>/bad:REF</option> here).\r
140 When bisect is active, you can use <option>/good</option>, <option>/bad</option> and <option>/reset</option> to control the bisect process.\r
141 </entry>\r
142 </row>\r
143 <row>\r
144 <entry condition="pot">:fetch</entry>\r
145 <entry>\r
146 Opens the fetch dialog.\r
147 Use the <option>/remote</option> parameter to control the remote which should be pre-selected.\r
148 </entry>\r
149 </row>\r
150 <row>\r
151 <entry condition="pot">:log</entry>\r
152 <entry>\r
153 Opens the log dialog. The <option>/path</option> specifies the\r
154 file or folder for which the log should be shown.\r
155 Additional options can be set:\r
156 <option>/rev:"SHA1"</option> highlights and automatically scrolls to the specified revision,\r
157 <option>/endrev:"SHA1/branch"</option>, shows the log of the specified revision,\r
158 <option>/startrev:"SHA1/branch"</option> (only in combination with endrev), shows the log of the revision range startrev..endrev,\r
159 <option>/range:"gitrevision"</option>, shows the log of the entered gitrevision (e.g. "branch1...branch2"),\r
160 <option>/findstring:"filterstring"</option> fills in the filter text,\r
161 <option>/findtext</option> forces the filter to use text, not regex, or\r
162 <option>/findregex</option> forces the filter to use regex, not simple text search, and\r
163 <option>/findtype:X</option> with X being a number between 0 and 127. The numbers\r
164 are the sum of the following options:\r
165 <itemizedlist>\r
166 <listitem>\r
167 <para>\r
168 <option>/findtype:0</option> filter by everything\r
169 </para>\r
170 </listitem>\r
171 <listitem>\r
172 <para>\r
173 <option>/findtype:1</option> filter by messages\r
174 </para>\r
175 </listitem>\r
176 <listitem>\r
177 <para>\r
178 <option>/findtype:2</option> filter by path\r
179 </para>\r
180 </listitem>\r
181 <listitem>\r
182 <para>\r
183 <option>/findtype:4</option> filter by authors\r
184 </para>\r
185 </listitem>\r
186 <listitem>\r
187 <para>\r
188 <option>/findtype:8</option> filter by revisions\r
189 </para>\r
190 </listitem>\r
191 <listitem>\r
192 <para>\r
193 <option>/findtype:16</option> not used\r
194 </para>\r
195 </listitem>\r
196 <listitem>\r
197 <para>\r
198 <option>/findtype:32</option> filter by bug ID\r
199 </para>\r
200 </listitem>\r
201 <listitem>\r
202 <para>\r
203 <option>/findtype:64</option> filter by subject\r
204 </para>\r
205 </listitem>\r
206 </itemizedlist>\r
207 If <option>/outfile:path\to\file</option> is specified,\r
208 the selected revision is written to that file when\r
209 the log dialog is closed.\r
210 </entry>\r
211 </row>\r
212 <row>\r
213 <entry condition="pot">:clone</entry>\r
214 <entry>\r
215 Opens the clone dialog.\r
216 The <option>/url</option> specifies the URL to clone from.\r
217 The <option>/path</option> specifies the target directory\r
218 to clone to.\r
219 If <option>/exactpath</option> is not specfied, the \r
220 repository name (without trailing .git) will be appended to\r
221 target directory. This is the default behaviour.\r
222 If <option>/exactpath</option> is specfied, the \r
223 exact <option>/path</option> is considered the target directory,\r
224 without appending repository name to it.\r
225 </entry>\r
226 </row>\r
227 <!--\r
228 <row>\r
229 <entry condition="pot">:import</entry>\r
230 <entry>\r
231 Opens the import dialog. The <option>/path</option>\r
232 specifies the directory with the data to import.\r
233 </entry>\r
234 </row>\r
235 -->\r
236 <!--\r
237 <row>\r
238 <entry condition="pot">:update</entry>\r
239 <entry>\r
240 Updates the working tree in <option>/path</option> to\r
241 HEAD. If the option <option>/rev</option> is given\r
242 then a dialog is shown to ask the user to which\r
243 revision the update should go. To avoid the dialog\r
244 specify a revision number <option>/rev:1234</option>.\r
245 Other options are <option>/nonrecursive</option> and\r
246 <option>/ignoreexternals</option>.\r
247 </entry>\r
248 </row>\r
249 -->\r
250 <row>\r
251 <entry condition="pot">:commit</entry>\r
252 <entry>\r
253 Opens the commit dialog. The <option>/path</option> specifies the\r
254 target directory or the list of files to commit.\r
255 You can also specify the <option>/logmsg</option> switch\r
256 to pass a predefined log message to the commit dialog.\r
257 Or, if you don't want to pass the log message on the\r
258 command line, use <option>/logmsgfile:path</option>,\r
259 where <option>path</option>\r
260 points to a file containing the log message.\r
261 To pre-fill the bug ID box (in case you've set up\r
262 integration with bug trackers properly), you can use\r
263 the <option>/bugid:"the bug id here"</option> to\r
264 do that.\r
265 </entry>\r
266 </row>\r
267 <row>\r
268 <entry condition="pot">:add</entry>\r
269 <entry>\r
270 Adds the files in <option>/path</option> to\r
271 version control.\r
272 </entry>\r
273 </row>\r
274 <row>\r
275 <entry condition="pot">:revert</entry>\r
276 <entry>\r
277 Reverts local modifications of a working tree.\r
278 The <option>/path</option> tells which items\r
279 to revert.\r
280 </entry>\r
281 </row>\r
282 <row>\r
283 <entry condition="pot">:cleanup</entry>\r
284 <entry>\r
285 Cleans up interrupted or aborted operations and\r
286 unlocks the working tree in <option>/path</option>.\r
287 </entry>\r
288 </row>\r
289 <row>\r
290 <entry condition="pot">:resolve</entry>\r
291 <entry>\r
292 Marks a conflicted file specified in \r
293 <option>/path</option> as resolved. If \r
294 <option>/noquestion</option> is given, then resolving\r
295 is done without asking the user first if it really\r
296 should be done.\r
297 </entry>\r
298 </row>\r
299 <row>\r
300 <entry condition="pot">:repocreate</entry>\r
301 <entry>\r
302 Creates a repository in <option>/path</option>\r
303 </entry>\r
304 </row>\r
305 <row>\r
306 <entry condition="pot">:switch</entry>\r
307 <entry>\r
308 Opens the switch dialog. The <option>/path</option> specifies the\r
309 target directory.\r
310 </entry>\r
311 </row>\r
312 <row>\r
313 <entry condition="pot">:export</entry>\r
314 <entry>\r
315 Exports the working tree in <option>/path</option>\r
316 to another directory. If the <option>/path</option>\r
317 points to an unversioned directory, a dialog will ask\r
318 for an URL to export to the directory in <option>/path</option>.\r
319 </entry>\r
320 </row>\r
321 <row>\r
322 <entry condition="pot">:merge</entry>\r
323 <entry>\r
324 Opens the merge dialog. The <option>/path</option> specifies the\r
325 target directory.\r
326 <!--\r
327 For merging a revision range, the following options are available:\r
328 <option>/fromurl:URL</option>,\r
329 <option>/revrange:string</option>.\r
330 For merging two repository trees, the following options are available:\r
331 <option>/fromurl:URL</option>,\r
332 <option>/tourl:URL</option>,\r
333 <option>/fromrev:xxx</option> and \r
334 <option>/torev:xxx</option>.\r
335 These pre-fill the relevant fields in the merge dialog.\r
336 -->\r
337 </entry>\r
338 </row>\r
339 <!--\r
340 <row>\r
341 <entry condition="pot">:copy</entry>\r
342 <entry>\r
343 Brings up the branch/tag dialog.\r
344 The <option>/path</option>\r
345 is the working tree to branch/tag from.\r
346 And the <option>/url</option> is the\r
347 target URL.\r
348 You can also specify the <option>/logmsg</option> switch\r
349 to pass a predefined log message to the branch/tag dialog.\r
350 Or, if you don't want to pass the log message on the\r
351 command line, use <option>/logmsgfile:path</option>,\r
352 where <option>path</option>\r
353 points to a file containing the log message.\r
354 </entry>\r
355 </row>\r
356 -->\r
357 <row>\r
358 <entry condition="pot">:settings</entry>\r
359 <entry>\r
360 Opens the settings dialog.\r
361 </entry>\r
362 </row>\r
363 <row>\r
364 <entry condition="pot">:remove</entry>\r
365 <entry>\r
366 Removes the file(s) in <option>/path</option> from\r
367 version control.\r
368 </entry>\r
369 </row>\r
370 <row>\r
371 <entry condition="pot">:rename</entry>\r
372 <entry>\r
373 Renames the file in <option>/path</option>. The new\r
374 name for the file is asked with a dialog.\r
375 To avoid the question about renaming similar files\r
376 in one step, pass <option>/noquestion</option>.\r
377 </entry>\r
378 </row>\r
379 <row>\r
380 <entry condition="pot">:diff</entry>\r
381 <entry>\r
382 Starts the external diff program specified in the\r
383 TortoiseGit settings. The <option>/path</option>\r
384 specifies the first file.\r
385 If the option <option>/path2</option>\r
386 is set, then the diff program is started with those\r
387 two files. If <option>/path2</option> is omitted,\r
388 then the diff is done between the file in\r
389 <option>/path</option> and its BASE.\r
390 To explicitly set the revision use\r
391 <option>/startrev:xxx</option> and\r
392 <option>/endrev:xxx</option>.\r
393 Add <option>/unified</option> to get a unified diff.\r
394 <!--\r
395 If <option>/blame</option> is set and <option>/path2</option>\r
396 is not set, then the diff is done by first blaming \r
397 the files with the given revisions.\r
398 -->\r
399 </entry>\r
400 </row>\r
401 <row>\r
402 <entry condition="pot">:showcompare</entry>\r
403 <entry>\r
404 <para>\r
405 Depending on revisions to compare and the path, this\r
406 either shows a unified diff (if the option <option>unified</option> is set), \r
407 a dialog with a list of files that have changed (filtered by a possibly entered subpath) or if \r
408 the path point to a file starts the diff viewer for \r
409 those the file in the different revisions.\r
410 </para>\r
411 </entry>\r
412 </row>\r
413 <row>\r
414 <entry condition="pot">:conflicteditor</entry>\r
415 <entry>\r
416 Starts the conflict editor specified in the TortoiseGit\r
417 settings with the correct files for the conflicted\r
418 file in <option>/path</option>.\r
419 </entry>\r
420 </row>\r
421 <row>\r
422 <entry condition="pot">:help</entry>\r
423 <entry>\r
424 Opens the help file.\r
425 </entry>\r
426 </row>\r
427 <row>\r
428 <entry condition="pot">:repostatus</entry>\r
429 <entry>\r
430 Opens the check-for-modifications dialog. The <option>/path</option>\r
431 specifies the working tree directory.\r
432 </entry>\r
433 </row>\r
434 <row>\r
435 <entry condition="pot">:repobrowser</entry>\r
436 <entry>\r
437 Starts the repository browser dialog, pointing to\r
438 the working tree given in <option>/path</option>.\r
439 An additional option <option>/rev:xxx</option> can\r
440 be used to specify the revision which the repository\r
441 browser should show. If the <option>/rev:xxx</option>\r
442 is omitted, it defaults to HEAD.\r
443 </entry>\r
444 </row>\r
445 <row>\r
446 <entry condition="pot">:ignore</entry>\r
447 <entry>\r
448 Adds all targets in <option>/path</option> to the\r
449 ignore list, i.e. adds the <literal>svn:ignore</literal>\r
450 property to those files.\r
451 </entry>\r
452 </row>\r
453 <row>\r
454 <entry condition="pot">:blame</entry>\r
455 <entry>\r
456 <para>\r
457 Opens the blame dialog for the file specified \r
458 in <option>/path</option>.\r
459 </para>\r
460 <para>\r
461 If the option <option>/endrev</option> is set TortoiseGitBlame\r
462 ends at that revision.\r
463 </para>\r
464 <para>\r
465 If the option <option>/line:nnn</option> is set,\r
466 TortoiseGitBlame will open with the specified line\r
467 number showing.\r
468 </para>\r
469 </entry>\r
470 </row>\r
471 <row>\r
472 <entry condition="pot">:cat</entry>\r
473 <entry>\r
474 Saves a file from an URL or working tree path given\r
475 in <option>/path</option> to the location given in\r
476 <option>/savepath:path</option>. The revision is\r
477 given in <option>/revision:xxx</option>. This can\r
478 be used to get a file with a specific revision.\r
479 </entry>\r
480 </row>\r
481 <!--\r
482 <row>\r
483 <entry condition="pot">:createpatch</entry>\r
484 <entry>\r
485 Creates a patch file for the path given in\r
486 <option>/path</option>.\r
487 </entry>\r
488 </row>\r
489 -->\r
490 <row>\r
491 <entry condition="pot">:pull</entry>\r
492 <entry>\r
493 Pull change from remote repository\r
494 <option>/path</option>.\r
495 </entry>\r
496 </row>\r
497 <row>\r
498 <entry condition="pot">:push</entry>\r
499 <entry>\r
500 Push change to remote repository\r
501 <option>/path</option>.\r
502 </entry>\r
503 </row>\r
504 <row>\r
505 <entry condition="pot">:rebase</entry>\r
506 <entry>\r
507 Rebase commits to special commit.\r
508 <option>/path</option>.\r
509 </entry>\r
510 </row>\r
511 <row>\r
512 <entry condition="pot">:stashsave</entry>\r
513 <entry>\r
514 <option>/path</option>.\r
515 </entry>\r
516 </row>\r
517 <row>\r
518 <entry condition="pot">:stashapply</entry>\r
519 <entry>\r
520 <option>/path</option>.\r
521 </entry>\r
522 </row>\r
523 <row>\r
524 <entry condition="pot">:stashpop</entry>\r
525 <entry>\r
526 <option>/path</option>.\r
527 </entry>\r
528 </row>\r
529 <row>\r
530 <entry condition="pot">:subadd</entry>\r
531 <entry>\r
532 <option>/path</option>.\r
533 </entry>\r
534 </row>\r
535 <row>\r
536 <entry condition="pot">:subupdate</entry>\r
537 <entry>\r
538 <option>/path</option>.\r
539 </entry>\r
540 </row>\r
541 <row>\r
542 <entry condition="pot">:subsync</entry>\r
543 <entry>\r
544 <option>/path</option>.\r
545 </entry>\r
546 </row>\r
547 <row>\r
548 <entry condition="pot">:reflog</entry>\r
549 <entry>\r
550 <option>/path</option>.\r
551 </entry>\r
552 </row>\r
553 <row>\r
554 <entry condition="pot">:refbrowse</entry>\r
555 <entry>\r
556 <option>/path</option>.\r
557 </entry>\r
558 </row>\r
559 <row>\r
560 <entry condition="pot">:updatecheck</entry>\r
561 <entry>\r
562 <option>/visible</option>: Shows the dialog even if no newer TortoiseGit version is available.\r
563 <option>/force</option>: Shows file list for download even if the latest TortoiseGit has been installed.\r
564 </entry>\r
565 </row>\r
566 <row>\r
567 <entry condition="pot">:revisiongraph</entry>\r
568 <entry>\r
569 Shows the revision graph for the path given in\r
570 <option>/path</option>.\r
571 <para>\r
572 To create an image file of the revision graph for a specific path, but\r
573 without showing the graph window, pass <option>/output:path</option>\r
574 with the path to the output file. The output file must have\r
575 an extension that the revision graph can actually\r
576 export to. These are:\r
577 <literal>.svg</literal>,\r
578 <literal>.wmf</literal>,\r
579 <literal>.gv</literal>,\r
580 <literal>.png</literal>,\r
581 <literal>.jpg</literal>,\r
582 <literal>.bmp</literal> and\r
583 <literal>.gif</literal>.\r
584 </para>\r
585 </entry>\r
586 </row>\r
587 <row>\r
588 <entry condition="pot">:daemon</entry>\r
589 <entry>\r
590 Launch Git Daemon for the path given in\r
591 <option>/path</option>.\r
592 </entry>\r
593 </row>\r
594 \r
595 <!--\r
596 <row>\r
597 <entry condition="pot">:rebuildiconcache</entry>\r
598 <entry>\r
599 Rebuilds the windows icon cache. Only use this in\r
600 case the windows icons are corrupted. A side effect\r
601 of this (which can't be avoided) is that the icons\r
602 on the desktop get rearranged.\r
603 To suppress the message box, pass <option>/noquestion</option>.\r
604 </entry>\r
605 </row>\r
606 -->\r
607 </tbody>\r
608 </tgroup>\r
609 </table>\r
610 </para>\r
611 <para>\r
612 Examples (which should be entered on one line):\r
613 <screen>\r
614 TortoiseGitProc.exe /command:commit\r
615 /path:"c:\svn_wc\file1.txt*c:\svn_wc\file2.txt"\r
616 /logmsg:"test log message" /closeonend:0\r
617 \r
618 TortoiseGitProc.exe /command:update /path:"c:\svn_wc\" /closeonend:0\r
619 \r
620 TortoiseGitProc.exe /command:log /path:"c:\svn_wc\file1.txt"\r
621 /startrev:50 /endrev:60 /closeonend:0\r
622 </screen>\r
623 </para>\r
624 </sect1>\r
625 \r
626 <sect1 id="tgit-automation-idiff">\r
627 <title>TortoiseGitIDiff Commands</title>\r
628 <indexterm>\r
629 <primary>automation</primary>\r
630 </indexterm>\r
631 <indexterm>\r
632 <primary>command line</primary>\r
633 </indexterm>\r
634 <para>\r
635 The image diff tool has a few command line options which you\r
636 can use to control how the tool is started.\r
637 The program is called <literal>TortoiseGitIDiff.exe</literal>.\r
638 </para>\r
639 <para>\r
640 The table below lists all the options which can be passed\r
641 to the image diff tool on the command line.\r
642 </para>\r
643 <!--\r
644 ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION\r
645 Don't touch these lines:\r
646 <entry condition="pot">:about</entry>\r
647 \r
648 The condition="pot" prevents the strings from being extracted into\r
649 the .pot file, so nobody translates them.\r
650 The colons in front of the command have to stay there to prevent these strings\r
651 from being translated if the po file "by chance" contains a matching translation.\r
652 -->\r
653 <para>\r
654 <table id="tgit-automation-idiff-1-table">\r
655 <title>List of available options</title>\r
656 <tgroup cols="2">\r
657 <colspec colnum="1" colwidth="2*"/>\r
658 <colspec colnum="2" colwidth="6*"/>\r
659 <thead>\r
660 <row>\r
661 <entry>Option</entry>\r
662 <entry>Description</entry>\r
663 </row>\r
664 </thead>\r
665 <tbody>\r
666 <row>\r
667 <entry condition="pot">:left</entry>\r
668 <entry>\r
669 Path to the file shown on the left.\r
670 </entry>\r
671 </row>\r
672 <row>\r
673 <entry condition="pot">:lefttitle</entry>\r
674 <entry>\r
675 A title string. This string is used in the image view\r
676 title instead of the full path to the image file.\r
677 </entry>\r
678 </row>\r
679 <row>\r
680 <entry condition="pot">:right</entry>\r
681 <entry>\r
682 Path to the file shown on the right.\r
683 </entry>\r
684 </row>\r
685 <row>\r
686 <entry condition="pot">:righttitle</entry>\r
687 <entry>\r
688 A title string. This string is used in the image view\r
689 title instead of the full path to the image file.\r
690 </entry>\r
691 </row>\r
692 <row>\r
693 <entry condition="pot">:overlay</entry>\r
694 <entry>\r
695 If specified, the image diff tool switches\r
696 to the overlay mode (alpha blend).\r
697 </entry>\r
698 </row>\r
699 <row>\r
700 <entry condition="pot">:fit</entry>\r
701 <entry>\r
702 If specified, the image diff tool fits both\r
703 images together.\r
704 </entry>\r
705 </row>\r
706 <row>\r
707 <entry condition="pot">:showinfo</entry>\r
708 <entry>\r
709 Shows the image info box.\r
710 </entry>\r
711 </row>\r
712 </tbody>\r
713 </tgroup>\r
714 </table>\r
715 </para>\r
716 <para>\r
717 Example (which should be entered on one line):\r
718 <screen>\r
719 TortoiseGitIDiff.exe /left:"c:\images\img1.jpg" /lefttitle:"image 1"\r
720 /right:"c:\images\img2.jpg" /righttitle:"image 2"\r
721 /fit /overlay\r
722 </screen>\r
723 </para>\r
724 </sect1>\r
725 \r
726 </appendix>\r