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