glfs/general/graphlib/harfbuzz.xml
Bruce Dubbs 1f6d0c13e3 Xorg tags and a few others
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23553 af4574ff-66df-0310-9fd7-8a98e5e911e0
2020-08-17 21:48:50 +00:00

282 lines
9.1 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY harfbuzz-download-http
"https://github.com/harfbuzz/harfbuzz/releases/download/&harfbuzz-version;/harfbuzz-&harfbuzz-version;.tar.xz">
<!ENTITY harfbuzz-download-ftp " ">
<!ENTITY harfbuzz-md5sum "ae164a9de4deab6610f6058c8d29426e">
<!ENTITY harfbuzz-size "9.3 MB">
<!ENTITY harfbuzz-buildsize "244 MB (add 31 MB for tests)">
<!ENTITY harfbuzz-time "0.5 SBU (Using parallelism=4; add 0.8 SBU for tests)">
]>
<sect1 id="harfbuzz" xreflabel="HarfBuzz-&harfbuzz-version;">
<?dbhtml filename="harfbuzz.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>HarfBuzz-&harfbuzz-version;</title>
<indexterm zone="harfbuzz">
<primary sortas="a-HarfBuzz">HarfBuzz</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Harfbuzz</title>
<para>
The <application>HarfBuzz</application> package contains an OpenType text
shaping engine.
</para>
&lfs10_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&harfbuzz-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&harfbuzz-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &harfbuzz-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &harfbuzz-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &harfbuzz-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &harfbuzz-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">HarfBuzz Dependencies</bridgehead>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="glib2"/> (required for Pango),
<xref role="first" linkend="graphite2"/> (required for building
<xref role="nodep" linkend="texlive"/> or
<xref role="nodep" linkend="libreoffice"/> with system harfbuzz),
<xref linkend="icu"/>, and
<xref role="first" linkend="freetype2"/>
(after <xref role="nodep" linkend="harfbuzz"/> is installed, reinstall
<xref role="nodep" linkend="freetype2"/>)
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="cairo"/> (circular: build cairo and all its recommended
dependencies, including harfbuzz, first, then rebuild harfbuzz if the
cairo backend is needed),
<xref linkend="gobject-introspection"/>,
<xref linkend="gtk-doc"/>, and
<ulink url="https://pypi.org/project/FontTools/">FontTools</ulink>
(Python 3 module, for the testsuite)
</para>
<warning>
<para>
Recommended dependencies are not strictly required to build
the package. However, you might not get expected results at
runtime if you don't install them. Please do not report bugs
with this package if you <emphasis>have not</emphasis>
installed the recommended dependencies.
</para>
</warning>
<para condition="html" role="usernotes">
User Notes: <ulink url="&blfs-wiki;/harfbuzz"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of HarfBuzz</title>
<para>
Install <application>HarfBuzz</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr --with-gobject --with-graphite2 &amp;&amp;
make</userinput></screen>
<para>
To test the results, issue: <command>make check</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<parameter>--with-gobject</parameter>: This switch enables building
of the <application>HarfBuzz</application> GObject wrapper. Remove
it if you did not install <application>GLib</application>.
</para>
<para>
<parameter>--with-graphite2</parameter>: This switch enables
<application>Graphite2</application> support, which is required for
building <xref linkend="texlive"/> or <xref linkend="libreoffice"/>
with system harfbuzz.
</para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/gtk-doc-rebuild.xml"/>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
hb-ot-shape-closure, hb-shape, hb-subset, and
hb-view (only if cairo is installed)
</seg>
<seg>
libharfbuzz.so, libharfbuzz-gobject.so, libharfbuzz-icu.so, and
libharfbuzz-subset.so
</seg>
<seg>
/usr/{include,lib/cmake,share/gtk-doc/html}/harfbuzz
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="hb-ot-shape-closure">
<term><command>hb-ot-shape-closure</command></term>
<listitem>
<para>
gives the set of characters contained in a string, represented as
single characters and/or single character names. Example:
<command>hb-ot-shape-closure
/usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."</command>.
</para>
<indexterm zone="harfbuzz hb-ot-shape-closure">
<primary sortas="b-hb-ot-shape-closure">hb-ot-shape-closure</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hb-shape">
<term><command>hb-shape</command></term>
<listitem>
<para>
is used for the conversion of text strings into positioned glyphs.
</para>
<indexterm zone="harfbuzz hb-shape">
<primary sortas="b-hb-shape">hb-shape</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hb-subset">
<term><command>hb-subset</command></term>
<listitem>
<para>
is used to create subsets of fonts, and display text using them.
</para>
<indexterm zone="harfbuzz hb-subset">
<primary sortas="b-hb-subset">hb-subset</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hb-view">
<term><command>hb-view</command></term>
<listitem>
<para>
displays a graphical view of a string shape using a
particular font as a set of glyphs. The output format is
automatically defined by the file extension, the supported ones
being ansi/png/svg/pdf/ps/eps. For example:
<command>hb-view --output-file=hello.png
/usr/share/fonts/dejavu/DejaVuSans.ttf "Hello World."</command>.
</para>
<indexterm zone="harfbuzz hb-view">
<primary sortas="b-hb-view">hb-view</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libharfbuzz">
<term><filename class="libraryfile">libharfbuzz.so</filename></term>
<listitem>
<para>
is the HarfBuzz text shaping library.
</para>
<indexterm zone="harfbuzz libharfbuzz">
<primary sortas="c-libharfbuzz">libharfbuzz.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libharfbuzz-gobject">
<term><filename class="libraryfile">libharfbuzz-gobject.so</filename></term>
<listitem>
<para>
provides GObject integration for the HarfBuzz text shaping library.
</para>
<indexterm zone="harfbuzz libharfbuzz-gobject">
<primary sortas="c-libharfbuzz-gobject">libharfbuzz-gobject.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libharfbuzz-icu">
<term><filename class="libraryfile">libharfbuzz-icu.so</filename></term>
<listitem>
<para>
provides ICU integration for the HarfBuzz text shaping library.
</para>
<indexterm zone="harfbuzz libharfbuzz-icu">
<primary sortas="c-libharfbuzz-icu">libharfbuzz-icu.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>