source: general/genlib/libgtkhtml.xml@ bd6f068

<?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 libgtkhtml-download-http "&gnome-download-http;/libgtkhtml/2.11/libgtkhtml-&libgtkhtml-version;.tar.bz2">
  <!ENTITY libgtkhtml-download-ftp  "&gnome-download-ftp;/libgtkhtml/2.11/libgtkhtml-&libgtkhtml-version;.tar.bz2">
  <!ENTITY libgtkhtml-md5sum        "a1d1a197dcff8c4571659deef5495e24">
  <!ENTITY libgtkhtml-size          "597 KB">
  <!ENTITY libgtkhtml-buildsize     "36 MB">
  <!ENTITY libgtkhtml-time          "0.8 SBU">
]>

<sect1 id="libgtkhtml" xreflabel="libgtkhtml-&libgtkhtml-version;">
  <?dbhtml filename="libgtkhtml.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>libgtkhtml-&libgtkhtml-version;</title>

  <indexterm zone="libgtkhtml">
    <primary sortas="a-Libgtkhtml">Libgtkhtml</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libgtkhtml</title>

    <para>The <application>libgtkhtml</application> package contains the
    <filename class="libraryfile">libgtkhtml-2</filename> library. This
    library provides an API for rendering HTML.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&libgtkhtml-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libgtkhtml-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libgtkhtml-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libgtkhtml-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libgtkhtml-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libgtkhtml-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libgtkhtml Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gtk2"/> and
    <xref linkend="libxml2"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gail"/> and
    <xref linkend="gnome-vfs"/> (only used in the test suite)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libgtkhtml"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libgtkhtml</title>

    <para>Install <application>libgtkhtml</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --disable-accessibility &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite. You can run a test
    program which includes many test cases; if desired, issue:
    <command>( cd tests; ./testgtkhtml )</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>--disable-accessibility</parameter>: This forces the
    package to build without linking to the
    <filename class='libraryfile'>libgailutil</filename> accessibility
    library. Remove this switch if you have <application>GAIL</application>
    installed.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libgtkhtml-2.{so,a}</seg>
        <seg>/usr/include/gtkhtml-2.0</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libgtkhtml-2">
        <term><filename class='libraryfile'>libgtkhtml-2.{so,a}</filename></term>
        <listitem>
          <para>provides the functions necessary to render and/or
          edit HTML.</para>
          <indexterm zone="libgtkhtml libgtkhtml-2">
            <primary sortas="c-libgtkhtml-2">libgtkhtml-2.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>