@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Set configuration as default
@DESC@
-Sets the current default configuration to 'config'. Implicitly calls
+Sets the current default configuration to <parameter>config</parameter>. Implicitly calls
FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
@@
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Check timestamps on config files
@DESC@
-Checks all of the files related to 'config' and returns whether the
+Checks all of the files related to <parameter>config</parameter> and returns whether the
in-memory version is in sync with the disk version.
@@
@PURPOSE@ Get config directories
@DESC@
Returns the list of font directories specified in the configuration files
-for 'config'. Does not include any subdirectories.
+for <parameter>config</parameter>. Does not include any subdirectories.
@@
@RET@ FcStrList *
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get font directories
@DESC@
-Returns the list of font directories in 'config'. This includes the
+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.
@@
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config files
@DESC@
-Returns the list of known configuration files used to generate 'config'.
+Returns the list of known configuration files used to generate <parameter>config</parameter>.
Note that this will not include any configuration done with FcConfigParse.
@@
@PURPOSE@ Get config font set
@DESC@
Returns one of the two sets of fonts from the configuration as specified
-by 'set'.
+by <parameter>set</parameter>.
@@
@RET@ FcBlanks *
@PURPOSE@ Get config rescan interval
@DESC@
Returns the interval between automatic checks of the configuration (in
-seconds) specified in 'config'. The configuration is checked during
+seconds) specified in <parameter>config</parameter>. The configuration is checked during
a call to FcFontList when this interval has passed since the last check.
@@
@TYPE4@ FcMatchKind @ARG4@ kind
@PURPOSE@ Execute substitutions
@DESC@
-Performs the sequence of pattern modification operations, if 'kind' is
+Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
FcMatchPattern, then those tagged as pattern operations are applied, else
-if 'kind' is FcMatchFont, those tagged as font operations are applied and
+if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
p_pat is used for <test> elements with target=pattern.
@@
@TYPE3@ FcResult * @ARG3@ result
@PURPOSE@ Return best font
@DESC@
-Returns the font in 'config' most close matching 'p'. This function
+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 'p'; otherwise the results will not be correct.
+been called for <parameter>p</parameter>; otherwise the results will not be correct.
@@
@RET@ FcFontSet *
@TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return list of matching fonts
@DESC@
-Returns the list of fonts sorted by closeness to 'p'. If 'trim' is FcTrue,
+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 'csp', if 'csp' is not NULL. This function
+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 'p'; otherwise the results will not be correct.
+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 'p' to
+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.
@TYPE3@ FcPattern * @ARG3@ font
@PURPOSE@ Prepare pattern for loading font file
@DESC@
-Creates a new pattern consisting of elements of 'font' not appearing
-in 'pat', elements of 'pat' not appearing in 'font' and the best matching
-value from 'pat' for elements appearing in both. The result is passed to
-FcConfigSubstitute with 'kind' FcMatchFont and then returned.
+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 *
@TYPE3@ FcObjectSet * @ARG3@ os
@PURPOSE@ List fonts
@DESC@
-Selects fonts matching 'p', creates patterns from those fonts containing
-only the objects in 'os' and returns the set of unique such patterns.
+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 *
This provides applications a way to convert various configuration file
references into filename form.
</para><para>
-A null or empty 'name' indicates that the default configuration file should
+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 '~', it
+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
git.wh0rd.org / fontconfig.git / blobdiff