[dabe4b0] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[a084926] | 7 | <!ENTITY libpeas-download-http "&gnome-download-http;/libpeas/1.32/libpeas-&libpeas-version;.tar.xz">
|
---|
| 8 | <!ENTITY libpeas-download-ftp "&gnome-download-ftp;/libpeas/1.32/libpeas-&libpeas-version;.tar.xz">
|
---|
| 9 | <!ENTITY libpeas-md5sum "ea067e520d1b19606dbe47d20c625b8f">
|
---|
| 10 | <!ENTITY libpeas-size "189 KB">
|
---|
| 11 | <!ENTITY libpeas-buildsize "26 MB (with tests)">
|
---|
[e7a0ebd] | 12 | <!ENTITY libpeas-time "0.2 SBU (with tests)">
|
---|
[dabe4b0] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libpeas" xreflabel="libpeas-&libpeas-version;">
|
---|
| 16 | <?dbhtml filename="libpeas.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>libpeas-&libpeas-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="libpeas">
|
---|
| 25 | <primary sortas="a-libpeas">libpeas</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to libpeas</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | <application>libpeas</application> is a GObject based plugins
|
---|
| 33 | engine, and is targeted at giving every application the chance
|
---|
| 34 | to assume its own extensibility.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[b410868] | 37 | &lfs111_checked;
|
---|
[dabe4b0] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&libpeas-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&libpeas-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &libpeas-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &libpeas-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &libpeas-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &libpeas-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">libpeas Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
| 77 | <xref linkend="gobject-introspection"/> and
|
---|
| 78 | <xref linkend="gtk3"/>
|
---|
| 79 | </para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 82 | <para role="recommended">
|
---|
[bb8b4003] | 83 | <xref linkend="libxml2"/> and
|
---|
[dabe4b0] | 84 | <xref linkend="pygobject3"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
| 89 | <xref linkend="gtk-doc"/>,
|
---|
[5ea0e30] | 90 | <ulink url="http://glade.gnome.org/">Glade</ulink>,
|
---|
[bb8b4003] | 91 | <ulink url="https://pypi.org/project/embed">embed</ulink>,
|
---|
[5ea0e30] | 92 | <ulink url="https://github.com/pavouk/lgi">LGI</ulink> (for LUA bindings,
|
---|
| 93 | built with LUA-5.1), with either
|
---|
| 94 | <ulink url="http://luajit.org/">luajit</ulink> or
|
---|
[c6b192c] | 95 | <ulink url="https://www.lua.org/ftp/lua-5.1.5.tar.gz">LUA-5.1</ulink>
|
---|
[dabe4b0] | 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <para condition="html" role="usernotes">User Notes:
|
---|
| 99 | <ulink url="&blfs-wiki;/libpeas"/>
|
---|
| 100 | </para>
|
---|
| 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="installation">
|
---|
| 104 | <title>Installation of libpeas</title>
|
---|
| 105 |
|
---|
[3b339ddc] | 106 | <!-- Fixed in 1.30.0
|
---|
[b56f4046] | 107 | <para>
|
---|
| 108 | First, adapt the tests to changes in meson-0.55:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <screen><userinput remap="pre">sed -i 's/test_exe,/test_exe, depends: [libintrospection_gir],/' tests/libpeas/meson.build</userinput></screen>
|
---|
[3b339ddc] | 112 | -->
|
---|
[b56f4046] | 113 |
|
---|
[dabe4b0] | 114 | <para>
|
---|
| 115 | Install <application>libpeas</application> by running the following
|
---|
| 116 | commands:
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
[bb8b4003] | 119 | <screen><userinput>mkdir build &&
|
---|
[5d314e0] | 120 | cd build &&
|
---|
| 121 |
|
---|
[b035527] | 122 | meson --prefix=/usr --buildtype=release --wrap-mode=nofallback .. &&
|
---|
[5d314e0] | 123 | ninja</userinput></screen>
|
---|
[dabe4b0] | 124 |
|
---|
| 125 | <para>
|
---|
[5d314e0] | 126 | To test the results, issue: <command>ninja test</command>.
|
---|
[b468e12] | 127 | An active graphical session with bus address is necessary to
|
---|
[8558044] | 128 | run the tests.
|
---|
[dabe4b0] | 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <para>
|
---|
| 132 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
[5d314e0] | 135 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[dabe4b0] | 136 |
|
---|
| 137 | </sect2>
|
---|
| 138 |
|
---|
[2aeddd8] | 139 | <sect2 role="commands">
|
---|
| 140 | <title>Command Explanations</title>
|
---|
| 141 |
|
---|
[adf17153] | 142 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 143 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 144 |
|
---|
[b035527] | 145 | <!-- gi-docgen can get installed without this, if deps exist -->
|
---|
| 146 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 147 | href="../../xincludes/meson-wrap-nofallback.xml"/>
|
---|
| 148 |
|
---|
[5d314e0] | 149 | <para>
|
---|
[8558044] | 150 | <option>-Dvapi=true</option>: Add this switch if you wish to
|
---|
[5d314e0] | 151 | generate vapi (vala) data.
|
---|
| 152 | </para>
|
---|
| 153 |
|
---|
| 154 | <para>
|
---|
[8558044] | 155 | <option>-Ddemos=false</option>: Add this switch if you do not wish to
|
---|
[5d314e0] | 156 | build the demo programs.
|
---|
| 157 | </para>
|
---|
| 158 |
|
---|
| 159 | <para>
|
---|
[a084926] | 160 | <option>-Dgtk_doc=true</option>: Add this switch if you wish to
|
---|
[ae7e4b9] | 161 | build the reference manual.
|
---|
[5d314e0] | 162 | </para>
|
---|
[2aeddd8] | 163 |
|
---|
| 164 | </sect2>
|
---|
| 165 |
|
---|
[dabe4b0] | 166 | <sect2 role="content">
|
---|
| 167 | <title>Contents</title>
|
---|
| 168 |
|
---|
| 169 | <segmentedlist>
|
---|
| 170 | <segtitle>Installed Program</segtitle>
|
---|
| 171 | <segtitle>Installed Libraries</segtitle>
|
---|
| 172 | <segtitle>Installed Directories</segtitle>
|
---|
| 173 |
|
---|
| 174 | <seglistitem>
|
---|
| 175 | <seg>
|
---|
| 176 | peas-demo
|
---|
| 177 | </seg>
|
---|
| 178 | <seg>
|
---|
| 179 | libpeas-1.0.so and libpeas-gtk-1.0.so
|
---|
| 180 | </seg>
|
---|
| 181 | <seg>
|
---|
| 182 | /usr/include/libpeas-1.0,
|
---|
| 183 | /usr/lib/libpeas-1.0,
|
---|
| 184 | /usr/lib/peas-demo and
|
---|
[a084926] | 185 | /usr/share/gtk-doc/html/libpeas (optional)
|
---|
[dabe4b0] | 186 | </seg>
|
---|
| 187 | </seglistitem>
|
---|
| 188 | </segmentedlist>
|
---|
| 189 |
|
---|
| 190 | <variablelist>
|
---|
| 191 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 192 | <?dbfo list-presentation="list"?>
|
---|
| 193 | <?dbhtml list-presentation="table"?>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="peas-demo">
|
---|
| 196 | <term><command>peas-demo</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
[4c24eb0a] | 199 | is the Peas demo program
|
---|
[dabe4b0] | 200 | </para>
|
---|
| 201 | <indexterm zone="libpeas peas-demo">
|
---|
| 202 | <primary sortas="b-peas-demo">peas-demo</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="libpeas-1">
|
---|
| 208 | <term><filename class="libraryfile">libpeas-1.0.so</filename></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
[4c24eb0a] | 211 | contains the <application>libpeas</application> API functions
|
---|
[dabe4b0] | 212 | </para>
|
---|
| 213 | <indexterm zone="libpeas libpeas-1">
|
---|
| 214 | <primary sortas="c-libpeas-1">libpeas-1.0.so</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
| 219 | <varlistentry id="libpeas-gtk-1">
|
---|
| 220 | <term><filename class="libraryfile">libpeas-gtk-1.0.so</filename></term>
|
---|
| 221 | <listitem>
|
---|
| 222 | <para>
|
---|
| 223 | contains the <application>libpeas</application>
|
---|
[4c24eb0a] | 224 | <application>GTK+</application> widgets
|
---|
[dabe4b0] | 225 | </para>
|
---|
| 226 | <indexterm zone="libpeas libpeas-gtk-1">
|
---|
| 227 | <primary sortas="c-libpeas-gtk-1">libpeas-gtk-1.0.so</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | </variablelist>
|
---|
| 233 |
|
---|
| 234 | </sect2>
|
---|
| 235 |
|
---|
| 236 | </sect1>
|
---|