Create/Update file similarity cache

[geeqie.git] / doc / docbook / GuideReferenceManagement.xml

diff --git a/doc/docbook/GuideReferenceManagement.xml b/doc/docbook/GuideReferenceManagement.xml
index c197e7d..073c3f9 100644 (file)
--- a/doc/docbook/GuideReferenceManagement.xml
+++ b/doc/docbook/GuideReferenceManagement.xml
@@ -5,13 +5,13 @@
     Thumbnails and other cached data can be maintained from the dialog accessible by selecting\r
     <menuchoice>\r
       <guimenu>Edit</guimenu>\r
-      <guimenuitem>Thumbnail Maintenance</guimenuitem>\r
+      <guimenuitem>Cache maintenance</guimenuitem>\r
     </menuchoice>\r
     .\r
   </para>\r
   <para />\r
   <section id="Geeqiethumbnailcache">\r
-    <title>Geeqie thumbnail cache</title>\r
+    <title>Geeqie thumbnail and sim. cache</title>\r
     <para>\r
       The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the\r
       <link linkend="GuideImageSearchSearch">search</link>\r
@@ -25,7 +25,7 @@
           <guilabel>Clean up</guilabel>\r
         </term>\r
         <listitem>\r
-          <para>Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.</para>\r
+          <para>Removes thumbnails, sim. files, and data for which the source image is no longer present, or has been modified since the thumbnail was generated.</para>\r
         </listitem>\r
       </varlistentry>\r
       <varlistentry>\r
@@ -33,7 +33,7 @@
           <guilabel>Clear cache</guilabel>\r
         </term>\r
         <listitem>\r
-          <para>Removes all thumbnails and data stored in the designated folder.</para>\r
+          <para>Removes all thumbnails, sim. files, and data stored in the designated folder.</para>\r
         </listitem>\r
       </varlistentry>\r
     </variablelist>\r
@@ -94,6 +94,52 @@
       </varlistentry>\r
     </variablelist>\r
   </section>\r
+  <section id="CreateSimFiles">\r
+    <title>Create file similarity cache</title>\r
+    <para>\r
+      Some file operations, such as\r
+      <link linkend="GuideImageSearchSearch">search</link>\r
+      and\r
+      <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link>\r
+      , are speeded up if similarity data files for the images have been created. This utility will create sim. files recursively under the specified folder.\r
+      <para />\r
+      The sim. files contain some or all of the following fields:\r
+      <variablelist>\r
+        <varlistentry>\r
+          <term>\r
+            <guilabel>Dimensions</guilabel>\r
+          </term>\r
+          <listitem>\r
+            <para>width x height</para>\r
+          </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+          <term>\r
+            <guilabel>Date</guilabel>\r
+          </term>\r
+          <listitem>\r
+            <para>Exif date in time_t format</para>\r
+          </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+          <term>\r
+            <guilabel>checksum</guilabel>\r
+          </term>\r
+          <listitem>\r
+            <para>MD5sum 32 character ascii text digest</para>\r
+          </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+          <term>\r
+            <guilabel>SimilarityGrid</guilabel>\r
+          </term>\r
+          <listitem>\r
+            <para>[32 x 32] = 3072 bytes of data (1024 pixels in RGB format, 1 pixel is 24bits)</para>\r
+          </listitem>\r
+        </varlistentry>\r
+      </variablelist>\r
+    </para>\r
+  </section>\r
   <section id="Metadata">\r
     <title>Metadata</title>\r
     <para>\r