summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkira TAGOH <akira@tagoh.org>2021-11-08 20:18:51 +0900
committerAkira TAGOH <tagoh@redhat.com>2021-12-21 19:51:12 +0900
commit9a6b1d6b6d6dd230585ef16e4dd896c15d853cf3 (patch)
treeaaf7f552b9448f551abb5353e51de786f59a3723
parent4238402f1cfee3946a4090cea7ff31d46ceb2c11 (diff)
downloadfontconfig-9a6b1d6b6d6dd230585ef16e4dd896c15d853cf3.tar.gz
Add more description for fc-conflist.1 and FcConfigFileInfoIterInit.3
Fixes https://gitlab.freedesktop.org/fontconfig/fontconfig/-/issues/299
-rw-r--r--doc/fcconfig.fncs3
-rw-r--r--fc-conflist/fc-conflist.sgml10
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index e709b54..c1e2622 100644
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -442,6 +442,9 @@ When setting this on the current config this causes changing current config
@DESC@
Initialize 'iter' with the first iterator in the config file information list.
</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
before using this and then <function>FcConfigDestroy</function> when the relevant
values are no longer referenced.
diff --git a/fc-conflist/fc-conflist.sgml b/fc-conflist/fc-conflist.sgml
index cda7ca2..aacca71 100644
--- a/fc-conflist/fc-conflist.sgml
+++ b/fc-conflist/fc-conflist.sgml
@@ -42,7 +42,7 @@ manpage.1: manpage.sgml
<!ENTITY dhfirstname "<firstname>Akira</firstname>">
<!ENTITY dhsurname "<surname>TAGOH</surname>">
<!-- 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
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
@@ -78,7 +78,7 @@ manpage.1: manpage.sgml
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>Show the ruleset files information on the system</refpurpose>
+ <refpurpose>list the configuration files processed by Fontconfig</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
@@ -94,8 +94,10 @@ manpage.1: manpage.sgml
<refsect1>
<title>DESCRIPTION</title>
- <para><command>&dhpackage;</command> shows the ruleset files' information
- being installed on the system.</para>
+ <para><command>&dhpackage;</command> prints an annotated list of all the configuration files processed by Fontconfig.</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>