source: general/graphlib/fontconfig.xml@ aaf26b3

xry111/for-12.3
Last change on this file since aaf26b3 was aaf26b3, checked in by Xi Ruoyao <xry111@…>, 4 weeks ago

fontconfig: Don't make doc installation over-complex

Even without --disable-docs, make should guarantee not to invoke the
optional dependencies to regenerate the existing docs (otherwise you
have a broken timestamp and we don't support such a breakage).
  • Property mode set to 100644
File size: 12.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY fontconfig-download-http
8 "https://www.freedesktop.org/software/fontconfig/release/fontconfig-&fontconfig-version;.tar.xz">
9 <!ENTITY fontconfig-download-ftp " ">
10 <!ENTITY fontconfig-md5sum "5bb3a2829aecb22ae553c39099bd0d6a">
11 <!ENTITY fontconfig-size "1.4 MB">
12 <!ENTITY fontconfig-buildsize "17 MB (with tests)">
13 <!ENTITY fontconfig-time "0.4 SBU (with tests)">
14]>
15
16<sect1 id="fontconfig" xreflabel="Fontconfig-&fontconfig-version;">
17 <?dbhtml filename="fontconfig.html"?>
18
19
20 <title>Fontconfig-&fontconfig-version;</title>
21
22 <indexterm zone="fontconfig">
23 <primary sortas="a-Fontconfig">Fontconfig</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to Fontconfig</title>
28
29 <para>
30 The <application>Fontconfig</application> package contains
31 a library and support programs used for configuring and
32 customizing font access.
33 </para>
34
35 &lfs122_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&fontconfig-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&fontconfig-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &fontconfig-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &fontconfig-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &fontconfig-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &fontconfig-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70<!--
71 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
72 <itemizedlist spacing="compact">
73 <listitem>
74 <para>
75 Required patch:
76 <ulink url="&patch-root;/fontconfig-&fontconfig-version;-gperf-3.1-1.patch"/>
77 </para>
78 </listitem>
79 </itemizedlist>
80-->
81 <bridgehead renderas="sect3">Fontconfig Dependencies</bridgehead>
82
83 <bridgehead renderas="sect4">Required</bridgehead>
84 <para role="required">
85 <xref linkend="freetype2"/>
86 </para>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="bubblewrap"/> (used by some tests),
91 <xref linkend="curl"/> and <xref linkend="unzip"/>
92 (both used by some tests for downloading and extracting test files),
93 <xref linkend="json-c"/>,
94 </para>
95
96 <bridgehead renderas="sect4">Optional for regenerating the documentation</bridgehead>
97 <para>
98 These dependencies are only used if you've modified some files in
99 the <filename class='directory'>doc</filename> directory in the source
100 code tree:
101 <xref linkend="docbook-utils"/>,
102 <xref linkend="libxml2"/>,
103 <xref linkend="perl-sgmlspm"/>, and
104 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
105 </para>
106
107 &test-use-internet;
108
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of Fontconfig</title>
113
114 <para>
115 Install <application>Fontconfig</application> by running the following
116 commands:
117 </para>
118
119<screen><userinput>./configure --prefix=/usr \
120 --sysconfdir=/etc \
121 --localstatedir=/var \
122 --docdir=/usr/share/doc/fontconfig-&fontconfig-version; &amp;&amp;
123make</userinput></screen>
124
125 <para>
126 To test the results, issue: <command>make check</command>. One test
127 is known to fail if the kernel does not support user namespaces. Some
128 tests will download some font files via Internet.
129 </para>
130
131 <para>
132 Now, as the <systemitem class="username">root</systemitem> user:
133 </para>
134
135<screen role="root"><userinput>make install</userinput></screen>
136
137 </sect2>
138
139 <sect2 role="configuration">
140 <title>Configuring Fontconfig</title>
141
142 <sect3 id="fontconfig-config">
143 <title>Config Files</title>
144
145 <para>
146 <filename>
147 /etc/fonts/*,
148 /etc/fonts/conf.d/* and
149 /usr/share/fontconfig/conf.avail/*
150 </filename>
151 </para>
152
153 <indexterm zone="fontconfig fontconfig-config">
154 <primary sortas="e-etc-fonts">/etc/fonts/*</primary>
155 </indexterm>
156
157 <indexterm zone="fontconfig fontconfig-config">
158 <primary sortas="e-etc-fonts-conf.d">/etc/fonts/conf.d/*</primary>
159 </indexterm>
160
161 <indexterm zone="fontconfig fontconfig-config">
162 <primary sortas="e-usr-share-fontconfig-conf.avail">/usr/share/fontconfig/conf.avail/*</primary>
163 </indexterm>
164
165 </sect3>
166
167 <sect3>
168 <title>Configuration Information</title>
169
170 <para>
171 The main configuration file for <application>Fontconfig</application> is
172 <filename>/etc/fonts/fonts.conf</filename>. Generally you do not want
173 to edit this file. It will also read <filename>/etc/fonts/local.conf</filename>
174 and any files in <filename class="directory">/etc/fonts/conf.d</filename>.
175 To put a new font directory in the configuration, create
176 (or update) the <filename>/etc/fonts/local.conf</filename> file with your
177 local information or add a new file in
178 <filename class="directory">/etc/fonts/conf.d</filename>. The default
179 location of fonts in <application>Fontconfig</application> is:
180 </para>
181
182 <itemizedlist spacing="compact">
183 <listitem>
184 <para>
185 /usr/share/fonts
186 </para>
187 </listitem>
188 <listitem>
189 <para>
190 ~/.local/share/fonts
191 </para>
192 </listitem>
193 <listitem>
194 <para>
195 ~/.fonts <emphasis>(this is now deprecated, but for the moment
196 it still works)</emphasis>
197 </para>
198 </listitem>
199 </itemizedlist>
200
201 <para>
202 <application>Fontconfig</application> also ships many example
203 configuration files in the
204 <filename class="directory">/usr/share/fontconfig/conf.avail</filename>
205 directory. Symlinking specific files to
206 <filename class="directory">/etc/fonts/conf.d</filename>
207 will enable them. The default setup is generally good enough for
208 most users. See <filename>/etc/fonts/conf.d/README</filename>
209 for a description of the configuration files.
210 </para>
211
212 <indexterm zone="fontconfig fontconfig-config">
213 <primary sortas="e-usr-share-fonts">/usr/share/fonts</primary>
214 </indexterm>
215
216 <indexterm zone="fontconfig fontconfig-config">
217 <primary sortas="e-AA.fonts">~/.fonts</primary>
218 </indexterm>
219
220 <para>
221 More information about configuring <application>Fontconfig</application>
222 can be found in the user's manual in <ulink
223 url="file:///usr/share/doc/fontconfig-&fontconfig-version;/fontconfig-user.html"/>.
224 </para>
225
226 </sect3>
227
228 </sect2>
229
230 <sect2 role="content">
231 <title>Contents</title>
232
233 <segmentedlist>
234 <segtitle>Installed Programs</segtitle>
235 <segtitle>Installed Library</segtitle>
236 <segtitle>Installed Directories</segtitle>
237
238 <seglistitem>
239 <seg>
240 fc-cache, fc-cat, fc-conflist, fc-list, fc-match, fc-pattern,
241 fc-query, fc-scan, and fc-validate
242 </seg>
243 <seg>
244 libfontconfig.so
245 </seg>
246 <seg>
247 /etc/fonts,
248 /usr/include/fontconfig,
249 /usr/share/doc/fontconfig-&fontconfig-version;,
250 /usr/share/fontconfig,
251 /usr/share/xml/fontconfig, and
252 /var/cache/fontconfig
253 </seg>
254 </seglistitem>
255 </segmentedlist>
256
257 <variablelist>
258 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
259 <?dbfo list-presentation="list"?>
260 <?dbhtml list-presentation="table"?>
261
262 <varlistentry id="fc-cache">
263 <term><command>fc-cache</command></term>
264 <listitem>
265 <para>
266 is used to create font information caches
267 </para>
268 <indexterm zone="fontconfig fc-cache">
269 <primary sortas="b-fc-cache">fc-cache</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="fc-cat">
275 <term><command>fc-cat</command></term>
276 <listitem>
277 <para>
278 is used to read font information caches
279 </para>
280 <indexterm zone="fontconfig fc-cat">
281 <primary sortas="b-fc-cat">fc-cat</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="fc-conflist">
287 <term><command>fc-conflist</command></term>
288 <listitem>
289 <para>
290 shows the ruleset files' information on the system
291 </para>
292 <indexterm zone="fontconfig fc-conflist">
293 <primary sortas="b-fc-conflist">fc-conflist</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="fc-list">
299 <term><command>fc-list</command></term>
300 <listitem>
301 <para>
302 is used to create font lists
303 </para>
304 <indexterm zone="fontconfig fc-list">
305 <primary sortas="b-fc-list">fc-list</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="fc-match">
311 <term><command>fc-match</command></term>
312 <listitem>
313 <para>
314 is used to match available fonts, or find fonts that match
315 a given pattern
316 </para>
317 <indexterm zone="fontconfig fc-match">
318 <primary sortas="b-fc-match">fc-match</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="fc-pattern">
324 <term><command>fc-pattern</command></term>
325 <listitem>
326 <para>
327 is used to parse pattern (empty pattern by default) and show
328 the parsed result
329 </para>
330 <indexterm zone="fontconfig fc-pattern">
331 <primary sortas="b-fc-pattern">fc-pattern</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="fc-query">
337 <term><command>fc-query</command></term>
338 <listitem>
339 <para>
340 is used to query fonts files and print resulting patterns
341 </para>
342 <indexterm zone="fontconfig fc-query">
343 <primary sortas="b-fc-query">fc-query</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="fc-scan">
349 <term><command>fc-scan</command></term>
350 <listitem>
351 <para>
352 is used to scan font files and directories, and print resulting
353 patterns
354 </para>
355 <indexterm zone="fontconfig fc-scan">
356 <primary sortas="b-fc-scan">fc-scan</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="fc-validate">
362 <term><command>fc-validate</command></term>
363 <listitem>
364 <para>
365 is used to validate font files
366 </para>
367 <indexterm zone="fontconfig fc-validate">
368 <primary sortas="b-fc-validate">fc-validate</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="libfontconfig">
374 <term><filename class="libraryfile">libfontconfig.so</filename></term>
375 <listitem>
376 <para>
377 contains functions used by the <application>Fontconfig</application>
378 programs and also by other programs to configure or customize font
379 access
380 </para>
381 <indexterm zone="fontconfig libfontconfig">
382 <primary sortas="c-libfontconfig">libfontconfig.so</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 </variablelist>
388
389 </sect2>
390
391</sect1>
Note: See TracBrowser for help on using the repository browser.