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