doc/docbook/GuideImageSearchSearch.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideImageSearchSearch">
   3   <title id="titleGuideImageSearchSearch">Search Window</title>
   4   <para>Geeqie provides a utility to find one or more images based on various parameters.</para>
   5   <para>
   6     To display a new Search Window press
   7     <keycap>F3</keycap>
   8     or select
   9     <guimenu>Search</guimenu>
  10     from the File menu.
  11   </para>
  12   <para>
  13     To start a search activate the
  14     <code>
  15       <guibutton>
  16         <guiicon>
  17           <inlinegraphic fileref="edit-find.png" />
  18         </guiicon>
  19         Find
  20       </guibutton>
  21     </code>
  22     button or press
  23     <code>Ctrl + Enter</code>
  24     . A search in progress can be stopped by activating the
  25     <code>
  26       <guibutton>
  27         <guiicon>
  28           <inlinegraphic fileref="process-stop.png" />
  29         </guiicon>
  30         Stop
  31       </guibutton>
  32     </code>
  33     button or press
  34     <code>Ctrl + Enter</code>
  35     .
  36   </para>
  37   <para>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.</para>
  38   <para>When a search is completed, the total number of files found and their total size will be displayed in the status bar.</para>
  39   <para />
  40   <section id="Searchlocation">
  41     <title>Search location</title>
  42     <para>One of several locations can be chosen as the source to use in the search.</para>
  43     <variablelist>
  44       <varlistentry>
  45         <term>
  46           <guilabel>Path</guilabel>
  47         </term>
  48         <listitem>The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.</listitem>
  49       </varlistentry>
  50       <varlistentry>
  51         <term>
  52           <guilabel>Comments</guilabel>
  53         </term>
  54         <listitem>
  55           This option is only for use with GqView legacy metadata.
  56           <para />
  57           The search will include all files that have a keyword or comment associated to it.
  58           <note>Only keyword and comment associations stored in the user's home folder are included in this search type.</note>
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term>
  63           <guilabel>Results</guilabel>
  64         </term>
  65         <listitem>The search will include all files currently listed in the results list. Use this to refine a previous search.</listitem>
  66       </varlistentry>
  67       <varlistentry>
  68         <term>
  69           <guilabel>Collection</guilabel>
  70         </term>
  71         <listitem>The search will include all files in the selected collection.</listitem>
  72       </varlistentry>
  73     </variablelist>
  74     <para />
  75     <para />
  76   </section>
  77   <section id="Searchparameters">
  78     <title>Search parameters</title>
  79     <para>Each search parameter can be enabled or disabled with the check box to its left. For a file to be a match, all enabled parameters must be true.</para>
  80     <variablelist>
  81       <varlistentry>
  82         <term>
  83           <guilabel>File</guilabel>
  84         </term>
  85         <listitem>
  86           If "name is" is selected, the search will match if the text exactly matches the file name. If "name contains" or "path contains" is selected, the search will match if the entered text appears within the file name or path.
  87           <para/>The text comparison can be made to be case sensitive by enabling the Match case checkbox.
  88           <para/>The search can be restricted to symbolic links by enabling the Symbolic Link checkbox.
  89           <para />
  90           If "contains" or "path contains" is selected,
  91           <link linkend="GuideReferencePCRE">Perl Compatible Regular Expressions</link>
  92           are used.
  93         </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term>
  97           <guilabel>File size</guilabel>
  98         </term>
  99         <listitem>
 100           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
 101           <emphasis>between</emphasis>
 102           test is inclusive - for example a file of size 10 will match if the size parameters are between 10 and 15.
 103         </listitem>
 104       </varlistentry>
 105       <varlistentry>
 106         <term>
 107           <guilabel>File date</guilabel>
 108         </term>
 109         <listitem>
 110           The search will match if the file date is equal to, before, after, or between the entered date, depending on the method selected from the drop down menu. The
 111           <emphasis>between</emphasis>
 112           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.
 113           <para />
 114           For convenience, the
 115           <code>
 116             <guibutton>
 117               <guiicon>
 118                 <inlinegraphic fileref="go-down.png" />
 119               </guiicon>
 120             </guibutton>
 121           </code>
 122           button displays a pop up calendar to enter the date.
 123           <para />
 124           One of four date types may be selected. They are described in the
 125           <link linkend="GuideReferenceFileDates">Reference section</link>
 126           .
 127           <note>If an image does not have an exif date, it will default to 01 January 1970.</note>
 128         </listitem>
 129       </varlistentry>
 130       <varlistentry>
 131         <term>
 132           <guilabel>Image dimensions</guilabel>
 133         </term>
 134         <listitem>
 135           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
 136           <emphasis>between</emphasis>
 137           test is inclusive.
 138           <para />
 139           The image dimensions test is simple, both width and height must be within the allowed values for a match.
 140         </listitem>
 141       </varlistentry>
 142       <varlistentry>
 143         <term>
 144           <guilabel>Image content</guilabel>
 145         </term>
 146         <listitem>
 147           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
 148           <link linkend="GuideImageSearchFindingDuplicates">Finding Duplicates</link>
 149           . The entry is for entering the path for the image to use in this test.
 150         </listitem>
 151       </varlistentry>
 152       <varlistentry>
 153         <term>
 154           <guilabel>Keywords</guilabel>
 155         </term>
 156         <listitem>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.</listitem>
 157       </varlistentry>
 158       <varlistentry>
 159         <term>
 160           <guilabel>Comment</guilabel>
 161         </term>
 162         <listitem>
 163           The search will match if the file's Comments field contains the entered pattern.
 164           <link linkend="GuideReferencePCRE">Perl Compatible Regular Expressions</link>
 165           are used.
 166         </listitem>
 167       </varlistentry>
 168       <varlistentry>
 169         <term>
 170           <guilabel>Geocoded position</guilabel>
 171         </term>
 172         <listitem>
 173           The search will match if the file's GPS position is less than or greater than the selected distance from the specified position, or is not geocoded, depending on the method selected from the drop down menu.
 174           The search location can be specified by
 175           <itemizedlist>
 176             <listitem>
 177               Type in a latitude/longitude in the format
 178               <code>89.123 179.123</code>
 179             </listitem>
 180             <listitem>Drag-and-drop a geocoded image onto the search box</listitem>
 181             <listitem>If Geeqie's map is displayed, a left-click on the map will store the latitude/longitude under the mouse cursor into the clipboard. It can then be pasted into the search box.</listitem>
 182             <listitem>Copy-and-paste (in some circumstances drag-and-drop) the result of an Internet search.</listitem>
 183           </itemizedlist>
 184           <note>
 185             In this last case, the result of a search may contain the latitude/longitude embedded in the URL. This may be automatically decoded with the help of an external file:-
 186             <programlisting xml:space="preserve">$HOME/.config/geeqie/geocode-parameters.awk</programlisting>
 187             See
 188             <link linkend="GuideReferenceDecodeLatLong">Decoding Latitude and Longitude</link>
 189             for details on how to create this file.
 190           </note>
 191         </listitem>
 192       </varlistentry>
 193       <varlistentry>
 194         <term>
 195           <guilabel>Class</guilabel>
 196         </term>
 197         <listitem>
 198           The search will match if the file's class is, or is not, one of the following types.
 199           <itemizedlist>
 200             <listitem>Unknown</listitem>
 201             <listitem>Image</listitem>
 202             <listitem>Raw Image</listitem>
 203             <listitem>Video</listitem>
 204             <listitem>Document</listitem>
 205             <listitem>Metadata</listitem>
 206             <listitem>Unknown</listitem>
 207             <listitem>Broken (Of class Image, Raw Image, Video, or Document, but Geeqie cannot display an image)</listitem>
 208           </itemizedlist>
 209         </listitem>
 210       </varlistentry>
 211       <varlistentry>
 212         <term>
 213           <guilabel>Marks</guilabel>
 214         </term>
 215         <listitem>
 216           The search will match if the file does or does not have a mark attached to it. Refer to
 217           <link linkend="GuideImageMarks">Marking Images</link>
 218           .
 219         </listitem>
 220       </varlistentry>
 221     </variablelist>
 222     <para />
 223     <para />
 224   </section>
 225   <section id="Resultslist">
 226     <title>Results list</title>
 227     <para>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.</para>
 228     <para>
 229       A
 230       <emphasis role="strong">context menu</emphasis>
 231       is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.
 232     </para>
 233     <para>
 234       The
 235       <link linkend="GuideReferenceKeyboardShortcuts" endterm="titleGuideReferenceKeyboardShortcuts" />
 236       available are listed here.
 237     </para>
 238     <para>The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.</para>
 239     <para />
 240   </section>
 241   <section id="Statusbar">
 242     <title>Status bar</title>
 243     <para>At the bottom of the search window is an area that includes the following items from left to right:</para>
 244     <variablelist>
 245       <varlistentry>
 246         <term>
 247           <guilabel>Thumbnails</guilabel>
 248         </term>
 249         <listitem>Enable this check box to display a thumbnail next to each image in the results list.</listitem>
 250       </varlistentry>
 251       <varlistentry>
 252         <term>
 253           <guilabel>File count display</guilabel>
 254         </term>
 255         <listitem>Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.</listitem>
 256       </varlistentry>
 257       <varlistentry>
 258         <term>
 259           <guilabel>Search progress</guilabel>
 260         </term>
 261         <listitem>When a search is active, the text “Searching...” 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.</listitem>
 262       </varlistentry>
 263       <varlistentry>
 264         <term>
 265           <code>
 266             <guibutton>
 267               <guiicon>
 268                 <inlinegraphic fileref="edit-find.png" />
 269               </guiicon>
 270               Find
 271             </guibutton>
 272           </code>
 273         </term>
 274         <listitem>Activate the find button to start a search with the selected parameters.</listitem>
 275       </varlistentry>
 276       <para />
 277       <varlistentry>
 278         <term>
 279           <code>
 280             <guibutton>
 281               <guiicon>
 282                 <inlinegraphic fileref="process-stop.png" />
 283               </guiicon>
 284               Stop
 285             </guibutton>
 286           </code>
 287         </term>
 288         <listitem>Activate the stop button to end a search that is in progress.</listitem>
 289       </varlistentry>
 290     </variablelist>
 291     <para />
 292     <para />
 293   </section>
 294   <section id="DragandDrop">
 295     <title>Drag and Drop</title>
 296     <para>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.</para>
 297     <para />
 298   </section>
 299 </section>