03a89d32c794adf824ae6308b3bbe59b0d197902
[geeqie.git] / doc / docbook / GuideOptionsBehavior.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideOptionsBehavior">
3   <title>Behavior Options</title>
4   <para>This section describes the options presented under the Behavior Tab of the preferences dialog.</para>
5   <section id="Delete">
6     <title>Delete</title>
7     <variablelist>
8       <varlistentry>
9         <term>
10           <guilabel>Confirm permanent file delete</guilabel>
11         </term>
12         <listitem>
13           <para>Prompts for confirmation before deleting files.</para>
14         </listitem>
15       </varlistentry>
16       <varlistentry>
17         <term>
18           <guilabel>Confirm move file to Trash</guilabel>
19         </term>
20         <listitem>
21           <para>Prompts for confirmation before moving files to the trash bin.</para>
22         </listitem>
23       </varlistentry>
24       <varlistentry>
25         <term>
26           <guilabel>
27             Enable
28             <keycap>Delete key</keycap>
29           </guilabel>
30         </term>
31         <listitem>
32           <para>
33             Disable this to disassociate the delete file function from the
34             <keycap>Delete</keycap>
35             key.
36           </para>
37           <para>
38             If
39             <emphasis>Confirm file delete</emphasis>
40             , above, is disabled, accidentally hitting the
41             <keycap>Delete</keycap>
42             can result in files being erroneously deleted without warning. Disabling the
43             <keycap>Delete</keycap>
44             key will prevent this. The
45             <code>
46               Ctrl +
47               <keycap>D</keycap>
48             </code>
49             key sequence is not affected.
50           </para>
51         </listitem>
52       </varlistentry>
53       <varlistentry>
54         <term>
55           <guilabel>Use Geeqie trash location</guilabel>
56         </term>
57         <listitem>
58           <para>Moves deleted files to a temporary folder, for easy retrieval of deleted files. Files in the temporary folder are retained until the maximum size is reached, at which point deleting additional files will result in the removal of the oldest files to reclaim the space needed for the new files.</para>
59           <note>
60             <para>
61               Files moved to the Safe Delete folder are prefixed with a six digit number in the format:
62               <literal>nnnnnn_FILENAME</literal>
63               <para />
64               This is used by the delete feature to distinguish which files to remove first when clearing space for new files.
65               <para />
66               The digit counter increments with each deleted file.
67             </para>
68           </note>
69         </listitem>
70       </varlistentry>
71       <varlistentry>
72         <term>
73           <guilabel>Use system Trash bin</guilabel>
74         </term>
75         <listitem>
76           <para>Moves deleted files to the system-defined trash bin.</para>
77         </listitem>
78       </varlistentry>
79       <varlistentry>
80         <term>
81           <guilabel>Folder</guilabel>
82         </term>
83         <listitem>
84           <para>The location of the folder used by the Safe Delete feature.</para>
85         </listitem>
86       </varlistentry>
87       <varlistentry>
88         <term>
89           <guilabel>Maximum size</guilabel>
90         </term>
91         <listitem>
92           <para>The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit.</para>
93         </listitem>
94       </varlistentry>
95       <varlistentry>
96         <term>
97           <guilabel>Clear button</guilabel>
98         </term>
99         <listitem>
100           <para>Removes all files contained in the Safe Delete folder.</para>
101         </listitem>
102       </varlistentry>
103       <varlistentry>
104         <term>
105           <guilabel>View button</guilabel>
106         </term>
107         <listitem>
108           <para>Changes the Geeqie main window to display the contents of the Safe Delete folder.</para>
109         </listitem>
110       </varlistentry>
111     </variablelist>
112   </section>
113   <section id="Behaviour">
114     <title>Behavior</title>
115     <variablelist>
116       <varlistentry>
117         <term>
118           <guilabel>Descend folders in tree view</guilabel>
119         </term>
120         <listitem>
121           <para>This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.</para>
122           <note>
123             <para>Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</para>
124           </note>
125         </listitem>
126       </varlistentry>
127       <varlistentry>
128         <term>
129           <guilabel>In place renaming</guilabel>
130         </term>
131         <listitem>
132           <para>When renaming a single file, this will allow the rename entry to appear directly over the original filename.</para>
133         </listitem>
134       </varlistentry>
135       <varlistentry>
136         <term>
137           <guilabel>List directory view uses single click to enter</guilabel>
138         </term>
139         <listitem>
140           <para>If selected, a single click will enter a directory, rather than the GTK+ default of a double click.</para>
141         </listitem>
142       </varlistentry>
143       <varlistentry>
144         <term>
145           <guilabel>Circular selection lists</guilabel>
146         </term>
147         <listitem>
148           <para>If selected, when traversing a list of selected images using Next or Previous Image, when the last or first image is encountered the focus moves to the beginning or end of the list. When deselected, focus will go no further than the start or end of the list.</para>
149         </listitem>
150       </varlistentry>
151       <varlistentry>
152         <term>
153           <guilabel>Save marks on exit</guilabel>
154         </term>
155         <listitem>
156           <para>Save all marks that have been set. Note that marks that are linked to a keyword will always be saved irrespective of this setting.</para>
157         </listitem>
158       </varlistentry>
159       <varlistentry>
160         <term>
161           <guilabel>Use "With Rename" as default for Copy/Move dialogs</guilabel>
162         </term>
163         <listitem>
164           <para>Move the "With Rename" button to the default position.</para>
165         </listitem>
166       </varlistentry>
167       <varlistentry>
168         <term>
169           <guilabel>Open Collections on top</guilabel>
170         </term>
171         <listitem>
172           <para>Open collection windows with "Always on Top" set.</para>
173         </listitem>
174       </varlistentry>
175       <varlistentry>
176         <term>
177           <guilabel>Recent folder list maximum size</guilabel>
178         </term>
179         <listitem>
180           <para>This is the number of entries to be saved from the recent open folder list drop-down box. The number of entries displayed in the current session is unlimited.</para>
181         </listitem>
182       </varlistentry>
183       <varlistentry>
184         <term>
185           <guilabel>Drag'n drop icon size</guilabel>
186         </term>
187         <listitem>
188           <para>This is the width and height of the icon generated from image and displayed when doing drag and drop actions. High resolution screens may require to increase this number.</para>
189         </listitem>
190       </varlistentry>
191       <varlistentry>
192         <term>
193           <guilabel>Drag'n drop default action</guilabel>
194         </term>
195         <listitem>
196           <para>When using drag and drop to copy or move files, the default action is to use a pop-up menu to permit you to select which action is to be taken. This option allows you to set the default action to either Copy or Move.
197           </para>
198           <note>
199             <para>When using the pop-up menu, the menu will also include an option for a symbolic link and any other plugins that are defined as being a <link linkend="Geeqieextensions">filter</link>. If you set the default action to Copy or Move these additional options will not be available to you.</para>
200           </note>
201         </listitem>
202       </varlistentry>
203       <varlistentry>
204         <term>
205           <guilabel>Copy path clipboard selection</guilabel>
206         </term>
207         <listitem>
208           <para>
209             This option determines which clipboard selection is used for the "Copy path" menu item. The exact method of the paste operation will depend on the operating system, but in general will be:
210             <variablelist>
211               <varlistentry>
212                 <term>
213                   <guilabel>Primary</guilabel>
214                 </term>
215                 <listitem>
216                   <para>Paste using mouse middle-click, or shift-insert.</para>
217                 </listitem>
218               </varlistentry>
219               <varlistentry>
220                 <term>
221                   <guilabel>Clipboard</guilabel>
222                 </term>
223                 <listitem>
224                   <para>Paste using mouse right-click and select paste, or control-v.</para>
225                 </listitem>
226               </varlistentry>
227               <varlistentry>
228                 <term>
229                   <guilabel>Both</guilabel>
230                 </term>
231                 <listitem>
232                   <para>Paste using either method.</para>
233                 </listitem>
234               </varlistentry>
235             </variablelist>
236           </para>
237         </listitem>
238       </varlistentry>
239     </variablelist>
240   </section>
241   <section id="Navigation">
242     <title>Navigation</title>
243     <variablelist>
244       <varlistentry>
245         <term>
246           <guilabel>Progressive keyboard scrolling</guilabel>
247         </term>
248         <listitem>
249           <para>This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.</para>
250         </listitem>
251       </varlistentry>
252       <varlistentry>
253         <term>
254           <guilabel>Keyboard scrolling step multiplier:</guilabel>
255         </term>
256         <listitem>
257           <para>Defines the amount to pan an image when using the keyboard arrows.</para>
258         </listitem>
259       </varlistentry>
260       <varlistentry>
261         <term>
262           <guilabel>Mouse wheel scrolls image</guilabel>
263         </term>
264         <listitem>
265           <para>
266             The default is for the mouse wheel to change the image, and to scroll the image when
267             <keycap>Shift</keycap>
268             is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down
269             <keycap>Shift</keycap>
270             will change the image.
271           </para>
272         </listitem>
273       </varlistentry>
274       <varlistentry>
275         <term>
276           <guilabel>Navigation by left or middle click on image</guilabel>
277         </term>
278         <listitem>
279           <para>If selected, mouse left-click will select the next image; mouse middle-click will select the previous image.</para>
280         </listitem>
281       </varlistentry>
282       <varlistentry>
283         <term>
284           <guilabel>Open archive by left click on image</guilabel>
285         </term>
286         <listitem>
287           <para>If selected, mouse left-click on an image belonging to the archive class will decompress the file contents and display them in a new Geeqie window.</para>
288         </listitem>
289       </varlistentry>
290       <varlistentry>
291         <term>
292           <guilabel>Play video by left click on image</guilabel>
293         </term>
294         <listitem>
295           <para>If selected, mouse left-click on an image belonging to the video class will start a program chosen in a box below.</para>
296         </listitem>
297       </varlistentry>
298       <varlistentry>
299         <term>
300           <guilabel>Mouse button Back/Forward</guilabel>
301         </term>
302         <listitem>
303           <para>Some mice have additional buttons designated Back/Forward (mouse buttons 8 and 9). You may allocate any menu item to either of these buttons.</para>
304         </listitem>
305       </varlistentry>
306     </variablelist>
307   </section>
308   <section id="Debugging">
309     <title>Debugging</title>
310     <variablelist>
311       <varlistentry>
312         <term>
313           <guilabel>Debug level</guilabel>
314         </term>
315         <listitem>
316           <para>Displayed when compiled with the option --enable-debug-log. This defines the verbosity of debug info sent to console and log window (0 disables the debug output).</para>
317         </listitem>
318       </varlistentry>
319       <varlistentry>
320         <term>
321           <guilabel>Log Window max. lines</guilabel>
322         </term>
323         <listitem>
324           <para>The maximum number of data lines to be displayed. The window will show the most recent data.</para>
325         </listitem>
326       </varlistentry>
327     </variablelist>
328   </section>
329 </section>