]> git.wh0rd.org - fontconfig.git/blame - doc/fcfile.fncs
Document skipping of fonts from FcFileScan/FcDirScan.
[fontconfig.git] / doc / fcfile.fncs
CommitLineData
39381776
KP
1/*
2 * $Id$
3 *
46b51147 4 * Copyright © 2003 Keith Packard
39381776
KP
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 Keith Packard not be used in
11 * advertising or publicity pertaining to distribution of the software without
12 * specific, written prior permission. Keith Packard makes 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 * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18 * EVENT SHALL KEITH PACKARD 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
25@RET@ FcBool
26@FUNC@ FcFileScan
27@TYPE1@ FcFontSet * @ARG1@ set
28@TYPE2@ FcStrSet * @ARG2@ dirs
29@TYPE3@ FcFileCache * @ARG3@ cache
30@TYPE4@ FcBlanks * @ARG4@ blanks
31@TYPE5@ const char * @ARG5@ file
61895ed1 32@TYPE6@ FcBool% @ARG6@ force
39381776
KP
33@PURPOSE@ scan a font file
34@DESC@
35Scans a single file and adds all fonts found to <parameter>set</parameter>.
36If <parameter>force</parameter> is FcTrue, then the file is scanned even if
37associated information is found in <parameter>cache</parameter>. If
38<parameter>file</parameter> is a directory, it is added to
2ddce88c
KP
39<parameter>dirs</parameter>. Whether fonts are found depends on fontconfig
40poliy as well as the current configuration.
39381776
KP
41@@
42
43@RET@ FcBool
44@FUNC@ FcDirScan
45@TYPE1@ FcFontSet * @ARG1@ set
46@TYPE2@ FcStrSet * @ARG2@ dirs
47@TYPE3@ FcFileCache * @ARG3@ cache
48@TYPE4@ FcBlanks * @ARG4@ blanks
49@TYPE5@ const char * @ARG5@ dir
61895ed1 50@TYPE6@ FcBool% @ARG6@ force
39381776
KP
51@PURPOSE@ scan a font directory
52@DESC@
53Scans an entire directory and adds all fonts found to
54<parameter>set</parameter>. If <parameter>force</parameter> is FcTrue, then
55the directory and all files within it are scanned even if information is
56present in the per-directory cache file or <parameter>cache</parameter>. Any
2ddce88c
KP
57subdirectories found are added to <parameter>dirs</parameter>. Whether fonts
58or directories are found depends on fontconfig
59policy as well as the current configuration.
39381776
KP
60@@
61
62@RET@ FcBool
63@FUNC@ FcDirSave
64@TYPE1@ FcFontSet * @ARG1@ set
65@TYPE2@ FcStrSet * @ARG2@ dirs
66@TYPE3@ const char * @ARG3@ dir
67@PURPOSE@ save a directory cache
68@DESC@
69Creates the per-directory cache file for <parameter>dir</parameter> and
70populates it with the fonts in <parameter>set</parameter> and subdirectories
71in <parameter>dirs</parameter>.
72@@
73
74@RET@ FcBool
75@FUNC@ FcDirCacheValid
76@TYPE1@ const FcChar8 * @ARG1@ cache_file
77@PURPOSE@ check directory cache timestamp
78@DESC@
79Returns FcTrue if <parameter>cache_file</parameter> is no older than the
80directory containing it, else FcFalse.
81@@