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