X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=doc%2Ffcfile.fncs;h=48213655457f743b68ddbb22dc7eec724d9bd285;hb=f2772d6b45bcfc27618968fdbb08dcc50a18be22;hp=b20b099fe718a85ed6c36b07c8177111b2cef393;hpb=39381776a4c0cf4077a31f3a493cbd37420cec71;p=fontconfig.git

diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs
index b20b099..4821365 100644
--- a/doc/fcfile.fncs
+++ b/doc/fcfile.fncs
@@ -1,7 +1,7 @@
 /*
  * $Id$
  *
- * Copyright © 2003 Keith Packard
+ * 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
@@ -28,15 +28,29 @@
 @TYPE2@		FcStrSet *			@ARG2@		dirs	
 @TYPE3@		FcFileCache *			@ARG3@		cache	
 @TYPE4@		FcBlanks *			@ARG4@		blanks	
-@TYPE5@		const char *			@ARG5@		file	
-@TYPE6@		FcBool 				@ARG6@		force	
+@TYPE5@		const FcChar8 *			@ARG5@		file	
+@TYPE6@		FcBool% 				@ARG6@		force	
 @PURPOSE@	scan a font file
 @DESC@
 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>.
+<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.
+@@
+
+@RET@		FcBool
+@FUNC@		FcFileIsDir
+@TYPE1@		const FcChar8 *			@ARG1@		file
+@PURPOSE@	check whether a file is a directory
+@DESC@
+Returns FcTrue if <parameter>file</parameter> is a directory, otherwise
+returns FcFalse.
 @@
 
 @RET@		FcBool 	
@@ -45,22 +59,24 @@ associated information is found in <parameter>cache</parameter>.  If
 @TYPE2@		FcStrSet *			@ARG2@		dirs	
 @TYPE3@		FcFileCache *			@ARG3@		cache	
 @TYPE4@		FcBlanks *			@ARG4@		blanks	
-@TYPE5@		const char *			@ARG5@		dir	
-@TYPE6@		FcBool 				@ARG6@		force	
+@TYPE5@		const FcChar8 *			@ARG5@		dir	
+@TYPE6@		FcBool% 				@ARG6@		force	
 @PURPOSE@	scan a font directory
 @DESC@
 Scans an entire directory and adds all fonts found to
 <parameter>set</parameter>.  If <parameter>force</parameter> is FcTrue, then
 the directory and all files within it are scanned even if information is
 present in the per-directory cache file or <parameter>cache</parameter>.  Any
-subdirectories found are added to <parameter>dirs</parameter>.
+subdirectories found are added to <parameter>dirs</parameter>. See the
+manual for <function>FcFileScan</function> for a description of how
+fontconfig selects which fonts to include.
 @@
 
 @RET@		FcBool 	
 @FUNC@		FcDirSave 
 @TYPE1@		FcFontSet *			@ARG1@		set	
 @TYPE2@		FcStrSet *			@ARG2@		dirs	
-@TYPE3@		const char *			@ARG3@		dir	
+@TYPE3@		const FcChar8 *			@ARG3@		dir	
 @PURPOSE@	save a directory cache
 @DESC@
 Creates the per-directory cache file for <parameter>dir</parameter> and
@@ -68,11 +84,3 @@ populates it with the fonts in <parameter>set</parameter> and subdirectories
 in <parameter>dirs</parameter>.
 @@
 
-@RET@		FcBool 	
-@FUNC@		FcDirCacheValid 
-@TYPE1@		const FcChar8 *			@ARG1@		cache_file	
-@PURPOSE@	check directory cache timestamp
-@DESC@
-Returns FcTrue if <parameter>cache_file</parameter> is no older than the
-directory containing it, else FcFalse.
-@@