Add more description for fc-conflist.1 and FcConfigFileInfoIterInit.3

Fixes https://gitlab.freedesktop.org/fontconfig/fontconfig/-/issues/299
This commit is contained in:
Akira TAGOH 2021-11-08 20:18:51 +09:00 committed by Akira TAGOH
parent 4238402f1c
commit 9a6b1d6b6d
2 changed files with 9 additions and 4 deletions

View File

@ -442,6 +442,9 @@ When setting this on the current config this causes changing current config
@DESC@ @DESC@
Initialize 'iter' with the first iterator in the config file information list. Initialize 'iter' with the first iterator in the config file information list.
</para><para> </para><para>
The config file information list is stored in numerical order for filenames
i.e. how fontconfig actually read them.
</para><para>
This function isn't MT-safe. <function>FcConfigReference</function> must be called This function isn't MT-safe. <function>FcConfigReference</function> must be called
before using this and then <function>FcConfigDestroy</function> when the relevant before using this and then <function>FcConfigDestroy</function> when the relevant
values are no longer referenced. values are no longer referenced.

View File

@ -42,7 +42,7 @@ manpage.1: manpage.sgml
<!ENTITY dhfirstname "<firstname>Akira</firstname>"> <!ENTITY dhfirstname "<firstname>Akira</firstname>">
<!ENTITY dhsurname "<surname>TAGOH</surname>"> <!ENTITY dhsurname "<surname>TAGOH</surname>">
<!-- Please adjust the date whenever revising the manpage. --> <!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>Apr 1, 2014</date>"> <!ENTITY dhdate "<date>Dec 21, 2021</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). --> allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>"> <!ENTITY dhsection "<manvolnum>1</manvolnum>">
@ -78,7 +78,7 @@ manpage.1: manpage.sgml
<refnamediv> <refnamediv>
<refname>&dhpackage;</refname> <refname>&dhpackage;</refname>
<refpurpose>Show the ruleset files information on the system</refpurpose> <refpurpose>list the configuration files processed by Fontconfig</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
@ -94,8 +94,10 @@ manpage.1: manpage.sgml
<refsect1> <refsect1>
<title>DESCRIPTION</title> <title>DESCRIPTION</title>
<para><command>&dhpackage;</command> shows the ruleset files' information <para><command>&dhpackage;</command> prints an annotated list of all the configuration files processed by Fontconfig.</para>
being installed on the system.</para> <para>The output is a `-' or `+' depending on whether the file is ignored or processed, a space, the file's path, a colon and space, and the description from the file or `No description' if none is present.</para>
<para>The order of files looks like how fontconfig acautlly process them except one contains &lt;include&gt; element.
In that case, it will be shown after processing all the sub directories where is targeted by &lt;include&gt;.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>