doc/docbook/GuideReferenceManagement.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideReferenceManagement">
   3   <title id="titleGuideReferenceManagement">Cache and Data Maintenance</title>
   4   <para>
   5     Thumbnails and other cached data can be maintained from the dialog accessible by selecting
   6     <menuchoice>
   7       <guimenu>Edit</guimenu>
   8       <guimenuitem>Cache maintenance</guimenuitem>
   9     </menuchoice>
  10     .
  11   </para>
  12   <para />
  13   <section id="Geeqiethumbnailcache">
  14     <title>Geeqie thumbnail and sim. cache</title>
  15     <para>
  16       The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the
  17       <link linkend="GuideImageSearchSearch">search</link>
  18       and
  19       <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link>
  20       utilities.
  21     </para>
  22     <variablelist>
  23       <varlistentry>
  24         <term>
  25           <guilabel>Clean up</guilabel>
  26         </term>
  27         <listitem>
  28           <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>
  29         </listitem>
  30       </varlistentry>
  31       <varlistentry>
  32         <term>
  33           <guilabel>Clear cache</guilabel>
  34         </term>
  35         <listitem>
  36           <para>Removes all thumbnails, sim. files, and data stored in the designated folder.</para>
  37         </listitem>
  38       </varlistentry>
  39     </variablelist>
  40   </section>
  41   <section id="Sharedthumbnailcache">
  42     <title>Shared thumbnail cache</title>
  43     <para>The utilities listed here operate on the shared thumbnail mechanism.</para>
  44     <variablelist>
  45       <varlistentry>
  46         <term>
  47           <guilabel>Clean up</guilabel>
  48         </term>
  49         <listitem>
  50           <para>Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.</para>
  51         </listitem>
  52       </varlistentry>
  53       <varlistentry>
  54         <term>
  55           <guilabel>Clear cache</guilabel>
  56         </term>
  57         <listitem>
  58           <para>Removes all thumbnails stored in the designated folder.</para>
  59         </listitem>
  60       </varlistentry>
  61     </variablelist>
  62   </section>
  63   <section id="Createthumbnails">
  64     <title>Create thumbnails</title>
  65     <para>
  66       This utility will render thumbnails using the current thumbnail caching mechanism, as determined in
  67       <link linkend="GuideOptionsGeneral">Preferences</link>
  68       .
  69     </para>
  70     <variablelist>
  71       <varlistentry>
  72         <term>
  73           <guilabel>Render</guilabel>
  74         </term>
  75         <listitem>
  76           <para>Pre-render thumbnails for a specific folder, the utility has the following options:</para>
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term>
  81           <guilabel>Include subfolders</guilabel>
  82         </term>
  83         <listitem>
  84           <para>Enable to include all images contained in the subfolders of folder.</para>
  85         </listitem>
  86       </varlistentry>
  87       <varlistentry>
  88         <term>
  89           <guilabel>Store thumbnails local to source images</guilabel>
  90         </term>
  91         <listitem>
  92           <para>The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images.</para>
  93         </listitem>
  94       </varlistentry>
  95     </variablelist>
  96   </section>
  97   <section id="CreateSimFiles">
  98     <title>Create file similarity cache</title>
  99     <para>
 100       Some file operations, such as
 101       <link linkend="GuideImageSearchSearch">search</link>
 102       and
 103       <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link>
 104       , are speeded up if similarity data files for the images have been created. This utility will create sim. files recursively under the specified folder.
 105       <para />
 106       The sim. files contain some or all of the following fields:
 107       <variablelist>
 108         <varlistentry>
 109           <term>
 110             <guilabel>Dimensions</guilabel>
 111           </term>
 112           <listitem>
 113             <para>width x height</para>
 114           </listitem>
 115         </varlistentry>
 116         <varlistentry>
 117           <term>
 118             <guilabel>Date</guilabel>
 119           </term>
 120           <listitem>
 121             <para>Exif date in time_t format</para>
 122           </listitem>
 123         </varlistentry>
 124         <varlistentry>
 125           <term>
 126             <guilabel>checksum</guilabel>
 127           </term>
 128           <listitem>
 129             <para>MD5sum 32 character ascii text digest</para>
 130           </listitem>
 131         </varlistentry>
 132         <varlistentry>
 133           <term>
 134             <guilabel>SimilarityGrid</guilabel>
 135           </term>
 136           <listitem>
 137             <para>[32 x 32] = 3072 bytes of data (1024 pixels in RGB format, 1 pixel is 24bits)</para>
 138           </listitem>
 139         </varlistentry>
 140       </variablelist>
 141     </para>
 142   </section>
 143   <section id="Metadata">
 144     <title>Metadata</title>
 145     <para>
 146       This utility operates on the data store for
 147       <link linkend="MetadataWritingProcess">Metadata</link>
 148       located in the folder:
 149       <programlisting>$HOME/.local/share/Geeqie/metadata</programlisting>
 150     </para>
 151     <variablelist>
 152       <varlistentry>
 153         <term>
 154           <guilabel>Clean up</guilabel>
 155         </term>
 156         <listitem>
 157           <para>Removes keywords and comments for which the source image is no longer present.</para>
 158           <para />
 159           <para />
 160         </listitem>
 161       </varlistentry>
 162     </variablelist>
 163   </section>
 164   <section id="BackgroundCacheMaintenance">
 165     <title>Background Cache Maintenance</title>
 166     <para>
 167       This facility will run the command line program described below as a stand-alone background job.
 168     </para>
 169   </section>
 170   <section id="CacheMaintenance">
 171     <title>Command line program</title>
 172     <para>
 173       Geeqie can be run as a command line program: <code>geeqie --cache-maintenance &lt;path to images&gt;</code>. It will recursively remove orphaned thumbnails and .sim files, and create thumbnails and similarity data for all images found.
 174     <para/>
 175       It may also be called from <code>cron</code> or <code>anacron</code> thus enabling automatic updating of the cached data for all your images.
 176     </para>
 177   </section>
 178 </section>