diff doc/docbook/GuideReferenceManagement.xml @ 1773:2ae81598b254

scripts for converting wiki documentation to docbook
author nadvornik
date Sun, 22 Nov 2009 09:12:22 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/docbook/GuideReferenceManagement.xml	Sun Nov 22 09:12:22 2009 +0000
@@ -0,0 +1,163 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section id="GuideReferenceManagement">
+    <title>
+      Cache and Data Maintenance
+    </title>
+    <para>
+      Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window.
+    </para>
+    <para/><section id="Geeqiethumbnailcache"><title>
+      Geeqie thumbnail cache
+    </title>
+    <para>
+      The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the <link linkend="GuideImageSearchSearch">search</link> and <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> utilities.
+    </para>
+    <variablelist><varlistentry><term>
+        Clean up
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.
+    </para>
+    <variablelist><varlistentry><term>
+        Clear cache
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails.
+    </para>
+    <para/></section><section id="Sharedthumbnailcache"><title>
+      Shared thumbnail cache
+    </title>
+    <para>
+      The utilities listed here operate on the shared thumbnail mechanism.
+    </para>
+    <variablelist><varlistentry><term>
+        Clean up
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.
+    </para>
+    <variablelist><varlistentry><term>
+        Clear cache
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails.
+    </para>
+    <para/></section><section id="Createthumbnails"><title>
+      Create thumbnails
+    </title>
+    <para>
+      This utility will render thumbnails using the current thumbnail caching mechanism, as determined in <link linkend="GuideOptionsGeneral">preferences</link>.
+    </para>
+    <variablelist><varlistentry><term>
+        Render
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Pre-render thumbnails for a specific folder, the utility has the following options:
+    </para>
+    <variablelist><varlistentry><term>
+        Include subfolders
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Enable to include all images contained in the subfolders of folder.
+    </para>
+    <variablelist><varlistentry><term>
+        Store thumbnails local to source images
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <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>
+    <para/></section><section id="Metadata"><title>
+      Metadata
+    </title>
+    <para>
+      This utility operates on the data store for <link linkend="GuideSidebarsKeywords">keywords and comments?</link> located in the user's home folder: $HOME/.geeqie/metadata.
+    </para>
+    <variablelist><varlistentry><term>
+        Clean up
+      </term><listitem><para/></listitem></varlistentry></variablelist>
+    <para>
+      Removes keywords and comments for which the source image is no longer present.
+    </para>
+    <para/></section><section id="Filelocations"><title>
+      File locations
+    </title>
+    <para>
+      The various file locations and their use are listed below. <emphasis role="i">&amp;lt;HOME&amp;gt;</emphasis> refers to your home folder and <emphasis role="i">&amp;lt;SOURCE&amp;gt;</emphasis> refers to the folder containing the image.
+    </para>
+    <informaltable><tgroup cols="2"><tbody><row><entry>
+          Folder or File name
+        </entry><entry>
+          Description
+        </entry></row>
+<row><entry>
+          Thumbnails
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.thumbnails
+        </entry><entry>
+          Shared thumbnail cache folder.
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/thumbnails
+        </entry><entry>
+          Classic Geeqie thumbnail cache folder. Also used to cache data used for the search and find duplicates utilities to increase the speed for subsequent searches.
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;SOURCE&gt;/.</emphasis>thumbnails
+        </entry><entry>
+          Local thumbnail cache folder.
+        </entry></row>
+<row><entry>
+          Metadata (keywords and comments)
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/metadata
+        </entry><entry>
+          Metadata stored in user's home folder.
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;SOURCE&gt;</emphasis>/.metadata
+        </entry><entry>
+          Metadata stored local to source image. Requires option to be enabled in advanced preferences.
+        </entry></row>
+<row><entry>
+          Collections
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/collections
+        </entry><entry>
+          Default location for Geeqie collections, collections in this folder will appear in the <link linkend="GuideSidebarsSortManager">sort manager</link> sidebar.
+        </entry></row>
+<row><entry>
+          Preferences
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie
+        </entry><entry>
+          Geeqie preferences folder.
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/geeqierc
+        </entry><entry>
+          Geeqie preferences rc file.
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/history
+        </entry><entry>
+          Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings.
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/accels
+        </entry><entry>
+          Keyboard shortcut mapping.
+        </entry></row>
+<row><entry>
+          Safe Delete
+        </entry></row>
+<row><entry>
+          <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/trash
+        </entry><entry>
+          Default location of the safe delete folder.
+        </entry></row>
+</tbody></tgroup></informaltable>
+  <para/></section></section>