source: general/graphlib/graphite2.xml@ 683821c2

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 683821c2 was 683821c2, checked in by Xi Ruoyao <xry111@…>, 16 months ago

update to harfbuzz-2.9.0, tag related font libs

  • Property mode set to 100644
File size: 8.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 graphite2-download-http
8 "https://github.com/silnrsi/graphite/releases/download/&graphite2-version;/graphite2-&graphite2-version;.tgz">
9 <!ENTITY graphite2-download-ftp " ">
10 <!ENTITY graphite2-md5sum "1bccb985a7da01092bfb53bb5041e836">
11 <!ENTITY graphite2-size "6.3 MB">
12 <!ENTITY graphite2-buildsize "28 MB (with tests add docs)">
13 <!ENTITY graphite2-time "0.2 SBU (with tests and docs)">
14]>
15
16<sect1 id="graphite2" xreflabel="Graphite2-&graphite2-version;">
17 <?dbhtml filename="graphite2.html"?>
18
19 <sect1info>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Graphite2-&graphite2-version;</title>
24
25 <indexterm zone="graphite2">
26 <primary sortas="a-Graphite2">Graphite2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Graphite2</title>
31
32 <para>
33 <application>Graphite2</application> is a rendering engine for graphite
34 fonts. These are TrueType fonts with additional tables containing smart
35 rendering information and were originally developed to support complex
36 non-Roman writing systems. They may contain rules for e.g. ligatures,
37 glyph substitution, kerning, justification - this can make them useful
38 even on text written in Roman writing systems such as English. Note that
39 <application>firefox</application> by default provides an internal copy of
40 the graphite engine and cannot use a system version (although it can now
41 be patched to use it), but it too should benefit from the availability of
42 graphite fonts.
43 </para>
44
45 &lfs110a_checked;
46
47 <bridgehead renderas="sect3">Package Information</bridgehead>
48 <itemizedlist spacing="compact">
49 <listitem>
50 <para>
51 Download (HTTP): <ulink url="&graphite2-download-http;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download (FTP): <ulink url="&graphite2-download-ftp;"/>
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download MD5 sum: &graphite2-md5sum;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Download size: &graphite2-size;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated disk space required: &graphite2-buildsize;
72 </para>
73 </listitem>
74 <listitem>
75 <para>
76 Estimated build time: &graphite2-time;
77 </para>
78 </listitem>
79 </itemizedlist>
80
81 <bridgehead renderas="sect3">Graphite2 Dependencies</bridgehead>
82
83 <bridgehead renderas="sect4">Required</bridgehead>
84 <para role="required">
85 <xref linkend="cmake"/>
86 </para>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="freetype2"/>,
91 <ulink url="https://sourceforge.net/projects/silgraphite/files/silgraphite/2.3.1/">silgraphite</ulink>
92 to build the <command>comparerender</command> test and benchmarking tool,
93 and if that is present, and
94 <xref linkend="harfbuzz"/> to add more functionality to it (this is a
95 circular dependency, you would need to first build
96 <application>graphite2</application> without
97 <application>harfbuzz</application>).
98 </para>
99
100 <para role="optional">
101 To build the documentation:
102 <xref linkend="asciidoc"/>,
103 <xref linkend="doxygen"/>,
104 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>), and
105 <ulink url="http://dblatex.sourceforge.net/">
106 dblatex</ulink> (for PDF docs)
107 </para>
108
109 <para role="optional">
110 To execute the test suite you will need
111 <ulink url="https://pypi.python.org/pypi/FontTools">FontTools</ulink>
112 (Python 3 module), otherwise, the "cmp" tests fail.
113 </para>
114
115 <bridgehead renderas="sect4">Optional (at runtime)</bridgehead>
116 <para role="optional">
117 You will need at least one suitable <ulink role="runtime"
118 url="http://scripts.sil.org/cms/scripts/page.php?site_id=projects&amp;item_id=graphite_fonts">graphite font</ulink>
119 for the package to be useful.
120 </para>
121
122 <para condition="html" role="usernotes">
123 User Notes: <ulink url="&blfs-wiki;/graphite2"/>
124 </para>
125 </sect2>
126
127 <sect2 role="installation">
128 <title>Installation of Graphite2</title>
129
130 <para>
131 Some tests fail if
132 <ulink url="https://pypi.python.org/pypi/FontTools">FontTools</ulink>
133 (Python 3 module) is not installed. These tests can be removed with:
134 </para>
135
136<screen><userinput>sed -i '/cmptest/d' tests/CMakeLists.txt</userinput></screen>
137
138 <para>
139 Install <application>Graphite2</application> by running the following
140 commands:
141 </para>
142
143<screen><userinput>mkdir build &amp;&amp;
144cd build &amp;&amp;
145
146cmake -DCMAKE_INSTALL_PREFIX=/usr .. &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 If you wish to build the documentation, issue:
151 </para>
152
153<screen remap="doc"><userinput>make docs</userinput></screen>
154
155 <para>
156 To test the results, issue: <command>make test</command>.
157 </para>
158
159 <para>
160 Now, as the <systemitem class="username">root</systemitem> user:
161 </para>
162
163<screen role="root"><userinput>make install</userinput></screen>
164
165 <para>
166 If you built the documentation, install, as the
167 <systemitem class="username">root</systemitem> user:
168 </para>
169
170<screen role="root"
171 remap="doc"><userinput>install -v -d -m755 /usr/share/doc/graphite2-&graphite2-version; &amp;&amp;
172<!-- doc/doxygen seems to have gone, so I removed the api dir, but now both html
173and pdf for the GTF and the manual
174cp -v -r -f doc/doxygen/{html,latex/refman.pdf} \
175 /usr/share/doc/graphite2-&graphite2-version;/api &amp;&amp;-->
176cp -v -f doc/{GTF,manual}.html \
177 /usr/share/doc/graphite2-&graphite2-version; &amp;&amp;
178cp -v -f doc/{GTF,manual}.pdf \
179 /usr/share/doc/graphite2-&graphite2-version;</userinput></screen>
180
181 </sect2>
182
183 <sect2 role="commands">
184 <title>Command Explanations</title>
185
186 <para>
187 <option>-DCMAKE_VERBOSE_MAKEFILE=ON</option>: This switch turns on
188 build verbose mode.
189 </para>
190
191 </sect2>
192
193 <sect2 role="content">
194 <title>Contents</title>
195
196 <segmentedlist>
197 <segtitle>Installed Programs</segtitle>
198 <segtitle>Installed Libraries</segtitle>
199 <segtitle>Installed Directories</segtitle>
200
201 <seglistitem>
202 <seg>
203 gr2fonttest, and optionally comparerender
204 </seg>
205 <seg>
206 libgraphite2.so
207 </seg>
208 <seg>
209 /usr/{include,share}/graphite2 and optionally
210 /usr/share/doc/graphite2-&graphite2-version;
211 </seg>
212 </seglistitem>
213 </segmentedlist>
214
215 <variablelist>
216 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
217 <?dbfo list-presentation="list"?>
218 <?dbhtml list-presentation="table"?>
219
220 <varlistentry id="comparerender">
221 <term><command>comparerender</command></term>
222 <listitem>
223 <para>
224 is a test and benchmarking tool
225 </para>
226 <indexterm zone="graphite2 comparerender">
227 <primary sortas="b-comparerender">comparerender</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="gr2fonttest">
233 <term><command>gr2fonttest</command></term>
234 <listitem>
235 <para>
236 is a diagnostic console tool for graphite fonts
237 </para>
238 <indexterm zone="graphite2 gr2fonttest">
239 <primary sortas="b-gr2fonttest">gr2fonttest</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="libgraphite2">
245 <term><filename class="libraryfile">libgraphite2.so</filename></term>
246 <listitem>
247 <para>
248 is a rendering engine for graphite fonts
249 </para>
250 <indexterm zone="graphite2 libgraphite2">
251 <primary sortas="c-libgraphite2">libgraphite2.so</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 </variablelist>
257
258 </sect2>
259
260</sect1>
Note: See TracBrowser for help on using the repository browser.