Beautify the manual.
[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       <thead>
19         <tr>
20           <td>
21             <p class="previous"><a href="image_search.html">Previous</a>
22             </p>
23           </td>
24
25           <td>
26             <p class="navtop_title">Search Window &ndash; Image Search</p>
27           </td>
28
29           <td>
30             <p class="next"><a href="image_search_finding_duplicates.html">Next</a>
31             </p>
32           </td>
33         </tr>
34       </thead>
35     </table>
36   </div>
37
38   <hr />
39
40   <h1>Search Window</h1>
41
42   <p>Geeqie provides a utility to find one or more images based on various parameters.</p>
43
44   <p>To display a new Search Window press F3 or select Search from the File menu.</p>
45
46   <p>To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.</p>
47
48   <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>
49
50   <p>When a search is completed, the total number of files found and their total size will be displayed in the status bar.</p>
51
52   <h2>Search location</h2>
53
54   <p>One of several locations can be chosen as the source to use in the search.</p>
55
56   <p>
57   <dl class="dialog_desc">
58   <dt>Path</dt>
59   <dd>
60   <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>
61   </dd>
62
63   <dt>Comments</dt>
64   <dd>
65   <p>The search will include all files that have a keyword or comment associated to it.</p>
66   <p class="note">Note: Only keyword and comment associations stored in the user's home folder are included in this search type.</p>
67   </dd>
68
69   <dt>Results</dt>
70   <dd>
71   <p>The search will include all files currently listed in the results list, use this to refine a previous search.</p>
72   </dd>
73   </dl>
74
75   <h2>Search parameters</h2>
76
77   <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>
78   
79   <dl class="dialog_desc">
80   <dt>File name</dt>
81   <dd>
82   <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>
83   </dd>
84
85   <dt>File size</dt>
86   <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>
87   </dd>
88
89   <dt>File date</dt>
90   <dd>
91   <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>
92   <p>For convenience, the button with the down arrow displays a pop up calendar to enter the date.</p>
93   </dd>
94
95   <dt>Image dimensions</dt>
96   <dd>
97   <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>
98   <p>The image dimensions test is simple, both width and height must be within the allowed values for a match.</p>
99   </dd>
100
101   <dt>Image content</dt>
102   <dd>
103   <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>
104   </dd>
105
106   <dt>Keywords</dt>
107   <dd>
108   <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>
109   </dd>
110   </dl>
111   
112   <h2>Results list</h2>
113
114   <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>
115
116   <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>
117
118   <p><b>Keyboard shortcuts</b> available in the results list:</p>
119
120   <div class="gq-search-4">
121     <table width="80%" border="1" cellpadding="2" cellspacing="0">
122     <col id="search_shortcuts_col1" width="25%"></col>
123     <col id="search_shortcuts_col2" width="25%"></col>
124     <col id="search_shortcuts_col3" width="50%"></col>
125
126     <thead>
127       <tr>
128         <td>
129           <p>Shortcut</p>
130         </td>
131
132         <td>
133           <p>Context menu name</p>
134         </td>
135
136         <td>
137           <p>Description</p>
138         </td>
139       </tr>
140     </thead>
141     <tbody>
142       <tr>
143         <td>
144           <p>Enter</p>
145         </td>
146
147         <td>
148           <p>View</p>
149         </td>
150
151         <td>
152           <p>Opens selected image in main window.</p>
153         </td>
154       </tr>
155
156       <tr>
157         <td>
158           <p>V</p>
159         </td>
160
161         <td>
162           <p>View in new window</p>
163         </td>
164
165         <td>
166           <p>Opens selected image in a new window.</p>
167         </td>
168       </tr>
169
170       <tr>
171         <td>
172           <p>Control + A</p>
173         </td>
174
175         <td>
176           <p>Select all</p>
177         </td>
178
179         <td>
180           <p>Selects all images.</p>
181         </td>
182       </tr>
183
184       <tr>
185         <td>
186           <p>Control + Shift + A</p>
187         </td>
188
189         <td>
190           <p>Select none</p>
191         </td>
192
193         <td>
194           <p>Clear the image selection.</p>
195         </td>
196       </tr>
197
198       <tr>
199         <td>
200           <p>Control + 1 through<br />
201           Control + 0</p>
202         </td>
203
204         <td>
205           <p>Edit sub menu</p>
206         </td>
207
208         <td>
209           <p>Executes the respective editor command.</p>
210         </td>
211       </tr>
212
213       <tr>
214         <td>
215           <p>Control + P</p>
216         </td>
217
218         <td>
219           <p>Properties</p>
220         </td>
221
222         <td>
223           <p>Opens a properties window for selected images.</p>
224         </td>
225       </tr>
226
227       <tr>
228         <td>
229           <p>C</p>
230         </td>
231
232         <td>
233           <p>Add to new collection</p>
234         </td>
235
236         <td>
237           <p>Creates a new collection containing the selected images.</p>
238         </td>
239       </tr>
240
241       <tr>
242         <td>&nbsp;</td>
243
244         <td>
245           <p>Print</p>
246         </td>
247
248         <td>
249           <p>Opens a print dialog for selected images.</p>
250         </td>
251       </tr>
252
253       <tr>
254         <td>
255           <p>Control + C</p>
256         </td>
257
258         <td>
259           <p>Copy</p>
260         </td>
261
262         <td>
263           <p>Copy selected images.</p>
264         </td>
265       </tr>
266
267       <tr>
268         <td>
269           <p>Control + M</p>
270         </td>
271
272         <td>
273           <p>Move</p>
274         </td>
275
276         <td>
277           <p>Move selected images.</p>
278         </td>
279       </tr>
280
281       <tr>
282         <td>
283           <p>Control + R</p>
284         </td>
285
286         <td>
287           <p>Rename</p>
288         </td>
289
290         <td>
291           <p>Rename selected images.</p>
292         </td>
293       </tr>
294
295       <tr>
296         <td>
297           <p>Control + D</p>
298         </td>
299
300         <td>
301           <p>Delete</p>
302         </td>
303
304         <td>
305           <p>Delete selected images.</p>
306         </td>
307       </tr>
308
309       <tr>
310         <td>
311           <p>Delete</p>
312         </td>
313
314         <td>
315           <p>Remove</p>
316         </td>
317
318         <td>
319           <p>Remove selected images from result list.</p>
320         </td>
321       </tr>
322
323       <tr>
324         <td>
325           <p>Control + Delete</p>
326         </td>
327
328         <td>
329           <p>Clear</p>
330         </td>
331
332         <td>
333           <p>Cleared the result list.</p>
334         </td>
335       </tr>
336
337       <tr>
338         <td>
339           <p>Menu</p>
340         </td>
341
342         <td>&nbsp;</td>
343
344         <td>
345           <p>Displays the context menu.</p>
346         </td>
347       </tr>
348
349       <tr>
350         <td>
351           <p>Control + T</p>
352         </td>
353
354         <td>&nbsp;</td>
355
356         <td>
357           <p>Toggle display of thumbnails.</p>
358         </td>
359       </tr>
360
361       <tr>
362         <td>
363           <p>Control + W</p>
364         </td>
365
366         <td>&nbsp;</td>
367
368         <td>
369           <p>Close window.</p>
370         </td>
371       </tr>
372       </tbody>
373     </table>
374   </div>
375
376   <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>
377
378   <p>The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.</p>
379
380   <h2>Status bar</h2>
381
382   <p>At the bottom of the search window is an area that includes the following items from left to right:</p>
383
384   <dl class="dialog_desc">
385   <dt>Thumbnails</dt>
386   <dd>
387   <p>Enable this check box to display a thumbnail next to each image in the results list.</p>
388   </dd>
389
390   <dt>File count display</dt>
391   <dd>
392   <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>
393   </dd>
394
395   <dt>Search progress</dt>
396   <dd>
397   <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>
398   </dd>
399
400   <dt>Find</dt>
401   <dd>
402   <p>Activate the find button to start a search with the selected parameters.</p>
403   </dd>
404   
405   <dt>Stop</dt>
406   <dd>
407   <p>Activate the stop button to end a search that is in progress.</p>
408   </dd>
409   </dl>
410
411   <h2>Drag and Drop</h2>
412
413   <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>
414
415   <hr id="bottomseparator" />
416
417   <div class="navbottom">
418     <table width="100%" border="0" cellpadding="4" cellspacing="0">
419       <col id="navbottom_col1" width="33%"></col>
420       <col id="navbottom_col2" width="33%"></col>
421       <col id="navbottom_col3" width="33%"></col>
422
423       <thead>
424         <tr>
425           <td>
426             <p class="previous"><a href="image_search.html">Previous</a>
427             </p>
428           </td>
429
430           <td>
431             <p class="navbottom_title"><a href="index.html">Contents</a>
432             </p>
433           </td>
434
435           <td>
436             <p class="next"><a href="image_search_finding_duplicates.html">Next</a>
437             </p>
438           </td>
439         </tr>
440       </thead>
441
442     </table>
443   </div>
444
445   <div class="footer">Geeqie User Manual</div>
446   <div class="bottomspacer">&nbsp;</div>
447 </body>
448 </html>