e29738c606a558629d3125d4760ded4cfa3990db
[platform/upstream/fontconfig.git] / doc / fccache.sgml
1 <!--
2    fontconfig/doc/func.sgml
3   
4    Copyright © 2003 Keith Packard
5   
6    Permission to use, copy, modify, distribute, and sell this software and its
7    documentation for any purpose is hereby granted without fee, provided that
8    the above copyright notice appear in all copies and that both that
9    copyright notice and this permission notice appear in supporting
10    documentation, and that the name of the author(s) not be used in
11    advertising or publicity pertaining to distribution of the software without
12    specific, written prior permission.  The authors make no
13    representations about the suitability of this software for any purpose.  It
14    is provided "as is" without express or implied warranty.
15   
16    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22    PERFORMANCE OF THIS SOFTWARE.
23  -->
24     <refentry id="FcCacheDir">
25         <refmeta>
26             <refentrytitle>FcCacheDir</refentrytitle>
27             <manvolnum>3</manvolnum>
28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
29         </refmeta>
30         <refnamediv>
31             <refname>FcCacheDir</refname>
32             <refpurpose>Return directory of <parameter>cache</parameter></refpurpose>
33         </refnamediv>
34         <refsynopsisdiv>
35         <funcsynopsis>
36         <funcsynopsisinfo>
37 #include &lt;fontconfig/fontconfig.h&gt;
38         </funcsynopsisinfo>
39         <funcprototype>
40             <funcdef>const FcChar8 * <function>FcCacheDir</function></funcdef>
41                 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
42         </funcprototype>
43         </funcsynopsis>
44         </refsynopsisdiv>
45         <refsect1><title>Description</title>
46             <para>
47 This function returns the directory from which the cache was constructed.
48             </para>
49         </refsect1>
50     </refentry>
51 <!--
52    fontconfig/doc/func.sgml
53   
54    Copyright © 2003 Keith Packard
55   
56    Permission to use, copy, modify, distribute, and sell this software and its
57    documentation for any purpose is hereby granted without fee, provided that
58    the above copyright notice appear in all copies and that both that
59    copyright notice and this permission notice appear in supporting
60    documentation, and that the name of the author(s) not be used in
61    advertising or publicity pertaining to distribution of the software without
62    specific, written prior permission.  The authors make no
63    representations about the suitability of this software for any purpose.  It
64    is provided "as is" without express or implied warranty.
65   
66    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
67    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
68    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
69    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
70    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
71    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
72    PERFORMANCE OF THIS SOFTWARE.
73  -->
74     <refentry id="FcCacheCopySet">
75         <refmeta>
76             <refentrytitle>FcCacheCopySet</refentrytitle>
77             <manvolnum>3</manvolnum>
78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
79         </refmeta>
80         <refnamediv>
81             <refname>FcCacheCopySet</refname>
82             <refpurpose>Returns a copy of the fontset from <parameter>cache</parameter></refpurpose>
83         </refnamediv>
84         <refsynopsisdiv>
85         <funcsynopsis>
86         <funcsynopsisinfo>
87 #include &lt;fontconfig/fontconfig.h&gt;
88         </funcsynopsisinfo>
89         <funcprototype>
90             <funcdef>FcFontSet * <function>FcCacheCopySet</function></funcdef>
91                 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
92         </funcprototype>
93         </funcsynopsis>
94         </refsynopsisdiv>
95         <refsect1><title>Description</title>
96             <para>
97 The returned fontset contains each of the font patterns from
98 <parameter>cache</parameter>. This fontset may be modified, but the patterns
99 from the cache are read-only.
100             </para>
101         </refsect1>
102     </refentry>
103 <!--
104    fontconfig/doc/func.sgml
105   
106    Copyright © 2003 Keith Packard
107   
108    Permission to use, copy, modify, distribute, and sell this software and its
109    documentation for any purpose is hereby granted without fee, provided that
110    the above copyright notice appear in all copies and that both that
111    copyright notice and this permission notice appear in supporting
112    documentation, and that the name of the author(s) not be used in
113    advertising or publicity pertaining to distribution of the software without
114    specific, written prior permission.  The authors make no
115    representations about the suitability of this software for any purpose.  It
116    is provided "as is" without express or implied warranty.
117   
118    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
119    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
120    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
121    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
122    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
123    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
124    PERFORMANCE OF THIS SOFTWARE.
125  -->
126     <refentry id="FcCacheSubdir">
127         <refmeta>
128             <refentrytitle>FcCacheSubdir</refentrytitle>
129             <manvolnum>3</manvolnum>
130             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
131         </refmeta>
132         <refnamediv>
133             <refname>FcCacheSubdir</refname>
134             <refpurpose>Return the <parameter>i</parameter>'th subdirectory.</refpurpose>
135         </refnamediv>
136         <refsynopsisdiv>
137         <funcsynopsis>
138         <funcsynopsisinfo>
139 #include &lt;fontconfig/fontconfig.h&gt;
140         </funcsynopsisinfo>
141         <funcprototype>
142             <funcdef>const FcChar8 * <function>FcCacheSubdir</function></funcdef>
143                 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
144                 <paramdef>int<parameter>i</parameter></paramdef>
145         </funcprototype>
146         </funcsynopsis>
147         </refsynopsisdiv>
148         <refsect1><title>Description</title>
149             <para>
150 The set of subdirectories stored in a cache file are indexed by this
151 function, <parameter>i</parameter> should range from 0 to
152 <parameter>n</parameter>-1, where <parameter>n</parameter> is the return
153 value from FcCacheNumSubdir.
154             </para>
155         </refsect1>
156     </refentry>
157 <!--
158    fontconfig/doc/func.sgml
159   
160    Copyright © 2003 Keith Packard
161   
162    Permission to use, copy, modify, distribute, and sell this software and its
163    documentation for any purpose is hereby granted without fee, provided that
164    the above copyright notice appear in all copies and that both that
165    copyright notice and this permission notice appear in supporting
166    documentation, and that the name of the author(s) not be used in
167    advertising or publicity pertaining to distribution of the software without
168    specific, written prior permission.  The authors make no
169    representations about the suitability of this software for any purpose.  It
170    is provided "as is" without express or implied warranty.
171   
172    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
173    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
174    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
175    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
176    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
177    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
178    PERFORMANCE OF THIS SOFTWARE.
179  -->
180     <refentry id="FcCacheNumSubdir">
181         <refmeta>
182             <refentrytitle>FcCacheNumSubdir</refentrytitle>
183             <manvolnum>3</manvolnum>
184             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
185         </refmeta>
186         <refnamediv>
187             <refname>FcCacheNumSubdir</refname>
188             <refpurpose>Return the number of subdirectories in <parameter>cache</parameter>.</refpurpose>
189         </refnamediv>
190         <refsynopsisdiv>
191         <funcsynopsis>
192         <funcsynopsisinfo>
193 #include &lt;fontconfig/fontconfig.h&gt;
194         </funcsynopsisinfo>
195         <funcprototype>
196             <funcdef>int <function>FcCacheNumSubdir</function></funcdef>
197                 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
198         </funcprototype>
199         </funcsynopsis>
200         </refsynopsisdiv>
201         <refsect1><title>Description</title>
202             <para>
203 This returns the total number of subdirectories in the cache.
204             </para>
205         </refsect1>
206     </refentry>
207 <!--
208    fontconfig/doc/func.sgml
209   
210    Copyright © 2003 Keith Packard
211   
212    Permission to use, copy, modify, distribute, and sell this software and its
213    documentation for any purpose is hereby granted without fee, provided that
214    the above copyright notice appear in all copies and that both that
215    copyright notice and this permission notice appear in supporting
216    documentation, and that the name of the author(s) not be used in
217    advertising or publicity pertaining to distribution of the software without
218    specific, written prior permission.  The authors make no
219    representations about the suitability of this software for any purpose.  It
220    is provided "as is" without express or implied warranty.
221   
222    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
223    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
224    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
225    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
226    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
227    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
228    PERFORMANCE OF THIS SOFTWARE.
229  -->
230     <refentry id="FcCacheNumFont">
231         <refmeta>
232             <refentrytitle>FcCacheNumFont</refentrytitle>
233             <manvolnum>3</manvolnum>
234             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
235         </refmeta>
236         <refnamediv>
237             <refname>FcCacheNumFont</refname>
238             <refpurpose>Returns the number of fonts in <parameter>cache</parameter>.</refpurpose>
239         </refnamediv>
240         <refsynopsisdiv>
241         <funcsynopsis>
242         <funcsynopsisinfo>
243 #include &lt;fontconfig/fontconfig.h&gt;
244         </funcsynopsisinfo>
245         <funcprototype>
246             <funcdef>int <function>FcCacheNumFont</function></funcdef>
247                 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
248         </funcprototype>
249         </funcsynopsis>
250         </refsynopsisdiv>
251         <refsect1><title>Description</title>
252             <para>
253 This returns the number of fonts which would be included in the return from
254 FcCacheCopySet.
255             </para>
256         </refsect1>
257     </refentry>
258 <!--
259    fontconfig/doc/func.sgml
260   
261    Copyright © 2003 Keith Packard
262   
263    Permission to use, copy, modify, distribute, and sell this software and its
264    documentation for any purpose is hereby granted without fee, provided that
265    the above copyright notice appear in all copies and that both that
266    copyright notice and this permission notice appear in supporting
267    documentation, and that the name of the author(s) not be used in
268    advertising or publicity pertaining to distribution of the software without
269    specific, written prior permission.  The authors make no
270    representations about the suitability of this software for any purpose.  It
271    is provided "as is" without express or implied warranty.
272   
273    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
274    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
275    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
276    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
277    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
278    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
279    PERFORMANCE OF THIS SOFTWARE.
280  -->
281     <refentry id="FcDirCacheClean">
282         <refmeta>
283             <refentrytitle>FcDirCacheClean</refentrytitle>
284             <manvolnum>3</manvolnum>
285             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
286         </refmeta>
287         <refnamediv>
288             <refname>FcDirCacheClean</refname>
289             <refpurpose>Clean up a cache directory</refpurpose>
290         </refnamediv>
291         <refsynopsisdiv>
292         <funcsynopsis>
293         <funcsynopsisinfo>
294 #include &lt;fontconfig/fontconfig.h&gt;
295         </funcsynopsisinfo>
296         <funcprototype>
297             <funcdef>FcBool <function>FcDirCacheClean</function></funcdef>
298                 <paramdef>const FcChar8 *<parameter>cache_dir</parameter></paramdef>
299                 <paramdef>FcBool<parameter>verbose</parameter></paramdef>
300         </funcprototype>
301         </funcsynopsis>
302         </refsynopsisdiv>
303         <refsect1><title>Description</title>
304             <para>
305 This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
306 This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
307             </para>
308         </refsect1>
309         <refsect1><title>Since</title>
310             <para>version 2.9.91</para>
311         </refsect1>
312     </refentry>
313 <!--
314    fontconfig/doc/func.sgml
315   
316    Copyright © 2003 Keith Packard
317   
318    Permission to use, copy, modify, distribute, and sell this software and its
319    documentation for any purpose is hereby granted without fee, provided that
320    the above copyright notice appear in all copies and that both that
321    copyright notice and this permission notice appear in supporting
322    documentation, and that the name of the author(s) not be used in
323    advertising or publicity pertaining to distribution of the software without
324    specific, written prior permission.  The authors make no
325    representations about the suitability of this software for any purpose.  It
326    is provided "as is" without express or implied warranty.
327   
328    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
329    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
330    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
331    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
332    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
333    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
334    PERFORMANCE OF THIS SOFTWARE.
335  -->
336     <refentry id="FcCacheCreateTagFile">
337         <refmeta>
338             <refentrytitle>FcCacheCreateTagFile</refentrytitle>
339             <manvolnum>3</manvolnum>
340             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
341         </refmeta>
342         <refnamediv>
343             <refname>FcCacheCreateTagFile</refname>
344             <refpurpose>Create CACHEDIR.TAG at cache directory.</refpurpose>
345         </refnamediv>
346         <refsynopsisdiv>
347         <funcsynopsis>
348         <funcsynopsisinfo>
349 #include &lt;fontconfig/fontconfig.h&gt;
350         </funcsynopsisinfo>
351         <funcprototype>
352             <funcdef>void <function>FcCacheCreateTagFile</function></funcdef>
353                 <paramdef>const FcConfig *<parameter>config</parameter></paramdef>
354         </funcprototype>
355         </funcsynopsis>
356         </refsynopsisdiv>
357         <refsect1><title>Description</title>
358             <para>
359 This tries to create CACHEDIR.TAG file at the cache directory registered
360 to <parameter>config</parameter>.
361             </para>
362         </refsect1>
363         <refsect1><title>Since</title>
364             <para>version 2.9.91</para>
365         </refsect1>
366     </refentry>
367 <!--
368    fontconfig/doc/func.sgml
369   
370    Copyright © 2003 Keith Packard
371   
372    Permission to use, copy, modify, distribute, and sell this software and its
373    documentation for any purpose is hereby granted without fee, provided that
374    the above copyright notice appear in all copies and that both that
375    copyright notice and this permission notice appear in supporting
376    documentation, and that the name of the author(s) not be used in
377    advertising or publicity pertaining to distribution of the software without
378    specific, written prior permission.  The authors make no
379    representations about the suitability of this software for any purpose.  It
380    is provided "as is" without express or implied warranty.
381   
382    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
383    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
384    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
385    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
386    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
387    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
388    PERFORMANCE OF THIS SOFTWARE.
389  -->
390     <refentry id="FcDirCacheCreateUUID">
391         <refmeta>
392             <refentrytitle>FcDirCacheCreateUUID</refentrytitle>
393             <manvolnum>3</manvolnum>
394             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
395         </refmeta>
396         <refnamediv>
397             <refname>FcDirCacheCreateUUID</refname>
398             <refpurpose>Create .uuid file at a directory</refpurpose>
399         </refnamediv>
400         <refsynopsisdiv>
401         <funcsynopsis>
402         <funcsynopsisinfo>
403 #include &lt;fontconfig/fontconfig.h&gt;
404         </funcsynopsisinfo>
405         <funcprototype>
406             <funcdef>FcBool <function>FcDirCacheCreateUUID</function></funcdef>
407                 <paramdef>FcChar8 *<parameter>dir</parameter></paramdef>
408                 <paramdef>FcBool<parameter>force</parameter></paramdef>
409                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
410         </funcprototype>
411         </funcsynopsis>
412         </refsynopsisdiv>
413         <refsect1><title>Description</title>
414             <para>
415 This is to create .uuid file containing an UUID at a font directory of
416 <parameter>dir</parameter>.
417 The UUID will be used to identify the font directory and is used to determine
418 the cache filename if available.
419             </para>
420         </refsect1>
421         <refsect1><title>Since</title>
422             <para>version 2.12.92</para>
423         </refsect1>
424     </refentry>
425 <!--
426    fontconfig/doc/func.sgml
427   
428    Copyright © 2003 Keith Packard
429   
430    Permission to use, copy, modify, distribute, and sell this software and its
431    documentation for any purpose is hereby granted without fee, provided that
432    the above copyright notice appear in all copies and that both that
433    copyright notice and this permission notice appear in supporting
434    documentation, and that the name of the author(s) not be used in
435    advertising or publicity pertaining to distribution of the software without
436    specific, written prior permission.  The authors make no
437    representations about the suitability of this software for any purpose.  It
438    is provided "as is" without express or implied warranty.
439   
440    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
441    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
442    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
443    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
444    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
445    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
446    PERFORMANCE OF THIS SOFTWARE.
447  -->
448     <refentry id="FcDirCacheDeleteUUID">
449         <refmeta>
450             <refentrytitle>FcDirCacheDeleteUUID</refentrytitle>
451             <manvolnum>3</manvolnum>
452             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
453         </refmeta>
454         <refnamediv>
455             <refname>FcDirCacheDeleteUUID</refname>
456             <refpurpose>Delete .uuid file</refpurpose>
457         </refnamediv>
458         <refsynopsisdiv>
459         <funcsynopsis>
460         <funcsynopsisinfo>
461 #include &lt;fontconfig/fontconfig.h&gt;
462         </funcsynopsisinfo>
463         <funcprototype>
464             <funcdef>FcBool <function>FcDirCacheDeleteUUID</function></funcdef>
465                 <paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
466                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
467         </funcprototype>
468         </funcsynopsis>
469         </refsynopsisdiv>
470         <refsect1><title>Description</title>
471             <para>
472 This is to delete .uuid file containing an UUID at a font directory of
473 <parameter>dir</parameter>.
474             </para>
475         </refsect1>
476         <refsect1><title>Since</title>
477             <para>version 2.13.1</para>
478         </refsect1>
479     </refentry>