LogDlg: Allow arbitrary gitrevision ranges from cli
[TortoiseGit.git] / doc / source / en / TortoiseGit / tsvn_app_automation.xml
blob50302ab386e597f9fcfd4073c5628ffc0e19c6a1
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE appendix SYSTEM "../../dtd/dblite.dtd">\r
3 <appendix id="tsvn-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="tsvn-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 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 by checking\r
55                         the corresponding option in the settings dialog. But using that setting\r
56                         will close the progress dialog, no matter if you start the command\r
57                         from your batch file or from the TortoiseGit context menu.\r
58                 </para>\r
59                 <para>\r
60                         To specify a different location of the configuration file, use the parameter\r
61                         <option>/configdir:"path\to\config\directory"</option>.\r
62                         This will override the default path, including any registry setting.\r
63                 </para>\r
64 <!--\r
65                 <para>\r
66                         To close the progress dialog at the end of a command automatically without\r
67                         using the permanent setting you can pass the <option>/closeonend</option>\r
68                         parameter.\r
69                         <itemizedlist>\r
70                                 <listitem>\r
71                                         <para>\r
72                                                 <option>/closeonend:0</option> don't close the dialog automatically\r
73                                         </para>\r
74                                 </listitem>\r
75                                 <listitem>\r
76                                         <para>\r
77                                                 <option>/closeonend:1</option> auto close if no errors\r
78                                         </para>\r
79                                 </listitem>\r
80                                 <listitem>\r
81                                         <para>\r
82                                                 <option>/closeonend:2</option> auto close if no errors and conflicts\r
83                                         </para>\r
84                                 </listitem>\r
85                                 <listitem>\r
86                                         <para>\r
87                                                 <option>/closeonend:3</option> auto close if no errors, conflicts and merges\r
88                                         </para>\r
89                                 </listitem>\r
90                                 <listitem>\r
91                                         <para>\r
92                                                 <option>/closeonend:4</option> auto close if no errors, conflicts and merges\r
93                                                 for local operations\r
94                                         </para>\r
95                                 </listitem>\r
96                         </itemizedlist>\r
97                 </para>\r
98 -->\r
99                 <para>\r
100                         The table below lists all the commands which can be accessed\r
101                         using the TortoiseGitProc.exe command line. As described above,\r
102                         these should be used in the form <literal>/command:abcd</literal>.\r
103                         In the table, the <literal>/command</literal> prefix is omitted\r
104                         to save space.\r
105                 </para>\r
106 <!--\r
107 ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION\r
108 Don't touch these lines:\r
109 <entry condition="pot">:about</entry>\r
111   The condition="pot" prevents the strings from being extracted into\r
112         the .pot file, so nobody translates them.\r
113   The colons in front of the command have to stay there to prevent these strings\r
114   from being translated if the po file "by chance" contains a matching translation.\r
115 -->\r
116                 <para>\r
117                         <table id="tsvn-automation-1-table">\r
118                                 <title>List of available commands and options</title>\r
119                                 <tgroup cols="2">\r
120                                         <colspec colnum="1" colwidth="2*"/>\r
121                                         <colspec colnum="2" colwidth="6*"/>\r
122                                         <thead>\r
123                                                 <row>\r
124                                                         <entry>Command</entry>\r
125                                                         <entry>Description</entry>\r
126                                                 </row>\r
127                                         </thead>\r
128                                         <tbody>\r
129                                                 <row>\r
130                                                         <entry condition="pot">:about</entry>\r
131                                                         <entry>\r
132                                                                 Shows the about dialog. This is also shown if no\r
133                                                                 command is given.\r
134                                                         </entry>\r
135                                                 </row>\r
136                                                 <row>\r
137                                                         <entry condition="pot">:bisect</entry>\r
138                                                         <entry>\r
139                                                                 Allows to control the bisect logic of TortoiseGit.\r
140                                                                 Use the <option>/start</option> parameter to start a bisect you can specify <option>/good:REF</option> and <option>/bad:REF</option> here).\r
141                                                                 When bisect is active, you can use <option>/good</option>, <option>/bad</option> and <option>/reset</option> to control the bisect process.\r
142                                                         </entry>\r
143                                                 </row>\r
144                                                 <row>\r
145                                                         <entry condition="pot">:fetch</entry>\r
146                                                         <entry>\r
147                                                                 Opens the fetch dialog.\r
148                                                                 Use the <option>/remote</option> parameter to control the remote which should be pre-selected.\r
149                                                         </entry>\r
150                                                 </row>\r
151                                                 <row>\r
152                                                         <entry condition="pot">:log</entry>\r
153                                                         <entry>\r
154                                                                 Opens the log dialog. The <option>/path</option> specifies the\r
155                                                                 file or folder for which the log should be shown.\r
156                                                                 Additional options can be set:\r
157                                                                 <option>/rev:"SHA1"</option> highlights and automatically scrolls to the specified revision,\r
158                                                                 <option>/endrev:"SHA1/branch"</option>, shows the log of the specified revision,\r
159                                                                 <option>/startrev:"SHA1/branch"</option> (only in combination with endrev), shows the log of the revision range startrev..endrev,\r
160                                                                 <option>/range:"gitrevision"</option>, shows the log of the entered gitrevision (e.g. "branch1...branch2"),\r
161                                                                 <option>/findstring:"filterstring"</option> fills in the filter text,\r
162                                                                 <option>/findtext</option> forces the filter to use text, not regex, or\r
163                                                                 <option>/findregex</option> forces the filter to use regex, not simple text search, and\r
164                                                                 <option>/findtype:X</option> with X being a number between 0 and 127. The numbers\r
165                                                                 are the sum of the following options:\r
166                                                                 <itemizedlist>\r
167                                                                         <listitem>\r
168                                                                                 <para>\r
169                                                                                         <option>/findtype:0</option> filter by everything\r
170                                                                                 </para>\r
171                                                                         </listitem>\r
172                                                                         <listitem>\r
173                                                                                 <para>\r
174                                                                                         <option>/findtype:1</option> filter by messages\r
175                                                                                 </para>\r
176                                                                         </listitem>\r
177                                                                         <listitem>\r
178                                                                                 <para>\r
179                                                                                         <option>/findtype:2</option> filter by path\r
180                                                                                 </para>\r
181                                                                         </listitem>\r
182                                                                         <listitem>\r
183                                                                                 <para>\r
184                                                                                         <option>/findtype:4</option> filter by authors\r
185                                                                                 </para>\r
186                                                                         </listitem>\r
187                                                                         <listitem>\r
188                                                                                 <para>\r
189                                                                                         <option>/findtype:8</option> filter by revisions\r
190                                                                                 </para>\r
191                                                                         </listitem>\r
192                                                                         <listitem>\r
193                                                                                 <para>\r
194                                                                                         <option>/findtype:16</option> not used\r
195                                                                                 </para>\r
196                                                                         </listitem>\r
197                                                                         <listitem>\r
198                                                                                 <para>\r
199                                                                                         <option>/findtype:32</option> filter by bug ID\r
200                                                                                 </para>\r
201                                                                         </listitem>\r
202                                                                         <listitem>\r
203                                                                                 <para>\r
204                                                                                         <option>/findtype:64</option> filter by subject\r
205                                                                                 </para>\r
206                                                                         </listitem>\r
207                                                                 </itemizedlist>\r
208                                                                 If <option>/outfile:path\to\file</option> is specified,\r
209                                                                 the selected revision is written to that file when\r
210                                                                 the log dialog is closed.\r
211                                                         </entry>\r
212                                                 </row>\r
213                                                 <row>\r
214                                                         <entry condition="pot">:clone</entry>\r
215                                                         <entry>\r
216                                                                 Opens the clone dialog.\r
217                                                         </entry>\r
218                                                 </row>\r
219                                                 <!--\r
220                                                 <row>\r
221                                                         <entry condition="pot">:import</entry>\r
222                                                         <entry>\r
223                                                                 Opens the import dialog. The <option>/path</option>\r
224                                                                 specifies the directory with the data to import.\r
225                                                         </entry>\r
226                                                 </row>\r
227                                                 -->\r
228                                                 <!--\r
229                                                 <row>\r
230                                                         <entry condition="pot">:update</entry>\r
231                                                         <entry>\r
232                                                                 Updates the working tree in <option>/path</option> to\r
233                                                                 HEAD. If the option <option>/rev</option> is given\r
234                                                                 then a dialog is shown to ask the user to which\r
235                                                                 revision the update should go. To avoid the dialog\r
236                                                                 specify a revision number <option>/rev:1234</option>.\r
237                                                                 Other options are <option>/nonrecursive</option> and\r
238                                                                 <option>/ignoreexternals</option>.\r
239                                                         </entry>\r
240                                                 </row>\r
241                                                 -->\r
242                                                 <row>\r
243                                                         <entry condition="pot">:commit</entry>\r
244                                                         <entry>\r
245                                                                 Opens the commit dialog. The <option>/path</option> specifies the\r
246                                                                 target directory or the list of files to commit.\r
247                                                                 You can also specify the <option>/logmsg</option> switch\r
248                                                                 to pass a predefined log message to the commit dialog.\r
249                                                                 Or, if you don't want to pass the log message on the\r
250                                                                 command line, use <option>/logmsgfile:path</option>,\r
251                                                                 where <option>path</option>\r
252                                                                 points to a file containing the log message.\r
253                                                                 To pre-fill the bug ID box (in case you've set up\r
254                                                                 integration with bug trackers properly), you can use\r
255                                                                 the <option>/bugid:"the bug id here"</option> to\r
256                                                                 do that.\r
257                                                         </entry>\r
258                                                 </row>\r
259                                                 <row>\r
260                                                         <entry condition="pot">:add</entry>\r
261                                                         <entry>\r
262                                                                 Adds the files in <option>/path</option> to\r
263                                                                 version control.\r
264                                                         </entry>\r
265                                                 </row>\r
266                                                 <row>\r
267                                                         <entry condition="pot">:revert</entry>\r
268                                                         <entry>\r
269                                                                 Reverts local modifications of a working tree.\r
270                                                                 The <option>/path</option> tells which items\r
271                                                                 to revert.\r
272                                                         </entry>\r
273                                                 </row>\r
274                                                 <row>\r
275                                                         <entry condition="pot">:cleanup</entry>\r
276                                                         <entry>\r
277                                                                 Cleans up interrupted or aborted operations and\r
278                                                                 unlocks the working tree in <option>/path</option>.\r
279                                                         </entry>\r
280                                                 </row>\r
281                                                 <row>\r
282                                                         <entry condition="pot">:resolve</entry>\r
283                                                         <entry>\r
284                                                                 Marks a conflicted file specified in \r
285                                                                 <option>/path</option> as resolved. If \r
286                                                                 <option>/noquestion</option> is given, then resolving\r
287                                                                 is done without asking the user first if it really\r
288                                                                 should be done.\r
289                                                         </entry>\r
290                                                 </row>\r
291                                                 <row>\r
292                                                         <entry condition="pot">:repocreate</entry>\r
293                                                         <entry>\r
294                                                                 Creates a repository in <option>/path</option>\r
295                                                         </entry>\r
296                                                 </row>\r
297                                                 <row>\r
298                                                         <entry condition="pot">:switch</entry>\r
299                                                         <entry>\r
300                                                                 Opens the switch dialog. The <option>/path</option> specifies the\r
301                                                                 target directory.\r
302                                                         </entry>\r
303                                                 </row>\r
304                                                 <row>\r
305                                                         <entry condition="pot">:export</entry>\r
306                                                         <entry>\r
307                                                                 Exports the working tree in <option>/path</option>\r
308                                                                 to another directory. If the <option>/path</option>\r
309                                                                 points to an unversioned directory, a dialog will ask\r
310                                                                 for an URL to export to the directory in <option>/path</option>.\r
311                                                         </entry>\r
312                                                 </row>\r
313                                                 <row>\r
314                                                         <entry condition="pot">:merge</entry>\r
315                                                         <entry>\r
316                                                                 Opens the merge dialog. The <option>/path</option> specifies the\r
317                                                                 target directory.\r
318 <!--\r
319                                                                 For merging a revision range, the following options are available:\r
320                                                                 <option>/fromurl:URL</option>,\r
321                                                                 <option>/revrange:string</option>.\r
322                                                                 For merging two repository trees, the following options are available:\r
323                                                                 <option>/fromurl:URL</option>,\r
324                                                                 <option>/tourl:URL</option>,\r
325                                                                 <option>/fromrev:xxx</option> and \r
326                                                                 <option>/torev:xxx</option>.\r
327                                                                 These pre-fill the relevant fields in the merge dialog.\r
328 -->\r
329                                                         </entry>\r
330                                                 </row>\r
331                                                 <!--\r
332                                                 <row>\r
333                                                         <entry condition="pot">:copy</entry>\r
334                                                         <entry>\r
335                                                                 Brings up the branch/tag dialog.\r
336                                                                 The <option>/path</option>\r
337                                                                 is the working tree to branch/tag from.\r
338                                                                 And the <option>/url</option> is the\r
339                                                                 target URL.\r
340                                                                 You can also specify the <option>/logmsg</option> switch\r
341                                                                 to pass a predefined log message to the branch/tag dialog.\r
342                                                                 Or, if you don't want to pass the log message on the\r
343                                                                 command line, use <option>/logmsgfile:path</option>,\r
344                                                                 where <option>path</option>\r
345                                                                 points to a file containing the log message.\r
346                                                         </entry>\r
347                                                 </row>\r
348                                                 -->\r
349                                                 <row>\r
350                                                         <entry condition="pot">:settings</entry>\r
351                                                         <entry>\r
352                                                                 Opens the settings dialog.\r
353                                                         </entry>\r
354                                                 </row>\r
355                                                 <row>\r
356                                                         <entry condition="pot">:remove</entry>\r
357                                                         <entry>\r
358                                                                 Removes the file(s) in <option>/path</option> from\r
359                                                                 version control.\r
360                                                         </entry>\r
361                                                 </row>\r
362                                                 <row>\r
363                                                         <entry condition="pot">:rename</entry>\r
364                                                         <entry>\r
365                                                                 Renames the file in <option>/path</option>. The new\r
366                                                                 name for the file is asked with a dialog.\r
367                                                                 To avoid the question about renaming similar files\r
368                                                                 in one step, pass <option>/noquestion</option>.\r
369                                                         </entry>\r
370                                                 </row>\r
371                                                 <row>\r
372                                                         <entry condition="pot">:diff</entry>\r
373                                                         <entry>\r
374                                                                 Starts the external diff program specified in the\r
375                                                                 TortoiseGit settings. The <option>/path</option>\r
376                                                                 specifies the first file.\r
377                                                                 If the option <option>/path2</option>\r
378                                                                 is set, then the diff program is started with those\r
379                                                                 two files. If <option>/path2</option> is omitted,\r
380                                                                 then the diff is done between the file in\r
381                                                                 <option>/path</option> and its BASE.\r
382                                                                 To explicitly set the revision numbers use\r
383                                                                 <option>/startrev:xxx</option> and\r
384                                                                 <option>/endrev:xxx</option>.\r
385                                                                 If <option>/blame</option> is set and <option>/path2</option>\r
386                                                                 is not set, then the diff is done by first blaming \r
387                                                                 the files with the given revisions.\r
388                                                         </entry>\r
389                                                 </row>\r
390                                                 <row>\r
391                                                         <entry condition="pot">:showcompare</entry>\r
392                                                         <entry>\r
393                                                                 <para>\r
394                                                                 Depending on revisions to compare and the path, this\r
395                                                                 either shows a unified diff (if the option <option>unified</option> is set), \r
396                                                                 a dialog with a list of files that have changed (filtered by a possibly entered subpath) or if \r
397                                                                 the path point to a file starts the diff viewer for \r
398                                                                 those the file in the different revisions.\r
399                                                                 </para>\r
400                                                         </entry>\r
401                                                 </row>\r
402                                                 <row>\r
403                                                         <entry condition="pot">:conflicteditor</entry>\r
404                                                         <entry>\r
405                                                                 Starts the conflict editor specified in the TortoiseGit\r
406                                                                 settings with the correct files for the conflicted\r
407                                                                 file in <option>/path</option>.\r
408                                                         </entry>\r
409                                                 </row>\r
410                                                 <!--\r
411                                                 <row>\r
412                                                         <entry condition="pot">:relocate</entry>\r
413                                                         <entry>\r
414                                                                 Opens the relocate dialog. The <option>/path</option>\r
415                                                                 specifies the working tree path to relocate.\r
416                                                         </entry>\r
417                                                 </row>\r
418                                                 -->\r
419                                                 <row>\r
420                                                         <entry condition="pot">:help</entry>\r
421                                                         <entry>\r
422                                                                 Opens the help file.\r
423                                                         </entry>\r
424                                                 </row>\r
425                                                 <row>\r
426                                                         <entry condition="pot">:repostatus</entry>\r
427                                                         <entry>\r
428                                                                 Opens the check-for-modifications dialog. The <option>/path</option>\r
429                                                                 specifies the working tree directory.\r
430                                                         </entry>\r
431                                                 </row>\r
432                                                 <row>\r
433                                                         <entry condition="pot">:repobrowser</entry>\r
434                                                         <entry>\r
435                                                                 Starts the repository browser dialog, pointing to\r
436                                                                 the working tree given in <option>/path</option>.\r
437                                                                 An additional option <option>/rev:xxx</option> can\r
438                                                                 be used to specify the revision which the repository\r
439                                                                 browser should show. If the <option>/rev:xxx</option>\r
440                                                                 is omitted, it defaults to HEAD.\r
441                                                         </entry>\r
442                                                 </row>\r
443                                                 <row>\r
444                                                         <entry condition="pot">:ignore</entry>\r
445                                                         <entry>\r
446                                                                 Adds all targets in <option>/path</option> to the\r
447                                                                 ignore list, i.e. adds the <literal>svn:ignore</literal>\r
448                                                                 property to those files.\r
449                                                         </entry>\r
450                                                 </row>\r
451                                                 <row>\r
452                                                         <entry condition="pot">:blame</entry>\r
453                                                         <entry>\r
454                                                                 <para>\r
455                                                                 Opens the blame dialog for the file specified \r
456                                                                 in <option>/path</option>.\r
457                                                                 </para>\r
458                                                                 <para>\r
459                                                                 If the option <option>/endrev</option> is set TortoiseGitBlame\r
460                                                                 ends at that revision.\r
461                                                                 </para>\r
462 <!--\r
463                                                                 <para>\r
464                                                                 If the option <option>/line:nnn</option> is set,\r
465                                                                 TortoiseBlame will open with the specified line\r
466                                                                 number showing.\r
467                                                                 </para>\r
468 -->\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                                                 <!--\r
567                                                 <row>\r
568                                                         <entry condition="pot">:revisiongraph</entry>\r
569                                                         <entry>\r
570                                                                 Shows the revision graph for the path given in\r
571                                                                 <option>/path</option>.\r
572                                                         </entry>\r
573                                                 </row>\r
574                                                 -->\r
575                                                 <!--\r
576                                                 <row>\r
577                                                         <entry condition="pot">:rebuildiconcache</entry>\r
578                                                         <entry>\r
579                                                                 Rebuilds the windows icon cache. Only use this in\r
580                                                                 case the windows icons are corrupted. A side effect\r
581                                                                 of this (which can't be avoided) is that the icons\r
582                                                                 on the desktop get rearranged.\r
583                                                                 To suppress the message box, pass <option>/noquestion</option>.\r
584                                                         </entry>\r
585                                                 </row>\r
586                                                 -->\r
587                                         </tbody>\r
588                                 </tgroup>\r
589                         </table>\r
590                 </para>\r
591                 <para>\r
592                         Examples (which should be entered on one line):\r
593 <screen>\r
594 TortoiseGitProc.exe /command:commit\r
595                  /path:"c:\svn_wc\file1.txt*c:\svn_wc\file2.txt"\r
596                  /logmsg:"test log message" /closeonend:0\r
598 TortoiseGitProc.exe /command:update /path:"c:\svn_wc\" /closeonend:0\r
600 TortoiseGitProc.exe /command:log /path:"c:\svn_wc\file1.txt"\r
601                  /startrev:50 /endrev:60 /closeonend:0\r
602 </screen>\r
603                 </para>\r
604         </sect1>\r
606         <sect1 id="tsvn-automation-idiff">\r
607                 <title>TortoiseIDiff Commands</title>\r
608                 <indexterm>\r
609                         <primary>automation</primary>\r
610                 </indexterm>\r
611                 <indexterm>\r
612                         <primary>command line</primary>\r
613                 </indexterm>\r
614                 <para>\r
615                         The image diff tool has a few command line options which you\r
616                         can use to control how the tool is started.\r
617                         The program is called <literal>TortoiseGitIDiff.exe</literal>.\r
618                 </para>\r
619                 <para>\r
620                         The table below lists all the options which can be passed\r
621                         to the image diff tool on the command line.\r
622                 </para>\r
623 <!--\r
624 ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION ATTENTION\r
625 Don't touch these lines:\r
626 <entry condition="pot">:about</entry>\r
628   The condition="pot" prevents the strings from being extracted into\r
629         the .pot file, so nobody translates them.\r
630   The colons in front of the command have to stay there to prevent these strings\r
631   from being translated if the po file "by chance" contains a matching translation.\r
632 -->\r
633                 <para>\r
634                         <table id="tsvn-automation-idiff-1-table">\r
635                                 <title>List of available options</title>\r
636                                 <tgroup cols="2">\r
637                                         <colspec colnum="1" colwidth="2*"/>\r
638                                         <colspec colnum="2" colwidth="6*"/>\r
639                                         <thead>\r
640                                                 <row>\r
641                                                         <entry>Option</entry>\r
642                                                         <entry>Description</entry>\r
643                                                 </row>\r
644                                         </thead>\r
645                                         <tbody>\r
646                                                 <row>\r
647                                                         <entry condition="pot">:left</entry>\r
648                                                         <entry>\r
649                                                                 Path to the file shown on the left.\r
650                                                         </entry>\r
651                                                 </row>\r
652                                                 <row>\r
653                                                         <entry condition="pot">:lefttitle</entry>\r
654                                                         <entry>\r
655                                                                 A title string. This string is used in the image view\r
656                                                                 title instead of the full path to the image file.\r
657                                                         </entry>\r
658                                                 </row>\r
659                                                 <row>\r
660                                                         <entry condition="pot">:right</entry>\r
661                                                         <entry>\r
662                                                                 Path to the file shown on the right.\r
663                                                         </entry>\r
664                                                 </row>\r
665                                                 <row>\r
666                                                         <entry condition="pot">:righttitle</entry>\r
667                                                         <entry>\r
668                                                                 A title string. This string is used in the image view\r
669                                                                 title instead of the full path to the image file.\r
670                                                         </entry>\r
671                                                 </row>\r
672                                                 <row>\r
673                                                         <entry condition="pot">:overlay</entry>\r
674                                                         <entry>\r
675                                                                 If specified, the image diff tool switches\r
676                                                                 to the overlay mode (alpha blend).\r
677                                                         </entry>\r
678                                                 </row>\r
679                                                 <row>\r
680                                                         <entry condition="pot">:fit</entry>\r
681                                                         <entry>\r
682                                                                 If specified, the image diff tool fits both\r
683                                                                 images together.\r
684                                                         </entry>\r
685                                                 </row>\r
686                                                 <row>\r
687                                                         <entry condition="pot">:showinfo</entry>\r
688                                                         <entry>\r
689                                                                 Shows the image info box.\r
690                                                         </entry>\r
691                                                 </row>\r
692                                         </tbody>\r
693                                 </tgroup>\r
694                         </table>\r
695                 </para>\r
696                 <para>\r
697                         Example (which should be entered on one line):\r
698 <screen>\r
699 TortoiseGitIDiff.exe /left:"c:\images\img1.jpg" /lefttitle:"image 1"\r
700                   /right:"c:\images\img2.jpg" /righttitle:"image 2"\r
701                   /fit /overlay\r
702 </screen>\r
703                 </para>\r
704         </sect1>\r
706 </appendix>\r