[fontconfig.git] / doc / fcconfig.fncs

/*
 * $Id$
 *
 * 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 Keith Packard not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission.  Keith Packard makes 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,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL KEITH PACKARD 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.
 */
@RET@           FcConfig *
@FUNC@          FcConfigCreate
@TYPE1@		void
@PURPOSE@	Create a configuration
@DESC@
Creates an empty configuration.
@@

@RET@           void
@FUNC@          FcConfigDestroy
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Destroy a configuration
@DESC@
Destroys a configuration and any data associated with it.  Note that calling
this function with the return from FcConfigGetCurrent will place the library
in an indeterminate state.
@@

@RET@           FcBool
@FUNC@          FcConfigSetCurrent
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Set configuration as default
@DESC@
Sets the current default configuration to <parameter>config</parameter>.  Implicitly calls
FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
@@

@RET@           FcConfig *
@FUNC@          FcConfigGetCurrent
@TYPE1@		void
@PURPOSE@	Return current configuration
@DESC@
Returns the current default configuration.
@@

@RET@           FcBool
@FUNC@          FcConfigUptoDate
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Check timestamps on config files
@DESC@
Checks all of the files related to <parameter>config</parameter> and returns
whether any of them has been modified since the configuration was created.
@@

@RET@		FcBool
@FUNC@		FcConfigHome
@TYPE1@		void
@PURPOSE@	return the current home directory.
@DESC@
Return the current user's home directory, if it is available, and if using it
is enabled. See also <function>FcConfigEnableHome</function>).
@@

@RET@		FcBol
@FUNC@		FcConfigEnableHome
@TYPE1@		FcBool%				@ARG1@		enable
@PURPOSE@	controls use of the home directory.
@DESC@
If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
files which are specified relative to the user's home directory (using the ~
notation in the configuration). When <parameter>enable</parameter> is
FcFalse, then all use of the home directory in these contexts will be
disabled. The previous setting of the value is returned.
@@

@RET@           FcBool
@FUNC@          FcConfigBuildFonts
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Build font database
@DESC@
Builds the set of available fonts for the given configuration.  Note that
any changes to the configuration after this call have indeterminate effects.
Returns FcFalse if this operation runs out of memory.
@@

@RET@           FcStrList *
@FUNC@          FcConfigGetConfigDirs
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Get config directories
@DESC@
Returns the list of font directories specified in the configuration files
for <parameter>config</parameter>.  Does not include any subdirectories.
@@

@RET@           FcStrList *
@FUNC@          FcConfigGetFontDirs
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Get font directories
@DESC@
Returns the list of font directories in <parameter>config</parameter>. This includes the
configured font directories along with any directories below those in the
filesystem.
@@

@RET@           FcStrList *
@FUNC@          FcConfigGetConfigFiles
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Get config files
@DESC@
Returns the list of known configuration files used to generate <parameter>config</parameter>.
Note that this will not include any configuration done with FcConfigParse.
@@

@RET@           char *
@FUNC@          FcConfigGetCache
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Get cache filename
@DESC@
Returns the name of the file used to store per-user font information.
@@

@RET@		FcStrList *
@FUNC@		FcConfigGetCacheDirs
@TYPE1@		FcConfig *			@ARG1@		config
@PURPOSE@	return the list of directories searched for cache files
@DESC@
<function>FcConfigGetCacheDirs</function> returns a string list containing
all of the directories that fontconfig will search when attempting to load a
cache file for a font directory.
@@

@RET@           FcFontSet *
@FUNC@          FcConfigGetFonts
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcSetName%                      @ARG2@          set
@PURPOSE@	Get config font set
@DESC@
Returns one of the two sets of fonts from the configuration as specified
by <parameter>set</parameter>.
@@

@RET@           FcBlanks *
@FUNC@          FcConfigGetBlanks
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Get config blanks
@DESC@
Returns the FcBlanks object associated with the given configuration, if no
blanks were present in the configuration, this function will return 0.
@@

@RET@           int
@FUNC@          FcConfigGetRescanInterval
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Get config rescan interval
@DESC@
Returns the interval between automatic checks of the configuration (in
seconds) specified in <parameter>config</parameter>.  The configuration is checked during
a call to FcFontList when this interval has passed since the last check.
@@

@RET@           FcBool
@FUNC@          FcConfigSetRescanInterval
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		int%                       	@ARG2@          rescanInterval
@PURPOSE@	Set config rescan interval
@DESC@
Sets the rescan interval; returns FcFalse if an error occurred.
@@

