Merge remote-tracking branch 'github/merge-requests/407'
[geeqie.git] / doc / docbook / GuideOptionsBehavior.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideOptionsBehavior">\r
3   <title>Behavior Options</title>\r
4   <para>This section describes the options presented under the Behavior Tab of the preferences dialog.</para>\r
5   <section id="Delete">\r
6     <title>Delete</title>\r
7     <variablelist>\r
8       <varlistentry>\r
9         <term>\r
10           <guilabel>Confirm file delete</guilabel>\r
11         </term>\r
12         <listitem>\r
13           <para>Prompts for confirmation before deleting files.</para>\r
14         </listitem>\r
15       </varlistentry>\r
16       <varlistentry>\r
17         <term>\r
18           <guilabel>\r
19             Enable\r
20             <keycap>Delete key</keycap>\r
21           </guilabel>\r
22         </term>\r
23         <listitem>\r
24           <para>\r
25             Disable this to disassociate the delete file function from the\r
26             <keycap>Delete</keycap>\r
27             key.\r
28           </para>\r
29           <para>\r
30             If\r
31             <emphasis>Confirm file delete</emphasis>\r
32             , above, is disabled, accidentally hitting the\r
33             <keycap>Delete</keycap>\r
34             can result in files being erroneously deleted without warning. Disabling the\r
35             <keycap>Delete</keycap>\r
36             key will prevent this. The\r
37             <code>\r
38               Ctrl +\r
39               <keycap>D</keycap>\r
40             </code>\r
41             key sequence is not affected.\r
42           </para>\r
43         </listitem>\r
44       </varlistentry>\r
45       <varlistentry>\r
46         <term>\r
47           <guilabel>Safe Delete</guilabel>\r
48         </term>\r
49         <listitem>\r
50           <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>\r
51           <note>\r
52             <para>\r
53               Files moved to the Safe Delete folder are prefixed with a six digit number in the format:\r
54               <literal>nnnnnn_FILENAME</literal>\r
55               <para />\r
56               This is used by the delete feature to distinguish which files to remove first when clearing space for new files.\r
57               <para />\r
58               The digit counter increments with each deleted file.\r
59             </para>\r
60           </note>\r
61         </listitem>\r
62       </varlistentry>\r
63       <varlistentry>\r
64         <term>\r
65           <guilabel>Folder</guilabel>\r
66         </term>\r
67         <listitem>\r
68           <para>The location of the folder used by the Safe Delete feature.</para>\r
69         </listitem>\r
70       </varlistentry>\r
71       <varlistentry>\r
72         <term>\r
73           <guilabel>Maximum size</guilabel>\r
74         </term>\r
75         <listitem>\r
76           <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>\r
77         </listitem>\r
78       </varlistentry>\r
79       <varlistentry>\r
80         <term>\r
81           <guilabel>Clear button</guilabel>\r
82         </term>\r
83         <listitem>\r
84           <para>Removes all files contained in the Safe Delete folder.</para>\r
85         </listitem>\r
86       </varlistentry>\r
87       <varlistentry>\r
88         <term>\r
89           <guilabel>View button</guilabel>\r
90         </term>\r
91         <listitem>\r
92           <para>Changes the Geeqie main window to display the contents of the Safe Delete folder.</para>\r
93         </listitem>\r
94       </varlistentry>\r
95     </variablelist>\r
96   </section>\r
97   <section id="Behaviour">\r
98     <title>Behavior</title>\r
99     <variablelist>\r
100       <varlistentry>\r
101         <term>\r
102           <guilabel>Rectangular selection in icon view</guilabel>\r
103         </term>\r
104         <listitem>\r
105           <para>Enable this to change the selection method used when selecting multiple items in an icon view.</para>\r
106         </listitem>\r
107       </varlistentry>\r
108       <varlistentry>\r
109         <term>\r
110           <guilabel>Descend folders in tree view</guilabel>\r
111         </term>\r
112         <listitem>\r
113           <para>This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.</para>\r
114           <note>\r
115             <para>Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</para>\r
116           </note>\r
117         </listitem>\r
118       </varlistentry>\r
119       <varlistentry>\r
120         <term>\r
121           <guilabel>In place renaming</guilabel>\r
122         </term>\r
123         <listitem>\r
124           <para>When renaming a single file, this will allow the rename entry to appear directly over the original filename.</para>\r
125         </listitem>\r
126       </varlistentry>\r
127       <varlistentry>\r
128         <term>\r
129           <guilabel>Open recent list maximum size</guilabel>\r
130         </term>\r
131         <listitem>\r
132           <para>This is the number of entries saved in the recent open file list.</para>\r
133         </listitem>\r
134       </varlistentry>\r
135       <varlistentry>\r
136         <term>\r
137           <guilabel>Drag'n drop icon size</guilabel>\r
138         </term>\r
139         <listitem>\r
140           <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>\r
141         </listitem>\r
142       </varlistentry>\r
143     </variablelist>\r
144   </section>\r
145   <section id="Navigation">\r
146     <title>Navigation</title>\r
147     <variablelist>\r
148       <varlistentry>\r
149         <term>\r
150           <guilabel>Progressive keyboard scrolling</guilabel>\r
151         </term>\r
152         <listitem>\r
153           <para>This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.</para>\r
154         </listitem>\r
155       </varlistentry>\r
156       <varlistentry>\r
157         <term>\r
158           <guilabel>Mouse wheel scrolls image</guilabel>\r
159         </term>\r
160         <listitem>\r
161           <para>\r
162             The default is for the mouse wheel to change the image, and to scroll the image when\r
163             <keycap>Shift</keycap>\r
164             is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down\r
165             <keycap>Shift</keycap>\r
166             will change the image.\r
167           </para>\r
168         </listitem>\r
169       </varlistentry>\r
170     </variablelist>\r
171   </section>\r
172   <section id="Miscellaneous">\r
173     <title>Miscellaneous</title>\r
174     <variablelist>\r
175       <varlistentry>\r
176         <term>\r
177           <guilabel>Custom similarity threshold</guilabel>\r
178         </term>\r
179         <listitem>\r
180           <para>\r
181             This setting is used by the compare method\r
182             <emphasis>Similarity (custom)</emphasis>\r
183             , located in the\r
184             <link linkend="GuideImageSearchFindingDuplicates" endterm="titleGuideImageSearchFindingDuplicates" />\r
185             section.\r
186           </para>\r
187         </listitem>\r
188       </varlistentry>\r
189     </variablelist>\r
190   </section>\r
191   <section id="Debugging">\r
192     <title>Debugging</title>\r
193     <variablelist>\r
194       <varlistentry>\r
195         <term>\r
196           <guilabel>Debug level</guilabel>\r
197         </term>\r
198         <listitem>\r
199           <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>\r
200         </listitem>\r
201       </varlistentry>\r
202     </variablelist>\r
203   </section>\r
204 </section>\r