X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=doc%2Ffontconfig-devel.sgml;h=87339511c85f98437891d93f5246f50c2ba62dfe;hb=a53553b4b65d6230b1a91b1a7433c8c5852ab055;hp=3f91e642c5ab6430bd4ae6e5534499c4edb159f1;hpb=f2772d6b45bcfc27618968fdbb08dcc50a18be22;p=fontconfig.git

diff --git a/doc/fontconfig-devel.sgml b/doc/fontconfig-devel.sgml
index 3f91e64..8733951 100644
--- a/doc/fontconfig-devel.sgml
+++ b/doc/fontconfig-devel.sgml
@@ -1,13 +1,17 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
 <!ENTITY fcatomic SYSTEM "fcatomic.sgml">
 <!ENTITY fcblanks SYSTEM "fcblanks.sgml">
+<!ENTITY fccache SYSTEM "fccache.sgml">
 <!ENTITY fccharset SYSTEM "fccharset.sgml">
 <!ENTITY fcconfig SYSTEM "fcconfig.sgml">
 <!ENTITY fcconstant SYSTEM "fcconstant.sgml">
+<!ENTITY fcdircache SYSTEM "fcdircache.sgml">
 <!ENTITY fcfile SYSTEM "fcfile.sgml">
 <!ENTITY fcfontset SYSTEM "fcfontset.sgml">
+<!ENTITY fcformat SYSTEM "fcformat.sgml">
 <!ENTITY fcfreetype SYSTEM "fcfreetype.sgml">
 <!ENTITY fcinit SYSTEM "fcinit.sgml">
+<!ENTITY fclangset SYSTEM "fclangset.sgml">
 <!ENTITY fcmatrix SYSTEM "fcmatrix.sgml">
 <!ENTITY fcobjectset SYSTEM "fcobjectset.sgml">
 <!ENTITY fcobjecttype SYSTEM "fcobjecttype.sgml">
@@ -18,7 +22,7 @@
 <!ENTITY version SYSTEM "version.sgml">
 ]>
 <!--
-    $Id$
+    fontconfig/doc/local-fontconfig-devel.sgml
    
     Copyright © 2003 Keith Packard
    
@@ -26,15 +30,15 @@
     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 Keith Packard not be used in
+    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.  Keith Packard makes no
+    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.
    
-    KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
     INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
-    EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+    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
@@ -61,15 +65,15 @@ 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 Keith Packard not be used in
+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.  Keith Packard makes no
+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.
 			</simpara><simpara>
-KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
-EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+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
@@ -92,7 +96,7 @@ which accepts font patterns and returns the nearest matching font.
   <sect2><title>FONT CONFIGURATION</title>
     <para>
 The configuration module consists of the FcConfig datatype, libexpat and
-FcConfigParse which walks over an XML tree and ammends a configuration with
+FcConfigParse which walks over an XML tree and amends a configuration with
 data found within.  From an external perspective, configuration of the
 library consists of generating a valid XML tree and feeding that to
 FcConfigParse.  The only other mechanism provided to applications for
@@ -122,82 +126,83 @@ simplify and regularize font installation and customization.
 While font patterns may contain essentially any properties, there are some
 well known properties with associated types.  Fontconfig uses some of these
 properties for font matching and font completion.  Others are provided as a
-convenience for the applications rendering mechanism.
+convenience for the application's rendering mechanism.
     </para>
     <programlisting>
                  Property Definitions
 
-    Property       CPP Symbol           Type    Description
+    Property       C Preprocessor Symbol  Type    Description
     ----------------------------------------------------
