Update documentation for similarity cache

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

diff --git a/doc/docbook/GuideImageSearch.xml b/doc/docbook/GuideImageSearch.xml
index b2188f3..a6cf05b 100644 (file)
--- a/doc/docbook/GuideImageSearch.xml
+++ b/doc/docbook/GuideImageSearch.xml
@@ -4,8 +4,29 @@
   <para>Geeqie provides comprehensive set of search methods, including not only the standard functions such as file date or size, but also image similarity.</para>\r
   <para>There is a duplicate file finder, which uses search parameters such as image dimensions or checksum. Two sets of image files may be compared.</para>\r
   <para>Geeqie also has a set of temporary "marks" or "tags" which may be allocated to any image as an aide to file organising.</para>\r
+  <section id="GuideImageSearchCache">\r
+    <title id="titleGuideImageSearchCache">Caching Data For Searches</title>\r
+    <para>\r
+      Searching large numbers of files for similarity can take significant cpu time. Part of this is the time to compute the similarity matrix for each file.\r
+      <para />\r
+      If the\r
+      <link linkend="PreferencesThumbnails">Cache Thumbnails</link>\r
+      option is selected in Preferences/General, the similarity matrix and the checksum will also be cached. This will reduce the time needed for future searches.\r
+      <note>If you frequently search on similarity and your images are in a tree arrangement under a single point, initiating a one-time search on similarity from the top of the tree will generate the similarity data for all images.</note>\r
+      <para>Similarity data are stored in a folder hierachy that mirrors the location of the source images. The data have the same name as the original appended by the file extension .sim.</para>\r
+      <para>\r
+        The root of the hierachy is:\r
+        <para>\r
+          <programlisting>$XDG_CACHE_HOME/geeqie/thumbnails/</programlisting>\r
+          or, if $XDG_CACHE_HOME is not defined:\r
+          <programlisting>$HOME/.cache/geeqie/thumbnails/</programlisting>\r
+        </para>\r
+      </para>\r
+    </para>\r
+    <para />\r
+  </section>\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageSearchSearch.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageSearchFindingDuplicates.xml" />\r
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageMarks.xml" />\r
   <para />\r
-</chapter>
+</chapter>\r