| blob | 6e0bdc09003e66ce3d4106ef9c81e32dad65f564 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect2 id="tsvn-dug-settings-main">\r
4 <?dbhh topicname="HIDD_SETTINGSMAIN"?>\r
5 <title>General Settings</title>\r
6 <indexterm>\r
7 <primary>sounds</primary>\r
8 </indexterm>\r
9 <para>\r
10 <figure id="tsvn-dug-settings-dia-main">\r
11 <title>The Settings Dialog, General Page</title>\r
12 <graphic fileref="../images/SettingsMain.png"/>\r
13 </figure>\r
14 This dialog allows you to specify your preferred language,\r
15 and the Git-specific settings.\r
16 </para>\r
17 <variablelist>\r
18 <varlistentry>\r
19 <term>Language</term>\r
20 <listitem>\r
21 <para>\r
22 Selects your user interface language.\r
23 What else did you expect?\r
24 </para>\r
25 </listitem>\r
26 </varlistentry>\r
27 <varlistentry>\r
28 <term>Automatically check for newer versions every week</term>\r
29 <listitem>\r
30 <para>\r
31 If checked, TortoiseGit will contact its download site once a week \r
32 to see if there is a newer version of the program available.\r
33 Use <guibutton>Check now</guibutton> if you want an answer\r
34 right away. The new version will not be downloaded; you\r
35 simply receive an information dialog telling you that the\r
36 new version is available.\r
37 </para>\r
38 </listitem>\r
39 </varlistentry>\r
40 <varlistentry>\r
41 <term>System sounds</term>\r
42 <listitem>\r
43 <para>\r
44 TortoiseGit has three custom sounds which are installed by default.\r
45 <itemizedlist>\r
46 <listitem>\r
47 <para>\r
48 Error\r
49 </para>\r
50 </listitem>\r
51 <listitem>\r
52 <para>\r
53 Notice\r
54 </para>\r
55 </listitem>\r
56 <listitem>\r
57 <para>\r
58 Warning\r
59 </para>\r
60 </listitem>\r
61 </itemizedlist>\r
62 You can select different sounds (or turn these sounds\r
63 off completely) using the Windows Control Panel.\r
64 <guibutton>Configure</guibutton> is a shortcut to the Control Panel.\r
65 </para>\r
66 </listitem>\r
67 </varlistentry>\r
68 <varlistentry>\r
69 <term>Create Library</term>\r
70 <listitem>\r
71 <para>\r
72 On Windows 7 you can create a Library in which to group working copies\r
73 which are scattered in various places on your system.\r
74 </para>\r
75 </listitem>\r
76 </varlistentry>\r
77 <varlistentry>\r
78 <term>Extern DLL Path</term>\r
79 <listitem>\r
80 <para>\r
81 If your git installation needs an extra entry in the PATH environment variable,\r
82 you can enter it here and it will get added to the PATH environment variable automatically when TortoiseGit starts.\r
83 </para>\r
84 </listitem>\r
85 </varlistentry>\r
86 </variablelist>\r
87 <sect3 id="tsvn-dug-settings-look-feel">\r
88 <title>Context Menu Settings</title>\r
89 <?dbhh topicname="HIDD_SETTINGSLOOKANDFEEL"?>\r
90 <para>\r
91 <figure id="tsvn-dug-settings-dia-context">\r
92 <title>The Settings Dialog, Context Menu Page</title>\r
93 <graphic fileref="../images/SettingsContext.png"/>\r
94 </figure>\r
95 This page allows you to specify which of the TortoiseGit context menu\r
96 entries will show up in the main context menu, and which will appear\r
97 in the TortoiseGit submenu. By default most items are unchecked and\r
98 appear in the submenu.\r
99 </para>\r
100 <para>\r
101 Most of the time, you won't need the TortoiseGit context menu, apart\r
102 for folders that are under version control by Git. For non-\r
103 versioned folders, you only really need the context menu when you\r
104 want to do a checkout. If you check the option <literal>Hide menus\r
105 for unversioned paths</literal>, TortoiseGit will not add its entries\r
106 to the context menu for unversioned folders. But the entries are\r
107 added for all items and paths in a versioned folder. And you can\r
108 get the entries back for unversioned folders by holding the \r
109 <keycap>Shift</keycap> key down while showing the context menu.\r
110 </para>\r
111 <para>\r
112 If there are some paths on your computer where you just don't want\r
113 TortoiseGit's context menu to appear at all, you can list them in\r
114 the box at the bottom.\r
115 </para>\r
116 </sect3>\r
117 \r
118 <sect3 id="tsvn-dug-settings-look-feel-extended">\r
119 <title>Set Extend Menu Item</title>\r
120 <?dbhh topicname="HIDD_SETTINGSEXTMENU"?>\r
121 <para>\r
122 <figure id="tsvn-dug-settings-ext-menu">\r
123 <title>The Settings Dialog, Set Extend Menu Item</title>\r
124 <graphic fileref="../images/SettingsExtendMenu.png"/>\r
125 </figure>\r
126 This page allows you to specify which of the TortoiseGit context menu\r
127 entries will show up in the extend context menu (press <keycap>Shift</keycap>\r
128 key on <action>right click</action>), \r
129 and which will appear in the normal context menu. \r
130 This config will help reduce the context menu number at normal usage case\r
131 according to your usage module. \r
132 </para>\r
133 </sect3>\r
134 \r
135 <sect3 id="tsvn-dug-settings-dialogs">\r
136 <title>TortoiseGit Dialog Settings</title>\r
137 <?dbhh topicname="HIDD_SETTINGSDIALOGS"?>\r
138 <para>\r
139 <figure id="tsvn-dug-settings-dia-dialogs">\r
140 <title>The Settings Dialog, Dialogs Page</title>\r
141 <graphic fileref="../images/SettingsDialog.png"/>\r
142 </figure>\r
143 This dialog allows you to configure some of TortoiseGit's\r
144 dialogs the way you like them.\r
145 </para>\r
146 <variablelist>\r
147 <varlistentry>\r
148 <term>Font for log messages</term>\r
149 <listitem>\r
150 <para>\r
151 Selects the font face and size used to display the log\r
152 message itself in the middle pane of the Revision Log\r
153 dialog, and when composing log messages in the Commit\r
154 dialog.\r
155 </para>\r
156 </listitem>\r
157 </varlistentry>\r
158 <varlistentry>\r
159 <term>Short date / time format in log messages</term>\r
160 <listitem>\r
161 <para>\r
162 If the standard long messages use up too much \r
163 space on your screen use the short format.\r
164 </para>\r
165 </listitem>\r
166 </varlistentry>\r
167 <varlistentry>\r
168 <term>apply --topo-order</term>\r
169 <listitem>\r
170 <para>\r
171 Normally log entries/commits are ordered in descending order of the commit date.\r
172 '--topo-order' makes the commits appear in topological order (i.e. descendant\r
173 commits are shown before their parents). Not using this option, might break\r
174 the graph in the log dialog. However, this option is slower, because all\r
175 log entries have to be processed before displaying them.\r
176 </para>\r
177 </listitem>\r
178 </varlistentry>\r
179 <varlistentry>\r
180 <term>Can double-click in log list to compare with previous revision</term>\r
181 <listitem>\r
182 <para>\r
183 If you frequently find yourself comparing revisions in the top\r
184 pane of the log dialog, you can use this option to allow that\r
185 action on double-click. It is not enabled by default because\r
186 fetching the diff is often a long process, and many people\r
187 prefer to avoid the wait after an accidental double-click,\r
188 which is why this option is not enabled by default.\r
189 </para>\r
190 </listitem>\r
191 </varlistentry>\r
192 <varlistentry>\r
193 <term>Abbreviate renamings</term>\r
194 <listitem>\r
195 <para>\r
196 Normally renamed files are listed as "long/path/for/file.txt (from long/path/to/file.txt)".\r
197 If you check this option renamed files will be listed in a shorter format ("long/path/{to => for}/file.txt"),\r
198 however, this abbreviated format might be harder to understand.\r
199 </para>\r
200 </listitem>\r
201 </varlistentry>\r
202 <varlistentry>\r
203 <term>Symbolize ref names</term>\r
204 <listitem>\r
205 <para>\r
206 Show symbols on ref labels to substitute part of the ref names.\r
207 If this option is enabled, the following description and example will apply.\r
208 If there is only a single remote, a lightning symbol will substitute the remote name part of each remote branch.\r
209 If the remote branch is the upstream of a local branch, an up triangle symbol will substitute the branch name part of the remote branch.\r
210 <figure id="tsvn-dug-settings-symbolizerefname-example">\r
211 <title>Example of Symbolize ref names</title>\r
212 <graphic fileref="../images/SymbolizeRefNamesExample.png"/>\r
213 </figure>\r
214 </para>\r
215 </listitem>\r
216 </varlistentry>\r
217 <varlistentry>\r
218 <term>Enable log cache</term>\r
219 <listitem>\r
220 <para>\r
221 Load/saves log cache in .git folder (tortoisegit.data, tortoisegit.index) to boost performance of subsequent use of log list.\r
222 If this option is disabled, the cache files are not read or written.\r
223 Default is enabled.\r
224 </para>\r
225 </listitem>\r
226 </varlistentry>\r
227 <!--\r
228 <varlistentry>\r
229 <term>Progress Dialog</term>\r
230 <listitem>\r
231 <para>\r
232 TortoiseGit can automatically close all progress dialogs \r
233 when the action is finished without error. This setting\r
234 allows you to select the conditions for closing the\r
235 dialogs. The default (recommended) setting is\r
236 <guilabel>Close manually</guilabel>\r
237 which allows you to review all messages and check what\r
238 has happened. However, you may decide that you want to\r
239 ignore some types of message and have the dialog\r
240 close automatically if there are no critical changes.\r
241 </para>\r
242 <para>\r
243 <guilabel>Auto-close if no merges, adds or deletes</guilabel>\r
244 means that the progress dialog will close if there were\r
245 simple updates, but if changes from the repository were\r
246 merged with yours, or if any files were added or deleted,\r
247 the dialog will remain open. It will also stay open if\r
248 there were any conflicts or errors during the operation.\r
249 </para>\r
250 <para>\r
251 <guilabel>Auto-close if no merges, adds or deletes for\r
252 local operations</guilabel> means that the progress dialog\r
253 will close as for <guilabel>Auto-close if no merges, adds\r
254 or deletes</guilabel> but only for local operations like adding\r
255 files or reverting changes. For remote operations the\r
256 dialog will stay open.\r
257 </para>\r
258 <para>\r
259 <guilabel>Auto-close if no conflicts</guilabel>\r
260 relaxes the criteria further and will close the dialog\r
261 even if there were merges, adds or deletes. However,\r
262 if there were any conflicts or errors, the dialog\r
263 remains open.\r
264 </para>\r
265 <para>\r
266 <guilabel>Auto-close if no errors</guilabel>\r
267 always closes the dialog even if there were conflicts.\r
268 The only condition that keeps the dialog open is an\r
269 error condition, which occurs when Git is unable\r
270 to complete the task. For example, an update fails\r
271 because the server is inaccessible, or a commit fails\r
272 because the working tree is out-of-date.\r
273 </para>\r
274 </listitem>\r
275 </varlistentry>\r
276 -->\r
277 <varlistentry>\r
278 <term>Use recycle bin when reverting</term>\r
279 <listitem>\r
280 <para>\r
281 When you revert local modifications, your changes are\r
282 discarded. TortoiseGit gives you an extra safety net by\r
283 sending the modified file to the recycle bin before\r
284 bringing back the pristine copy. If you prefer to\r
285 skip the recycle bin, uncheck this option.\r
286 </para>\r
287 </listitem>\r
288 </varlistentry>\r
289 <varlistentry>\r
290 <term>Use auto-completion of file paths and keywords</term>\r
291 <listitem>\r
292 <para>\r
293 The commit dialog includes a facility to parse the list\r
294 of filenames being committed. When you type the first 3\r
295 letters of an item in the list, the auto-completion\r
296 box pops up, and you can press Enter to complete the\r
297 filename. Check the box to enable this feature.\r
298 </para>\r
299 </listitem>\r
300 </varlistentry>\r
301 <varlistentry>\r
302 <term>Timeout in seconds to stop the auto-completion parsing</term>\r
303 <listitem>\r
304 <para>\r
305 The auto-completion parser can be quite slow if there are a lot\r
306 of large files to check. This timeout stops the commit dialog\r
307 being held up for too long. If you are missing important\r
308 auto-completion information, you can extend the timeout.\r
309 </para>\r
310 </listitem>\r
311 </varlistentry>\r
312 <varlistentry>\r
313 <term>Max. items to keep in the log message history</term>\r
314 <listitem>\r
315 <para>\r
316 When you type in a log message in the commit dialog, TortoiseGit\r
317 stores it for possible re-use later. By default it will keep the\r
318 last 25 log messages for each repository, but you can customize\r
319 that number here.\r
320 If you have many different repositories, you may wish to\r
321 reduce this to avoid filling your registry.\r
322 </para>\r
323 <para>\r
324 Note that this setting applies only to messages that you type\r
325 in on this computer. It has nothing to do with the log cache.\r
326 </para>\r
327 </listitem>\r
328 </varlistentry>\r
329 <varlistentry>\r
330 <term>Select items automatically</term>\r
331 <listitem>\r
332 <para>\r
333 The normal behaviour in the commit dialog is for all modified\r
334 (versioned) items to be selected for commit automatically.\r
335 If you prefer to start with nothing selected and pick the\r
336 items for commit manually, uncheck this box.\r
337 </para>\r
338 </listitem>\r
339 </varlistentry>\r
340 </variablelist>\r
341 </sect3>\r
342 <sect3 id="tsvn-dug-settings-colours">\r
343 <title>TortoiseGit Colour Settings</title>\r
344 <?dbhh topicname="HIDD_SETTINGSCOLORS_1"?>\r
345 <para>\r
346 <figure id="tsvn-dug-settings-dia-colors">\r
347 <title>The Settings Dialog, Colours Page</title>\r
348 <graphic fileref="../images/SettingsColors.png"/>\r
349 </figure>\r
350 This dialog allows you to configure the text colours\r
351 used in TortoiseGit's dialogs the way you like them.\r
352 </para>\r
353 <variablelist>\r
354 <varlistentry>\r
355 <term>Possible or real conflict / obstructed</term>\r
356 <listitem>\r
357 <para>\r
358 A conflict has occurred during update, or may occur during merge.\r
359 Update is obstructed by an existing unversioned file/folder of\r
360 the same name as a versioned one.\r
361 </para>\r
362 <para>\r
363 This colour is also used for error messages in the progress dialogs.\r
364 </para>\r
365 </listitem>\r
366 </varlistentry>\r
367 <varlistentry>\r
368 <term>Added files</term>\r
369 <listitem>\r
370 <para>\r
371 Items added to the repository.\r
372 </para>\r
373 </listitem>\r
374 </varlistentry>\r
375 <varlistentry>\r
376 <term>Missing / deleted / replaced</term>\r
377 <listitem>\r
378 <para>\r
379 Items deleted from the repository, missing from the working\r
380 copy, or deleted from the working tree and replaced with\r
381 another file of the same name.\r
382 </para>\r
383 </listitem>\r
384 </varlistentry>\r
385 <varlistentry>\r
386 <term>Merged</term>\r
387 <listitem>\r
388 <para>\r
389 Changes from the repository successfully merged into the working tree\r
390 without creating any conflicts.\r
391 </para>\r
392 </listitem>\r
393 </varlistentry>\r
394 <varlistentry>\r
395 <term>Modified / copied</term>\r
396 <listitem>\r
397 <para>\r
398 Add with history, or paths copied in the repository.\r
399 Also used in the log dialog for entries which include\r
400 copied items.\r
401 </para>\r
402 </listitem>\r
403 </varlistentry>\r
404 <varlistentry>\r
405 <term>Deleted node</term>\r
406 <listitem>\r
407 <para>\r
408 An item which has been deleted from the repository.\r
409 </para>\r
410 </listitem>\r
411 </varlistentry>\r
412 <varlistentry>\r
413 <term>Added node</term>\r
414 <listitem>\r
415 <para>\r
416 An item which has been added to the repository, by an add, copy\r
417 or move operation.\r
418 </para>\r
419 </listitem>\r
420 </varlistentry>\r
421 <varlistentry>\r
422 <term>Renamed node</term>\r
423 <listitem>\r
424 <para>\r
425 An item which has been renamed within the repository.\r
426 </para>\r
427 </listitem>\r
428 </varlistentry>\r
429 <varlistentry>\r
430 <term>Replaced node</term>\r
431 <listitem>\r
432 <para>\r
433 The original item has been deleted and a new item with\r
434 the same name replaces it.\r
435 </para>\r
436 </listitem>\r
437 </varlistentry>\r
438 </variablelist>\r
439 </sect3>\r
440 <sect3 id="tsvn-dug-settings-colours2">\r
441 <title>TortoiseGit Colour Settings 2</title>\r
442 <?dbhh topicname="HIDD_SETTINGSCOLORS_2"?>\r
443 <para>\r
444 <figure id="tsvn-dug-settings-dia-colors2">\r
445 <title>The Settings Dialog, Colours Page</title>\r
446 <graphic fileref="../images/SettingsColors2.png"/>\r
447 </figure>\r
448 This dialog allows you to configure the text colours\r
449 used in TortoiseGit's dialogs the way you like them.\r
450 </para>\r
451 </sect3>\r
452 <sect3 id="tsvn-dug-settings-colours3">\r
453 <title>TortoiseGit Colour Settings 3</title>\r
454 <?dbhh topicname="HIDD_SETTINGSCOLORS_3"?>\r
455 <para>\r
456 <figure id="tsvn-dug-settings-dia-colors-3">\r
457 <title>The Settings Dialog, Colours Page</title>\r
458 <graphic fileref="../images/SettingsColors3.png"/>\r
459 </figure>\r
460 This dialog allows you to configure the line colours\r
461 in the graph column used in TortoiseGit's log dialog the way you like them.\r
462 </para>\r
463 </sect3>\r
464 </sect2>