[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[dabe4b0] | 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">
|
---|
[e1e58be] | 8 | <!ENTITY libpeas-download-ftp " ">
|
---|
[bbdb4bb6] | 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 |
|
---|
[5eaa870e] | 34 | &lfs122_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">
|
---|
[c0bc0a9] | 74 | &gobject-introspection; and
|
---|
[dabe4b0] | 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
|
---|
[535cd3d] | 91 | <xref linkend="luajit"/> 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 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of libpeas</title>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | Install <application>libpeas</application> by running the following
|
---|
| 102 | commands:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
[bb8b4003] | 105 | <screen><userinput>mkdir build &&
|
---|
[5d314e0] | 106 | cd build &&
|
---|
| 107 |
|
---|
[91318eb] | 108 | meson setup --prefix=/usr \
|
---|
| 109 | --buildtype=release \
|
---|
| 110 | --wrap-mode=nofallback \
|
---|
| 111 | .. &&
|
---|
[5d22507] | 112 | ninja</userinput></screen>
|
---|
| 113 |
|
---|
| 114 | <para>
|
---|
| 115 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 116 | the API documentation for this package, issue:
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
| 119 | <screen role='nodump'><userinput>sed "/docs_dir =/s@\$@/ 'libpeas-&libpeas-version;'@" \
|
---|
| 120 | -i ../docs/reference/meson.build &&
|
---|
[6af00bd] | 121 | meson configure -D gtk_doc=true &&
|
---|
[5d314e0] | 122 | ninja</userinput></screen>
|
---|
[dabe4b0] | 123 |
|
---|
| 124 | <para>
|
---|
[5d314e0] | 125 | To test the results, issue: <command>ninja test</command>.
|
---|
[b468e12] | 126 | An active graphical session with bus address is necessary to
|
---|
[8558044] | 127 | run the tests.
|
---|
[dabe4b0] | 128 | </para>
|
---|
| 129 |
|
---|
| 130 | <para>
|
---|
| 131 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
[5d314e0] | 134 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[dabe4b0] | 135 |
|
---|
| 136 | </sect2>
|
---|
| 137 |
|
---|
[2aeddd8] | 138 | <sect2 role="commands">
|
---|
| 139 | <title>Command Explanations</title>
|
---|
| 140 |
|
---|
[adf17153] | 141 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 142 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 143 |
|
---|
[b035527] | 144 | <!-- gi-docgen can get installed without this, if deps exist -->
|
---|
| 145 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 146 | href="../../xincludes/meson-wrap-nofallback.xml"/>
|
---|
| 147 |
|
---|
[5d314e0] | 148 | <para>
|
---|
[6af00bd] | 149 | <option>-D vapi=true</option>: Add this switch if you wish to
|
---|
[5d314e0] | 150 | generate vapi (vala) data.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | <para>
|
---|
[6af00bd] | 154 | <option>-D demos=false</option>: Add this switch if you do not wish to
|
---|
[5d314e0] | 155 | build the demo programs.
|
---|
| 156 | </para>
|
---|
| 157 |
|
---|
[2aeddd8] | 158 | </sect2>
|
---|
| 159 |
|
---|
[dabe4b0] | 160 | <sect2 role="content">
|
---|
| 161 | <title>Contents</title>
|
---|
| 162 |
|
---|
| 163 | <segmentedlist>
|
---|
| 164 | <segtitle>Installed Program</segtitle>
|
---|
| 165 | <segtitle>Installed Libraries</segtitle>
|
---|
| 166 | <segtitle>Installed Directories</segtitle>
|
---|
| 167 |
|
---|
| 168 | <seglistitem>
|
---|
| 169 | <seg>
|
---|
| 170 | peas-demo
|
---|
| 171 | </seg>
|
---|
| 172 | <seg>
|
---|
| 173 | libpeas-1.0.so and libpeas-gtk-1.0.so
|
---|
| 174 | </seg>
|
---|
| 175 | <seg>
|
---|
| 176 | /usr/include/libpeas-1.0,
|
---|
| 177 | /usr/lib/libpeas-1.0,
|
---|
| 178 | /usr/lib/peas-demo and
|
---|
[a084926] | 179 | /usr/share/gtk-doc/html/libpeas (optional)
|
---|
[dabe4b0] | 180 | </seg>
|
---|
| 181 | </seglistitem>
|
---|
| 182 | </segmentedlist>
|
---|
| 183 |
|
---|
| 184 | <variablelist>
|
---|
| 185 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 186 | <?dbfo list-presentation="list"?>
|
---|
| 187 | <?dbhtml list-presentation="table"?>
|
---|
| 188 |
|
---|
| 189 | <varlistentry id="peas-demo">
|
---|
| 190 | <term><command>peas-demo</command></term>
|
---|
| 191 | <listitem>
|
---|
| 192 | <para>
|
---|
[4c24eb0a] | 193 | is the Peas demo program
|
---|
[dabe4b0] | 194 | </para>
|
---|
| 195 | <indexterm zone="libpeas peas-demo">
|
---|
| 196 | <primary sortas="b-peas-demo">peas-demo</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | <varlistentry id="libpeas-1">
|
---|
| 202 | <term><filename class="libraryfile">libpeas-1.0.so</filename></term>
|
---|
| 203 | <listitem>
|
---|
| 204 | <para>
|
---|
[4c24eb0a] | 205 | contains the <application>libpeas</application> API functions
|
---|
[dabe4b0] | 206 | </para>
|
---|
| 207 | <indexterm zone="libpeas libpeas-1">
|
---|
| 208 | <primary sortas="c-libpeas-1">libpeas-1.0.so</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="libpeas-gtk-1">
|
---|
| 214 | <term><filename class="libraryfile">libpeas-gtk-1.0.so</filename></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>
|
---|
| 217 | contains the <application>libpeas</application>
|
---|
[4c24eb0a] | 218 | <application>GTK+</application> widgets
|
---|
[dabe4b0] | 219 | </para>
|
---|
| 220 | <indexterm zone="libpeas libpeas-gtk-1">
|
---|
| 221 | <primary sortas="c-libpeas-gtk-1">libpeas-gtk-1.0.so</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
| 226 | </variablelist>
|
---|
| 227 |
|
---|
| 228 | </sect2>
|
---|
| 229 |
|
---|
| 230 | </sect1>
|
---|