source: general/graphlib/harfbuzz.xml@ ee98f114

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since ee98f114 was ee98f114, checked in by Douglas R. Reno <renodr@…>, 10 months ago

Harfbuzz: Add command explanation for -Dbenchmark=disabled and promote Git to recommended
OpenCV: URL fixes
GTK3: Remove required dependency on Fribidi since it's satisfied by the required dependency in Pango.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24055 af4574ff-66df-0310-9fd7-8a98e5e911e0

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