-    family         FC_FAMILY            String  Font family names
-    familylang     FC_FAMILYLANG        String  Language cooresponding to
-                                                each family name
-    style          FC_STYLE             String  Font style. Overrides weight
-                                                and slant
-    stylelang      FC_STYLELANG         String  Language cooresponding to
-                                                each style name
-    fullname       FC_FULLNAME          String  Font face full name where
-                                                different from family and
-                                                family + style
-    fullnamelang   FC_FULLNAMELANG      String  Language cooresponding to
-                                                each fullname
-    slant          FC_SLANT             Int     Italic, oblique or roman
-    weight         FC_WEIGHT            Int     Light, medium, demibold,
-                                                bold or black
-    size           FC_SIZE              Double  Point size
-    width          FC_WIDTH             Int     Condensed, normal or expanded
-    aspect         FC_ASPECT            Double  Stretches glyphs horizontally
-                                                before hinting
-    pixelsize      FC_PIXEL_SIZE        Double  Pixel size
-    spacing        FC_SPACING           Int     Proportional, dual-width,
-                                                monospace or charcell
-    foundry        FC_FOUNDRY           String  Font foundry name
-    antialias      FC_ANTIALIAS         Bool    Whether glyphs can be
-                                                antialiased
-    hinting        FC_HINTING           Bool    Whether the rasterizer should
-                                                use hinting
-    hintstyle      FC_HINT_STYLE        Int     Automatic hinting style
-    verticallayout FC_VERTICAL_LAYOUT   Bool    Use vertical layout
-    autohint       FC_AUTOHINT          Bool    Use autohinter instead of
-                                                normal hinter
-    globaladvance  FC_GLOBAL_ADVANCE    Bool    Use font global advance data
-    file           FC_FILE              String  The filename holding the font
-    index          FC_INDEX             Int     The index of the font within
-                                                the file
-    ftface         FC_FT_FACE           FT_Face Use the specified FreeType
-                                                face object
-    rasterizer     FC_RASTERIZER        String  Which rasterizer is in use
-    outline        FC_OUTLINE           Bool    Whether the glyphs are outlines
-    scalable       FC_SCALABLE          Bool    Whether glyphs can be scaled
-    scale          FC_SCALE             Double  Scale factor for point->pixel
-                                                conversions
-    dpi            FC_DPI               Double  Target dots per inch
-    rgba           FC_RGBA              Int     unknown, rgb, bgr, vrgb,
-                                                vbgr, none - subpixel geometry
-    minspace       FC_MINSPACE          Bool    Eliminate leading from line
-                                                spacing
-    charset        FC_CHARSET           CharSet Unicode chars encoded by
-                                                the font
-    lang           FC_LANG              LangSet Set of RFC-3066-style
-                                                languages this font supports
-    fontversion    FC_FONTVERSION       Int     Version number of the font
-    capability     FC_CAPABILITY        String  List of layout capabilities in
-                                                the font
-    embolden       FC_EMBOLDEN          Bool    Rasterizer should
-                                                synthetically embolden the font
+    family         FC_FAMILY              String  Font family names
+    familylang     FC_FAMILYLANG          String  Language corresponding to
+                                                  each family name
+    style          FC_STYLE               String  Font style. Overrides weight
+                                                  and slant
+    stylelang      FC_STYLELANG           String  Language corresponding to
+                                                  each style name
+    fullname       FC_FULLNAME            String  Font face full name where
+                                                  different from family and
+                                                  family + style
+    fullnamelang   FC_FULLNAMELANG        String  Language corresponding to
+                                                  each fullname
+    slant          FC_SLANT               Int     Italic, oblique or roman
+    weight         FC_WEIGHT              Int     Light, medium, demibold,
+                                                  bold or black
+    size           FC_SIZE                Double  Point size
+    width          FC_WIDTH               Int     Condensed, normal or expanded
+    aspect         FC_ASPECT              Double  Stretches glyphs horizontally
+                                                  before hinting
+    pixelsize      FC_PIXEL_SIZE          Double  Pixel size
+    spacing        FC_SPACING             Int     Proportional, dual-width,
+                                                  monospace or charcell
+    foundry        FC_FOUNDRY             String  Font foundry name
+    antialias      FC_ANTIALIAS           Bool    Whether glyphs can be
+                                                  antialiased
+    hinting        FC_HINTING             Bool    Whether the rasterizer should
+                                                  use hinting
+    hintstyle      FC_HINT_STYLE          Int     Automatic hinting style
+    verticallayout FC_VERTICAL_LAYOUT     Bool    Use vertical layout
+    autohint       FC_AUTOHINT            Bool    Use autohinter instead of
+                                                  normal hinter
+    globaladvance  FC_GLOBAL_ADVANCE      Bool    Use font global advance data
+    file           FC_FILE                String  The filename holding the font
+    index          FC_INDEX               Int     The index of the font within
+                                                  the file
+    ftface         FC_FT_FACE             FT_Face Use the specified FreeType
+                                                  face object
+    rasterizer     FC_RASTERIZER          String  Which rasterizer is in use
+    outline        FC_OUTLINE             Bool    Whether the glyphs are outlines
+    scalable       FC_SCALABLE            Bool    Whether glyphs can be scaled
+    scale          FC_SCALE               Double  Scale factor for point->pixel
+                                                  conversions
+    dpi            FC_DPI                 Double  Target dots per inch
+    rgba           FC_RGBA                Int     unknown, rgb, bgr, vrgb,
+                                                  vbgr, none - subpixel geometry
+    lcdfilter      FC_LCD_FILTER          Int     Type of LCD filter
+    minspace       FC_MINSPACE            Bool    Eliminate leading from line
+                                                  spacing
+    charset        FC_CHARSET             CharSet Unicode chars encoded by
+                                                  the font
+    lang           FC_LANG                LangSet Set of RFC-3066-style
+                                                  languages this font supports
+    fontversion    FC_FONTVERSION         Int     Version number of the font
+    capability     FC_CAPABILITY          String  List of layout capabilities in
+                                                  the font
+    embolden       FC_EMBOLDEN            Bool    Rasterizer should
+                                                  synthetically embolden the font
     </programlisting>
   </sect2>
 </sect1>
 <sect1><title>Datatypes</title>
   <para>
