249 lines
10 KiB
Plaintext
249 lines
10 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="FcFileScan">
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>FcFileScan</refentrytitle>
|
||
|
|
<manvolnum>3</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>FcFileScan</refname>
|
||
|
|
<refpurpose>scan a font file</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcsynopsisinfo>
|
||
|
|
#include <fontconfig/fontconfig.h>
|
||
|
|
</funcsynopsisinfo>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>FcBool <function>FcFileScan</function></funcdef>
|
||
|
|
<paramdef>FcFontSet *<parameter>set</parameter></paramdef>
|
||
|
|
<paramdef>FcStrSet *<parameter>dirs</parameter></paramdef>
|
||
|
|
<paramdef>FcFileCache *<parameter>cache</parameter></paramdef>
|
||
|
|
<paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
|
||
|
|
<paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
|
||
|
|
<paramdef>FcBool <parameter>force</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1><title>Description</title>
|
||
|
|
<para>
|
||
|
|
Scans a single file and adds all fonts found to <parameter>set</parameter>.
|
||
|
|
If <parameter>force</parameter> is FcTrue, then the file is scanned even if
|
||
|
|
associated information is found in <parameter>cache</parameter>. If
|
||
|
|
<parameter>file</parameter> is a directory, it is added to
|
||
|
|
<parameter>dirs</parameter>. Whether fonts are found depends on fontconfig
|
||
|
|
policy as well as the current configuration. Internally, fontconfig will
|
||
|
|
ignore BDF and PCF fonts which are not in Unicode (or the effectively
|
||
|
|
equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
|
||
|
|
applications. The configuration can ignore fonts based on filename or
|
||
|
|
contents of the font file itself. Returns FcFalse if any of the fonts cannot be
|
||
|
|
added (due to allocation failure). 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="FcFileIsDir">
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>FcFileIsDir</refentrytitle>
|
||
|
|
<manvolnum>3</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>FcFileIsDir</refname>
|
||
|
|
<refpurpose>check whether a file is a directory</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcsynopsisinfo>
|
||
|
|
#include <fontconfig/fontconfig.h>
|
||
|
|
</funcsynopsisinfo>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>FcBool <function>FcFileIsDir</function></funcdef>
|
||
|
|
<paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1><title>Description</title>
|
||
|
|
<para>
|
||
|
|
Returns FcTrue if <parameter>file</parameter> is a directory, otherwise
|
||
|
|
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="FcDirScan">
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>FcDirScan</refentrytitle>
|
||
|
|
<manvolnum>3</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>FcDirScan</refname>
|
||
|
|
<refpurpose>scan a font directory without caching it</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcsynopsisinfo>
|
||
|
|
#include <fontconfig/fontconfig.h>
|
||
|
|
</funcsynopsisinfo>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>FcBool <function>FcDirScan</function></funcdef>
|
||
|
|
<paramdef>FcFontSet *<parameter>set</parameter></paramdef>
|
||
|
|
<paramdef>FcStrSet *<parameter>dirs</parameter></paramdef>
|
||
|
|
<paramdef>FcFileCache *<parameter>cache</parameter></paramdef>
|
||
|
|
<paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
|
||
|
|
<paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
|
||
|
|
<paramdef>FcBool <parameter>force</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1><title>Description</title>
|
||
|
|
<para>
|
||
|
|
If <parameter>cache</parameter> is not zero or if <parameter>force</parameter>
|
||
|
|
is FcFalse, this function currently returns FcFalse. Otherwise, it scans an
|
||
|
|
entire directory and adds all fonts found to <parameter>set</parameter>.
|
||
|
|
Any subdirectories found are added to <parameter>dirs</parameter>. Calling
|
||
|
|
this function does not create any cache files. Use FcDirCacheRead() if
|
||
|
|
caching is desired.
|
||
|
|
</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="FcDirSave">
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>FcDirSave</refentrytitle>
|
||
|
|
<manvolnum>3</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>FcDirSave</refname>
|
||
|
|
<refpurpose>DEPRECATED: formerly used to save a directory cache</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcsynopsisinfo>
|
||
|
|
#include <fontconfig/fontconfig.h>
|
||
|
|
</funcsynopsisinfo>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>FcBool <function>FcDirSave</function></funcdef>
|
||
|
|
<paramdef>FcFontSet *<parameter>set</parameter></paramdef>
|
||
|
|
<paramdef>FcStrSet *<parameter>dirs</parameter></paramdef>
|
||
|
|
<paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1><title>Description</title>
|
||
|
|
<para>
|
||
|
|
This function now does nothing aside from returning FcFalse. It used to creates the
|
||
|
|
per-directory cache file for <parameter>dir</parameter> and populates it
|
||
|
|
with the fonts in <parameter>set</parameter> and subdirectories in
|
||
|
|
<parameter>dirs</parameter>. All of this functionality is now automatically
|
||
|
|
managed by FcDirCacheLoad and FcDirCacheRead.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1><title>Version</title>
|
||
|
|
<para>
|
||
|
|
Fontconfig version &version;
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
</refentry>
|