@RET@           FcBool
@FUNC@          FcConfigAppFontAddFile
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		const char *                    @ARG2@          file
@PURPOSE@	Add font file to font database
@DESC@
Adds an application-specific font to the configuration.
@@

@RET@           FcBool
@FUNC@          FcConfigAppFontAddDir
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		const char *                    @ARG1@          dir
@PURPOSE@	Add fonts from directory to font database
@DESC@
Scans the specified directory for fonts, adding each one found to the
application-specific set of fonts.
@@

@RET@           void
@FUNC@          FcConfigAppFontClear
@TYPE1@         FcConfig *                      @ARG1@          config
@PURPOSE@	Remove all app fonts from font database
@DESC@
Clears the set of application-specific fonts.
@@

@RET@           FcBool
@FUNC@          FcConfigSubstituteWithPat
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcPattern *			@ARG2@		p
@TYPE3@		FcPattern *			@ARG3@		p_pat
@TYPE4@		FcMatchKind%                     @ARG4@          kind
@PURPOSE@	Execute substitutions
@DESC@
Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
FcMatchPattern, then those tagged as pattern operations are applied, else
if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
p_pat is used for &lt;test&gt; elements with target=pattern.
@@

@RET@           FcBool
@FUNC@          FcConfigSubstitute
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcPattern *			@ARG2@		p
@TYPE3@		FcMatchKind%                    @ARG3@          kind
@PURPOSE@	Execute substitutions
@DESC@
Calls FcConfigSubstituteWithPat setting p_pat to NULL.
@@

@RET@           FcPattern *
@FUNC@          FcFontMatch
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcPattern *			@ARG2@		p
@TYPE3@		FcResult *                      @ARG3@          result
@PURPOSE@	Return best font
@DESC@
Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>.  This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for <parameter>p</parameter>; otherwise the results will not be correct.
@@

@RET@           FcFontSet *
@FUNC@          FcFontSort
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcPattern *			@ARG2@		p
@TYPE3@		FcBool%				@ARG3@		trim
@TYPE4@		FcCharSet **			@ARG4@		csp
@TYPE5@		FcResult *                      @ARG5@          result
@PURPOSE@	Return list of matching fonts
@DESC@
Returns the list of fonts sorted by closeness to <parameter>p</parameter>.  If <parameter>trim</parameter> is FcTrue,
elements in the list which don't include Unicode coverage not provided by
earlier elements in the list are elided.  The union of Unicode coverage of
all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL.  This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for <parameter>p</parameter>; otherwise the results will not be correct.
    </para><para>
The returned FcFontSet references FcPattern structures which may be shared
by the return value from multiple FcFontSort calls, applications must not
modify these patterns.  Instead, they should be passed, along with <parameter>p</parameter> to
FcFontRenderPrepare which combines them into a complete pattern.
    </para><para>
The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
@@

@RET@           FcPattern *
@FUNC@          FcFontRenderPrepare
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcPattern *			@ARG2@		pat
@TYPE3@		FcPattern *                     @ARG3@          font
@PURPOSE@	Prepare pattern for loading font file
@DESC@
Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
value from <parameter>pat</parameter> for elements appearing in both.  The result is passed to
FcConfigSubstitute with <parameter>kind</parameter> FcMatchFont and then returned.
@@

@RET@           FcFontSet *
@FUNC@          FcFontList
@TYPE1@         FcConfig *			@ARG1@		config
@TYPE2@		FcPattern *			@ARG2@		p
@TYPE3@		FcObjectSet *                   @ARG3@          os
@PURPOSE@	List fonts
@DESC@
Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
@@

@RET@           char *
@FUNC@          FcConfigFilename
@TYPE1@         const char *                    @ARG1@          name
@PURPOSE@	Find a config file
@DESC@
Given the specified external entity name, return the associated filename.
This provides applications a way to convert various configuration file
references into filename form.
    </para><para>
A null or empty <parameter>name</parameter> indicates that the default configuration file should
be used; which file this references can be overridden with the
FC_CONFIG_FILE environment variable.  Next, if the name starts with <parameter>~</parameter>, it
refers to a file in the current users home directory.  Otherwise if the name
doesn't start with '/', it refers to a file in the default configuration
directory; the built-in default directory can be overridden with the
FC_CONFIG_DIR environment variable.
@@