-Fontconfig uses abstract datatypes to hide internal implementation details
+Fontconfig uses abstract data types to hide internal implementation details
 for most data structures.  A few structures are exposed where appropriate.
   </para>
   <sect2><title>FcChar8, FcChar16, FcChar32, FcBool</title>
     <para>
-These are primitive datatypes; the FcChar* types hold precisely the number
+These are primitive data types; the FcChar* types hold precisely the number
 of bits stated (if supported by the C implementation).  FcBool holds
-one of two CPP symbols: FcFalse or FcTrue.
+one of two C preprocessor symbols: FcFalse or FcTrue.
     </para>
   </sect2>
   <sect2><title>FcMatrix</title>
@@ -213,7 +218,7 @@ A small set of matrix operations are provided to manipulate these.
   </sect2>
   <sect2><title>FcCharSet</title>
     <para>
-An FcCharSet is an abstract type that holds the set of encoded unicode chars
+An FcCharSet is an abstract type that holds the set of encoded Unicode chars
 in a font.  Operations to build and compare these sets are provided.
     </para>
   </sect2>
@@ -373,7 +378,7 @@ public entry points that need global data can take an optional FcConfig*
 argument; passing 0 uses the default configuration.  FcConfig objects hold two
 sets of fonts, the first contains those specified by the configuration, the
 second set holds those added by the application at run-time.  Interfaces
-that need to reference a particulat set use one of the FcSetName enumerated
+that need to reference a particular set use one of the FcSetName enumerated
 values.
     </para>
   </sect2>
@@ -396,20 +401,29 @@ Used as a return type for functions manipulating FcPattern objects.
         FcResultTypeMismatch    Object exists, but the type doesn't match
         FcResultNoId            Object exists, but has fewer values
                                 than specified
