xenocara/lib/fontconfig/doc/FcFileScan.3

32 lines
1.1 KiB
Groff

.\\" auto-generated by docbook2man-spec $Revision: 1.3 $
.TH "FcFileScan" "3" "18 November 2009" "" ""
.SH NAME
FcFileScan \- scan a font file
.SH SYNOPSIS
.nf
\fB#include <fontconfig.h>
.sp
FcBool FcFileScan(FcFontSet *\fIset\fB);
(FcStrSet *\fIdirs\fB);
(FcFileCache *\fIcache\fB);
(FcBlanks *\fIblanks\fB);
(const FcChar8 *\fIfile\fB);
(FcBool \fIforce\fB);
\fR.fi
.SH "DESCRIPTION"
.PP
Scans a single file and adds all fonts found to \fIset\fR\&.
If \fIforce\fR is FcTrue, then the file is scanned even if
associated information is found in \fIcache\fR\&. If
\fIfile\fR is a directory, it is added to
\fIdirs\fR\&. 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.
.SH "VERSION"
.PP
Fontconfig version 2.8.0