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