source: gnome/core/libpeas.xml@ 976fd75e

<?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.2/libpeas-&libpeas-version;.tar.xz">
  <!ENTITY libpeas-download-ftp  "&gnome-download-ftp;/libpeas/1.2/libpeas-&libpeas-version;.tar.xz">
  <!ENTITY libpeas-md5sum        "ed23e817108920dd6d3ef8fe487ba520">
  <!ENTITY libpeas-size          "486 KB">
  <!ENTITY libpeas-buildsize     "16 MB">
  <!ENTITY libpeas-time          "0.4 SBU">
]>

<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 targetted at giving every application the chance to assume its own
    extensibility.</para>

    &lfs70_built;

    <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="pygobject2"/> and
    <!-- FIXME:ken
    <xref linkend="seed"/></para>-->
    seed-3.2.0</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>./configure --prefix=$GNOME_PREFIX &amp;&amp;
make</userinput></screen>

    <!-- in accordance with custom and practice, lying again: it has a testsuite
    but it seems to pass on some machines and not on others (see e.g. debian who
    had it commented out - even for 1.2.0 - at one time.  for me (ken) it reports
    an assertion failure and then fails with Error 143 -->
    <para>This package does not have a testsuite.</para>

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

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>peas-demo and pythonhello.py</seg>
        <seg>libcloader.so, libgjsloader.so, libhelloworld.so, libpeas-1.0.so, libpeas-gtk-1.0.so, libpythonloader.so, libsecondtime.so, libseedloader.so, and libvalahello.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/libpeas-1.0/libpeas-gtk,lib/{libpeas-1.0/loaders,peas-demo/plugins/{gjshello,helloworld,pythonhello,secondtime,seedhello,valahello}},share/{gtk-doc/html/libpeas,icons/hicolor/{16x16/actions,22x22/actions,32x32/actions,scalable/actions}}}</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>does this .....</para>
          <indexterm zone="libpeas peas-demo">
            <primary sortas="b-peas-demo">peas-demo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pythonhello.py">
        <term><command>pythonhello.py</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="libpeas pythonhello.py">
            <primary sortas="b-pythonhello.py">pythonhello.py</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcloader">
        <term><filename class='libraryfile'>libcloader.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libcloader">
            <primary sortas="c-libcloader">libcloader.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgjsloader">
        <term><filename class='libraryfile'>libgjsloader.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libgjsloader">
            <primary sortas="c-libgjsloader">libgjsloader.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libhelloworld">
        <term><filename class='libraryfile'>libhelloworld.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libhelloworld">
            <primary sortas="c-libhelloworld">libhelloworld.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpeas-1">
        <term><filename class='libraryfile'>libpeas-1.0.so</filename></term>
        <listitem>
          <para>contains functions that .....</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 functions that .....</para>
          <indexterm zone="libpeas libpeas-gtk-1">
            <primary sortas="c-libpeas-gtk-1">libpeas-gtk-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpythonloader">
        <term><filename class='libraryfile'>libpythonloader.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libpythonloader">
            <primary sortas="c-libpythonloader">libpythonloader.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsecondtime">
        <term><filename class='libraryfile'>libsecondtime.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libsecondtime">
            <primary sortas="c-libsecondtime">libsecondtime.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libseedloader">
        <term><filename class='libraryfile'>libseedloader.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libseedloader">
            <primary sortas="c-libseedloader">libseedloader.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libvalahello">
        <term><filename class='libraryfile'>libvalahello.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="libpeas libvalahello">
            <primary sortas="c-libvalahello">libvalahello.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>