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