393 lines
15 KiB
Plaintext
393 lines
15 KiB
Plaintext
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcInitLoadConfig">
|
|
<refmeta>
|
|
<refentrytitle>FcInitLoadConfig</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcInitLoadConfig</refname>
|
|
<refpurpose>load configuration</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcConfig * <function>FcInitLoadConfig</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Loads the default configuration file and returns the resulting configuration.
|
|
Does not load any font information.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcInitLoadConfigAndFonts">
|
|
<refmeta>
|
|
<refentrytitle>FcInitLoadConfigAndFonts</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcInitLoadConfigAndFonts</refname>
|
|
<refpurpose>load configuration and font data</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcConfig * <function>FcInitLoadConfigAndFonts</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Loads the default configuration file and builds information about the
|
|
available fonts. Returns the resulting configuration.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcInit">
|
|
<refmeta>
|
|
<refentrytitle>FcInit</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcInit</refname>
|
|
<refpurpose>initialize fontconfig library</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcBool <function>FcInit</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Loads the default configuration file and the fonts referenced therein and
|
|
sets the default configuration to that result. Returns whether this
|
|
process succeeded or not. If the default configuration has already
|
|
been loaded, this routine does nothing and returns FcTrue.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcFini">
|
|
<refmeta>
|
|
<refentrytitle>FcFini</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcFini</refname>
|
|
<refpurpose>finalize fontconfig library</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>void <function>FcFini</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Frees all data structures allocated by previous calls to fontconfig
|
|
functions. Fontconfig returns to an uninitialized state, requiring a
|
|
new call to one of the FcInit functions before any other fontconfig
|
|
function may be called.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcGetVersion">
|
|
<refmeta>
|
|
<refentrytitle>FcGetVersion</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcGetVersion</refname>
|
|
<refpurpose>library version number</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>int <function>FcGetVersion</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Returns the version number of the library.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcInitReinitialize">
|
|
<refmeta>
|
|
<refentrytitle>FcInitReinitialize</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcInitReinitialize</refname>
|
|
<refpurpose>re-initialize library</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcBool <function>FcInitReinitialize</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Forces the default configuration file to be reloaded and resets the default
|
|
configuration. Returns FcFalse if the configuration cannot be reloaded (due
|
|
to configuration file errors, allocation failures or other issues) and leaves the
|
|
existing configuration unchanged. Otherwise returns FcTrue.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--
|
|
fontconfig/doc/func.sgml
|
|
|
|
Copyright © 2003 Keith Packard
|
|
|
|
Permission to use, copy, modify, distribute, and sell this software and its
|
|
documentation for any purpose is hereby granted without fee, provided that
|
|
the above copyright notice appear in all copies and that both that
|
|
copyright notice and this permission notice appear in supporting
|
|
documentation, and that the name of the author(s) not be used in
|
|
advertising or publicity pertaining to distribution of the software without
|
|
specific, written prior permission. The authors make no
|
|
representations about the suitability of this software for any purpose. It
|
|
is provided "as is" without express or implied warranty.
|
|
|
|
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
|
|
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
|
|
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
|
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
PERFORMANCE OF THIS SOFTWARE.
|
|
-->
|
|
<refentry id="FcInitBringUptoDate">
|
|
<refmeta>
|
|
<refentrytitle>FcInitBringUptoDate</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcInitBringUptoDate</refname>
|
|
<refpurpose>reload configuration files if needed</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcBool <function>FcInitBringUptoDate</function></funcdef>
|
|
<paramdef>void<parameter></parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Checks the rescan interval in the default configuration, checking the
|
|
configuration if the interval has passed and reloading the configuration if
|
|
when any changes are detected. Returns FcFalse if the configuration cannot
|
|
be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|