doc/fcconfig.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="FcConfigCreate">
  25         <refmeta>
  26             <refentrytitle>FcConfigCreate</refentrytitle>
  27             <manvolnum>3</manvolnum>
  28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  29         </refmeta>
  30         <refnamediv>
  31             <refname>FcConfigCreate</refname>
  32             <refpurpose>Create a configuration</refpurpose>
  33         </refnamediv>
  34         <refsynopsisdiv>
  35         <funcsynopsis>
  36         <funcsynopsisinfo>
  37 #include &lt;fontconfig/fontconfig.h&gt;
  38         </funcsynopsisinfo>
  39         <funcprototype>
  40             <funcdef>FcConfig * <function>FcConfigCreate</function></funcdef>
  41                 <paramdef>void<parameter></parameter></paramdef>
  42         </funcprototype>
  43         </funcsynopsis>
  44         </refsynopsisdiv>
  45         <refsect1><title>Description</title>
  46             <para>
  47 Creates an empty configuration.
  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="FcConfigReference">
  75         <refmeta>
  76             <refentrytitle>FcConfigReference</refentrytitle>
  77             <manvolnum>3</manvolnum>
  78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  79         </refmeta>
  80         <refnamediv>
  81             <refname>FcConfigReference</refname>
  82             <refpurpose>Increment config reference count</refpurpose>
  83         </refnamediv>
  84         <refsynopsisdiv>
  85         <funcsynopsis>
  86         <funcsynopsisinfo>
  87 #include &lt;fontconfig/fontconfig.h&gt;
  88         </funcsynopsisinfo>
  89         <funcprototype>
  90             <funcdef>FcConfig * <function>FcConfigReference</function></funcdef>
  91                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
  92         </funcprototype>
  93         </funcsynopsis>
  94         </refsynopsisdiv>
  95         <refsect1><title>Description</title>
  96             <para>
  97 Add another reference to <parameter>config</parameter>. Configs are freed only
  98 when the reference count reaches zero.
  99 If <parameter>config</parameter> is NULL, the current configuration is used.
 100 In that case this function will be similar to FcConfigGetCurrent() except that
 101 it increments the reference count before returning and the user is responsible
 102 for destroying the configuration when not needed anymore.
 103             </para>
 104         </refsect1>
 105     </refentry>
 106 <!--
 107    fontconfig/doc/func.sgml
 108
 109    Copyright © 2003 Keith Packard
 110
 111    Permission to use, copy, modify, distribute, and sell this software and its
 112    documentation for any purpose is hereby granted without fee, provided that
 113    the above copyright notice appear in all copies and that both that
 114    copyright notice and this permission notice appear in supporting
 115    documentation, and that the name of the author(s) not be used in
 116    advertising or publicity pertaining to distribution of the software without
 117    specific, written prior permission.  The authors make no
 118    representations about the suitability of this software for any purpose.  It
 119    is provided "as is" without express or implied warranty.
 120
 121    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 122    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 123    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 124    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 125    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 126    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 127    PERFORMANCE OF THIS SOFTWARE.
 128  -->
 129     <refentry id="FcConfigDestroy">
 130         <refmeta>
 131             <refentrytitle>FcConfigDestroy</refentrytitle>
 132             <manvolnum>3</manvolnum>
 133             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 134         </refmeta>
 135         <refnamediv>
 136             <refname>FcConfigDestroy</refname>
 137             <refpurpose>Destroy a configuration</refpurpose>
 138         </refnamediv>
 139         <refsynopsisdiv>
 140         <funcsynopsis>
 141         <funcsynopsisinfo>
 142 #include &lt;fontconfig/fontconfig.h&gt;
 143         </funcsynopsisinfo>
 144         <funcprototype>
 145             <funcdef>void <function>FcConfigDestroy</function></funcdef>
 146                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 147         </funcprototype>
 148         </funcsynopsis>
 149         </refsynopsisdiv>
 150         <refsect1><title>Description</title>
 151             <para>
 152 Decrements the config reference count. If all references are gone, destroys
 153 the configuration and any data associated with it.
 154 Note that calling this function with the return from FcConfigGetCurrent will
 155 cause a new configuration to be created for use as current configuration.
 156             </para>
 157         </refsect1>
 158     </refentry>
 159 <!--
 160    fontconfig/doc/func.sgml
 161
 162    Copyright © 2003 Keith Packard
 163
 164    Permission to use, copy, modify, distribute, and sell this software and its
 165    documentation for any purpose is hereby granted without fee, provided that
 166    the above copyright notice appear in all copies and that both that
 167    copyright notice and this permission notice appear in supporting
 168    documentation, and that the name of the author(s) not be used in
 169    advertising or publicity pertaining to distribution of the software without
 170    specific, written prior permission.  The authors make no
 171    representations about the suitability of this software for any purpose.  It
 172    is provided "as is" without express or implied warranty.
 173
 174    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 175    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 176    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 177    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 178    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 179    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 180    PERFORMANCE OF THIS SOFTWARE.
 181  -->
 182     <refentry id="FcConfigSetCurrent">
 183         <refmeta>
 184             <refentrytitle>FcConfigSetCurrent</refentrytitle>
 185             <manvolnum>3</manvolnum>
 186             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 187         </refmeta>
 188         <refnamediv>
 189             <refname>FcConfigSetCurrent</refname>
 190             <refpurpose>Set configuration as default</refpurpose>
 191         </refnamediv>
 192         <refsynopsisdiv>
 193         <funcsynopsis>
 194         <funcsynopsisinfo>
 195 #include &lt;fontconfig/fontconfig.h&gt;
 196         </funcsynopsisinfo>
 197         <funcprototype>
 198             <funcdef>FcBool <function>FcConfigSetCurrent</function></funcdef>
 199                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 200         </funcprototype>
 201         </funcsynopsis>
 202         </refsynopsisdiv>
 203         <refsect1><title>Description</title>
 204             <para>
 205 Sets the current default configuration to <parameter>config</parameter>.  Implicitly calls
 206 FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count
 207 in <parameter>config</parameter> since 2.12.0, returning FcFalse if that call fails.
 208             </para>
 209         </refsect1>
 210     </refentry>
 211 <!--
 212    fontconfig/doc/func.sgml
 213
 214    Copyright © 2003 Keith Packard
 215
 216    Permission to use, copy, modify, distribute, and sell this software and its
 217    documentation for any purpose is hereby granted without fee, provided that
 218    the above copyright notice appear in all copies and that both that
 219    copyright notice and this permission notice appear in supporting
 220    documentation, and that the name of the author(s) not be used in
 221    advertising or publicity pertaining to distribution of the software without
 222    specific, written prior permission.  The authors make no
 223    representations about the suitability of this software for any purpose.  It
 224    is provided "as is" without express or implied warranty.
 225
 226    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 227    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 228    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 229    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 230    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 231    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 232    PERFORMANCE OF THIS SOFTWARE.
 233  -->
 234     <refentry id="FcConfigGetCurrent">
 235         <refmeta>
 236             <refentrytitle>FcConfigGetCurrent</refentrytitle>
 237             <manvolnum>3</manvolnum>
 238             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 239         </refmeta>
 240         <refnamediv>
 241             <refname>FcConfigGetCurrent</refname>
 242             <refpurpose>Return current configuration</refpurpose>
 243         </refnamediv>
 244         <refsynopsisdiv>
 245         <funcsynopsis>
 246         <funcsynopsisinfo>
 247 #include &lt;fontconfig/fontconfig.h&gt;
 248         </funcsynopsisinfo>
 249         <funcprototype>
 250             <funcdef>FcConfig * <function>FcConfigGetCurrent</function></funcdef>
 251                 <paramdef>void<parameter></parameter></paramdef>
 252         </funcprototype>
 253         </funcsynopsis>
 254         </refsynopsisdiv>
 255         <refsect1><title>Description</title>
 256             <para>
 257 Returns the current default configuration.
 258             </para>
 259         </refsect1>
 260     </refentry>
 261 <!--
 262    fontconfig/doc/func.sgml
 263
 264    Copyright © 2003 Keith Packard
 265
 266    Permission to use, copy, modify, distribute, and sell this software and its
 267    documentation for any purpose is hereby granted without fee, provided that
 268    the above copyright notice appear in all copies and that both that
 269    copyright notice and this permission notice appear in supporting
 270    documentation, and that the name of the author(s) not be used in
 271    advertising or publicity pertaining to distribution of the software without
 272    specific, written prior permission.  The authors make no
 273    representations about the suitability of this software for any purpose.  It
 274    is provided "as is" without express or implied warranty.
 275
 276    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 277    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 278    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 279    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 280    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 281    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 282    PERFORMANCE OF THIS SOFTWARE.
 283  -->
 284     <refentry id="FcConfigUptoDate">
 285         <refmeta>
 286             <refentrytitle>FcConfigUptoDate</refentrytitle>
 287             <manvolnum>3</manvolnum>
 288             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 289         </refmeta>
 290         <refnamediv>
 291             <refname>FcConfigUptoDate</refname>
 292             <refpurpose>Check timestamps on config files</refpurpose>
 293         </refnamediv>
 294         <refsynopsisdiv>
 295         <funcsynopsis>
 296         <funcsynopsisinfo>
 297 #include &lt;fontconfig/fontconfig.h&gt;
 298         </funcsynopsisinfo>
 299         <funcprototype>
 300             <funcdef>FcBool <function>FcConfigUptoDate</function></funcdef>
 301                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 302         </funcprototype>
 303         </funcsynopsis>
 304         </refsynopsisdiv>
 305         <refsect1><title>Description</title>
 306             <para>
 307 Checks all of the files related to <parameter>config</parameter> and returns
 308 whether any of them has been modified since the configuration was created.
 309 If <parameter>config</parameter> is NULL, the current configuration is used.
 310             </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="FcConfigHome">
 337         <refmeta>
 338             <refentrytitle>FcConfigHome</refentrytitle>
 339             <manvolnum>3</manvolnum>
 340             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 341         </refmeta>
 342         <refnamediv>
 343             <refname>FcConfigHome</refname>
 344             <refpurpose>return the current home directory.</refpurpose>
 345         </refnamediv>
 346         <refsynopsisdiv>
 347         <funcsynopsis>
 348         <funcsynopsisinfo>
 349 #include &lt;fontconfig/fontconfig.h&gt;
 350         </funcsynopsisinfo>
 351         <funcprototype>
 352             <funcdef>FcChar8 * <function>FcConfigHome</function></funcdef>
 353                 <paramdef>void<parameter></parameter></paramdef>
 354         </funcprototype>
 355         </funcsynopsis>
 356         </refsynopsisdiv>
 357         <refsect1><title>Description</title>
 358             <para>
 359 Return the current user's home directory, if it is available, and if using it
 360 is enabled, and NULL otherwise.
 361 See also <function>FcConfigEnableHome</function>).
 362             </para>
 363         </refsect1>
 364     </refentry>
 365 <!--
 366    fontconfig/doc/func.sgml
 367
 368    Copyright © 2003 Keith Packard
 369
 370    Permission to use, copy, modify, distribute, and sell this software and its
 371    documentation for any purpose is hereby granted without fee, provided that
 372    the above copyright notice appear in all copies and that both that
 373    copyright notice and this permission notice appear in supporting
 374    documentation, and that the name of the author(s) not be used in
 375    advertising or publicity pertaining to distribution of the software without
 376    specific, written prior permission.  The authors make no
 377    representations about the suitability of this software for any purpose.  It
 378    is provided "as is" without express or implied warranty.
 379
 380    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 381    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 382    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 383    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 384    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 385    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 386    PERFORMANCE OF THIS SOFTWARE.
 387  -->
 388     <refentry id="FcConfigEnableHome">
 389         <refmeta>
 390             <refentrytitle>FcConfigEnableHome</refentrytitle>
 391             <manvolnum>3</manvolnum>
 392             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 393         </refmeta>
 394         <refnamediv>
 395             <refname>FcConfigEnableHome</refname>
 396             <refpurpose>controls use of the home directory.</refpurpose>
 397         </refnamediv>
 398         <refsynopsisdiv>
 399         <funcsynopsis>
 400         <funcsynopsisinfo>
 401 #include &lt;fontconfig/fontconfig.h&gt;
 402         </funcsynopsisinfo>
 403         <funcprototype>
 404             <funcdef>FcBool <function>FcConfigEnableHome</function></funcdef>
 405                 <paramdef>FcBool <parameter>enable</parameter></paramdef>
 406         </funcprototype>
 407         </funcsynopsis>
 408         </refsynopsisdiv>
 409         <refsect1><title>Description</title>
 410             <para>
 411 If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
 412 files which are specified relative to the user's home directory (using the ~
 413 notation in the configuration). When <parameter>enable</parameter> is
 414 FcFalse, then all use of the home directory in these contexts will be
 415 disabled. The previous setting of the value is returned.
 416             </para>
 417         </refsect1>
 418     </refentry>
 419 <!--
 420    fontconfig/doc/func.sgml
 421
 422    Copyright © 2003 Keith Packard
 423
 424    Permission to use, copy, modify, distribute, and sell this software and its
 425    documentation for any purpose is hereby granted without fee, provided that
 426    the above copyright notice appear in all copies and that both that
 427    copyright notice and this permission notice appear in supporting
 428    documentation, and that the name of the author(s) not be used in
 429    advertising or publicity pertaining to distribution of the software without
 430    specific, written prior permission.  The authors make no
 431    representations about the suitability of this software for any purpose.  It
 432    is provided "as is" without express or implied warranty.
 433
 434    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 435    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 436    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 437    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 438    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 439    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 440    PERFORMANCE OF THIS SOFTWARE.
 441  -->
 442     <refentry id="FcConfigBuildFonts">
 443         <refmeta>
 444             <refentrytitle>FcConfigBuildFonts</refentrytitle>
 445             <manvolnum>3</manvolnum>
 446             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 447         </refmeta>
 448         <refnamediv>
 449             <refname>FcConfigBuildFonts</refname>
 450             <refpurpose>Build font database</refpurpose>
 451         </refnamediv>
 452         <refsynopsisdiv>
 453         <funcsynopsis>
 454         <funcsynopsisinfo>
 455 #include &lt;fontconfig/fontconfig.h&gt;
 456         </funcsynopsisinfo>
 457         <funcprototype>
 458             <funcdef>FcBool <function>FcConfigBuildFonts</function></funcdef>
 459                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 460         </funcprototype>
 461         </funcsynopsis>
 462         </refsynopsisdiv>
 463         <refsect1><title>Description</title>
 464             <para>
 465 Builds the set of available fonts for the given configuration.  Note that
 466 any changes to the configuration after this call have indeterminate effects.
 467 Returns FcFalse if this operation runs out of memory.
 468 If <parameter>config</parameter> is NULL, the current configuration is used.
 469             </para>
 470         </refsect1>
 471     </refentry>
 472 <!--
 473    fontconfig/doc/func.sgml
 474
 475    Copyright © 2003 Keith Packard
 476
 477    Permission to use, copy, modify, distribute, and sell this software and its
 478    documentation for any purpose is hereby granted without fee, provided that
 479    the above copyright notice appear in all copies and that both that
 480    copyright notice and this permission notice appear in supporting
 481    documentation, and that the name of the author(s) not be used in
 482    advertising or publicity pertaining to distribution of the software without
 483    specific, written prior permission.  The authors make no
 484    representations about the suitability of this software for any purpose.  It
 485    is provided "as is" without express or implied warranty.
 486
 487    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 488    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 489    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 490    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 491    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 492    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 493    PERFORMANCE OF THIS SOFTWARE.
 494  -->
 495     <refentry id="FcConfigGetConfigDirs">
 496         <refmeta>
 497             <refentrytitle>FcConfigGetConfigDirs</refentrytitle>
 498             <manvolnum>3</manvolnum>
 499             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 500         </refmeta>
 501         <refnamediv>
 502             <refname>FcConfigGetConfigDirs</refname>
 503             <refpurpose>Get config directories</refpurpose>
 504         </refnamediv>
 505         <refsynopsisdiv>
 506         <funcsynopsis>
 507         <funcsynopsisinfo>
 508 #include &lt;fontconfig/fontconfig.h&gt;
 509         </funcsynopsisinfo>
 510         <funcprototype>
 511             <funcdef>FcStrList * <function>FcConfigGetConfigDirs</function></funcdef>
 512                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 513         </funcprototype>
 514         </funcsynopsis>
 515         </refsynopsisdiv>
 516         <refsect1><title>Description</title>
 517             <para>
 518 Returns the list of font directories specified in the configuration files
 519 for <parameter>config</parameter>.  Does not include any subdirectories.
 520 If <parameter>config</parameter> is NULL, the current configuration is used.
 521             </para>
 522         </refsect1>
 523     </refentry>
 524 <!--
 525    fontconfig/doc/func.sgml
 526
 527    Copyright © 2003 Keith Packard
 528
 529    Permission to use, copy, modify, distribute, and sell this software and its
 530    documentation for any purpose is hereby granted without fee, provided that
 531    the above copyright notice appear in all copies and that both that
 532    copyright notice and this permission notice appear in supporting
 533    documentation, and that the name of the author(s) not be used in
 534    advertising or publicity pertaining to distribution of the software without
 535    specific, written prior permission.  The authors make no
 536    representations about the suitability of this software for any purpose.  It
 537    is provided "as is" without express or implied warranty.
 538
 539    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 540    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 541    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 542    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 543    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 544    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 545    PERFORMANCE OF THIS SOFTWARE.
 546  -->
 547     <refentry id="FcConfigGetFontDirs">
 548         <refmeta>
 549             <refentrytitle>FcConfigGetFontDirs</refentrytitle>
 550             <manvolnum>3</manvolnum>
 551             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 552         </refmeta>
 553         <refnamediv>
 554             <refname>FcConfigGetFontDirs</refname>
 555             <refpurpose>Get font directories</refpurpose>
 556         </refnamediv>
 557         <refsynopsisdiv>
 558         <funcsynopsis>
 559         <funcsynopsisinfo>
 560 #include &lt;fontconfig/fontconfig.h&gt;
 561         </funcsynopsisinfo>
 562         <funcprototype>
 563             <funcdef>FcStrList * <function>FcConfigGetFontDirs</function></funcdef>
 564                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 565         </funcprototype>
 566         </funcsynopsis>
 567         </refsynopsisdiv>
 568         <refsect1><title>Description</title>
 569             <para>
 570 Returns the list of font directories in <parameter>config</parameter>. This includes the
 571 configured font directories along with any directories below those in the
 572 filesystem.
 573 If <parameter>config</parameter> is NULL, the current configuration is used.
 574             </para>
 575         </refsect1>
 576     </refentry>
 577 <!--
 578    fontconfig/doc/func.sgml
 579
 580    Copyright © 2003 Keith Packard
 581
 582    Permission to use, copy, modify, distribute, and sell this software and its
 583    documentation for any purpose is hereby granted without fee, provided that
 584    the above copyright notice appear in all copies and that both that
 585    copyright notice and this permission notice appear in supporting
 586    documentation, and that the name of the author(s) not be used in
 587    advertising or publicity pertaining to distribution of the software without
 588    specific, written prior permission.  The authors make no
 589    representations about the suitability of this software for any purpose.  It
 590    is provided "as is" without express or implied warranty.
 591
 592    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 593    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 594    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 595    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 596    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 597    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 598    PERFORMANCE OF THIS SOFTWARE.
 599  -->
 600     <refentry id="FcConfigGetConfigFiles">
 601         <refmeta>
 602             <refentrytitle>FcConfigGetConfigFiles</refentrytitle>
 603             <manvolnum>3</manvolnum>
 604             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 605         </refmeta>
 606         <refnamediv>
 607             <refname>FcConfigGetConfigFiles</refname>
 608             <refpurpose>Get config files</refpurpose>
 609         </refnamediv>
 610         <refsynopsisdiv>
 611         <funcsynopsis>
 612         <funcsynopsisinfo>
 613 #include &lt;fontconfig/fontconfig.h&gt;
 614         </funcsynopsisinfo>
 615         <funcprototype>
 616             <funcdef>FcStrList * <function>FcConfigGetConfigFiles</function></funcdef>
 617                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 618         </funcprototype>
 619         </funcsynopsis>
 620         </refsynopsisdiv>
 621         <refsect1><title>Description</title>
 622             <para>
 623 Returns the list of known configuration files used to generate <parameter>config</parameter>.
 624 If <parameter>config</parameter> is NULL, the current configuration is used.
 625             </para>
 626         </refsect1>
 627     </refentry>
 628 <!--
 629    fontconfig/doc/func.sgml
 630
 631    Copyright © 2003 Keith Packard
 632
 633    Permission to use, copy, modify, distribute, and sell this software and its
 634    documentation for any purpose is hereby granted without fee, provided that
 635    the above copyright notice appear in all copies and that both that
 636    copyright notice and this permission notice appear in supporting
 637    documentation, and that the name of the author(s) not be used in
 638    advertising or publicity pertaining to distribution of the software without
 639    specific, written prior permission.  The authors make no
 640    representations about the suitability of this software for any purpose.  It
 641    is provided "as is" without express or implied warranty.
 642
 643    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 644    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 645    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 646    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 647    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 648    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 649    PERFORMANCE OF THIS SOFTWARE.
 650  -->
 651     <refentry id="FcConfigGetCache">
 652         <refmeta>
 653             <refentrytitle>FcConfigGetCache</refentrytitle>
 654             <manvolnum>3</manvolnum>
 655             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 656         </refmeta>
 657         <refnamediv>
 658             <refname>FcConfigGetCache</refname>
 659             <refpurpose>DEPRECATED used to return per-user cache filename</refpurpose>
 660         </refnamediv>
 661         <refsynopsisdiv>
 662         <funcsynopsis>
 663         <funcsynopsisinfo>
 664 #include &lt;fontconfig/fontconfig.h&gt;
 665         </funcsynopsisinfo>
 666         <funcprototype>
 667             <funcdef>FcChar8 * <function>FcConfigGetCache</function></funcdef>
 668                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 669         </funcprototype>
 670         </funcsynopsis>
 671         </refsynopsisdiv>
 672         <refsect1><title>Description</title>
 673             <para>
 674 With fontconfig no longer using per-user cache files, this function now
 675 simply returns NULL to indicate that no per-user file exists.
 676             </para>
 677         </refsect1>
 678     </refentry>
 679 <!--
 680    fontconfig/doc/func.sgml
 681
 682    Copyright © 2003 Keith Packard
 683
 684    Permission to use, copy, modify, distribute, and sell this software and its
 685    documentation for any purpose is hereby granted without fee, provided that
 686    the above copyright notice appear in all copies and that both that
 687    copyright notice and this permission notice appear in supporting
 688    documentation, and that the name of the author(s) not be used in
 689    advertising or publicity pertaining to distribution of the software without
 690    specific, written prior permission.  The authors make no
 691    representations about the suitability of this software for any purpose.  It
 692    is provided "as is" without express or implied warranty.
 693
 694    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 695    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 696    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 697    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 698    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 699    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 700    PERFORMANCE OF THIS SOFTWARE.
 701  -->
 702     <refentry id="FcConfigGetCacheDirs">
 703         <refmeta>
 704             <refentrytitle>FcConfigGetCacheDirs</refentrytitle>
 705             <manvolnum>3</manvolnum>
 706             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 707         </refmeta>
 708         <refnamediv>
 709             <refname>FcConfigGetCacheDirs</refname>
 710             <refpurpose>return the list of directories searched for cache files</refpurpose>
 711         </refnamediv>
 712         <refsynopsisdiv>
 713         <funcsynopsis>
 714         <funcsynopsisinfo>
 715 #include &lt;fontconfig/fontconfig.h&gt;
 716         </funcsynopsisinfo>
 717         <funcprototype>
 718             <funcdef>FcStrList * <function>FcConfigGetCacheDirs</function></funcdef>
 719                 <paramdef>const FcConfig *<parameter>config</parameter></paramdef>
 720         </funcprototype>
 721         </funcsynopsis>
 722         </refsynopsisdiv>
 723         <refsect1><title>Description</title>
 724             <para>
 725 <function>FcConfigGetCacheDirs</function> returns a string list containing
 726 all of the directories that fontconfig will search when attempting to load a
 727 cache file for a font directory.
 728 If <parameter>config</parameter> is NULL, the current configuration is used.
 729             </para>
 730         </refsect1>
 731     </refentry>
 732 <!--
 733    fontconfig/doc/func.sgml
 734
 735    Copyright © 2003 Keith Packard
 736
 737    Permission to use, copy, modify, distribute, and sell this software and its
 738    documentation for any purpose is hereby granted without fee, provided that
 739    the above copyright notice appear in all copies and that both that
 740    copyright notice and this permission notice appear in supporting
 741    documentation, and that the name of the author(s) not be used in
 742    advertising or publicity pertaining to distribution of the software without
 743    specific, written prior permission.  The authors make no
 744    representations about the suitability of this software for any purpose.  It
 745    is provided "as is" without express or implied warranty.
 746
 747    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 748    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 749    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 750    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 751    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 752    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 753    PERFORMANCE OF THIS SOFTWARE.
 754  -->
 755     <refentry id="FcConfigGetFonts">
 756         <refmeta>
 757             <refentrytitle>FcConfigGetFonts</refentrytitle>
 758             <manvolnum>3</manvolnum>
 759             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 760         </refmeta>
 761         <refnamediv>
 762             <refname>FcConfigGetFonts</refname>
 763             <refpurpose>Get config font set</refpurpose>
 764         </refnamediv>
 765         <refsynopsisdiv>
 766         <funcsynopsis>
 767         <funcsynopsisinfo>
 768 #include &lt;fontconfig/fontconfig.h&gt;
 769         </funcsynopsisinfo>
 770         <funcprototype>
 771             <funcdef>FcFontSet * <function>FcConfigGetFonts</function></funcdef>
 772                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 773                 <paramdef>FcSetName <parameter>set</parameter></paramdef>
 774         </funcprototype>
 775         </funcsynopsis>
 776         </refsynopsisdiv>
 777         <refsect1><title>Description</title>
 778             <para>
 779 Returns one of the two sets of fonts from the configuration as specified
 780 by <parameter>set</parameter>. This font set is owned by the library and must
 781 not be modified or freed.
 782 If <parameter>config</parameter> is NULL, the current configuration is used.
 783             </para>
 784         </refsect1>
 785     </refentry>
 786 <!--
 787    fontconfig/doc/func.sgml
 788
 789    Copyright © 2003 Keith Packard
 790
 791    Permission to use, copy, modify, distribute, and sell this software and its
 792    documentation for any purpose is hereby granted without fee, provided that
 793    the above copyright notice appear in all copies and that both that
 794    copyright notice and this permission notice appear in supporting
 795    documentation, and that the name of the author(s) not be used in
 796    advertising or publicity pertaining to distribution of the software without
 797    specific, written prior permission.  The authors make no
 798    representations about the suitability of this software for any purpose.  It
 799    is provided "as is" without express or implied warranty.
 800
 801    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 802    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 803    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 804    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 805    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 806    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 807    PERFORMANCE OF THIS SOFTWARE.
 808  -->
 809     <refentry id="FcConfigGetBlanks">
 810         <refmeta>
 811             <refentrytitle>FcConfigGetBlanks</refentrytitle>
 812             <manvolnum>3</manvolnum>
 813             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 814         </refmeta>
 815         <refnamediv>
 816             <refname>FcConfigGetBlanks</refname>
 817             <refpurpose>Get config blanks</refpurpose>
 818         </refnamediv>
 819         <refsynopsisdiv>
 820         <funcsynopsis>
 821         <funcsynopsisinfo>
 822 #include &lt;fontconfig/fontconfig.h&gt;
 823         </funcsynopsisinfo>
 824         <funcprototype>
 825             <funcdef>FcBlanks * <function>FcConfigGetBlanks</function></funcdef>
 826                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 827         </funcprototype>
 828         </funcsynopsis>
 829         </refsynopsisdiv>
 830         <refsect1><title>Description</title>
 831             <para>
 832 Returns the FcBlanks object associated with the given configuration, if no
 833 blanks were present in the configuration, this function will return 0.
 834 The returned FcBlanks object if not NULL, is valid as long as the owning
 835 FcConfig is alive.
 836 If <parameter>config</parameter> is NULL, the current configuration is used.
 837             </para>
 838         </refsect1>
 839     </refentry>
 840 <!--
 841    fontconfig/doc/func.sgml
 842
 843    Copyright © 2003 Keith Packard
 844
 845    Permission to use, copy, modify, distribute, and sell this software and its
 846    documentation for any purpose is hereby granted without fee, provided that
 847    the above copyright notice appear in all copies and that both that
 848    copyright notice and this permission notice appear in supporting
 849    documentation, and that the name of the author(s) not be used in
 850    advertising or publicity pertaining to distribution of the software without
 851    specific, written prior permission.  The authors make no
 852    representations about the suitability of this software for any purpose.  It
 853    is provided "as is" without express or implied warranty.
 854
 855    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 856    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 857    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 858    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 859    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 860    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 861    PERFORMANCE OF THIS SOFTWARE.
 862  -->
 863     <refentry id="FcConfigGetRescanInterval">
 864         <refmeta>
 865             <refentrytitle>FcConfigGetRescanInterval</refentrytitle>
 866             <manvolnum>3</manvolnum>
 867             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 868         </refmeta>
 869         <refnamediv>
 870             <refname>FcConfigGetRescanInterval</refname>
 871             <refpurpose>Get config rescan interval</refpurpose>
 872         </refnamediv>
 873         <refsynopsisdiv>
 874         <funcsynopsis>
 875         <funcsynopsisinfo>
 876 #include &lt;fontconfig/fontconfig.h&gt;
 877         </funcsynopsisinfo>
 878         <funcprototype>
 879             <funcdef>int <function>FcConfigGetRescanInterval</function></funcdef>
 880                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 881         </funcprototype>
 882         </funcsynopsis>
 883         </refsynopsisdiv>
 884         <refsect1><title>Description</title>
 885             <para>
 886 Returns the interval between automatic checks of the configuration (in
 887 seconds) specified in <parameter>config</parameter>.  The configuration is checked during
 888 a call to FcFontList when this interval has passed since the last check.
 889 An interval setting of zero disables automatic checks.
 890 If <parameter>config</parameter> is NULL, the current configuration is used.
 891             </para>
 892         </refsect1>
 893     </refentry>
 894 <!--
 895    fontconfig/doc/func.sgml
 896
 897    Copyright © 2003 Keith Packard
 898
 899    Permission to use, copy, modify, distribute, and sell this software and its
 900    documentation for any purpose is hereby granted without fee, provided that
 901    the above copyright notice appear in all copies and that both that
 902    copyright notice and this permission notice appear in supporting
 903    documentation, and that the name of the author(s) not be used in
 904    advertising or publicity pertaining to distribution of the software without
 905    specific, written prior permission.  The authors make no
 906    representations about the suitability of this software for any purpose.  It
 907    is provided "as is" without express or implied warranty.
 908
 909    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 910    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 911    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 912    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 913    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 914    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 915    PERFORMANCE OF THIS SOFTWARE.
 916  -->
 917     <refentry id="FcConfigSetRescanInterval">
 918         <refmeta>
 919             <refentrytitle>FcConfigSetRescanInterval</refentrytitle>
 920             <manvolnum>3</manvolnum>
 921             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 922         </refmeta>
 923         <refnamediv>
 924             <refname>FcConfigSetRescanInterval</refname>
 925             <refpurpose>Set config rescan interval</refpurpose>
 926         </refnamediv>
 927         <refsynopsisdiv>
 928         <funcsynopsis>
 929         <funcsynopsisinfo>
 930 #include &lt;fontconfig/fontconfig.h&gt;
 931         </funcsynopsisinfo>
 932         <funcprototype>
 933             <funcdef>FcBool <function>FcConfigSetRescanInterval</function></funcdef>
 934                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 935                 <paramdef>int <parameter>rescanInterval</parameter></paramdef>
 936         </funcprototype>
 937         </funcsynopsis>
 938         </refsynopsisdiv>
 939         <refsect1><title>Description</title>
 940             <para>
 941 Sets the rescan interval. Returns FcFalse if the interval cannot be set (due
 942 to allocation failure). Otherwise returns FcTrue.
 943 An interval setting of zero disables automatic checks.
 944 If <parameter>config</parameter> is NULL, the current configuration is used.
 945             </para>
 946         </refsect1>
 947     </refentry>
 948 <!--
 949    fontconfig/doc/func.sgml
 950
 951    Copyright © 2003 Keith Packard
 952
 953    Permission to use, copy, modify, distribute, and sell this software and its
 954    documentation for any purpose is hereby granted without fee, provided that
 955    the above copyright notice appear in all copies and that both that
 956    copyright notice and this permission notice appear in supporting
 957    documentation, and that the name of the author(s) not be used in
 958    advertising or publicity pertaining to distribution of the software without
 959    specific, written prior permission.  The authors make no
 960    representations about the suitability of this software for any purpose.  It
 961    is provided "as is" without express or implied warranty.
 962
 963    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 964    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 965    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 966    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 967    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 968    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 969    PERFORMANCE OF THIS SOFTWARE.
 970  -->
 971     <refentry id="FcConfigAppFontAddFile">
 972         <refmeta>
 973             <refentrytitle>FcConfigAppFontAddFile</refentrytitle>
 974             <manvolnum>3</manvolnum>
 975             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 976         </refmeta>
 977         <refnamediv>
 978             <refname>FcConfigAppFontAddFile</refname>
 979             <refpurpose>Add font file to font database</refpurpose>
 980         </refnamediv>
 981         <refsynopsisdiv>
 982         <funcsynopsis>
 983         <funcsynopsisinfo>
 984 #include &lt;fontconfig/fontconfig.h&gt;
 985         </funcsynopsisinfo>
 986         <funcprototype>
 987             <funcdef>FcBool <function>FcConfigAppFontAddFile</function></funcdef>
 988                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
 989                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
 990         </funcprototype>
 991         </funcsynopsis>
 992         </refsynopsisdiv>
 993         <refsect1><title>Description</title>
 994             <para>
 995 Adds an application-specific font to the configuration. Returns FcFalse
 996 if the fonts cannot be added (due to allocation failure or no fonts found).
 997 Otherwise returns FcTrue. If <parameter>config</parameter> is NULL,
 998 the current configuration is used.
 999             </para>
