367 lines
15 KiB
Plaintext
367 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="FcCacheDir">
|
|
<refmeta>
|
|
<refentrytitle>FcCacheDir</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcCacheDir</refname>
|
|
<refpurpose>Return directory of <parameter>cache</parameter></refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>const FcChar8 * <function>FcCacheDir</function></funcdef>
|
|
<paramdef>const FcCache *<parameter>cache</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This function returns the directory from which the cache was constructed.
|
|
</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="FcCacheCopySet">
|
|
<refmeta>
|
|
<refentrytitle>FcCacheCopySet</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcCacheCopySet</refname>
|
|
<refpurpose>Returns a copy of the fontset from <parameter>cache</parameter></refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcFontSet * <function>FcCacheCopySet</function></funcdef>
|
|
<paramdef>const FcCache *<parameter>cache</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
The returned fontset contains each of the font patterns from
|
|
<parameter>cache</parameter>. This fontset may be modified, but the patterns
|
|
from the cache are read-only.
|
|
</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="FcCacheSubdir">
|
|
<refmeta>
|
|
<refentrytitle>FcCacheSubdir</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcCacheSubdir</refname>
|
|
<refpurpose>Return the <parameter>i</parameter>'th subdirectory.</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>const FcChar8 * <function>FcCacheSubdir</function></funcdef>
|
|
<paramdef>const FcCache *<parameter>cache</parameter></paramdef>
|
|
<paramdef>int<parameter>i</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
The set of subdirectories stored in a cache file are indexed by this
|
|
function, <parameter>i</parameter> should range from 0 to
|
|
<parameter>n</parameter>-1, where <parameter>n</parameter> is the return
|
|
value from FcCacheNumSubdir.
|
|
</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="FcCacheNumSubdir">
|
|
<refmeta>
|
|
<refentrytitle>FcCacheNumSubdir</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcCacheNumSubdir</refname>
|
|
<refpurpose>Return the number of subdirectories in <parameter>cache</parameter>.</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>int <function>FcCacheNumSubdir</function></funcdef>
|
|
<paramdef>const FcCache *<parameter>cache</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This returns the total number of subdirectories in the cache.
|
|
</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="FcCacheNumFont">
|
|
<refmeta>
|
|
<refentrytitle>FcCacheNumFont</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcCacheNumFont</refname>
|
|
<refpurpose>Returns the number of fonts in <parameter>cache</parameter>.</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>int <function>FcCacheNumFont</function></funcdef>
|
|
<paramdef>const FcCache *<parameter>cache</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This returns the number of fonts which would be included in the return from
|
|
FcCacheCopySet.
|
|
</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="FcDirCacheClean">
|
|
<refmeta>
|
|
<refentrytitle>FcDirCacheClean</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcDirCacheClean</refname>
|
|
<refpurpose>This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
|
|
This returns FcTrue if the operation is successfully complete. otherwise FcFalse.</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>FcBool <function>FcDirCacheClean</function></funcdef>
|
|
<paramdef>const FcChar8 *<parameter>cache_dir</parameter></paramdef>
|
|
<paramdef>FcBool<parameter>verbose</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Since</title>
|
|
<para>version 2.9.91</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="FcCacheCreateTagFile">
|
|
<refmeta>
|
|
<refentrytitle>FcCacheCreateTagFile</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>FcCacheCreateTagFile</refname>
|
|
<refpurpose>Create CACHEDIR.TAG at cache directory.</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <fontconfig/fontconfig.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>void <function>FcCacheCreateTagFile</function></funcdef>
|
|
<paramdef>const FcConfig *<parameter>config</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
This tries to create CACHEDIR.TAG file at the cache directory registered
|
|
to <parameter>config</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Since</title>
|
|
<para>version 2.9.91</para>
|
|
</refsect1>
|
|
</refentry>
|