source: general/genlib/libwpe.xml@ 77a4525

<?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 libwpe-download-http "https://wpewebkit.org/releases/libwpe-&libwpe-version;.tar.xz">
  <!ENTITY libwpe-download-ftp  " ">
  <!ENTITY libwpe-md5sum        "d834d70a6b3afb24a05ec188df248e52">
  <!ENTITY libwpe-size          "64 KB">
  <!ENTITY libwpe-buildsize     "2.3 MB">
  <!ENTITY libwpe-time          "less than 0.1 SBU">
]>

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


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

  <indexterm zone="libwpe">
    <primary sortas="a-libwpe">libwpe</primary>
  </indexterm>

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

    <para>
      The <application>libwpe</application> package contains a general purpose
      library for WPE WebKit and the WPE Renderer.
    </para>

    &lfs112_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libxkbcommon"/> and
      <xref linkend="mesa"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://pypi.org/project/hotdoc/">hotdoc</ulink>
      <!-- FIXME - meson_options.txt mentions using hotdoc if you pass a switch
           to generate documentation. -->
    </para>

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

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libwpe-1.0.so
        </seg>
        <seg>
          /usr/include/wpe-1.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libwpe-1.0">
        <term><filename class="libraryfile">libwpe-1.0.so</filename></term>
        <listitem>
          <para>
            contains functions that provide a general purpose library for
            WPEWebKit and the WPE Renderer
          </para>
          <indexterm zone="libwpe libwpe-1.0">
            <primary sortas="c-libwpe-1.0">libwpe-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>