-        FcResultOutOfMemory     Malloc failed
+        FcResultOutOfMemory     malloc failed
     </programlisting>
     </para>
   </sect2>
   <sect2><title>FcAtomic</title>
     <para>
-Used for locking access to config files.  Provides a safe way to update
+Used for locking access to configuration files.  Provides a safe way to update
 configuration files.
     </para>
   </sect2>
+  <sect2><title>FcCache</title>
+    <para>
+Holds information about the fonts contained in a single directory. Normal
+applications need not worry about this as caches for font access are
+automatically managed by the library. Applications dealing with cache
+management may want to use some of these objects in their work, however the
+included 'fc-cache' program generally suffices for all of that.
+    </para>
+  </sect2>
 </sect1>
 <sect1><title>FUNCTIONS</title>
   <para>
-These are grouped by functionality, often using the main datatype being
+These are grouped by functionality, often using the main data type being
 manipulated.
   </para>
   <sect2><title>Initialization</title>
@@ -424,6 +438,7 @@ An FcPattern is an opaque type that holds both patterns to match against the
 available fonts, as well as the information about each font.
     </para>
     &fcpattern;
+    &fcformat;
   </sect2>
   <sect2><title>FcFontSet</title>
     <para>
@@ -435,7 +450,7 @@ results of listing available fonts.
   <sect2><title>FcObjectSet</title>
     <para>
 An FcObjectSet holds a list of pattern property names; it is used to
-indiciate which properties are to be returned in the patterns from
+indicate which properties are to be returned in the patterns from
 FcFontList.
     </para>
     &fcobjectset;
@@ -460,7 +475,7 @@ typechecking, although that depends on careful programming.
   </sect2>
   <sect2><title>FcCharSet</title>
     <para>
-An FcCharSet is a boolean array indicating a set of unicode chars.  Those
+An FcCharSet is a boolean array indicating a set of Unicode chars.  Those
 associated with a font are marked constant and cannot be edited.
 FcCharSets may be reference counted internally to reduce memory consumption;
 this may be visible to applications as the result of FcCharSetCopy may
@@ -468,6 +483,16 @@ return it's argument, and that CharSet may remain unmodifiable.
     </para>
     &fccharset;
   </sect2>
+  <sect2><title>FcLangSet</title>
+    <para>
+An FcLangSet is a set of language names (each of which include language and
+an optional territory). They are used when selecting fonts to indicate which
+languages the fonts need to support. Each font is marked, using language
+orthography information built into fontconfig, with the set of supported
+languages.
+    </para>
+    &fclangset;
+  </sect2>
   <sect2><title>FcMatrix</title>
     <para>
 FcMatrix structures hold an affine transformation in matrix form.
@@ -484,7 +509,7 @@ any function using the data within an FcConfig.
   </sect2>
   <sect2><title>FcObjectType</title>
     <para>
-Provides for applcation-specified font name object types so that new
+Provides for application-specified font name object types so that new
 pattern elements can be generated from font names.
     </para>
     &fcobjecttype;
@@ -507,9 +532,9 @@ accurate CharSet for applications.
   </sect2>
   <sect2><title>FcAtomic</title>
     <para>
-These functions provide a safe way to update config files, allowing ongoing
-reading of the old config file while locked for writing and ensuring that a
-consistent and complete version of the config file is always available.
+These functions provide a safe way to update configuration files, allowing ongoing
+reading of the old configuration file while locked for writing and ensuring that a
+consistent and complete version of the configuration file is always available.
     </para>
     &fcatomic;
   </sect2>
@@ -519,6 +544,15 @@ These routines work with font files and directories, including font
 directory cache files.
     </para>
     &fcfile;
+    &fcdircache;
+  </sect2>
+  <sect2><title>FcCache routines</title>
+    <para>
+These routines work with font directory caches, accessing their contents in
+limited ways. It is not expected that normal applications will need to use
+these functions.
+    </para>
+    &fccache;
   </sect2>
   <sect2><title>FcStrSet and FcStrList</title>
     <para>