source: general/graphlib/harfbuzz.xml@ 5c14fb68

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 5c14fb68 was 5c14fb68, checked in by Pierre Labastie <pieere@…>, 10 months ago

Add an option to remove the need for git in harfbuzz

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

  • Property mode set to 100644
File size: 9.5 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 "229 MB (add 6 MB for tests)">
13 <!ENTITY harfbuzz-time "0.3 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 -Dbenchmark=disabled &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 <parameter>-Dbenchmark=disabled</parameter>: This switch disables
159 downloading and building the <application>google-benchmark</application>
160 subproject, which requires <xref linkend="git"/>, and is of no
161 use for non developpers.
162 </para>
163
164 <para>
165 <option>-Ddocs=false</option>: If <xref linkend="gtk-doc"/> is installed,
166 the documentation is built and installed. This switch prevents that.
167 </para>
168
169 </sect2>
170
171 <sect2 role="content">
172 <title>Contents</title>
173
174 <segmentedlist>
175 <segtitle>Installed Programs</segtitle>
176 <segtitle>Installed Libraries</segtitle>
177 <segtitle>Installed Directories</segtitle>
178
179 <seglistitem>
180 <seg>
181 hb-ot-shape-closure, hb-shape, hb-subset, and
182 hb-view (only if cairo is installed)
183 </seg>
184 <seg>
185 libharfbuzz.so, libharfbuzz-gobject.so, libharfbuzz-icu.so, and
186 libharfbuzz-subset.so
187 </seg>
188 <seg>
189 /usr/{include,lib/cmake,share/gtk-doc/html}/harfbuzz
190 </seg>
191 </seglistitem>
192 </segmentedlist>
193
194 <variablelist>
195 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
196 <?dbfo list-presentation="list"?>
197 <?dbhtml list-presentation="table"?>
198
199 <varlistentry id="hb-ot-shape-closure">
200 <term><command>hb-ot-shape-closure</command></term>
201 <listitem>
202 <para>
203 gives the set of characters contained in a string, represented as
204 single characters and/or single character names. Example:
205 <command>hb-ot-shape-closure
206 /usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."</command>.
207 </para>
208 <indexterm zone="harfbuzz hb-ot-shape-closure">
209 <primary sortas="b-hb-ot-shape-closure">hb-ot-shape-closure</primary>
210 </indexterm>
211 </listitem>
212 </varlistentry>
213
214 <varlistentry id="hb-shape">
215 <term><command>hb-shape</command></term>
216 <listitem>
217 <para>
218 is used for the conversion of text strings into positioned glyphs.
219 </para>
220 <indexterm zone="harfbuzz hb-shape">
221 <primary sortas="b-hb-shape">hb-shape</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="hb-subset">
227 <term><command>hb-subset</command></term>
228 <listitem>
229 <para>
230 is used to create subsets of fonts, and display text using them.
231 </para>
232 <indexterm zone="harfbuzz hb-subset">
233 <primary sortas="b-hb-subset">hb-subset</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="hb-view">
239 <term><command>hb-view</command></term>
240 <listitem>
241 <para>
242 displays a graphical view of a string shape using a
243 particular font as a set of glyphs. The output format is
244 automatically defined by the file extension, the supported ones
245 being ansi/png/svg/pdf/ps/eps. For example:
246 <command>hb-view --output-file=hello.png
247 /usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."</command>.
248 </para>
249 <indexterm zone="harfbuzz hb-view">
250 <primary sortas="b-hb-view">hb-view</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="libharfbuzz">
256 <term><filename class="libraryfile">libharfbuzz.so</filename></term>
257 <listitem>
258 <para>
259 is the HarfBuzz text shaping library.
260 </para>
261 <indexterm zone="harfbuzz libharfbuzz">
262 <primary sortas="c-libharfbuzz">libharfbuzz.so</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="libharfbuzz-gobject">
268 <term><filename class="libraryfile">libharfbuzz-gobject.so</filename></term>
269 <listitem>
270 <para>
271 provides GObject integration for the HarfBuzz text shaping library.
272 </para>
273 <indexterm zone="harfbuzz libharfbuzz-gobject">
274 <primary sortas="c-libharfbuzz-gobject">libharfbuzz-gobject.so</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="libharfbuzz-icu">
280 <term><filename class="libraryfile">libharfbuzz-icu.so</filename></term>
281 <listitem>
282 <para>
283 provides ICU integration for the HarfBuzz text shaping library.
284 </para>
285 <indexterm zone="harfbuzz libharfbuzz-icu">
286 <primary sortas="c-libharfbuzz-icu">libharfbuzz-icu.so</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 </variablelist>
292
293 </sect2>
294
295</sect1>
Note: See TracBrowser for help on using the repository browser.