@RET@		FcBool
@FUNC@		FcConfigParseAndLoad
@TYPE1@		FcConfig *			@ARG1@		config
@TYPE2@		const FcChar8 *			@ARG2@		file
@TYPE3@		FcBool%				@ARG3@		complain
@PURPOSE@	load a configuration file
@DESC@
Walks the configuration in 'file' and constructs the internal representation
in 'config'.  Any include files referenced from within 'file' will be loaded
with FcConfigLoad and also parsed.  If 'complain' is FcFalse, no warning
will be displayed if 'file' does not exist.
@@
Commit	Line	Data
	1	/*
	2	* $Id$
	3	*
	4	* Copyright © 2003 Keith Packard
	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	@RET@ FcConfig *
	25	@FUNC@ FcConfigCreate
	26	@TYPE1@ void
	27	@PURPOSE@ Create a configuration
	28	@DESC@
	29	Creates an empty configuration.
	30	@@
	31
	32	@RET@ void
	33	@FUNC@ FcConfigDestroy
	34	@TYPE1@ FcConfig * @ARG1@ config
	35	@PURPOSE@ Destroy a configuration
	36	@DESC@
	37	Destroys a configuration and any data associated with it. Note that calling
	38	this function with the return from FcConfigGetCurrent will place the library
	39	in an indeterminate state.
	40	@@
	41
	42	@RET@ FcBool
	43	@FUNC@ FcConfigSetCurrent
	44	@TYPE1@ FcConfig * @ARG1@ config
	45	@PURPOSE@ Set configuration as default
	46	@DESC@
	47	Sets the current default configuration to <parameter>config</parameter>. Implicitly calls
	48	FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
	49	@@
	50
	51	@RET@ FcConfig *
	52	@FUNC@ FcConfigGetCurrent
	53	@TYPE1@ void
	54	@PURPOSE@ Return current configuration
	55	@DESC@
	56	Returns the current default configuration.
	57	@@
	58
	59	@RET@ FcBool
	60	@FUNC@ FcConfigUptoDate
	61	@TYPE1@ FcConfig * @ARG1@ config
	62	@PURPOSE@ Check timestamps on config files
	63	@DESC@
	64	Checks all of the files related to <parameter>config</parameter> and returns
	65	whether any of them has been modified since the configuration was created.
	66	@@
	67
	68	@RET@ FcBool
	69	@FUNC@ FcConfigHome
	70	@TYPE1@ void
	71	@PURPOSE@ return the current home directory.
	72	@DESC@
	73	Return the current user's home directory, if it is available, and if using it
	74	is enabled. See also <function>FcConfigEnableHome</function>).
	75	@@
	76
	77	@RET@ FcBol
	78	@FUNC@ FcConfigEnableHome
	79	@TYPE1@ FcBool% @ARG1@ enable
	80	@PURPOSE@ controls use of the home directory.
	81	@DESC@
	82	If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
	83	files which are specified relative to the user's home directory (using the ~
	84	notation in the configuration). When <parameter>enable</parameter> is
	85	FcFalse, then all use of the home directory in these contexts will be
	86	disabled. The previous setting of the value is returned.
	87	@@
	88
	89	@RET@ FcBool
	90	@FUNC@ FcConfigBuildFonts
	91	@TYPE1@ FcConfig * @ARG1@ config
	92	@PURPOSE@ Build font database
	93	@DESC@
	94	Builds the set of available fonts for the given configuration. Note that
	95	any changes to the configuration after this call have indeterminate effects.
	96	Returns FcFalse if this operation runs out of memory.
	97	@@
	98
	99	@RET@ FcStrList *
	100	@FUNC@ FcConfigGetConfigDirs
	101	@TYPE1@ FcConfig * @ARG1@ config
	102	@PURPOSE@ Get config directories
	103	@DESC@
	104	Returns the list of font directories specified in the configuration files
	105	for <parameter>config</parameter>. Does not include any subdirectories.
	106	@@
	107
	108	@RET@ FcStrList *
	109	@FUNC@ FcConfigGetFontDirs
	110	@TYPE1@ FcConfig * @ARG1@ config
	111	@PURPOSE@ Get font directories
	112	@DESC@
	113	Returns the list of font directories in <parameter>config</parameter>. This includes the
	114	configured font directories along with any directories below those in the
	115	filesystem.
	116	@@
	117
	118	@RET@ FcStrList *
	119	@FUNC@ FcConfigGetConfigFiles
	120	@TYPE1@ FcConfig * @ARG1@ config
	121	@PURPOSE@ Get config files
	122	@DESC@
	123	Returns the list of known configuration files used to generate <parameter>config</parameter>.
	124	Note that this will not include any configuration done with FcConfigParse.
	125	@@
	126
	127	@RET@ char *
	128	@FUNC@ FcConfigGetCache
	129	@TYPE1@ FcConfig * @ARG1@ config
	130	@PURPOSE@ Get cache filename
	131	@DESC@
	132	Returns the name of the file used to store per-user font information.
	133	@@
	134
	135	@RET@ FcStrList *
	136	@FUNC@ FcConfigGetCacheDirs
	137	@TYPE1@ FcConfig * @ARG1@ config
	138	@PURPOSE@ return the list of directories searched for cache files
	139	@DESC@
	140	<function>FcConfigGetCacheDirs</function> returns a string list containing
	141	all of the directories that fontconfig will search when attempting to load a
	142	cache file for a font directory.
	143	@@
	144
	145	@RET@ FcFontSet *
	146	@FUNC@ FcConfigGetFonts
	147	@TYPE1@ FcConfig * @ARG1@ config
	148	@TYPE2@ FcSetName% @ARG2@ set
	149	@PURPOSE@ Get config font set
	150	@DESC@
	151	Returns one of the two sets of fonts from the configuration as specified
	152	by <parameter>set</parameter>.
	153	@@
	154
	155	@RET@ FcBlanks *
	156	@FUNC@ FcConfigGetBlanks
	157	@TYPE1@ FcConfig * @ARG1@ config
	158	@PURPOSE@ Get config blanks
	159	@DESC@
	160	Returns the FcBlanks object associated with the given configuration, if no
	161	blanks were present in the configuration, this function will return 0.
	162	@@
	163
	164	@RET@ int
	165	@FUNC@ FcConfigGetRescanInterval
	166	@TYPE1@ FcConfig * @ARG1@ config
	167	@PURPOSE@ Get config rescan interval
	168	@DESC@
	169	Returns the interval between automatic checks of the configuration (in
	170	seconds) specified in <parameter>config</parameter>. The configuration is checked during
	171	a call to FcFontList when this interval has passed since the last check.
	172	@@
	173
	174	@RET@ FcBool
	175	@FUNC@ FcConfigSetRescanInterval
	176	@TYPE1@ FcConfig * @ARG1@ config
	177	@TYPE2@ int% @ARG2@ rescanInterval
	178	@PURPOSE@ Set config rescan interval
	179	@DESC@
	180	Sets the rescan interval; returns FcFalse if an error occurred.
	181	@@
	182
	183	@RET@ FcBool
	184	@FUNC@ FcConfigAppFontAddFile
	185	@TYPE1@ FcConfig * @ARG1@ config
	186	@TYPE2@ const char * @ARG2@ file
	187	@PURPOSE@ Add font file to font database
	188	@DESC@
	189	Adds an application-specific font to the configuration.
	190	@@
	191
	192	@RET@ FcBool
	193	@FUNC@ FcConfigAppFontAddDir
	194	@TYPE1@ FcConfig * @ARG1@ config
	195	@TYPE2@ const char * @ARG1@ dir
	196	@PURPOSE@ Add fonts from directory to font database
	197	@DESC@
	198	Scans the specified directory for fonts, adding each one found to the
	199	application-specific set of fonts.
	200	@@
	201
	202	@RET@ void
	203	@FUNC@ FcConfigAppFontClear
	204	@TYPE1@ FcConfig * @ARG1@ config
	205	@PURPOSE@ Remove all app fonts from font database
	206	@DESC@
	207	Clears the set of application-specific fonts.
	208	@@
	209
	210	@RET@ FcBool
	211	@FUNC@ FcConfigSubstituteWithPat
	212	@TYPE1@ FcConfig * @ARG1@ config
	213	@TYPE2@ FcPattern * @ARG2@ p
	214	@TYPE3@ FcPattern * @ARG3@ p_pat
	215	@TYPE4@ FcMatchKind% @ARG4@ kind
	216	@PURPOSE@ Execute substitutions
	217	@DESC@
	218	Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
	219	FcMatchPattern, then those tagged as pattern operations are applied, else
	220	if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
	221	p_pat is used for <test> elements with target=pattern.
	222	@@
	223
	224	@RET@ FcBool
	225	@FUNC@ FcConfigSubstitute
	226	@TYPE1@ FcConfig * @ARG1@ config
	227	@TYPE2@ FcPattern * @ARG2@ p
	228	@TYPE3@ FcMatchKind% @ARG3@ kind
	229	@PURPOSE@ Execute substitutions
	230	@DESC@
	231	Calls FcConfigSubstituteWithPat setting p_pat to NULL.
	232	@@
	233
	234	@RET@ FcPattern *
	235	@FUNC@ FcFontMatch
	236	@TYPE1@ FcConfig * @ARG1@ config
	237	@TYPE2@ FcPattern * @ARG2@ p
	238	@TYPE3@ FcResult * @ARG3@ result
	239	@PURPOSE@ Return best font
	240	@DESC@
	241	Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>. This function
	242	should be called only after FcConfigSubstitute and FcDefaultSubstitute have
	243	been called for <parameter>p</parameter>; otherwise the results will not be correct.
	244	@@
	245
	246	@RET@ FcFontSet *
	247	@FUNC@ FcFontSort
	248	@TYPE1@ FcConfig * @ARG1@ config
	249	@TYPE2@ FcPattern * @ARG2@ p
	250	@TYPE3@ FcBool% @ARG3@ trim
	251	@TYPE4@ FcCharSet ** @ARG4@ csp
	252	@TYPE5@ FcResult * @ARG5@ result
	253	@PURPOSE@ Return list of matching fonts
	254	@DESC@
	255	Returns the list of fonts sorted by closeness to <parameter>p</parameter>. If <parameter>trim</parameter> is FcTrue,
	256	elements in the list which don't include Unicode coverage not provided by
	257	earlier elements in the list are elided. The union of Unicode coverage of
	258	all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL. This function
	259	should be called only after FcConfigSubstitute and FcDefaultSubstitute have
	260	been called for <parameter>p</parameter>; otherwise the results will not be correct.
	261	</para><para>
	262	The returned FcFontSet references FcPattern structures which may be shared
	263	by the return value from multiple FcFontSort calls, applications must not
	264	modify these patterns. Instead, they should be passed, along with <parameter>p</parameter> to
	265	FcFontRenderPrepare which combines them into a complete pattern.
	266	</para><para>
	267	The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
	268	@@
	269
	270	@RET@ FcPattern *
	271	@FUNC@ FcFontRenderPrepare
	272	@TYPE1@ FcConfig * @ARG1@ config
	273	@TYPE2@ FcPattern * @ARG2@ pat
	274	@TYPE3@ FcPattern * @ARG3@ font
	275	@PURPOSE@ Prepare pattern for loading font file
	276	@DESC@
	277	Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
	278	in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
	279	value from <parameter>pat</parameter> for elements appearing in both. The result is passed to
	280	FcConfigSubstitute with <parameter>kind</parameter> FcMatchFont and then returned.
	281	@@
	282
	283	@RET@ FcFontSet *
	284	@FUNC@ FcFontList
	285	@TYPE1@ FcConfig * @ARG1@ config
	286	@TYPE2@ FcPattern * @ARG2@ p
	287	@TYPE3@ FcObjectSet * @ARG3@ os
	288	@PURPOSE@ List fonts
	289	@DESC@
	290	Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
	291	only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
	292	@@
	293
	294	@RET@ char *
	295	@FUNC@ FcConfigFilename
	296	@TYPE1@ const char * @ARG1@ name
	297	@PURPOSE@ Find a config file
	298	@DESC@
	299	Given the specified external entity name, return the associated filename.
	300	This provides applications a way to convert various configuration file
	301	references into filename form.
	302	</para><para>
	303	A null or empty <parameter>name</parameter> indicates that the default configuration file should
	304	be used; which file this references can be overridden with the
	305	FC_CONFIG_FILE environment variable. Next, if the name starts with <parameter>~</parameter>, it
	306	refers to a file in the current users home directory. Otherwise if the name
	307	doesn't start with '/', it refers to a file in the default configuration
	308	directory; the built-in default directory can be overridden with the
	309	FC_CONFIG_DIR environment variable.
	310	@@
	311
	312	@RET@ FcBool
	313	@FUNC@ FcConfigParseAndLoad
	314	@TYPE1@ FcConfig * @ARG1@ config
	315	@TYPE2@ const FcChar8 * @ARG2@ file
	316	@TYPE3@ FcBool% @ARG3@ complain
	317	@PURPOSE@ load a configuration file
	318	@DESC@
	319	Walks the configuration in 'file' and constructs the internal representation
	320	in 'config'. Any include files referenced from within 'file' will be loaded
	321	with FcConfigLoad and also parsed. If 'complain' is FcFalse, no warning
	322	will be displayed if 'file' does not exist.
	323	@@