source: general/graphlib/harfbuzz.xml@ 3b7efcd

<?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://www.freedesktop.org/software/harfbuzz/release/harfbuzz-&harfbuzz-version;.tar.bz2">
  <!ENTITY harfbuzz-download-ftp  " ">
  <!ENTITY harfbuzz-md5sum        "f176eeda0a4e51a056d3ea6b9e65c27f">
  <!ENTITY harfbuzz-size          "3.7 MB">
  <!ENTITY harfbuzz-buildsize     "52 MB (add 45 MB for tests)">
  <!ENTITY harfbuzz-time          "0.4 SBU (add 0.5 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>

    &lfs82_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 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"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk-doc"/>,
      <xref role="first" linkend="graphite2"/> (required for building
        <xref role="nodep" linkend="texlive"/> or 
        <xref role="nodep" linkend="libreoffice"/> with system harfbuzz)
      <xref linkend="python2"/> (required for the testsuite), and
      <ulink url="https://pypi.org/project/FontTools/">FontTools</ulink> (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 &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>
      <option>--with-graphite2</option>: This switch enables
      <application>Graphite2</application> support, which is required for
      building <xref linkend="texlive"/> 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, and
          hb-view (only if cairo is installed)
        </seg>
        <seg>
          libharfbuzz.so, libharfbuzz-gobject.so and libharfbuzz-icu.so
        </seg>
        <seg>
          /usr/{include,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-view">
        <term><command>hb-view</command></term>
        <listitem>
          <para>
            may be used for a graphical view of a string shape, using a
            particular font, as a set of glyphs. Output format is automatically
            defined by the file extension, the supported ones being
            ansi/png/svg/pdf/ps/eps. 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>
            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>
            HarfBuzz text shaping library GObject integration.
          </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>
            HarfBuzz text shaping library ICU integration.
          </para>
          <indexterm zone="harfbuzz libharfbuzz-icu">
            <primary sortas="c-libharfbuzz-icu">libharfbuzz-icu.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>