doc/fcinit.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="FcInitLoadConfig">
  25         <refmeta>
  26             <refentrytitle>FcInitLoadConfig</refentrytitle>
  27             <manvolnum>3</manvolnum>
  28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  29         </refmeta>
  30         <refnamediv>
  31             <refname>FcInitLoadConfig</refname>
  32             <refpurpose>load 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>FcInitLoadConfig</function></funcdef>
  41                 <paramdef>void<parameter></parameter></paramdef>
  42         </funcprototype>
  43         </funcsynopsis>
  44         </refsynopsisdiv>
  45         <refsect1><title>Description</title>
  46             <para>
  47 Loads the default configuration file and returns the resulting configuration.
  48 Does not load any font information.
  49             </para>
  50         </refsect1>
  51     </refentry>
  52 <!--
  53    fontconfig/doc/func.sgml
  54
  55    Copyright © 2003 Keith Packard
  56
  57    Permission to use, copy, modify, distribute, and sell this software and its
  58    documentation for any purpose is hereby granted without fee, provided that
  59    the above copyright notice appear in all copies and that both that
  60    copyright notice and this permission notice appear in supporting
  61    documentation, and that the name of the author(s) not be used in
  62    advertising or publicity pertaining to distribution of the software without
  63    specific, written prior permission.  The authors make no
  64    representations about the suitability of this software for any purpose.  It
  65    is provided "as is" without express or implied warranty.
  66
  67    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  68    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  69    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  70    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  71    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  72    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  73    PERFORMANCE OF THIS SOFTWARE.
  74  -->
  75     <refentry id="FcInitLoadConfigAndFonts">
  76         <refmeta>
  77             <refentrytitle>FcInitLoadConfigAndFonts</refentrytitle>
  78             <manvolnum>3</manvolnum>
  79             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  80         </refmeta>
  81         <refnamediv>
  82             <refname>FcInitLoadConfigAndFonts</refname>
  83             <refpurpose>load configuration and font data</refpurpose>
  84         </refnamediv>
  85         <refsynopsisdiv>
  86         <funcsynopsis>
  87         <funcsynopsisinfo>
  88 #include &lt;fontconfig/fontconfig.h&gt;
  89         </funcsynopsisinfo>
  90         <funcprototype>
  91             <funcdef>FcConfig * <function>FcInitLoadConfigAndFonts</function></funcdef>
  92                 <paramdef>void<parameter></parameter></paramdef>
  93         </funcprototype>
  94         </funcsynopsis>
  95         </refsynopsisdiv>
  96         <refsect1><title>Description</title>
  97             <para>
  98 Loads the default configuration file and builds information about the
  99 available fonts.  Returns the resulting configuration.
 100             </para>
 101         </refsect1>
 102     </refentry>
 103 <!--
 104    fontconfig/doc/func.sgml
 105
 106    Copyright © 2003 Keith Packard
 107
 108    Permission to use, copy, modify, distribute, and sell this software and its
 109    documentation for any purpose is hereby granted without fee, provided that
 110    the above copyright notice appear in all copies and that both that
 111    copyright notice and this permission notice appear in supporting
 112    documentation, and that the name of the author(s) not be used in
 113    advertising or publicity pertaining to distribution of the software without
 114    specific, written prior permission.  The authors make no
 115    representations about the suitability of this software for any purpose.  It
 116    is provided "as is" without express or implied warranty.
 117
 118    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 119    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 120    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 121    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 122    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 123    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 124    PERFORMANCE OF THIS SOFTWARE.
 125  -->
 126     <refentry id="FcInit">
 127         <refmeta>
 128             <refentrytitle>FcInit</refentrytitle>
 129             <manvolnum>3</manvolnum>
 130             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 131         </refmeta>
 132         <refnamediv>
 133             <refname>FcInit</refname>
 134             <refpurpose>initialize fontconfig library</refpurpose>
 135         </refnamediv>
 136         <refsynopsisdiv>
 137         <funcsynopsis>
 138         <funcsynopsisinfo>
 139 #include &lt;fontconfig/fontconfig.h&gt;
 140         </funcsynopsisinfo>
 141         <funcprototype>
 142             <funcdef>FcBool <function>FcInit</function></funcdef>
 143                 <paramdef>void<parameter></parameter></paramdef>
 144         </funcprototype>
 145         </funcsynopsis>
 146         </refsynopsisdiv>
 147         <refsect1><title>Description</title>
 148             <para>
 149 Loads the default configuration file and the fonts referenced therein and
 150 sets the default configuration to that result.  Returns whether this
 151 process succeeded or not.  If the default configuration has already
 152 been loaded, this routine does nothing and returns FcTrue.
 153             </para>
 154         </refsect1>
 155     </refentry>
 156 <!--
 157    fontconfig/doc/func.sgml
 158
 159    Copyright © 2003 Keith Packard
 160
 161    Permission to use, copy, modify, distribute, and sell this software and its
 162    documentation for any purpose is hereby granted without fee, provided that
 163    the above copyright notice appear in all copies and that both that
 164    copyright notice and this permission notice appear in supporting
 165    documentation, and that the name of the author(s) not be used in
 166    advertising or publicity pertaining to distribution of the software without
 167    specific, written prior permission.  The authors make no
 168    representations about the suitability of this software for any purpose.  It
 169    is provided "as is" without express or implied warranty.
 170
 171    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 172    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 173    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 174    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 175    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 176    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 177    PERFORMANCE OF THIS SOFTWARE.
 178  -->
 179     <refentry id="FcFini">
 180         <refmeta>
 181             <refentrytitle>FcFini</refentrytitle>
 182             <manvolnum>3</manvolnum>
 183             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 184         </refmeta>
 185         <refnamediv>
 186             <refname>FcFini</refname>
 187             <refpurpose>finalize fontconfig library</refpurpose>
 188         </refnamediv>
 189         <refsynopsisdiv>
 190         <funcsynopsis>
 191         <funcsynopsisinfo>
 192 #include &lt;fontconfig/fontconfig.h&gt;
 193         </funcsynopsisinfo>
 194         <funcprototype>
 195             <funcdef>void <function>FcFini</function></funcdef>
 196                 <paramdef>void<parameter></parameter></paramdef>
 197         </funcprototype>
 198         </funcsynopsis>
 199         </refsynopsisdiv>
 200         <refsect1><title>Description</title>
 201             <para>
 202 Frees all data structures allocated by previous calls to fontconfig
 203 functions. Fontconfig returns to an uninitialized state, requiring a
 204 new call to one of the FcInit functions before any other fontconfig
 205 function may be called.
 206             </para>
 207         </refsect1>
 208     </refentry>
 209 <!--
 210    fontconfig/doc/func.sgml
 211
 212    Copyright © 2003 Keith Packard
 213
 214    Permission to use, copy, modify, distribute, and sell this software and its
 215    documentation for any purpose is hereby granted without fee, provided that
 216    the above copyright notice appear in all copies and that both that
 217    copyright notice and this permission notice appear in supporting
 218    documentation, and that the name of the author(s) not be used in
 219    advertising or publicity pertaining to distribution of the software without
 220    specific, written prior permission.  The authors make no
 221    representations about the suitability of this software for any purpose.  It
 222    is provided "as is" without express or implied warranty.
 223
 224    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 225    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 226    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 227    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 228    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 229    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 230    PERFORMANCE OF THIS SOFTWARE.
 231  -->
 232     <refentry id="FcGetVersion">
 233         <refmeta>
 234             <refentrytitle>FcGetVersion</refentrytitle>
 235             <manvolnum>3</manvolnum>
 236             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 237         </refmeta>
 238         <refnamediv>
 239             <refname>FcGetVersion</refname>
 240             <refpurpose>library version number</refpurpose>
 241         </refnamediv>
 242         <refsynopsisdiv>
 243         <funcsynopsis>
 244         <funcsynopsisinfo>
 245 #include &lt;fontconfig/fontconfig.h&gt;
 246         </funcsynopsisinfo>
 247         <funcprototype>
 248             <funcdef>int <function>FcGetVersion</function></funcdef>
 249                 <paramdef>void<parameter></parameter></paramdef>
 250         </funcprototype>
 251         </funcsynopsis>
 252         </refsynopsisdiv>
 253         <refsect1><title>Description</title>
 254             <para>
 255 Returns the version number of the library.
 256             </para>
 257         </refsect1>
 258     </refentry>
 259 <!--
 260    fontconfig/doc/func.sgml
 261
 262    Copyright © 2003 Keith Packard
 263
 264    Permission to use, copy, modify, distribute, and sell this software and its
 265    documentation for any purpose is hereby granted without fee, provided that
 266    the above copyright notice appear in all copies and that both that
 267    copyright notice and this permission notice appear in supporting
 268    documentation, and that the name of the author(s) not be used in
 269    advertising or publicity pertaining to distribution of the software without
 270    specific, written prior permission.  The authors make no
 271    representations about the suitability of this software for any purpose.  It
 272    is provided "as is" without express or implied warranty.
 273
 274    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 275    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 276    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 277    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 278    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 279    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 280    PERFORMANCE OF THIS SOFTWARE.
 281  -->
 282     <refentry id="FcInitReinitialize">
 283         <refmeta>
 284             <refentrytitle>FcInitReinitialize</refentrytitle>
 285             <manvolnum>3</manvolnum>
 286             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 287         </refmeta>
 288         <refnamediv>
 289             <refname>FcInitReinitialize</refname>
 290             <refpurpose>re-initialize library</refpurpose>
 291         </refnamediv>
 292         <refsynopsisdiv>
 293         <funcsynopsis>
 294         <funcsynopsisinfo>
 295 #include &lt;fontconfig/fontconfig.h&gt;
 296         </funcsynopsisinfo>
 297         <funcprototype>
 298             <funcdef>FcBool <function>FcInitReinitialize</function></funcdef>
 299                 <paramdef>void<parameter></parameter></paramdef>
 300         </funcprototype>
 301         </funcsynopsis>
 302         </refsynopsisdiv>
 303         <refsect1><title>Description</title>
 304             <para>
 305 Forces the default configuration file to be reloaded and resets the default
 306 configuration. Returns FcFalse if the configuration cannot be reloaded (due
 307 to configuration file errors, allocation failures or other issues) and leaves the
 308 existing configuration unchanged. Otherwise returns FcTrue.
 309             </para>
 310         </refsect1>
 311     </refentry>
 312 <!--
 313    fontconfig/doc/func.sgml
 314
 315    Copyright © 2003 Keith Packard
 316
 317    Permission to use, copy, modify, distribute, and sell this software and its
 318    documentation for any purpose is hereby granted without fee, provided that
 319    the above copyright notice appear in all copies and that both that
 320    copyright notice and this permission notice appear in supporting
 321    documentation, and that the name of the author(s) not be used in
 322    advertising or publicity pertaining to distribution of the software without
 323    specific, written prior permission.  The authors make no
 324    representations about the suitability of this software for any purpose.  It
 325    is provided "as is" without express or implied warranty.
 326
 327    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 328    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 329    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 330    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 331    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 332    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 333    PERFORMANCE OF THIS SOFTWARE.
 334  -->
 335     <refentry id="FcInitBringUptoDate">
 336         <refmeta>
 337             <refentrytitle>FcInitBringUptoDate</refentrytitle>
 338             <manvolnum>3</manvolnum>
 339             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 340         </refmeta>
 341         <refnamediv>
 342             <refname>FcInitBringUptoDate</refname>
 343             <refpurpose>reload configuration files if needed</refpurpose>
 344         </refnamediv>
 345         <refsynopsisdiv>
 346         <funcsynopsis>
 347         <funcsynopsisinfo>
 348 #include &lt;fontconfig/fontconfig.h&gt;
 349         </funcsynopsisinfo>
 350         <funcprototype>
 351             <funcdef>FcBool <function>FcInitBringUptoDate</function></funcdef>
 352                 <paramdef>void<parameter></parameter></paramdef>
 353         </funcprototype>
 354         </funcsynopsis>
 355         </refsynopsisdiv>
 356         <refsect1><title>Description</title>
 357             <para>
 358 Checks the rescan interval in the default configuration, checking the
 359 configuration if the interval has passed and reloading the configuration if
 360 when any changes are detected. Returns FcFalse if the configuration cannot
 361 be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
 362             </para>
 363         </refsect1>
 364     </refentry>