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