[9d3d8a8] | 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 |
|
---|
[0d7900a] | 7 | <!ENTITY gobject-introspection-download-http
|
---|
[8b9cf4c] | 8 | "&gnome-download-http;/gobject-introspection/1.66/gobject-introspection-&gobject-introspection-version;.tar.xz">
|
---|
[0d7900a] | 9 | <!ENTITY gobject-introspection-download-ftp
|
---|
[8b9cf4c] | 10 | "&gnome-download-ftp;/gobject-introspection/1.66/gobject-introspection-&gobject-introspection-version;.tar.xz">
|
---|
[6d44b69] | 11 | <!ENTITY gobject-introspection-md5sum "f43d661d39ff52d33622cb1854aaaf76">
|
---|
[8b9cf4c] | 12 | <!ENTITY gobject-introspection-size "992 KB">
|
---|
[6d44b69] | 13 | <!ENTITY gobject-introspection-buildsize "55 MB (with tests)">
|
---|
[a8ea305] | 14 | <!ENTITY gobject-introspection-time "0.2 SBU (Using parallelism=4; with tests)">
|
---|
[9d3d8a8] | 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="gobject-introspection" xreflabel="gobject-introspection-&gobject-introspection-version;">
|
---|
| 18 | <?dbhtml filename="gobject-introspection.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
| 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
| 23 | </sect1info>
|
---|
| 24 |
|
---|
| 25 | <title>gobject-introspection-&gobject-introspection-version;</title>
|
---|
| 26 |
|
---|
| 27 | <indexterm zone="gobject-introspection">
|
---|
| 28 | <primary sortas="a-gobject-introspection">gobject-introspection</primary>
|
---|
| 29 | </indexterm>
|
---|
| 30 |
|
---|
| 31 | <sect2 role="package">
|
---|
[7ded7e3] | 32 | <title>Introduction to GObject Introspection</title>
|
---|
[9d3d8a8] | 33 |
|
---|
[7ded7e3] | 34 | <para>
|
---|
| 35 | The <application>GObject Introspection</application> is used
|
---|
| 36 | to describe the program APIs and collect them in a uniform,
|
---|
| 37 | machine readable format.
|
---|
| 38 | </para>
|
---|
[9d3d8a8] | 39 |
|
---|
[87351a9] | 40 | &lfs10_checked;
|
---|
[27e62762] | 41 |
|
---|
[9d3d8a8] | 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
[7ded7e3] | 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&gobject-introspection-download-http;"/>
|
---|
| 47 | </para>
|
---|
[9d3d8a8] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[7ded7e3] | 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&gobject-introspection-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
[9d3d8a8] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[7ded7e3] | 55 | <para>
|
---|
| 56 | Download MD5 sum: &gobject-introspection-md5sum;
|
---|
| 57 | </para>
|
---|
[9d3d8a8] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[7ded7e3] | 60 | <para>
|
---|
| 61 | Download size: &gobject-introspection-size;
|
---|
| 62 | </para>
|
---|
[9d3d8a8] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[7ded7e3] | 65 | <para>
|
---|
| 66 | Estimated disk space required: &gobject-introspection-buildsize;
|
---|
| 67 | </para>
|
---|
[9d3d8a8] | 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
[7ded7e3] | 70 | <para>
|
---|
| 71 | Estimated build time: &gobject-introspection-time;
|
---|
| 72 | </para>
|
---|
[9d3d8a8] | 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[b8a081c] | 77 | <para role="required">
|
---|
[ed9b0761] | 78 | <xref linkend="glib2"/>
|
---|
[b8a081c] | 79 | </para>
|
---|
[9d3d8a8] | 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b6a2a0e] | 82 | <para role="optional">
|
---|
[4dbf88b] | 83 | <xref linkend="cairo"/> (required for the tests),
|
---|
[a8ea305] | 84 | <xref linkend="gjs"/> (to satisfy one test),
|
---|
[ed9b0761] | 85 | <xref linkend="gtk-doc"/>,
|
---|
[a8ea305] | 86 | <xref linkend="Mako"/>, and
|
---|
| 87 | <ulink url="https://pypi.org/project/Markdown/">Markdown</ulink> (to satisfy one test)
|
---|
[c4a9102b] | 88 | <!-- There was talk of this being required in the release notes. Can someone
|
---|
[a8ea305] | 89 | who doesn't have this installed verify?
|
---|
| 90 | It is only needed for one test. bdubbs March 3, 2019
|
---|
| 91 | -->
|
---|
[b6a2a0e] | 92 | </para>
|
---|
[9d3d8a8] | 93 |
|
---|
| 94 | <para condition="html" role="usernotes">User Notes:
|
---|
[7ded7e3] | 95 | <ulink url="&blfs-wiki;/gobject-introspection"/>
|
---|
| 96 | </para>
|
---|
[9d3d8a8] | 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="installation">
|
---|
[7ded7e3] | 100 | <title>Installation of GObject Introspection</title>
|
---|
[9d3d8a8] | 101 |
|
---|
[7ded7e3] | 102 | <para>
|
---|
| 103 | Install <application>GObject Introspection</application> by running
|
---|
| 104 | the following commands:
|
---|
| 105 | </para>
|
---|
[9d3d8a8] | 106 |
|
---|
[a8ea305] | 107 | <screen><userinput>mkdir build &&
|
---|
[4a61228] | 108 | cd build &&
|
---|
[a8ea305] | 109 |
|
---|
| 110 | meson --prefix=/usr .. &&
|
---|
| 111 | ninja</userinput></screen>
|
---|
[9d3d8a8] | 112 |
|
---|
[7ded7e3] | 113 | <para>
|
---|
[a8ea305] | 114 | To test the results, issue: <command>ninja test -k0</command>.
|
---|
[80720f4a] | 115 | One test (test_docwriter) fails if the optional Markdown module is
|
---|
| 116 | not installed.
|
---|
[7ded7e3] | 117 | </para>
|
---|
[9d3d8a8] | 118 |
|
---|
[7ded7e3] | 119 | <para>
|
---|
| 120 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 121 | </para>
|
---|
[9d3d8a8] | 122 |
|
---|
[a8ea305] | 123 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[9d3d8a8] | 124 |
|
---|
| 125 | </sect2>
|
---|
| 126 |
|
---|
| 127 | <sect2 role="commands">
|
---|
| 128 | <title>Command Explanations</title>
|
---|
| 129 |
|
---|
[d56e7df] | 130 | <para>
|
---|
[dcde08a1] | 131 | <option>-Dgtk_doc=true</option>: Build and install
|
---|
[d56e7df] | 132 | the documentation.
|
---|
| 133 | </para>
|
---|
[9d3d8a8] | 134 |
|
---|
[d56e7df] | 135 | <para>
|
---|
[55e121da] | 136 | <option>-Dcairo=enabled</option>: Use cairo for tests.
|
---|
[d56e7df] | 137 | </para>
|
---|
[e977805c] | 138 |
|
---|
[d56e7df] | 139 | <para>
|
---|
[55e121da] | 140 | <option>-Ddoctool=enabled</option>: Install g-ir-doc-tool
|
---|
[d56e7df] | 141 | and run related tests.
|
---|
| 142 | </para>
|
---|
[c34cb2e5] | 143 |
|
---|
[9d3d8a8] | 144 | </sect2>
|
---|
| 145 |
|
---|
| 146 | <sect2 role="content">
|
---|
| 147 | <title>Contents</title>
|
---|
| 148 |
|
---|
| 149 | <segmentedlist>
|
---|
[7ded7e3] | 150 | <segtitle>Installed Program</segtitle>
|
---|
[9d3d8a8] | 151 | <segtitle>Installed Libraries</segtitle>
|
---|
| 152 | <segtitle>Installed Directories</segtitle>
|
---|
| 153 |
|
---|
[4dbf88b] | 154 | <!-- g-ir-doc-tool is installed if mako is presnet -->
|
---|
[9d3d8a8] | 155 | <seglistitem>
|
---|
[e977805c] | 156 | <seg>
|
---|
[4dbf88b] | 157 | g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
|
---|
[8b9cf4c] | 158 | g-ir-generate, g-ir-inspect, and g-ir-scanner
|
---|
[e977805c] | 159 | </seg>
|
---|
| 160 | <seg>
|
---|
[04bf697b] | 161 | libgirepository-1.0.so and
|
---|
[d94bd7f4] | 162 | _giscanner.&python3-lib-suffix;.so
|
---|
[e977805c] | 163 | </seg>
|
---|
[0913f48] | 164 | <seg>
|
---|
| 165 | /usr/include/gobject-introspection-1.0,
|
---|
[d3e019dc] | 166 | /usr/lib/girepository-1.0,
|
---|
| 167 | /usr/lib/gobject-introspection,
|
---|
[d8fe3e58] | 168 | /usr/share/gir-1.0, and
|
---|
| 169 | /usr/share/gobject-introspection-1.0
|
---|
[b6a2a0e] | 170 | </seg>
|
---|
[9d3d8a8] | 171 | </seglistitem>
|
---|
| 172 | </segmentedlist>
|
---|
| 173 |
|
---|
| 174 | <variablelist>
|
---|
| 175 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 176 | <?dbfo list-presentation="list"?>
|
---|
| 177 | <?dbhtml list-presentation="table"?>
|
---|
| 178 |
|
---|
[56c646a5] | 179 | <varlistentry id="g-ir-annotation-tool">
|
---|
| 180 | <term><command>g-ir-annotation-tool</command></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>
|
---|
| 183 | creates or extracts annotation data from GI typelibs.
|
---|
| 184 | </para>
|
---|
| 185 | <indexterm zone="gobject-introspection g-ir-annotation-tool">
|
---|
| 186 | <primary sortas="b-g-ir-annotation-tool">g-ir-annotation-tool</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
[9d3d8a8] | 191 | <varlistentry id="g-ir-compiler">
|
---|
| 192 | <term><command>g-ir-compiler</command></term>
|
---|
| 193 | <listitem>
|
---|
[7ded7e3] | 194 | <para>
|
---|
| 195 | converts one or more GIR files into one or more typelib.
|
---|
| 196 | </para>
|
---|
[9d3d8a8] | 197 | <indexterm zone="gobject-introspection g-ir-compiler">
|
---|
| 198 | <primary sortas="b-g-ir-compiler">g-ir-compiler</primary>
|
---|
| 199 | </indexterm>
|
---|
| 200 | </listitem>
|
---|
| 201 | </varlistentry>
|
---|
| 202 |
|
---|
[7e2908c] | 203 | <varlistentry id="g-ir-doc-tool">
|
---|
| 204 | <term><command>g-ir-doc-tool</command></term>
|
---|
| 205 | <listitem>
|
---|
| 206 | <para>
|
---|
| 207 | generates Mallard files that can be viewed with
|
---|
| 208 | <command>yelp</command> or rendered to HTML with
|
---|
| 209 | <command>yelp-build</command> from <ulink
|
---|
[3bf58b9c] | 210 | url="http://ftp.acc.umu.se/pub/gnome/sources/yelp-tools">yelp-tools</ulink>.
|
---|
[7e2908c] | 211 | </para>
|
---|
| 212 | <indexterm zone="gobject-introspection g-ir-doc-tool">
|
---|
| 213 | <primary sortas="b-g-ir-doc-tool">g-ir-doc-tool</primary>
|
---|
| 214 | </indexterm>
|
---|
| 215 | </listitem>
|
---|
| 216 | </varlistentry>
|
---|
| 217 |
|
---|
[0797528] | 218 | <varlistentry id="g-ir-inspect">
|
---|
| 219 | <term><command>g-ir-inspect</command></term>
|
---|
| 220 | <listitem>
|
---|
| 221 | <para>
|
---|
| 222 | is a utility that gives information about a GI typelib.
|
---|
| 223 | </para>
|
---|
| 224 | <indexterm zone="gobject-introspection g-ir-inspect">
|
---|
| 225 | <primary sortas="b-g-ir-inspect">g-ir-inspect</primary>
|
---|
| 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
[8b9cf4c] | 230 | <varlistentry id="g-ir-generate">
|
---|
| 231 | <term><command>g-ir-generate</command></term>
|
---|
[9d3d8a8] | 232 | <listitem>
|
---|
[7ded7e3] | 233 | <para>
|
---|
[8b9cf4c] | 234 | is a GIR generator that uses the repository API.
|
---|
[7ded7e3] | 235 | </para>
|
---|
[8b9cf4c] | 236 | <indexterm zone="gobject-introspection g-ir-generate">
|
---|
| 237 | <primary sortas="b-g-ir-generate">g-ir-generate</primary>
|
---|
[9d3d8a8] | 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
[8b9cf4c] | 242 | <varlistentry id="g-ir-scanner">
|
---|
| 243 | <term><command>g-ir-scanner</command></term>
|
---|
[9d3d8a8] | 244 | <listitem>
|
---|
[7ded7e3] | 245 | <para>
|
---|
[8b9cf4c] | 246 | is a tool which generates GIR XML files by parsing headers and
|
---|
| 247 | introspecting GObject based libraries.
|
---|
[7ded7e3] | 248 | </para>
|
---|
[8b9cf4c] | 249 | <indexterm zone="gobject-introspection g-ir-scanner">
|
---|
| 250 | <primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
|
---|
[9d3d8a8] | 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
| 254 |
|
---|
| 255 | <varlistentry id="libgirepository-1.0">
|
---|
[d3e019dc] | 256 | <term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
|
---|
[9d3d8a8] | 257 | <listitem>
|
---|
[7ded7e3] | 258 | <para>
|
---|
[0797528] | 259 | provides an API to access the typelib metadata.
|
---|
[7ded7e3] | 260 | </para>
|
---|
[9d3d8a8] | 261 | <indexterm zone="gobject-introspection libgirepository-1.0">
|
---|
[e977805c] | 262 | <primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
|
---|
[9d3d8a8] | 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 |
|
---|
| 267 | </variablelist>
|
---|
| 268 |
|
---|
| 269 | </sect2>
|
---|
| 270 |
|
---|
| 271 | </sect1>
|
---|