7447810a6db759d96ef0871dd86fef5f1f3a40b4
[TortoiseGit.git] / doc / source / en / TortoiseGit / tsvn_dug / dug_settings_advanced.xml
blob7447810a6db759d96ef0871dd86fef5f1f3a40b4
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect2 id="tsvn-dug-settings-registry">\r
4     <?dbhh topicname="HIDD_SETTINGS_CONFIG"?>\r
5     <title>Advanced Settings</title>\r
6     <indexterm>\r
7         <primary>registry</primary>\r
8     </indexterm>\r
9     <para>\r
10         A few infrequently used settings are available only in the advanced\r
11         page of the settings dialog. These settings modify the registry directly\r
12         and you have to know what each of these settings is used for and what\r
13         it does. Do not modify these settings unless you are sure you need to\r
14         change them.\r
15     </para>\r
16     <variablelist>\r
17         <varlistentry>\r
18             <term condition="pot">AutoCompleteMinChars</term>\r
19             <listitem>\r
20                 <para>\r
21                     The minimum amount of chars from which the editor\r
22                     shows an auto-completion popup. The default value\r
23                     is <literal>3</literal>.\r
24                 </para>\r
25             </listitem>\r
26         </varlistentry>\r
27         <varlistentry>\r
28             <term condition="pot">AutocompleteRemovesExtensions</term>\r
29             <listitem>\r
30                 <para>\r
31                     The auto-completion list shown in the commit message editor\r
32                     displays the names of files listed for commit.\r
33                     To also include these names with extensions removed,\r
34                     set this value to <literal>true</literal>.\r
35                 </para>\r
36             </listitem>\r
37         </varlistentry>\r
38         <varlistentry>\r
39             <term condition="pot">BlockStatus</term>\r
40             <listitem>\r
41                 <para>\r
42                     If you don't want the explorer to update the status overlays\r
43                     while another TortoiseGit command is running\r
44                     (e.g. Update, Commit, ...) then set this value to\r
45                     <literal>true</literal>.\r
46                 </para>\r
47             </listitem>\r
48         </varlistentry>\r
49         <varlistentry>\r
50             <term condition="pot">CacheTrayIcon</term>\r
51             <listitem>\r
52                 <para>\r
53                     To add a cache tray icon for the TGitCache program, set\r
54                     this value to <literal>true</literal>.\r
55                     This is really only useful for developers as it allows\r
56                     you to terminate the program gracefully.\r
57                 </para>\r
58             </listitem>\r
59         </varlistentry>\r
60         <varlistentry>\r
61             <term condition="pot">ColumnsEveryWhere</term>\r
62             <listitem>\r
63                 <para>\r
64                     The extra columns the TortoiseGit adds to the details view\r
65                     in Windows Explorer are normally only active in a working\r
66                     copy. If you want those to be accessible everywhere, not\r
67                     just in working trees, set this value to\r
68                     <literal>true</literal>.\r
69                     Note that the extra columns are only available in XP.\r
70                     Vista and later doesn't support that feature any more.\r
71                 </para>\r
72             </listitem>\r
73         </varlistentry>\r
74         <varlistentry>\r
75             <term condition="pot">Debug</term>\r
76             <listitem>\r
77                 <para>\r
78                     Set this to <literal>true</literal> if you want a dialog to\r
79                     pop up for every command showing the command line used to\r
80                     start TortoiseGitProc.exe.\r
81                 </para>\r
82             </listitem>\r
83         </varlistentry>\r
84         <varlistentry>\r
85             <term condition="pot">DiffBlamesWithTortoiseMerge</term>\r
86             <listitem>\r
87                 <para>\r
88                     TortoiseGit allows you to assign an external diff viewer.\r
89                     Most such viewers, however, are not suited for change blaming\r
90                     (<xref linkend="tsvn-dug-blame-diffs"/>),\r
91                     so you might wish to fall back to TortoiseMerge in this case.\r
92                     To do so, set this value to <literal>true</literal>.\r
93                 </para>\r
94             </listitem>\r
95         </varlistentry>\r
96         <varlistentry>\r
97             <term condition="pot">FullRowSelect</term>\r
98             <listitem>\r
99                 <para>\r
100                     The status list control which is used in various dialogs\r
101                     (e.g., commit, check-for-modifications, add, revert, ...)\r
102                     uses full row selection (i.e., if you select an entry, the\r
103                     full row is selected, not just the first column).\r
104                     This is fine, but the selected row then also covers the\r
105                     background image on the bottom right, which can look ugly.\r
106                     To disable full row select, set this value to\r
107                     <literal>false</literal>.\r
108                 </para>\r
109             </listitem>\r
110         </varlistentry>\r
111         <varlistentry>\r
112             <term condition="pot">GroupTaskbarIconsPerRepo</term>\r
113             <listitem>\r
114                 <para>\r
115                     This option determines how the Win7 taskbar icons of the various\r
116                     TortoiseGit dialogs and windows are grouped together. This\r
117                     option has no effect on Windows XP or Vista!\r
118                 </para>\r
119                 <para>\r
120                     <orderedlist>\r
121                         <listitem>\r
122                             <para>\r
123                                 The default value is 3. With this setting, the\r
124                                 icons are grouped together by application type per working tree.\r
125                                 All dialogs from TortoiseGit of one working tree are grouped together,\r
126                                 all windows from TortoiseGitMerge of one working tree are grouped together, ...\r
127                                 For example, if you have\r
128                                 a log dialog and a push dialog open for working tree\r
129                                 <literal>C:\A</literal>, and a check-for-modifications\r
130                                 dialog and a log dialog for working tree <literal>C:\B</literal>,\r
131                                 then there are two application icon groups shown\r
132                                 in the Win7 taskbar, one group for each working tree.\r
133                                 But TortoiseGitMerge windows are not grouped together\r
134                                 with TortoiseGit dialogs.\r
135                                 <figure id="tsvn-dug-settings-registry-task1-1">\r
136                                     <title>Taskbar with default grouping</title>\r
137                                     <graphic fileref="../images/TaskbarGroup1.png"/>\r
138                                 </figure>\r
139                             </para>\r
140                         </listitem>\r
141                         <listitem>\r
142                             <para>\r
143                                 If set to 4, then the grouping works as with\r
144                                 the setting set to 3, except that TortoiseGit, TortoiseGitMerge,\r
145                                 TortoiseGitBlame, TortoiseGitIDiff and TortoiseGitUDiff windows\r
146                                 of one working tree\r
147                                 are all grouped together. For example, if you have\r
148                                 the log dialog open and then double click on\r
149                                 a modified file, the opened TortoiseGitMerge diff window\r
150                                 will be put in the same icon group on the taskbar\r
151                                 as the log dialog icon.\r
152                                 <figure id="tsvn-dug-settings-registry-task2-1">\r
153                                     <title>Taskbar with repository grouping</title>\r
154                                     <graphic fileref="../images/TaskbarGroup2.png"/>\r
155                                 </figure>\r
156                             </para>\r
157                         </listitem>\r
158                         <listitem>\r
159                             <para>\r
160                                 If set to 1, then the grouping works as with\r
161                                 the setting set to 3 (grouping by application),\r
162                                 except that grouping takes place\r
163                                 indenpendently of the working tree. This was the default\r
164                                 before TGit 1.8.1.2.\r
165                             </para>\r
166                         </listitem>\r
167                         <listitem>\r
168                             <para>\r
169                                 If set to 2, then the grouping works as with\r
170                                 the setting set to 4, except that grouping takes place\r
171                                 indenpendently of the working tree. Thus all TortoiseGit\r
172                                 icons are grouped to only show one icon.\r
173                             </para>\r
174                         </listitem>\r
175                 </para>\r
176             </listitem>\r
177         </varlistentry>\r
178         <varlistentry>\r
179             <term condition="pot">GroupTaskbarIconsPerRepoOverlay</term>\r
180             <listitem>\r
181                 <para>\r
182                     This has no effect if the option <literal>GroupTaskbarIconsPerRepo</literal>\r
183                     is set to 0 (see above).\r
184                 </para>\r
185                 <para>\r
186                     If this option is set to <literal>true</literal>, then every\r
187                     icon on the Win7 taskbar shows a small colored rectangle overlay,\r
188                     indicating the working tree the dialogs/windows are used for.\r
189                     <figure id="tsvn-dug-settings-registry-overlay-1">\r
190                         <title>Taskbar grouping with repository color overlays</title>\r
191                         <graphic fileref="../images/TaskbarGroupOverlay.png"/>\r
192                     </figure>\r
193                 </para>\r
194             </listitem>\r
195         </varlistentry>\r
196         <varlistentry>\r
197             <term condition="pot">NoSortLocalBranchesFirst</term>\r
198             <listitem>\r
199                 <para>\r
200                     This option toggles if the branches are sorted fully by name (<literal>true</literal>) or if local branches should appear above remote ones (git default, <literal>false</literal>).\r
201                     The default value is <literal>false</literal>.\r
202                 </para>\r
203             </listitem>\r
204         </varlistentry>\r
205         <varlistentry>\r
206             <term condition="pot">NumDiffWarning</term>\r
207             <listitem>\r
208                 <para>\r
209                     If you want to show the diff at once for more items\r
210                     than specified with this settings, a warning dialog\r
211                     is shown first. The default is 10.\r
212                 </para>\r
213             </listitem>\r
214         </varlistentry>\r
215         <varlistentry>\r
216             <term condition="pot">ReaddUnselectedAddedFilesAfterCommit</term>\r
217             <listitem>\r
218                 <para>\r
219                     This option toggles the re-adding of unselected added files after a commit. Up to\r
220                     TortoiseGit 1.7.10 added files which were not checked on a commit, were removed from\r
221                     the index and unversioned after the commit. Set this value to <literal>false</literal>\r
222                     to restore the old behavior.\r
223                     Set this value to <literal>true</literal> to readd these files again after the commit (default).\r
224                 </para>\r
225             </listitem>\r
226         </varlistentry>\r
227         <varlistentry>\r
228             <term condition="pot">ScintillaDirect2D</term>\r
229             <listitem>\r
230                 <para>\r
231                     This option enables the use of Direct2D accelerated\r
232                     drawing in the Scintilla control which is used\r
233                     as the edit box in e.g. the commit dialog (also for the attached patch window), the\r
234                     unified diff viewer and TortoiseGitBlame.\r
235                     With some graphic cards, however, this sometimes\r
236                     doesn't work properly so that the cursor to enter\r
237                     text isn't always visible, the redraw does not work\r
238                     or the background is flashing. It's disabled by default. You\r
239                     can turn this feature on by setting this value\r
240                     to <literal>true</literal>.\r
241                 </para>\r
242             </listitem>\r
243         </varlistentry>\r
244         <varlistentry>\r
245             <term condition="pot">ShellMenuAccelerators</term>\r
246             <listitem>\r
247                 <para>\r
248                     TortoiseGit uses accelerators for its explorer context menu\r
249                     entries. Since this can lead to doubled accelerators (e.g.\r
250                     the <literal>Git Commit</literal> has the <keycap>Alt-C</keycap>\r
251                     accelerator, but so does the <literal>Copy</literal> entry\r
252                     of explorer).\r
253                     If you don't want or need the accelerators of the TortoiseGit\r
254                     entries, set this value to <literal>false</literal>.\r
255                 </para>\r
256             </listitem>\r
257         </varlistentry>\r
258         <varlistentry>\r
259             <term condition="pot">ShowContextMenuIcons</term>\r
260             <listitem>\r
261                 <para>\r
262                     This can be useful if you use something other than the windows explorer\r
263                     or if you get problems with the context menu displaying incorrectly.\r
264                     Set this value to <literal>false</literal>\r
265                     if you don't want TortoiseGit to show icons for the\r
266                     shell context menu items.\r
267                     Set this value to <literal>true</literal> to show the icons again.\r
268                 </para>\r
269             </listitem>\r
270         </varlistentry>\r
271         <varlistentry>\r
272             <term condition="pot">ShowListBackgroundImage</term>\r
273             <listitem>\r
274                 <para>\r
275                     If you do not want to have a small background image in list controls (e.g. Commit Dialog)\r
276                     set this value to <literal>false</literal>.\r
277                     Set this value to <literal>true</literal> to show the images again (default).\r
278                 </para>\r
279             </listitem>\r
280         </varlistentry>\r
281         <varlistentry>\r
282             <term condition="pot">TGitCacheCheckContent</term>\r
283             <listitem>\r
284                 <para>\r
285                     This makes TGitCache check file contents if timestamps (to index) missmatch in order to\r
286                     calculate the file status.\r
287                     TortoiseGit 1.7.0 up to 1.7.12 calculated the file status based on the timestamp only.\r
288                     If do not you want TGitCache to check the file contents (this lowers disk access and CPU time), set this value to <literal>false</literal>.\r
289                 </para>\r
290             </listitem>\r
291         </varlistentry>\r
292         <varlistentry>\r
293             <term condition="pot">UseLibgit2</term>\r
294             <listitem>\r
295                 <para>\r
296                     This makes TortoiseGit to use libgit2 as much as possible (e.g. for\r
297                     adding files to the index).\r
298                     If you do not want TortoiseGit to use libgit2 for file operations, set this value to <literal>false</literal>.\r
299                 </para>\r
300             </listitem>\r
301         </varlistentry>\r
302         <varlistentry>\r
303             <term condition="pot">VersionCheck</term>\r
304             <listitem>\r
305                 <para>\r
306                     TortoiseGit checks whether there's a new version available\r
307                     about once a week. If you don't want TortoiseGit to do this\r
308                     check, set this value to <literal>false</literal>.\r
309                 </para>\r
310             </listitem>\r
311         </varlistentry>\r
312         <varlistentry>\r
313             <term condition="pot">VersionCheckPreview</term>\r
314             <listitem>\r
315                 <para>\r
316                     Set this to <literal>true</literal> to make TortoiseGit also check for new preview releases.\r
317                     The default in all stable releases is <literal>false</literal>.\r
318                 </para>\r
319             </listitem>\r
320         </varlistentry>\r
321     </variablelist>\r
322 </sect2>\r