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 harfbuzz-download-http
|
---|
8 | "https://github.com/harfbuzz/harfbuzz/releases/download/&harfbuzz-version;/harfbuzz-&harfbuzz-version;.tar.xz">
|
---|
9 | <!ENTITY harfbuzz-download-ftp " ">
|
---|
10 | <!ENTITY harfbuzz-md5sum "295b211a0c6c0e5a07278ceee894ef68">
|
---|
11 | <!ENTITY harfbuzz-size "17 MB">
|
---|
12 | <!ENTITY harfbuzz-buildsize "146 MB (With tests)">
|
---|
13 | <!ENTITY harfbuzz-time "0.7 SBU (With tests; both using parallelism=4)">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="harfbuzz" xreflabel="harfBuzz-&harfbuzz-version;">
|
---|
17 | <?dbhtml filename="harfbuzz.html"?>
|
---|
18 |
|
---|
19 |
|
---|
20 | <title>harfBuzz-&harfbuzz-version;</title>
|
---|
21 |
|
---|
22 | <indexterm zone="harfbuzz">
|
---|
23 | <primary sortas="a-HarfBuzz">HarfBuzz</primary>
|
---|
24 | </indexterm>
|
---|
25 |
|
---|
26 | <sect2 role="package">
|
---|
27 | <title>Introduction to Harfbuzz</title>
|
---|
28 |
|
---|
29 | <para>
|
---|
30 | The <application>HarfBuzz</application> package contains an OpenType text
|
---|
31 | shaping engine.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs122_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&harfbuzz-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&harfbuzz-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &harfbuzz-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &harfbuzz-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &harfbuzz-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &harfbuzz-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">HarfBuzz Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
73 | <para role="recommended">
|
---|
74 | <xref linkend="glib2"/> (required for Pango; GObject Introspection
|
---|
75 | required for building GNOME),
|
---|
76 | <xref role="first" linkend="graphite2"/> (required for building
|
---|
77 | <xref role="nodep" linkend="texlive"/> or
|
---|
78 | <xref role="nodep" linkend="libreoffice"/> with system harfbuzz),
|
---|
79 | <xref linkend="icu"/>, and
|
---|
80 | <xref role="first" linkend="freetype2"/>
|
---|
81 | (after harfbuzz is installed, reinstall freetype)
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
85 | <para role="optional">
|
---|
86 | <xref linkend="cairo"/> (circular: build cairo and all its recommended
|
---|
87 | dependencies, including harfbuzz, first, then rebuild harfbuzz if the
|
---|
88 | cairo backend is needed),
|
---|
89 | <xref linkend="git"/>,
|
---|
90 | <xref linkend="gtk-doc"/>,
|
---|
91 | <ulink url="https://pypi.org/project/FontTools/">FontTools</ulink>
|
---|
92 | (Python 3 module, for the test suite),
|
---|
93 | <ulink url="https://www.colm.net/open-source/ragel/">ragel</ulink>,
|
---|
94 | and <ulink url="https://github.com/bytecodealliance/wasm-micro-runtime">wasm-micro-runtime</ulink>
|
---|
95 | </para>
|
---|
96 |
|
---|
97 | <warning>
|
---|
98 | <para>
|
---|
99 | Recommended dependencies are not strictly required to build
|
---|
100 | the package. However, you might not get expected results at
|
---|
101 | runtime if you don't install them. Please do not report bugs
|
---|
102 | with this package if you <emphasis>have not</emphasis>
|
---|
103 | installed the recommended dependencies.
|
---|
104 | </para>
|
---|
105 | </warning>
|
---|
106 |
|
---|
107 | </sect2>
|
---|
108 |
|
---|
109 | <sect2 role="installation">
|
---|
110 | <title>Installation of HarfBuzz</title>
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | Install <application>HarfBuzz</application> by running the following
|
---|
114 | commands:
|
---|
115 | </para>
|
---|
116 |
|
---|
117 | <screen><userinput>mkdir build &&
|
---|
118 | cd build &&
|
---|
119 |
|
---|
120 | meson setup .. \
|
---|
121 | --prefix=/usr \
|
---|
122 | --buildtype=release \
|
---|
123 | -D graphite2=enabled &&
|
---|
124 | ninja</userinput></screen>
|
---|
125 |
|
---|
126 | <para>
|
---|
127 | To test the results, issue: <command>ninja test</command>.
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | <para>
|
---|
131 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
132 | </para>
|
---|
133 |
|
---|
134 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
135 | </sect2>
|
---|
136 |
|
---|
137 | <sect2 role="commands">
|
---|
138 | <title>Command Explanations</title>
|
---|
139 |
|
---|
140 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
141 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
142 |
|
---|
143 | <para>
|
---|
144 | <parameter>-D graphite2=enabled</parameter>: This switch enables
|
---|
145 | <application>Graphite2</application> support, which is required for
|
---|
146 | building <xref linkend="texlive"/> or <xref linkend="libreoffice"/>
|
---|
147 | with system harfbuzz.
|
---|
148 | </para>
|
---|
149 |
|
---|
150 | <para>
|
---|
151 | <option>-D docs=disabled</option>: If <xref linkend="gtk-doc"/> is
|
---|
152 | installed, the documentation is built and installed. This switch
|
---|
153 | prevents that.
|
---|
154 | </para>
|
---|
155 |
|
---|
156 | </sect2>
|
---|
157 |
|
---|
158 | <sect2 role="content">
|
---|
159 | <title>Contents</title>
|
---|
160 |
|
---|
161 | <segmentedlist>
|
---|
162 | <segtitle>Installed Programs</segtitle>
|
---|
163 | <segtitle>Installed Libraries</segtitle>
|
---|
164 | <segtitle>Installed Directories</segtitle>
|
---|
165 |
|
---|
166 | <seglistitem>
|
---|
167 | <seg>
|
---|
168 | hb-info,
|
---|
169 | hb-ot-shape-closure,
|
---|
170 | hb-shape,
|
---|
171 | hb-subset, and
|
---|
172 | hb-view (only if Cairo is installed)
|
---|
173 | </seg>
|
---|
174 | <seg>
|
---|
175 | libharfbuzz.so,
|
---|
176 | libharfbuzz-cairo.so (only if Cairo is installed),
|
---|
177 | libharfbuzz-gobject.so,
|
---|
178 | libharfbuzz-icu.so, and
|
---|
179 | libharfbuzz-subset.so
|
---|
180 | </seg>
|
---|
181 | <seg>
|
---|
182 | /usr/include/harbuzz,
|
---|
183 | /usr/lib/cmake/harfbuzz, and
|
---|
184 | /usr/share/gtk-doc/html/harfbuzz (optional)
|
---|
185 | </seg>
|
---|
186 | </seglistitem>
|
---|
187 | </segmentedlist>
|
---|
188 |
|
---|
189 | <variablelist>
|
---|
190 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
191 | <?dbfo list-presentation="list"?>
|
---|
192 | <?dbhtml list-presentation="table"?>
|
---|
193 |
|
---|
194 | <varlistentry id="hb-info">
|
---|
195 | <term><command>hb-info</command></term>
|
---|
196 | <listitem>
|
---|
197 | <para>
|
---|
198 | is used for gathering information about fonts installed on the
|
---|
199 | system
|
---|
200 | </para>
|
---|
201 | <indexterm zone="harfbuzz hb-info">
|
---|
202 | <primary sortas="b-hb-info">hb-info</primary>
|
---|
203 | </indexterm>
|
---|
204 | </listitem>
|
---|
205 | </varlistentry>
|
---|
206 |
|
---|
207 | <varlistentry id="hb-ot-shape-closure">
|
---|
208 | <term><command>hb-ot-shape-closure</command></term>
|
---|
209 | <listitem>
|
---|
210 | <para>
|
---|
211 | gives the set of characters contained in a string, represented as
|
---|
212 | single characters and/or single character names. Example:
|
---|
213 | <command>hb-ot-shape-closure
|
---|
214 | /usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."</command>
|
---|
215 | </para>
|
---|
216 | <indexterm zone="harfbuzz hb-ot-shape-closure">
|
---|
217 | <primary sortas="b-hb-ot-shape-closure">hb-ot-shape-closure</primary>
|
---|
218 | </indexterm>
|
---|
219 | </listitem>
|
---|
220 | </varlistentry>
|
---|
221 |
|
---|
222 | <varlistentry id="hb-shape">
|
---|
223 | <term><command>hb-shape</command></term>
|
---|
224 | <listitem>
|
---|
225 | <para>
|
---|
226 | is used for the conversion of text strings into positioned glyphs
|
---|
227 | </para>
|
---|
228 | <indexterm zone="harfbuzz hb-shape">
|
---|
229 | <primary sortas="b-hb-shape">hb-shape</primary>
|
---|
230 | </indexterm>
|
---|
231 | </listitem>
|
---|
232 | </varlistentry>
|
---|
233 |
|
---|
234 | <varlistentry id="hb-subset">
|
---|
235 | <term><command>hb-subset</command></term>
|
---|
236 | <listitem>
|
---|
237 | <para>
|
---|
238 | is used to create subsets of fonts, and display text using them
|
---|
239 | </para>
|
---|
240 | <indexterm zone="harfbuzz hb-subset">
|
---|
241 | <primary sortas="b-hb-subset">hb-subset</primary>
|
---|
242 | </indexterm>
|
---|
243 | </listitem>
|
---|
244 | </varlistentry>
|
---|
245 |
|
---|
246 | <varlistentry id="hb-view">
|
---|
247 | <term><command>hb-view</command></term>
|
---|
248 | <listitem>
|
---|
249 | <para>
|
---|
250 | displays a graphical view of a string shape using a
|
---|
251 | particular font as a set of glyphs. The output format is
|
---|
252 | automatically defined by the file extension, the supported ones
|
---|
253 | being ansi/png/svg/pdf/ps/eps. For example:
|
---|
254 | <command>hb-view --output-file=hello.png
|
---|
255 | /usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."</command>
|
---|
256 | </para>
|
---|
257 | <indexterm zone="harfbuzz hb-view">
|
---|
258 | <primary sortas="b-hb-view">hb-view</primary>
|
---|
259 | </indexterm>
|
---|
260 | </listitem>
|
---|
261 | </varlistentry>
|
---|
262 |
|
---|
263 | <varlistentry id="libharfbuzz">
|
---|
264 | <term><filename class="libraryfile">libharfbuzz.so</filename></term>
|
---|
265 | <listitem>
|
---|
266 | <para>
|
---|
267 | is the HarfBuzz text shaping library
|
---|
268 | </para>
|
---|
269 | <indexterm zone="harfbuzz libharfbuzz">
|
---|
270 | <primary sortas="c-libharfbuzz">libharfbuzz.so</primary>
|
---|
271 | </indexterm>
|
---|
272 | </listitem>
|
---|
273 | </varlistentry>
|
---|
274 |
|
---|
275 | <varlistentry id="libharfbuzz-cairo">
|
---|
276 | <term><filename class="libraryfile">libharfbuzz-cairo.so</filename></term>
|
---|
277 | <listitem>
|
---|
278 | <para>
|
---|
279 | provides Cairo integration for the Harfbuzz text shaping library
|
---|
280 | </para>
|
---|
281 | <indexterm zone="harfbuzz libharfbuzz-cairo">
|
---|
282 | <primary sortas="c-libharfbuzz-cairo">libharfbuzz-cairo</primary>
|
---|
283 | </indexterm>
|
---|
284 | </listitem>
|
---|
285 | </varlistentry>
|
---|
286 |
|
---|
287 | <varlistentry id="libharfbuzz-gobject">
|
---|
288 | <term><filename class="libraryfile">libharfbuzz-gobject.so</filename></term>
|
---|
289 | <listitem>
|
---|
290 | <para>
|
---|
291 | provides GObject integration for the HarfBuzz text shaping library
|
---|
292 | </para>
|
---|
293 | <indexterm zone="harfbuzz libharfbuzz-gobject">
|
---|
294 | <primary sortas="c-libharfbuzz-gobject">libharfbuzz-gobject.so</primary>
|
---|
295 | </indexterm>
|
---|
296 | </listitem>
|
---|
297 | </varlistentry>
|
---|
298 |
|
---|
299 | <varlistentry id="libharfbuzz-icu">
|
---|
300 | <term><filename class="libraryfile">libharfbuzz-icu.so</filename></term>
|
---|
301 | <listitem>
|
---|
302 | <para>
|
---|
303 | provides ICU integration for the HarfBuzz text shaping library
|
---|
304 | </para>
|
---|
305 | <indexterm zone="harfbuzz libharfbuzz-icu">
|
---|
306 | <primary sortas="c-libharfbuzz-icu">libharfbuzz-icu.so</primary>
|
---|
307 | </indexterm>
|
---|
308 | </listitem>
|
---|
309 | </varlistentry>
|
---|
310 |
|
---|
311 | <varlistentry id="libharfbuzz-subset">
|
---|
312 | <term><filename class="libraryfile">libharfbuzz-subset.so</filename></term>
|
---|
313 | <listitem>
|
---|
314 | <para>
|
---|
315 | provides API functions for performing subsetting operations on font
|
---|
316 | files
|
---|
317 | </para>
|
---|
318 | <indexterm zone="harfbuzz libharfbuzz-subset">
|
---|
319 | <primary sortas="c-libharfbuzz-subset">libharfbuzz-subset.so</primary>
|
---|
320 | </indexterm>
|
---|
321 | </listitem>
|
---|
322 | </varlistentry>
|
---|
323 |
|
---|
324 | </variablelist>
|
---|
325 |
|
---|
326 | </sect2>
|
---|
327 |
|
---|
328 | </sect1>
|
---|