931de83351b84c99321e3be0caf56d9657ada09f
[geeqie.git] / doc / image_search_search.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5   <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" />
6
7   <title>Search Window - Geeqie User Manual</title>
8   <link rel="stylesheet" type="text/css" href="style.css" />
9 </head>
10
11 <body lang="en-US" dir="ltr">
12   <div class="navtop">
13     <table width="100%" border="0" cellpadding="4" cellspacing="0">
14       <col id="navtop_col1" width="33%"></col>
15       <col id="navtop_col2" width="33%"></col>
16       <col id="navtop_col3" width="33%"></col>
17
18         <tr>
19           <th>
20             <p class="previous"><a href="image_search.html">Previous</a>
21             </p>
22           </th>
23
24           <th>
25             <p class="navtop_title">Search Window &ndash; Image Search</p>
26           </th>
27
28           <th>
29             <p class="next"><a href="image_search_finding_duplicates.html">Next</a>
30             </p>
31           </th>
32         </tr>
33     </table>
34   </div>
35
36   <hr />
37
38   <h1>Search Window</h1>
39
40   <p>Geeqie provides a utility to find one or more images based on various parameters.</p>
41
42   <p>To display a new Search Window press F3 or select Search from the File menu.</p>
43
44   <p>To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.</p>
45
46   <p>The progress of an active search is displayed as a progress bar at the bottom of the window. The progress bar will also display the total files that match the search parameters, and the total number of files searched.</p>
47
48   <p>When a search is completed, the total number of files found and their total size will be displayed in the status bar.</p>
49
50   <h2>Search location</h2>
51
52   <p>One of several locations can be chosen as the source to use in the search.</p>
53
54   <dl class="dialog_desc">
55   <dt>Path</dt>
56   <dd>
57   <p>The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.</p>
58   </dd>
59
60   <dt>Comments</dt>
61   <dd>
62   <p>The search will include all files that have a keyword or comment associated to it.</p>
63   <p class="note"><span class="note_label">Note:</span> Only keyword and comment associations stored in the user's home folder are included in this search type.</p>
64   </dd>
65
66   <dt>Results</dt>
67   <dd>
68   <p>The search will include all files currently listed in the results list, use this to refine a previous search.</p>
69   </dd>
70   </dl>
71
72   <h2>Search parameters</h2>
73
74   <p>Each search parameter can be enabled or disabled with the check box to it's left. For a file to be a match, all enabled parameters must be true.</p>
75   
76   <dl class="dialog_desc">
77   <dt>File name</dt>
78   <dd>
79   <p>The search will match if the entered text appears within the file name, or if the text exactly matches the file name, depending on the method selected from the drop down menu. The text comparison can be made to be case sensitive by enabling the Match case checkbox.</p>
80   </dd>
81
82   <dt>File size</dt>
83   <dd><p>The search will match if the file size on disk is equal to, less than, greater than, or between the entered value, depending on the method selected from the drop down menu. The between test is inclusive, for example a file of size 10 will match if the size parameters are between 10 and 15.</p>
84   </dd>
85
86   <dt>File date</dt>
87   <dd>
88   <p>The search will match if the file modification time on disk is equal to, before, after, or between the entered date, depending on the method selected from the drop down menu. The between test is inclusive, for example a file with date of 10/04/2003 will match if the date parameters are between 10/04/2003 and 12/31/2003.</p>
89   <p>For convenience, the button with the down arrow displays a pop up calendar to enter the date.</p>
90   </dd>
91
92   <dt>Image dimensions</dt>
93   <dd>
94   <p>The search will match if the image dimensions are equal to, less than, greater than, or between the entered values, depending on the method selected from the drop down menu. The between test is inclusive.</p>
95   <p>The image dimensions test is simple, both width and height must be within the allowed values for a match.</p>
96   </dd>
97
98   <dt>Image content</dt>
99   <dd>
100   <p>The search will match if the image contents are similar within the percentage value, inclusive. This uses the same test and data that is used to determine image similarity when <a href="image_search_finding_duplicates.html">Finding Duplicates</a>. The entry is for entering the path for the image to use in this test.</p>
101   </dd>
102
103   <dt>Keywords</dt>
104   <dd>
105   <p>The search will match if the file's associated keywords match all, match any, or exclude the entered keywords, depending on the method selected from the drop down menu. Keywords can be separated with a space, comma, or tab character.</p>
106   </dd>
107   </dl>
108   
109   <h2>Results list</h2>
110
111   <p>Files that match the parameters of the search are shown in the list. By default they are displayed in the order that they are found, to sort the results list by a column activate or click the column title. Activating a column that is already used to sort the list will toggle between increasing and decreasing sort order.</p>
112
113   <p>A <b>context menu</b> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.</p>
114
115   <p><b>Keyboard shortcuts</b> available in the results list:</p>
116
117   <div class="search-shortcuts">
118     <table width="80%" border="1" cellpadding="2" cellspacing="0">
119     <col id="search_shortcuts_col1" width="25%"></col>
120     <col id="search_shortcuts_col2" width="25%"></col>
121     <col id="search_shortcuts_col3" width="50%"></col>
122
123     <thead>
124       <tr>
125         <td>
126           <p>Shortcut</p>
127         </td>
128
129         <td>
130           <p>Context menu name</p>
131         </td>
132
133         <td>
134           <p>Description</p>
135         </td>
136       </tr>
137     </thead>
138     <tbody>
139       <tr>
140         <td>
141           <p>Enter</p>
142         </td>
143
144         <td>
145           <p>View</p>
146         </td>
147
148         <td>
149           <p>Opens selected image in main window.</p>
150         </td>
151       </tr>
152
153       <tr>
154         <td>
155           <p>V</p>
156         </td>
157
158         <td>
159           <p>View in new window</p>
160         </td>
161
162         <td>
163           <p>Opens selected image in a new window.</p>
164         </td>
165       </tr>
166
167       <tr>
168         <td>
169           <p>Control + A</p>
170         </td>
171
172         <td>
173           <p>Select all</p>
174         </td>
175
176         <td>
177           <p>Selects all images.</p>
178         </td>
179       </tr>
180
181       <tr>
182         <td>
183           <p>Control + Shift + A</p>
184         </td>
185
186         <td>
187           <p>Select none</p>
188         </td>
189
190         <td>
191           <p>Clear the image selection.</p>
192         </td>
193       </tr>
194
195       <tr>
196         <td>
197           <p>Control + 1 through<br />
198           Control + 0</p>
199         </td>
200
201         <td>
202           <p>Edit sub menu</p>
203         </td>
204
205         <td>
206           <p>Executes the respective editor command.</p>
207         </td>
208       </tr>
209
210       <tr>
211         <td>
212           <p>Control + P</p>
213         </td>
214
215         <td>
216           <p>Properties</p>
217         </td>
218
219         <td>
220           <p>Opens a properties window for selected images.</p>
221         </td>
222       </tr>
223
224       <tr>
225         <td>
226           <p>C</p>
227         </td>
228
229         <td>
230           <p>Add to new collection</p>
231         </td>
232
233         <td>
234           <p>Creates a new collection containing the selected images.</p>
235         </td>
236       </tr>
237
238       <tr>
239         <td>&nbsp;</td>
240
241         <td>
242           <p>Print</p>
243         </td>
244
245         <td>
246           <p>Opens a print dialog for selected images.</p>
247         </td>
248       </tr>
249
250       <tr>
251         <td>
252           <p>Control + C</p>
253         </td>
254
255         <td>
256           <p>Copy</p>
257         </td>
258
259         <td>
260           <p>Copy selected images.</p>
261         </td>
262       </tr>
263
264       <tr>
265         <td>
266           <p>Control + M</p>
267         </td>
268
269         <td>
270           <p>Move</p>
271         </td>
272
273         <td>
274           <p>Move selected images.</p>
275         </td>
276       </tr>
277
278       <tr>
279         <td>
280           <p>Control + R</p>
281         </td>
282
283         <td>
284           <p>Rename</p>
285         </td>
286
287         <td>
288           <p>Rename selected images.</p>
289         </td>
290       </tr>
291
292       <tr>
293         <td>
294           <p>Control + D</p>
295         </td>
296
297         <td>
298           <p>Delete</p>
299         </td>
300
301         <td>
302           <p>Delete selected images.</p>
303         </td>
304       </tr>
305
306       <tr>
307         <td>
308           <p>Delete</p>
309         </td>
310
311         <td>
312           <p>Remove</p>
313         </td>
314
315         <td>
316           <p>Remove selected images from result list.</p>
317         </td>
318       </tr>
319
320       <tr>
321         <td>
322           <p>Control + Delete</p>
323         </td>
324
325         <td>
326           <p>Clear</p>
327         </td>
328
329         <td>
330           <p>Cleared the result list.</p>
331         </td>
332       </tr>
333
334       <tr>
335         <td>
336           <p>Menu</p>
337         </td>
338
339         <td>&nbsp;</td>
340
341         <td>
342           <p>Displays the context menu.</p>
343         </td>
344       </tr>
345
346       <tr>
347         <td>
348           <p>Control + T</p>
349         </td>
350
351         <td>&nbsp;</td>
352
353         <td>
354           <p>Toggle display of thumbnails.</p>
355         </td>
356       </tr>
357
358       <tr>
359         <td>
360           <p>Control + W</p>
361         </td>
362
363         <td>&nbsp;</td>
364
365         <td>
366           <p>Close window.</p>
367         </td>
368       </tr>
369       </tbody>
370     </table>
371   </div>
372
373   <p>The <b>selection</b> can be changed using the keyboard and mouse the same as in a <a href="main_window_file_pane.html">file pane</a> of the main window.</p>
374
375   <p>The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.</p>
376
377   <h2>Status bar</h2>
378
379   <p>At the bottom of the search window is an area that includes the following items from left to right:</p>
380
381   <dl class="dialog_desc">
382   <dt>Thumbnails</dt>
383   <dd>
384   <p>Enable this check box to display a thumbnail next to each image in the results list.</p>
385   </dd>
386
387   <dt>File count display</dt>
388   <dd>
389   <p>Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.</p>
390   </dd>
391
392   <dt>Search progress</dt>
393   <dd>
394   <p>When a search is active, the text &#8220;Searching...&#8221; will appear here. Two numbers in parenthesis will also be displayed, the first number is the number of files that match the search parameters and the second number is the total number of files that were searched.</p>
395   </dd>
396
397   <dt>Find</dt>
398   <dd>
399   <p>Activate the find button to start a search with the selected parameters.</p>
400   </dd>
401   
402   <dt>Stop</dt>
403   <dd>
404   <p>Activate the stop button to end a search that is in progress.</p>
405   </dd>
406   </dl>
407
408   <h2>Drag and Drop</h2>
409
410   <p>Drag and drop can be initiated with the primary or middle mouse buttons. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection.</p>
411
412   <hr id="bottomseparator" />
413
414   <div class="navbottom">
415     <table width="100%" border="0" cellpadding="4" cellspacing="0">
416       <col id="navbottom_col1" width="33%"></col>
417       <col id="navbottom_col2" width="33%"></col>
418       <col id="navbottom_col3" width="33%"></col>
419
420         <tr>
421           <th>
422             <p class="previous"><a href="image_search.html">Previous</a>
423             </p>
424           </th>
425
426           <th>
427             <p class="navbottom_title"><a href="index.html">Contents</a>
428             </p>
429           </th>
430
431           <th>
432             <p class="next"><a href="image_search_finding_duplicates.html">Next</a>
433             </p>
434           </th>
435         </tr>
436
437     </table>
438   </div>
439
440   <div class="footer">Geeqie User Manual</div>
441   <div class="bottomspacer">&nbsp;</div>
442 </body>
443 </html>