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