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