Remove commented out code.
[geeqie.git] / doc / docbook / GuideReferenceManagement.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideReferenceManagement">
3     <title>
4       Cache and Data Maintenance
5     </title>
6     <para>
7       Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window.
8     </para>
9     <para/><section id="Geeqiethumbnailcache"><title>
10       Geeqie thumbnail cache
11     </title>
12     <para>
13       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.
14     </para>
15     <variablelist><varlistentry><term>
16         Clean up
17       </term><listitem><para/></listitem></varlistentry></variablelist>
18     <para>
19       Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.
20     </para>
21     <variablelist><varlistentry><term>
22         Clear cache
23       </term><listitem><para/></listitem></varlistentry></variablelist>
24     <para>
25       Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails.
26     </para>
27     <para/></section><section id="Sharedthumbnailcache"><title>
28       Shared thumbnail cache
29     </title>
30     <para>
31       The utilities listed here operate on the shared thumbnail mechanism.
32     </para>
33     <variablelist><varlistentry><term>
34         Clean up
35       </term><listitem><para/></listitem></varlistentry></variablelist>
36     <para>
37       Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.
38     </para>
39     <variablelist><varlistentry><term>
40         Clear cache
41       </term><listitem><para/></listitem></varlistentry></variablelist>
42     <para>
43       Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails.
44     </para>
45     <para/></section><section id="Createthumbnails"><title>
46       Create thumbnails
47     </title>
48     <para>
49       This utility will render thumbnails using the current thumbnail caching mechanism, as determined in <link linkend="GuideOptionsGeneral">preferences</link>.
50     </para>
51     <variablelist><varlistentry><term>
52         Render
53       </term><listitem><para/></listitem></varlistentry></variablelist>
54     <para>
55       Pre-render thumbnails for a specific folder, the utility has the following options:
56     </para>
57     <variablelist><varlistentry><term>
58         Include subfolders
59       </term><listitem><para/></listitem></varlistentry></variablelist>
60     <para>
61       Enable to include all images contained in the subfolders of folder.
62     </para>
63     <variablelist><varlistentry><term>
64         Store thumbnails local to source images
65       </term><listitem><para/></listitem></varlistentry></variablelist>
66     <para>
67       The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images.
68     </para>
69     <para/></section><section id="Metadata"><title>
70       Metadata
71     </title>
72     <para>
73       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.
74     </para>
75     <variablelist><varlistentry><term>
76         Clean up
77       </term><listitem><para/></listitem></varlistentry></variablelist>
78     <para>
79       Removes keywords and comments for which the source image is no longer present.
80     </para>
81     <para/></section><section id="Filelocations"><title>
82       File locations
83     </title>
84     <para>
85       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.
86     </para>
87     <informaltable><tgroup cols="2"><tbody><row><entry>
88           Folder or File name
89         </entry><entry>
90           Description
91         </entry></row>
92 <row><entry>
93           Thumbnails
94         </entry></row>
95 <row><entry>
96           <emphasis role="i">&lt;HOME&gt;</emphasis>/.thumbnails
97         </entry><entry>
98           Shared thumbnail cache folder.
99         </entry></row>
100 <row><entry>
101           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/thumbnails
102         </entry><entry>
103           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.
104         </entry></row>
105 <row><entry>
106           <emphasis role="i">&lt;SOURCE&gt;/.</emphasis>thumbnails
107         </entry><entry>
108           Local thumbnail cache folder.
109         </entry></row>
110 <row><entry>
111           Metadata (keywords and comments)
112         </entry></row>
113 <row><entry>
114           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/metadata
115         </entry><entry>
116           Metadata stored in user's home folder.
117         </entry></row>
118 <row><entry>
119           <emphasis role="i">&lt;SOURCE&gt;</emphasis>/.metadata
120         </entry><entry>
121           Metadata stored local to source image. Requires option to be enabled in advanced preferences.
122         </entry></row>
123 <row><entry>
124           Collections
125         </entry></row>
126 <row><entry>
127           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/collections
128         </entry><entry>
129           Default location for Geeqie collections, collections in this folder will appear in the <link linkend="GuideSidebarsSortManager">sort manager</link> sidebar.
130         </entry></row>
131 <row><entry>
132           Preferences
133         </entry></row>
134 <row><entry>
135           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie
136         </entry><entry>
137           Geeqie preferences folder.
138         </entry></row>
139 <row><entry>
140           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/geeqierc
141         </entry><entry>
142           Geeqie preferences rc file.
143         </entry></row>
144 <row><entry>
145           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/history
146         </entry><entry>
147           Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings.
148         </entry></row>
149 <row><entry>
150           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/accels
151         </entry><entry>
152           Keyboard shortcut mapping.
153         </entry></row>
154 <row><entry>
155           Safe Delete
156         </entry></row>
157 <row><entry>
158           <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/trash
159         </entry><entry>
160           Default location of the safe delete folder.
161         </entry></row>
162 </tbody></tgroup></informaltable>
163   <para/></section></section>