1000         </refsect1>
1001     </refentry>
1002 <!--
1003    fontconfig/doc/func.sgml
1004
1005    Copyright © 2003 Keith Packard
1006
1007    Permission to use, copy, modify, distribute, and sell this software and its
1008    documentation for any purpose is hereby granted without fee, provided that
1009    the above copyright notice appear in all copies and that both that
1010    copyright notice and this permission notice appear in supporting
1011    documentation, and that the name of the author(s) not be used in
1012    advertising or publicity pertaining to distribution of the software without
1013    specific, written prior permission.  The authors make no
1014    representations about the suitability of this software for any purpose.  It
1015    is provided "as is" without express or implied warranty.
1016
1017    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1018    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1019    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1020    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1021    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1022    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1023    PERFORMANCE OF THIS SOFTWARE.
1024  -->
1025     <refentry id="FcConfigAppFontAddDir">
1026         <refmeta>
1027             <refentrytitle>FcConfigAppFontAddDir</refentrytitle>
1028             <manvolnum>3</manvolnum>
1029             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1030         </refmeta>
1031         <refnamediv>
1032             <refname>FcConfigAppFontAddDir</refname>
1033             <refpurpose>Add fonts from directory to font database</refpurpose>
1034         </refnamediv>
1035         <refsynopsisdiv>
1036         <funcsynopsis>
1037         <funcsynopsisinfo>
1038 #include &lt;fontconfig/fontconfig.h&gt;
1039         </funcsynopsisinfo>
1040         <funcprototype>
1041             <funcdef>FcBool <function>FcConfigAppFontAddDir</function></funcdef>
1042                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1043                 <paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
1044         </funcprototype>
1045         </funcsynopsis>
1046         </refsynopsisdiv>
1047         <refsect1><title>Description</title>
1048             <para>
1049 Scans the specified directory for fonts, adding each one found to the
1050 application-specific set of fonts. Returns FcFalse
1051 if the fonts cannot be added (due to allocation failure or no fonts found).
1052 Otherwise returns FcTrue. If <parameter>config</parameter> is NULL,
1053 the current configuration is used.
1054             </para>
1055         </refsect1>
1056     </refentry>
1057 <!--
1058    fontconfig/doc/func.sgml
1059
1060    Copyright © 2003 Keith Packard
1061
1062    Permission to use, copy, modify, distribute, and sell this software and its
1063    documentation for any purpose is hereby granted without fee, provided that
1064    the above copyright notice appear in all copies and that both that
1065    copyright notice and this permission notice appear in supporting
1066    documentation, and that the name of the author(s) not be used in
1067    advertising or publicity pertaining to distribution of the software without
1068    specific, written prior permission.  The authors make no
1069    representations about the suitability of this software for any purpose.  It
1070    is provided "as is" without express or implied warranty.
1071
1072    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1073    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1074    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1075    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1076    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1077    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1078    PERFORMANCE OF THIS SOFTWARE.
1079  -->
1080     <refentry id="FcConfigAppFontClear">
1081         <refmeta>
1082             <refentrytitle>FcConfigAppFontClear</refentrytitle>
1083             <manvolnum>3</manvolnum>
1084             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1085         </refmeta>
1086         <refnamediv>
1087             <refname>FcConfigAppFontClear</refname>
1088             <refpurpose>Remove all app fonts from font database</refpurpose>
1089         </refnamediv>
1090         <refsynopsisdiv>
1091         <funcsynopsis>
1092         <funcsynopsisinfo>
1093 #include &lt;fontconfig/fontconfig.h&gt;
1094         </funcsynopsisinfo>
1095         <funcprototype>
1096             <funcdef>void <function>FcConfigAppFontClear</function></funcdef>
1097                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1098         </funcprototype>
1099         </funcsynopsis>
1100         </refsynopsisdiv>
1101         <refsect1><title>Description</title>
1102             <para>
1103 Clears the set of application-specific fonts.
1104 If <parameter>config</parameter> is NULL, the current configuration is used.
1105             </para>
1106         </refsect1>
1107     </refentry>
1108 <!--
1109    fontconfig/doc/func.sgml
1110
1111    Copyright © 2003 Keith Packard
1112
1113    Permission to use, copy, modify, distribute, and sell this software and its
1114    documentation for any purpose is hereby granted without fee, provided that
1115    the above copyright notice appear in all copies and that both that
1116    copyright notice and this permission notice appear in supporting
1117    documentation, and that the name of the author(s) not be used in
1118    advertising or publicity pertaining to distribution of the software without
1119    specific, written prior permission.  The authors make no
1120    representations about the suitability of this software for any purpose.  It
1121    is provided "as is" without express or implied warranty.
1122
1123    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1124    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1125    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1126    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1127    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1128    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1129    PERFORMANCE OF THIS SOFTWARE.
1130  -->
1131     <refentry id="FcConfigSubstituteWithPat">
1132         <refmeta>
1133             <refentrytitle>FcConfigSubstituteWithPat</refentrytitle>
1134             <manvolnum>3</manvolnum>
1135             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1136         </refmeta>
1137         <refnamediv>
1138             <refname>FcConfigSubstituteWithPat</refname>
1139             <refpurpose>Execute substitutions</refpurpose>
1140         </refnamediv>
1141         <refsynopsisdiv>
1142         <funcsynopsis>
1143         <funcsynopsisinfo>
1144 #include &lt;fontconfig/fontconfig.h&gt;
1145         </funcsynopsisinfo>
1146         <funcprototype>
1147             <funcdef>FcBool <function>FcConfigSubstituteWithPat</function></funcdef>
1148                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1149                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1150                 <paramdef>FcPattern *<parameter>p_pat</parameter></paramdef>
1151                 <paramdef>FcMatchKind <parameter>kind</parameter></paramdef>
1152         </funcprototype>
1153         </funcsynopsis>
1154         </refsynopsisdiv>
1155         <refsect1><title>Description</title>
1156             <para>
1157 Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
1158 FcMatchPattern, then those tagged as pattern operations are applied, else
1159 if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
1160 p_pat is used for &lt;test&gt; elements with target=pattern. Returns FcFalse
1161 if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
1162 If <parameter>config</parameter> is NULL, the current configuration is used.
1163             </para>
1164         </refsect1>
1165     </refentry>
1166 <!--
1167    fontconfig/doc/func.sgml
1168
1169    Copyright © 2003 Keith Packard
1170
1171    Permission to use, copy, modify, distribute, and sell this software and its
1172    documentation for any purpose is hereby granted without fee, provided that
1173    the above copyright notice appear in all copies and that both that
1174    copyright notice and this permission notice appear in supporting
1175    documentation, and that the name of the author(s) not be used in
1176    advertising or publicity pertaining to distribution of the software without
1177    specific, written prior permission.  The authors make no
1178    representations about the suitability of this software for any purpose.  It
1179    is provided "as is" without express or implied warranty.
1180
1181    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1182    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1183    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1184    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1185    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1186    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1187    PERFORMANCE OF THIS SOFTWARE.
1188  -->
1189     <refentry id="FcConfigSubstitute">
1190         <refmeta>
1191             <refentrytitle>FcConfigSubstitute</refentrytitle>
1192             <manvolnum>3</manvolnum>
1193             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1194         </refmeta>
1195         <refnamediv>
1196             <refname>FcConfigSubstitute</refname>
1197             <refpurpose>Execute substitutions</refpurpose>
1198         </refnamediv>
1199         <refsynopsisdiv>
1200         <funcsynopsis>
1201         <funcsynopsisinfo>
1202 #include &lt;fontconfig/fontconfig.h&gt;
1203         </funcsynopsisinfo>
1204         <funcprototype>
1205             <funcdef>FcBool <function>FcConfigSubstitute</function></funcdef>
1206                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1207                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1208                 <paramdef>FcMatchKind <parameter>kind</parameter></paramdef>
1209         </funcprototype>
1210         </funcsynopsis>
1211         </refsynopsisdiv>
1212         <refsect1><title>Description</title>
1213             <para>
1214 Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse
1215 if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
1216 If <parameter>config</parameter> is NULL, the current configuration is used.
1217             </para>
1218         </refsect1>
1219     </refentry>
1220 <!--
1221    fontconfig/doc/func.sgml
1222
1223    Copyright © 2003 Keith Packard
1224
1225    Permission to use, copy, modify, distribute, and sell this software and its
1226    documentation for any purpose is hereby granted without fee, provided that
1227    the above copyright notice appear in all copies and that both that
1228    copyright notice and this permission notice appear in supporting
1229    documentation, and that the name of the author(s) not be used in
1230    advertising or publicity pertaining to distribution of the software without
1231    specific, written prior permission.  The authors make no
1232    representations about the suitability of this software for any purpose.  It
1233    is provided "as is" without express or implied warranty.
1234
1235    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1236    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1237    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1238    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1239    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1240    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1241    PERFORMANCE OF THIS SOFTWARE.
1242  -->
1243     <refentry id="FcFontMatch">
1244         <refmeta>
1245             <refentrytitle>FcFontMatch</refentrytitle>
1246             <manvolnum>3</manvolnum>
1247             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1248         </refmeta>
1249         <refnamediv>
1250             <refname>FcFontMatch</refname>
1251             <refpurpose>Return best font</refpurpose>
1252         </refnamediv>
1253         <refsynopsisdiv>
1254         <funcsynopsis>
1255         <funcsynopsisinfo>
1256 #include &lt;fontconfig/fontconfig.h&gt;
1257         </funcsynopsisinfo>
1258         <funcprototype>
1259             <funcdef>FcPattern * <function>FcFontMatch</function></funcdef>
1260                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1261                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1262                 <paramdef>FcResult *<parameter>result</parameter></paramdef>
1263         </funcprototype>
1264         </funcsynopsis>
1265         </refsynopsisdiv>
1266         <refsect1><title>Description</title>
1267             <para>
1268 Finds the font in <parameter>sets</parameter> most closely matching
1269 <parameter>pattern</parameter> and returns the result of
1270 <function>FcFontRenderPrepare</function> for that font and the provided
1271 pattern. This function should be called only after
1272 <function>FcConfigSubstitute</function> and
1273 <function>FcDefaultSubstitute</function> have been called for
1274 <parameter>p</parameter>; otherwise the results will not be correct.
1275 If <parameter>config</parameter> is NULL, the current configuration is used.
1276             </para>
1277         </refsect1>
1278     </refentry>
1279 <!--
1280    fontconfig/doc/func.sgml
1281
1282    Copyright © 2003 Keith Packard
1283
1284    Permission to use, copy, modify, distribute, and sell this software and its
1285    documentation for any purpose is hereby granted without fee, provided that
1286    the above copyright notice appear in all copies and that both that
1287    copyright notice and this permission notice appear in supporting
1288    documentation, and that the name of the author(s) not be used in
1289    advertising or publicity pertaining to distribution of the software without
1290    specific, written prior permission.  The authors make no
1291    representations about the suitability of this software for any purpose.  It
1292    is provided "as is" without express or implied warranty.
1293
1294    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1295    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1296    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1297    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1298    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1299    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1300    PERFORMANCE OF THIS SOFTWARE.
1301  -->
1302     <refentry id="FcFontSort">
1303         <refmeta>
1304             <refentrytitle>FcFontSort</refentrytitle>
1305             <manvolnum>3</manvolnum>
1306             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1307         </refmeta>
1308         <refnamediv>
1309             <refname>FcFontSort</refname>
1310             <refpurpose>Return list of matching fonts</refpurpose>
1311         </refnamediv>
1312         <refsynopsisdiv>
1313         <funcsynopsis>
1314         <funcsynopsisinfo>
1315 #include &lt;fontconfig/fontconfig.h&gt;
1316         </funcsynopsisinfo>
1317         <funcprototype>
1318             <funcdef>FcFontSet * <function>FcFontSort</function></funcdef>
1319                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1320                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1321                 <paramdef>FcBool <parameter>trim</parameter></paramdef>
1322                 <paramdef>FcCharSet **<parameter>csp</parameter></paramdef>
1323                 <paramdef>FcResult *<parameter>result</parameter></paramdef>
1324         </funcprototype>
1325         </funcsynopsis>
1326         </refsynopsisdiv>
1327         <refsect1><title>Description</title>
1328             <para>
1329 Returns the list of fonts sorted by closeness to <parameter>p</parameter>.  If <parameter>trim</parameter> is FcTrue,
1330 elements in the list which don't include Unicode coverage not provided by
1331 earlier elements in the list are elided.  The union of Unicode coverage of
1332 all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL.  This function
1333 should be called only after FcConfigSubstitute and FcDefaultSubstitute have
1334 been called for <parameter>p</parameter>; otherwise the results will not be correct.
1335     </para><para>
1336 The returned FcFontSet references FcPattern structures which may be shared
1337 by the return value from multiple FcFontSort calls, applications must not
1338 modify these patterns.  Instead, they should be passed, along with <parameter>p</parameter> to
1339 <function>FcFontRenderPrepare</function> which combines them into a complete pattern.
1340     </para><para>
1341 The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy.
1342 If <parameter>config</parameter> is NULL, the current configuration is used.
1343             </para>
1344         </refsect1>
1345     </refentry>
1346 <!--
1347    fontconfig/doc/func.sgml
1348
1349    Copyright © 2003 Keith Packard
1350
1351    Permission to use, copy, modify, distribute, and sell this software and its
1352    documentation for any purpose is hereby granted without fee, provided that
1353    the above copyright notice appear in all copies and that both that
1354    copyright notice and this permission notice appear in supporting
1355    documentation, and that the name of the author(s) not be used in
1356    advertising or publicity pertaining to distribution of the software without
1357    specific, written prior permission.  The authors make no
1358    representations about the suitability of this software for any purpose.  It
1359    is provided "as is" without express or implied warranty.
1360
1361    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1362    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1363    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1364    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1365    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1366    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1367    PERFORMANCE OF THIS SOFTWARE.
1368  -->
1369     <refentry id="FcFontRenderPrepare">
1370         <refmeta>
1371             <refentrytitle>FcFontRenderPrepare</refentrytitle>
1372             <manvolnum>3</manvolnum>
1373             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1374         </refmeta>
1375         <refnamediv>
1376             <refname>FcFontRenderPrepare</refname>
1377             <refpurpose>Prepare pattern for loading font file</refpurpose>
1378         </refnamediv>
1379         <refsynopsisdiv>
1380         <funcsynopsis>
1381         <funcsynopsisinfo>
1382 #include &lt;fontconfig/fontconfig.h&gt;
1383         </funcsynopsisinfo>
1384         <funcprototype>
1385             <funcdef>FcPattern * <function>FcFontRenderPrepare</function></funcdef>
1386                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1387                 <paramdef>FcPattern *<parameter>pat</parameter></paramdef>
1388                 <paramdef>FcPattern *<parameter>font</parameter></paramdef>
1389         </funcprototype>
1390         </funcsynopsis>
1391         </refsynopsisdiv>
1392         <refsect1><title>Description</title>
1393             <para>
1394 Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
1395 in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
1396 value from <parameter>pat</parameter> for elements appearing in both.  The result is passed to
1397 FcConfigSubstituteWithPat with <parameter>kind</parameter> FcMatchFont and then returned.
1398             </para>
1399         </refsect1>
1400     </refentry>
1401 <!--
1402    fontconfig/doc/func.sgml
1403
1404    Copyright © 2003 Keith Packard
1405
1406    Permission to use, copy, modify, distribute, and sell this software and its
1407    documentation for any purpose is hereby granted without fee, provided that
1408    the above copyright notice appear in all copies and that both that
1409    copyright notice and this permission notice appear in supporting
1410    documentation, and that the name of the author(s) not be used in
1411    advertising or publicity pertaining to distribution of the software without
1412    specific, written prior permission.  The authors make no
1413    representations about the suitability of this software for any purpose.  It
1414    is provided "as is" without express or implied warranty.
1415
1416    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1417    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1418    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1419    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1420    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1421    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1422    PERFORMANCE OF THIS SOFTWARE.
1423  -->
1424     <refentry id="FcFontList">
1425         <refmeta>
1426             <refentrytitle>FcFontList</refentrytitle>
1427             <manvolnum>3</manvolnum>
1428             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1429         </refmeta>
1430         <refnamediv>
1431             <refname>FcFontList</refname>
1432             <refpurpose>List fonts</refpurpose>
1433         </refnamediv>
1434         <refsynopsisdiv>
1435         <funcsynopsis>
1436         <funcsynopsisinfo>
1437 #include &lt;fontconfig/fontconfig.h&gt;
1438         </funcsynopsisinfo>
1439         <funcprototype>
1440             <funcdef>FcFontSet * <function>FcFontList</function></funcdef>
1441                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1442                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1443                 <paramdef>FcObjectSet *<parameter>os</parameter></paramdef>
1444         </funcprototype>
1445         </funcsynopsis>
1446         </refsynopsisdiv>
1447         <refsect1><title>Description</title>
1448             <para>
1449 Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
1450 only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
1451 If <parameter>config</parameter> is NULL, the default configuration is checked
1452 to be up to date, and used.
1453             </para>
1454         </refsect1>
1455     </refentry>
1456 <!--
1457    fontconfig/doc/func.sgml
1458
1459    Copyright © 2003 Keith Packard
1460
1461    Permission to use, copy, modify, distribute, and sell this software and its
1462    documentation for any purpose is hereby granted without fee, provided that
1463    the above copyright notice appear in all copies and that both that
1464    copyright notice and this permission notice appear in supporting
1465    documentation, and that the name of the author(s) not be used in
1466    advertising or publicity pertaining to distribution of the software without
1467    specific, written prior permission.  The authors make no
1468    representations about the suitability of this software for any purpose.  It
1469    is provided "as is" without express or implied warranty.
1470
1471    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1472    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1473    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1474    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1475    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1476    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1477    PERFORMANCE OF THIS SOFTWARE.
1478  -->
1479     <refentry id="FcConfigFilename">
1480         <refmeta>
1481             <refentrytitle>FcConfigFilename</refentrytitle>
1482             <manvolnum>3</manvolnum>
1483             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1484         </refmeta>
1485         <refnamediv>
1486             <refname>FcConfigFilename</refname>
1487             <refpurpose>Find a config file</refpurpose>
1488         </refnamediv>
1489         <refsynopsisdiv>
1490         <funcsynopsis>
1491         <funcsynopsisinfo>
1492 #include &lt;fontconfig/fontconfig.h&gt;
1493         </funcsynopsisinfo>
1494         <funcprototype>
1495             <funcdef>FcChar8 * <function>FcConfigFilename</function></funcdef>
1496                 <paramdef>const FcChar8 *<parameter>name</parameter></paramdef>
1497         </funcprototype>
1498         </funcsynopsis>
1499         </refsynopsisdiv>
1500         <refsect1><title>Description</title>
1501             <para>
1502 Given the specified external entity name, return the associated filename.
1503 This provides applications a way to convert various configuration file
1504 references into filename form.
1505     </para><para>
1506 A null or empty <parameter>name</parameter> indicates that the default configuration file should
1507 be used; which file this references can be overridden with the
1508 FONTCONFIG_FILE environment variable.  Next, if the name starts with <parameter>~</parameter>, it
1509 refers to a file in the current users home directory.  Otherwise if the name
1510 doesn't start with '/', it refers to a file in the default configuration
1511 directory; the built-in default directory can be overridden with the
1512 FONTCONFIG_PATH environment variable.
1513             </para>
1514         </refsect1>
1515     </refentry>
1516 <!--
1517    fontconfig/doc/func.sgml
1518
1519    Copyright © 2003 Keith Packard
1520
1521    Permission to use, copy, modify, distribute, and sell this software and its
1522    documentation for any purpose is hereby granted without fee, provided that
1523    the above copyright notice appear in all copies and that both that
1524    copyright notice and this permission notice appear in supporting
1525    documentation, and that the name of the author(s) not be used in
1526    advertising or publicity pertaining to distribution of the software without
1527    specific, written prior permission.  The authors make no
1528    representations about the suitability of this software for any purpose.  It
1529    is provided "as is" without express or implied warranty.
1530
1531    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1532    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1533    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1534    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1535    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1536    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1537    PERFORMANCE OF THIS SOFTWARE.
1538  -->
1539     <refentry id="FcConfigParseAndLoad">
1540         <refmeta>
1541             <refentrytitle>FcConfigParseAndLoad</refentrytitle>
1542             <manvolnum>3</manvolnum>
1543             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1544         </refmeta>
1545         <refnamediv>
1546             <refname>FcConfigParseAndLoad</refname>
1547             <refpurpose>load a configuration file</refpurpose>
1548         </refnamediv>
1549         <refsynopsisdiv>
1550         <funcsynopsis>
1551         <funcsynopsisinfo>
1552 #include &lt;fontconfig/fontconfig.h&gt;
1553         </funcsynopsisinfo>
1554         <funcprototype>
1555             <funcdef>FcBool <function>FcConfigParseAndLoad</function></funcdef>
1556                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1557                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
1558                 <paramdef>FcBool <parameter>complain</parameter></paramdef>
1559         </funcprototype>
1560         </funcsynopsis>
1561         </refsynopsisdiv>
1562         <refsect1><title>Description</title>
1563             <para>
1564 Walks the configuration in 'file' and constructs the internal representation
1565 in 'config'.  Any include files referenced from within 'file' will be loaded
1566 and parsed.  If 'complain' is FcFalse, no warning will be displayed if
1567 'file' does not exist. Error and warning messages will be output to stderr.
1568 Returns FcFalse if some error occurred while loading the file, either a
1569 parse error, semantic error or allocation failure. Otherwise returns FcTrue.
1570             </para>
1571         </refsect1>
1572     </refentry>
1573 <!--
1574    fontconfig/doc/func.sgml
1575
1576    Copyright © 2003 Keith Packard
1577
1578    Permission to use, copy, modify, distribute, and sell this software and its
1579    documentation for any purpose is hereby granted without fee, provided that
1580    the above copyright notice appear in all copies and that both that
1581    copyright notice and this permission notice appear in supporting
1582    documentation, and that the name of the author(s) not be used in
1583    advertising or publicity pertaining to distribution of the software without
1584    specific, written prior permission.  The authors make no
1585    representations about the suitability of this software for any purpose.  It
1586    is provided "as is" without express or implied warranty.
1587
1588    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1589    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1590    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1591    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1592    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1593    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1594    PERFORMANCE OF THIS SOFTWARE.
1595  -->
1596     <refentry id="FcConfigGetSysRoot">
1597         <refmeta>
1598             <refentrytitle>FcConfigGetSysRoot</refentrytitle>
1599             <manvolnum>3</manvolnum>
1600             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1601         </refmeta>
1602         <refnamediv>
1603             <refname>FcConfigGetSysRoot</refname>
1604             <refpurpose>Obtain the system root directory</refpurpose>
1605         </refnamediv>
1606         <refsynopsisdiv>
1607         <funcsynopsis>
1608         <funcsynopsisinfo>
1609 #include &lt;fontconfig/fontconfig.h&gt;
1610         </funcsynopsisinfo>
1611         <funcprototype>
1612             <funcdef>const FcChar8 * <function>FcConfigGetSysRoot</function></funcdef>
1613                 <paramdef>const FcConfig *<parameter>config</parameter></paramdef>
1614         </funcprototype>
1615         </funcsynopsis>
1616         </refsynopsisdiv>
1617         <refsect1><title>Description</title>
1618             <para>
1619 Obtrains the system root directory in 'config' if available.
1620             </para>
1621         </refsect1>
1622         <refsect1><title>Since</title>
1623             <para>version 2.10.92</para>
1624         </refsect1>
1625     </refentry>
1626 <!--
1627    fontconfig/doc/func.sgml
1628
1629    Copyright © 2003 Keith Packard
1630
1631    Permission to use, copy, modify, distribute, and sell this software and its
1632    documentation for any purpose is hereby granted without fee, provided that
1633    the above copyright notice appear in all copies and that both that
1634    copyright notice and this permission notice appear in supporting
1635    documentation, and that the name of the author(s) not be used in
1636    advertising or publicity pertaining to distribution of the software without
1637    specific, written prior permission.  The authors make no
1638    representations about the suitability of this software for any purpose.  It
1639    is provided "as is" without express or implied warranty.
1640
1641    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1642    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1643    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1644    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1645    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1646    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1647    PERFORMANCE OF THIS SOFTWARE.
1648  -->
1649     <refentry id="FcConfigSetSysRoot">
1650         <refmeta>
1651             <refentrytitle>FcConfigSetSysRoot</refentrytitle>
1652             <manvolnum>3</manvolnum>
1653             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1654         </refmeta>
1655         <refnamediv>
1656             <refname>FcConfigSetSysRoot</refname>
1657             <refpurpose>Set the system root directory</refpurpose>
1658         </refnamediv>
1659         <refsynopsisdiv>
1660         <funcsynopsis>
1661         <funcsynopsisinfo>
1662 #include &lt;fontconfig/fontconfig.h&gt;
1663         </funcsynopsisinfo>
1664         <funcprototype>
1665             <funcdef>void <function>FcConfigSetSysRoot</function></funcdef>
1666                 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1667                 <paramdef>const FcChar8 *<parameter>sysroot</parameter></paramdef>
1668         </funcprototype>
1669         </funcsynopsis>
1670         </refsynopsisdiv>
1671         <refsect1><title>Description</title>
1672             <para>
1673 Set 'sysroot' as the system root directory. fontconfig prepend 'sysroot'
1674 to the cache directories in order to allow people to generate caches at
1675 the build time. Note that this causes changing current config. i.e.
1676 this function calls FcConfigSetCurrent() internally.
1677             </para>
1678         </refsect1>
1679         <refsect1><title>Since</title>
1680             <para>version 2.10.92</para>
1681         </refsect1>
1682     </refentry>