2 fontconfig/doc/func.sgml
4 Copyright © 2003 Keith Packard
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.
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.
24 <refentry id="FcCacheDir">
26 <refentrytitle>FcCacheDir</refentrytitle>
27 <manvolnum>3</manvolnum>
28 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
31 <refname>FcCacheDir</refname>
32 <refpurpose>Return directory of <parameter>cache</parameter></refpurpose>
37 #include <fontconfig/fontconfig.h>
40 <funcdef>const FcChar8 * <function>FcCacheDir</function></funcdef>
41 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
45 <refsect1><title>Description</title>
47 This function returns the directory from which the cache was constructed.
52 fontconfig/doc/func.sgml
54 Copyright © 2003 Keith Packard
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.
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.
74 <refentry id="FcCacheCopySet">
76 <refentrytitle>FcCacheCopySet</refentrytitle>
77 <manvolnum>3</manvolnum>
78 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
81 <refname>FcCacheCopySet</refname>
82 <refpurpose>Returns a copy of the fontset from <parameter>cache</parameter></refpurpose>
87 #include <fontconfig/fontconfig.h>
90 <funcdef>FcFontSet * <function>FcCacheCopySet</function></funcdef>
91 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
95 <refsect1><title>Description</title>
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.
104 fontconfig/doc/func.sgml
106 Copyright © 2003 Keith Packard
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.
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.
126 <refentry id="FcCacheSubdir">
128 <refentrytitle>FcCacheSubdir</refentrytitle>
129 <manvolnum>3</manvolnum>
130 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
133 <refname>FcCacheSubdir</refname>
134 <refpurpose>Return the <parameter>i</parameter>'th subdirectory.</refpurpose>
139 #include <fontconfig/fontconfig.h>
142 <funcdef>const FcChar8 * <function>FcCacheSubdir</function></funcdef>
143 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
144 <paramdef>int<parameter>i</parameter></paramdef>
148 <refsect1><title>Description</title>
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.
158 fontconfig/doc/func.sgml
160 Copyright © 2003 Keith Packard
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.
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.
180 <refentry id="FcCacheNumSubdir">
182 <refentrytitle>FcCacheNumSubdir</refentrytitle>
183 <manvolnum>3</manvolnum>
184 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
187 <refname>FcCacheNumSubdir</refname>
188 <refpurpose>Return the number of subdirectories in <parameter>cache</parameter>.</refpurpose>
193 #include <fontconfig/fontconfig.h>
196 <funcdef>int <function>FcCacheNumSubdir</function></funcdef>
197 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
201 <refsect1><title>Description</title>
203 This returns the total number of subdirectories in the cache.
208 fontconfig/doc/func.sgml
210 Copyright © 2003 Keith Packard
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.
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.
230 <refentry id="FcCacheNumFont">
232 <refentrytitle>FcCacheNumFont</refentrytitle>
233 <manvolnum>3</manvolnum>
234 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
237 <refname>FcCacheNumFont</refname>
238 <refpurpose>Returns the number of fonts in <parameter>cache</parameter>.</refpurpose>
243 #include <fontconfig/fontconfig.h>
246 <funcdef>int <function>FcCacheNumFont</function></funcdef>
247 <paramdef>const FcCache *<parameter>cache</parameter></paramdef>
251 <refsect1><title>Description</title>
253 This returns the number of fonts which would be included in the return from
259 fontconfig/doc/func.sgml
261 Copyright © 2003 Keith Packard
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.
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.
281 <refentry id="FcDirCacheClean">
283 <refentrytitle>FcDirCacheClean</refentrytitle>
284 <manvolnum>3</manvolnum>
285 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
288 <refname>FcDirCacheClean</refname>
289 <refpurpose>This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
290 This returns FcTrue if the operation is successfully complete. otherwise FcFalse.</refpurpose>
295 #include <fontconfig/fontconfig.h>
298 <funcdef>FcBool <function>FcDirCacheClean</function></funcdef>
299 <paramdef>const FcChar8 *<parameter>cache_dir</parameter></paramdef>
300 <paramdef>FcBool<parameter>verbose</parameter></paramdef>
304 <refsect1><title>Description</title>
309 <refsect1><title>Since</title>
310 <para>version 2.9.91</para>
314 fontconfig/doc/func.sgml
316 Copyright © 2003 Keith Packard
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.
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.
336 <refentry id="FcCacheCreateTagFile">
338 <refentrytitle>FcCacheCreateTagFile</refentrytitle>
339 <manvolnum>3</manvolnum>
340 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
343 <refname>FcCacheCreateTagFile</refname>
344 <refpurpose>Create CACHEDIR.TAG at cache directory.</refpurpose>
349 #include <fontconfig/fontconfig.h>
352 <funcdef>void <function>FcCacheCreateTagFile</function></funcdef>
353 <paramdef>const FcConfig *<parameter>config</parameter></paramdef>
357 <refsect1><title>Description</title>
359 This tries to create CACHEDIR.TAG file at the cache directory registered
360 to <parameter>config</parameter>.
363 <refsect1><title>Since</title>
364 <para>version 2.9.91</para>