| blob | 6e2d40632d4add8c59f527094557eeb5057f9f9f |
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 </variablelist>\r
69 <sect3 id="tsvn-dug-settings-look-feel">\r
70 <title>Context Menu Settings</title>\r
71 <?dbhh topicname="HIDD_SETTINGSLOOKANDFEEL"?>\r
72 <para>\r
73 <figure id="tsvn-dug-settings-dia-context">\r
74 <title>The Settings Dialog, Context Menu Page</title>\r
75 <graphic fileref="../images/SettingsContext.png"/>\r
76 </figure>\r
77 This page allows you to specify which of the TortoiseGit context menu\r
78 entries will show up in the main context menu, and which will appear\r
79 in the TortoiseGit submenu. By default most items are unchecked and\r
80 appear in the submenu.\r
81 </para>\r
82 <para>\r
83 Most of the time, you won't need the TortoiseGit context menu, apart\r
84 for folders that are under version control by Git. For non-\r
85 versioned folders, you only really need the context menu when you\r
86 want to do a checkout. If you check the option <literal>Hide menus\r
87 for unversioned paths</literal>, TortoiseGit will not add its entries\r
88 to the context menu for unversioned folders. But the entries are\r
89 added for all items and paths in a versioned folder. And you can\r
90 get the entries back for unversioned folders by holding the \r
91 <keycap>Shift</keycap> key down while showing the context menu.\r
92 </para>\r
93 <para>\r
94 If there are some paths on your computer where you just don't want\r
95 TortoiseGit's context menu to appear at all, you can list them in\r
96 the box at the bottom.\r
97 </para>\r
98 </sect3>\r
99 \r
100 <sect3 id="tsvn-dug-settings-look-feel">\r
101 <title>Set Extend Menu Item</title>\r
102 <?dbhh topicname="HIDD_SETTINGSEXTMENU"?>\r
103 <para>\r
104 <figure id="tsvn-dug-settings-ext-menu">\r
105 <title>The Settings Dialog, Set Extend Menu Item</title>\r
106 <graphic fileref="../images/SettingsExtendMenu.png"/>\r
107 </figure>\r
108 This page allows you to specify which of the TortoiseGit context menu\r
109 entries will show up in the extend context menu (press <keycap>Shift</keycap>\r
110 key on <action>right click</action>), \r
111 and which will appear in the normal context menu. \r
112 This config will help reduce the context menu number at normal usage case\r
113 according to your usage module. \r
114 </para>\r
115 </sect3>\r
116 \r
117 <sect3 id="tsvn-dug-settings-dialogs">\r
118 <title>TortoiseGit Dialog Settings</title>\r
119 <?dbhh topicname="HIDD_SETTINGSDIALOGS"?>\r
120 <para>\r
121 <figure id="tsvn-dug-settings-dia-dialogs">\r
122 <title>The Settings Dialog, Dialogs Page</title>\r
123 <graphic fileref="../images/SettingsDialog.png"/>\r
124 </figure>\r
125 This dialog allows you to configure some of TortoiseGit's\r
126 dialogs the way you like them.\r
127 </para>\r
128 <variablelist>\r
129 <varlistentry>\r
130 <term>Font for log messages</term>\r
131 <listitem>\r
132 <para>\r
133 Selects the font face and size used to display the log\r
134 message itself in the middle pane of the Revision Log\r
135 dialog, and when composing log messages in the Commit\r
136 dialog.\r
137 </para>\r
138 </listitem>\r
139 </varlistentry>\r
140 <varlistentry>\r
141 <term>Short date / time format in log messages</term>\r
142 <listitem>\r
143 <para>\r
144 If the standard long messages use up too much \r
145 space on your screen use the short format.\r
146 </para>\r
147 </listitem>\r
148 </varlistentry>\r
149 <varlistentry>\r
150 <term>apply --topo-order</term>\r
151 <listitem>\r
152 <para>\r
153 Normally log entries/commits are ordered in descending order of the commit date.\r
154 '--topo-order' makes the commits appear in topological order (i.e. descendant\r
155 commits are shown before their parents). Not using this option, might break\r
156 the graph in the log dialog. However, this option is slower, because all\r
157 log entries have to be processed before displaying them.\r
158 </para>\r
159 </listitem>\r
160 </varlistentry>\r
161 <varlistentry>\r
162 <term>Can double-click in log list to compare with previous revision</term>\r
163 <listitem>\r
164 <para>\r
165 If you frequently find yourself comparing revisions in the top\r
166 pane of the log dialog, you can use this option to allow that\r
167 action on double-click. It is not enabled by default because\r
168 fetching the diff is often a long process, and many people\r
169 prefer to avoid the wait after an accidental double-click,\r
170 which is why this option is not enabled by default.\r
171 </para>\r
172 </listitem>\r
173 </varlistentry>\r
174 <!--\r
175 <varlistentry>\r
176 <term>Progress Dialog</term>\r
177 <listitem>\r
178 <para>\r
179 TortoiseGit can automatically close all progress dialogs \r
180 when the action is finished without error. This setting\r
181 allows you to select the conditions for closing the\r
182 dialogs. The default (recommended) setting is\r
183 <guilabel>Close manually</guilabel>\r
184 which allows you to review all messages and check what\r
185 has happened. However, you may decide that you want to\r
186 ignore some types of message and have the dialog\r
187 close automatically if there are no critical changes.\r
188 </para>\r
189 <para>\r
190 <guilabel>Auto-close if no merges, adds or deletes</guilabel>\r
191 means that the progress dialog will close if there were\r
192 simple updates, but if changes from the repository were\r
193 merged with yours, or if any files were added or deleted,\r
194 the dialog will remain open. It will also stay open if\r
195 there were any conflicts or errors during the operation.\r
196 </para>\r
197 <para>\r
198 <guilabel>Auto-close if no merges, adds or deletes for\r
199 local operations</guilabel> means that the progress dialog\r
200 will close as for <guilabel>Auto-close if no merges, adds\r
201 or deletes</guilabel> but only for local operations like adding\r
202 files or reverting changes. For remote operations the\r
203 dialog will stay open.\r
204 </para>\r
205 <para>\r
206 <guilabel>Auto-close if no conflicts</guilabel>\r
207 relaxes the criteria further and will close the dialog\r
208 even if there were merges, adds or deletes. However,\r
209 if there were any conflicts or errors, the dialog\r
210 remains open.\r
211 </para>\r
212 <para>\r
213 <guilabel>Auto-close if no errors</guilabel>\r
214 always closes the dialog even if there were conflicts.\r
215 The only condition that keeps the dialog open is an\r
216 error condition, which occurs when Git is unable\r
217 to complete the task. For example, an update fails\r
218 because the server is inaccessible, or a commit fails\r
219 because the working copy is out-of-date.\r
220 </para>\r
221 </listitem>\r
222 </varlistentry>\r
223 -->\r
224 <varlistentry>\r
225 <term>Use recycle bin when reverting</term>\r
226 <listitem>\r
227 <para>\r
228 When you revert local modifications, your changes are\r
229 discarded. TortoiseGit gives you an extra safety net by\r
230 sending the modified file to the recycle bin before\r
231 bringing back the pristine copy. If you prefer to\r
232 skip the recycle bin, uncheck this option.\r
233 </para>\r
234 </listitem>\r
235 </varlistentry>\r
236 <varlistentry>\r
237 <term>Use auto-completion of file paths and keywords</term>\r
238 <listitem>\r
239 <para>\r
240 The commit dialog includes a facility to parse the list\r
241 of filenames being committed. When you type the first 3\r
242 letters of an item in the list, the auto-completion\r
243 box pops up, and you can press Enter to complete the\r
244 filename. Check the box to enable this feature.\r
245 </para>\r
246 </listitem>\r
247 </varlistentry>\r
248 <varlistentry>\r
249 <term>Timeout in seconds to stop the auto-completion parsing</term>\r
250 <listitem>\r
251 <para>\r
252 The auto-completion parser can be quite slow if there are a lot\r
253 of large files to check. This timeout stops the commit dialog\r
254 being held up for too long. If you are missing important\r
255 auto-completion information, you can extend the timeout.\r
256 </para>\r
257 </listitem>\r
258 </varlistentry>\r
259 <varlistentry>\r
260 <term>Max. items to keep in the log message history</term>\r
261 <listitem>\r
262 <para>\r
263 When you type in a log message in the commit dialog, TortoiseGit\r
264 stores it for possible re-use later. By default it will keep the\r
265 last 25 log messages for each repository, but you can customize\r
266 that number here.\r
267 If you have many different repositories, you may wish to\r
268 reduce this to avoid filling your registry.\r
269 </para>\r
270 <para>\r
271 Note that this setting applies only to messages that you type\r
272 in on this computer. It has nothing to do with the log cache.\r
273 </para>\r
274 </listitem>\r
275 </varlistentry>\r
276 <varlistentry>\r
277 <term>Select items automatically</term>\r
278 <listitem>\r
279 <para>\r
280 The normal behaviour in the commit dialog is for all modified\r
281 (versioned) items to be selected for commit automatically.\r
282 If you prefer to start with nothing selected and pick the\r
283 items for commit manually, uncheck this box.\r
284 </para>\r
285 </listitem>\r
286 </varlistentry>\r
287 </variablelist>\r
288 </sect3>\r
289 <sect3 id="tsvn-dug-settings-colours">\r
290 <title>TortoiseGit Colour Settings</title>\r
291 <?dbhh topicname="HIDD_SETTINGSCOLORS_1"?>\r
292 <para>\r
293 <figure id="tsvn-dug-settings-dia-colors">\r
294 <title>The Settings Dialog, Colours Page</title>\r
295 <graphic fileref="../images/SettingsColors.png"/>\r
296 </figure>\r
297 This dialog allows you to configure the text colours\r
298 used in TortoiseGit's dialogs the way you like them.\r
299 </para>\r
300 <variablelist>\r
301 <varlistentry>\r
302 <term>Possible or real conflict / obstructed</term>\r
303 <listitem>\r
304 <para>\r
305 A conflict has occurred during update, or may occur during merge.\r
306 Update is obstructed by an existing unversioned file/folder of\r
307 the same name as a versioned one.\r
308 </para>\r
309 <para>\r
310 This colour is also used for error messages in the progress dialogs.\r
311 </para>\r
312 </listitem>\r
313 </varlistentry>\r
314 <varlistentry>\r
315 <term>Added files</term>\r
316 <listitem>\r
317 <para>\r
318 Items added to the repository.\r
319 </para>\r
320 </listitem>\r
321 </varlistentry>\r
322 <varlistentry>\r
323 <term>Missing / deleted / replaced</term>\r
324 <listitem>\r
325 <para>\r
326 Items deleted from the repository, missing from the working\r
327 copy, or deleted from the working copy and replaced with\r
328 another file of the same name.\r
329 </para>\r
330 </listitem>\r
331 </varlistentry>\r
332 <varlistentry>\r
333 <term>Merged</term>\r
334 <listitem>\r
335 <para>\r
336 Changes from the repository successfully merged into the WC\r
337 without creating any conflicts.\r
338 </para>\r
339 </listitem>\r
340 </varlistentry>\r
341 <varlistentry>\r
342 <term>Modified / copied</term>\r
343 <listitem>\r
344 <para>\r
345 Add with history, or paths copied in the repository.\r
346 Also used in the log dialog for entries which include\r
347 copied items.\r
348 </para>\r
349 </listitem>\r
350 </varlistentry>\r
351 <varlistentry>\r
352 <term>Deleted node</term>\r
353 <listitem>\r
354 <para>\r
355 An item which has been deleted from the repository.\r
356 </para>\r
357 </listitem>\r
358 </varlistentry>\r
359 <varlistentry>\r
360 <term>Added node</term>\r
361 <listitem>\r
362 <para>\r
363 An item which has been added to the repository, by an add, copy\r
364 or move operation.\r
365 </para>\r
366 </listitem>\r
367 </varlistentry>\r
368 <varlistentry>\r
369 <term>Renamed node</term>\r
370 <listitem>\r
371 <para>\r
372 An item which has been renamed within the repository.\r
373 </para>\r
374 </listitem>\r
375 </varlistentry>\r
376 <varlistentry>\r
377 <term>Replaced node</term>\r
378 <listitem>\r
379 <para>\r
380 The original item has been deleted and a new item with\r
381 the same name replaces it.\r
382 </para>\r
383 </listitem>\r
384 </varlistentry>\r
385 </variablelist>\r
386 </sect3>\r
387 <sect3 id="tsvn-dug-settings-colours2">\r
388 <title>TortoiseGit Colour Settings 2</title>\r
389 <?dbhh topicname="HIDD_SETTINGSCOLORS_2"?>\r
390 <para>\r
391 <figure id="tsvn-dug-settings-dia-colors2">\r
392 <title>The Settings Dialog, Colours Page</title>\r
393 <graphic fileref="../images/SettingsColors2.png"/>\r
394 </figure>\r
395 This dialog allows you to configure the text colours\r
396 used in TortoiseGit's dialogs the way you like them.\r
397 </para>\r
398 </sect3>\r
399 <sect3 id="tsvn-dug-settings-colours3">\r
400 <title>TortoiseGit Colour Settings 3</title>\r
401 <?dbhh topicname="HIDD_SETTINGSCOLORS_3"?>\r
402 <para>\r
403 <figure id="tsvn-dug-settings-dia-colors-3">\r
404 <title>The Settings Dialog, Colours Page</title>\r
405 <graphic fileref="../images/SettingsColors3.png"/>\r
406 </figure>\r
407 This dialog allows you to configure the line colours\r
408 in the graph column used in TortoiseGit's log dialog the way you like them.\r
409 </para>\r
410 </sect3>\r
411 </sect2>