344 lines
13 KiB
Plaintext
344 lines
13 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="FcDirCacheUnlink">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheUnlink</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheUnlink</refname>
|
|
<refpurpose>Remove all caches related to <parameter>dir</parameter></refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcBool <function>FcDirCacheUnlink</function></funcdef>
|
|
<paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
|
|
<paramdef>FcConfig *<parameter>config</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Scans the cache directories in <parameter>config</parameter>, removing any
|
|
instances of the cache file for <parameter>dir</parameter>. Returns FcFalse
|
|
when some internal error occurs (out of memory, etc). Errors actually
|
|
unlinking any files are ignored.
|
|
</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="FcDirCacheValid">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheValid</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheValid</refname>
|
|
<refpurpose>check directory cache</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcBool <function>FcDirCacheValid</function></funcdef>
|
|
<paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Returns FcTrue if <parameter>dir</parameter> has an associated valid cache
|
|
file, else returns FcFalse
|
|
</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="FcDirCacheLoad">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheLoad</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheLoad</refname>
|
|
<refpurpose>load a directory cache</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcCache * <function>FcDirCacheLoad</function></funcdef>
|
|
<paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
|
|
<paramdef>FcConfig *<parameter>config</parameter></paramdef>
|
|
<paramdef>FcChar8 **<parameter>cache_file</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
Loads the cache related to <parameter>dir</parameter>. If no cache file
|
|
exists, returns NULL. The name of the cache file is returned in
|
|
<parameter>cache_file</parameter>, unless that is NULL. See also
|
|
FcDirCacheRead.
|
|
</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="FcDirCacheRead">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheRead</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheRead</refname>
|
|
<refpurpose>read or construct a directory cache</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcCache * <function>FcDirCacheRead</function></funcdef>
|
|
<paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
|
|
<paramdef>FcBool <parameter>force</parameter></paramdef>
|
|
<paramdef>FcConfig *<parameter>config</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This returns a cache for <parameter>dir</parameter>. If
|
|
<parameter>force</parameter> is FcFalse, then an existing, valid cache file
|
|
will be used. Otherwise, a new cache will be created by scanning the
|
|
directory and that returned.
|
|
</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="FcDirCacheLoadFile">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheLoadFile</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheLoadFile</refname>
|
|
<refpurpose>load a cache file</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcCache * <function>FcDirCacheLoadFile</function></funcdef>
|
|
<paramdef>const FcChar8 *<parameter>cache_file</parameter></paramdef>
|
|
<paramdef>struct stat *<parameter>file_stat</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This function loads a directory cache from
|
|
<parameter>cache_file</parameter>. If <parameter>file_stat</parameter> is
|
|
non-NULL, it will be filled with the results of stat(2) on the cache file.
|
|
</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="FcDirCacheUnload">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheUnload</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheUnload</refname>
|
|
<refpurpose>unload a cache file</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>void <function>FcDirCacheUnload</function></funcdef>
|
|
<paramdef>FcCache *<parameter>cache</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This function dereferences <parameter>cache</parameter>. When no other
|
|
references to it remain, all memory associated with the cache will be freed.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Version</title>
|
|
<para>
|
|
Fontconfig version &version;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|