source: gnome/platform/libpeas.xml@ ff0b3aa8

<?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 libpeas-download-http "&gnome-download-http;/libpeas/1.26/libpeas-&libpeas-version;.tar.xz">
  <!ENTITY libpeas-download-ftp  "&gnome-download-ftp;/libpeas/1.26/libpeas-&libpeas-version;.tar.xz">
  <!ENTITY libpeas-md5sum        "f7723bf8433b7984121157e1e9a629b5">
  <!ENTITY libpeas-size          "188 KB">
  <!ENTITY libpeas-buildsize     "12 MB (with tests)">
  <!ENTITY libpeas-time          "0.2 SBU (with tests)">
]>

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

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

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

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

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

    <para>
      <application>libpeas</application> is a GObject based plugins
      engine, and is targeted at giving every application the chance
      to assume its own extensibility.
    </para>

    &lfs91_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libxml2"/> and
      <xref linkend="pygobject3"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <ulink url="http://glade.gnome.org/">Glade</ulink>,
      <ulink url="https://pypi.org/project/embed">embed</ulink>,
      <ulink url="https://github.com/pavouk/lgi">LGI</ulink> (for LUA bindings,
      built with LUA-5.1), with either
      <ulink url="http://luajit.org/">luajit</ulink> or
      <ulink url="http://www.lua.org/ftp/lua-5.1.5.tar.gz">LUA-5.1</ulink>
    </para>

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

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

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

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

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

    <para>
      To test the results, issue: <command>ninja test</command>.
      An active graphical session with bus address is necessary to
      run the tests. 
    </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>

    <para>
      <option>-Dvapi=true</option>: Add this switch if you wish to 
      generate vapi (vala) data.
    </para>

    <para>
      <option>-Ddemos=false</option>: Add this switch if you do not wish to 
      build the demo programs.
    </para>

    <para>
      <option>-Dgtk-doc=true</option>: Add this switch if wish to 
      build the reference manual.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          peas-demo
        </seg>
        <seg>
          libpeas-1.0.so and libpeas-gtk-1.0.so
        </seg>
        <seg>
          /usr/include/libpeas-1.0,
          /usr/lib/libpeas-1.0,
          /usr/lib/peas-demo and
          /usr/share/gtk-doc/html/libpeas
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="peas-demo">
        <term><command>peas-demo</command></term>
        <listitem>
          <para>
            is the Peas demo program.
          </para>
          <indexterm zone="libpeas peas-demo">
            <primary sortas="b-peas-demo">peas-demo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpeas-1">
        <term><filename class="libraryfile">libpeas-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>libpeas</application> API functions.
          </para>
          <indexterm zone="libpeas libpeas-1">
            <primary sortas="c-libpeas-1">libpeas-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpeas-gtk-1">
        <term><filename class="libraryfile">libpeas-gtk-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>libpeas</application>
            <application>GTK+</application> widgets.
          </para>
          <indexterm zone="libpeas libpeas-gtk-1">
            <primary sortas="c-libpeas-gtk-1">libpeas-gtk-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>