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 |
|
---|
7 | <!ENTITY gobject-introspection-download-http
|
---|
8 | "&gnome-download-http;/gobject-introspection/1.76/gobject-introspection-&gobject-introspection-version;.tar.xz">
|
---|
9 | <!ENTITY gobject-introspection-download-ftp
|
---|
10 | "&gnome-download-ftp;/gobject-introspection/1.76/gobject-introspection-&gobject-introspection-version;.tar.xz">
|
---|
11 | <!ENTITY gobject-introspection-md5sum "5cb554fdd139db79f9b1be13892fddac">
|
---|
12 | <!ENTITY gobject-introspection-size "1.0 MB">
|
---|
13 | <!ENTITY gobject-introspection-buildsize "49 MB (with tests)">
|
---|
14 | <!ENTITY gobject-introspection-time "0.3 SBU (With tests; both using parallelism=4)">
|
---|
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">
|
---|
27 | <title>Introduction to GObject Introspection</title>
|
---|
28 |
|
---|
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>
|
---|
34 |
|
---|
35 | &lfs120_checked;
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
39 | <listitem>
|
---|
40 | <para>
|
---|
41 | Download (HTTP): <ulink url="&gobject-introspection-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&gobject-introspection-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &gobject-introspection-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &gobject-introspection-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &gobject-introspection-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &gobject-introspection-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">GObject Introspection Dependencies</bridgehead>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
74 | <para role="required">
|
---|
75 | <xref linkend="glib2"/>
|
---|
76 | </para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
79 | <para role="optional">
|
---|
80 | <xref linkend="cairo"/> (required for the tests),
|
---|
81 | <xref linkend="gjs"/> (to satisfy one test),
|
---|
82 | <xref linkend="gtk-doc"/>,
|
---|
83 | <xref linkend="Mako"/>, and
|
---|
84 | <xref linkend="markdown"/>
|
---|
85 | <!--<ulink url="https://pypi.org/project/Markdown/">Markdown</ulink> (to satisfy one test)-->
|
---|
86 | <!-- There was talk of this being required in the release notes. Can someone
|
---|
87 | who doesn't have this installed verify?
|
---|
88 | It is only needed for one test. bdubbs March 3, 2019
|
---|
89 | I do not have Markdown and all tests pass for 1.74.0. Sep 2022
|
---|
90 | More investigation notes that Markdown and Mako are needed for gi-doc-tool.
|
---|
91 | January 2023
|
---|
92 | -->
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | </sect2>
|
---|
96 |
|
---|
97 | <sect2 role="installation">
|
---|
98 | <title>Installation of GObject Introspection</title>
|
---|
99 |
|
---|
100 | <para>
|
---|
101 | Install <application>GObject Introspection</application> by running
|
---|
102 | the following commands:
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <screen><userinput>mkdir build &&
|
---|
106 | cd build &&
|
---|
107 |
|
---|
108 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
109 | ninja</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | To test the results, issue: <command>ninja test</command>.
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
120 |
|
---|
121 | </sect2>
|
---|
122 |
|
---|
123 | <sect2 role="commands">
|
---|
124 | <title>Command Explanations</title>
|
---|
125 |
|
---|
126 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
127 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
128 |
|
---|
129 | <para>
|
---|
130 | <option>-Dgtk_doc=true</option>: Build and install
|
---|
131 | the documentation.
|
---|
132 | </para>
|
---|
133 |
|
---|
134 | <para>
|
---|
135 | <option>-Dcairo=enabled</option>: Use cairo for tests.
|
---|
136 | </para>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | <option>-Ddoctool=enabled</option>: Install g-ir-doc-tool
|
---|
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.
|
---|
144 | </para>
|
---|
145 |
|
---|
146 | </sect2>
|
---|
147 |
|
---|
148 | <sect2 role="content">
|
---|
149 | <title>Contents</title>
|
---|
150 |
|
---|
151 | <segmentedlist>
|
---|
152 | <segtitle>Installed Program</segtitle>
|
---|
153 | <segtitle>Installed Libraries</segtitle>
|
---|
154 | <segtitle>Installed Directories</segtitle>
|
---|
155 |
|
---|
156 | <!-- g-ir-doc-tool is installed if Mako and Markdown are present -->
|
---|
157 | <seglistitem>
|
---|
158 | <seg>
|
---|
159 | g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
|
---|
160 | g-ir-generate, g-ir-inspect, and g-ir-scanner
|
---|
161 | </seg>
|
---|
162 | <seg>
|
---|
163 | libgirepository-1.0.so and
|
---|
164 | _giscanner.&python3-lib-suffix;.so
|
---|
165 | </seg>
|
---|
166 | <seg>
|
---|
167 | /usr/include/gobject-introspection-1.0,
|
---|
168 | /usr/lib/girepository-1.0,
|
---|
169 | /usr/lib/gobject-introspection,
|
---|
170 | /usr/share/gir-1.0, and
|
---|
171 | /usr/share/gobject-introspection-1.0
|
---|
172 | </seg>
|
---|
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 |
|
---|
181 | <varlistentry id="g-ir-annotation-tool">
|
---|
182 | <term><command>g-ir-annotation-tool</command></term>
|
---|
183 | <listitem>
|
---|
184 | <para>
|
---|
185 | creates or extracts annotation data from GI typelibs
|
---|
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 |
|
---|
193 | <varlistentry id="g-ir-compiler">
|
---|
194 | <term><command>g-ir-compiler</command></term>
|
---|
195 | <listitem>
|
---|
196 | <para>
|
---|
197 | converts one or more GIR files into one or more typelib
|
---|
198 | </para>
|
---|
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 |
|
---|
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
|
---|
211 | <command>yelp-build</command> from
|
---|
212 | <ulink url="&gnome-download-http;/yelp-tools">yelp-tools</ulink>
|
---|
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 |
|
---|
220 | <varlistentry id="g-ir-inspect">
|
---|
221 | <term><command>g-ir-inspect</command></term>
|
---|
222 | <listitem>
|
---|
223 | <para>
|
---|
224 | is a utility that gives information about a GI typelib
|
---|
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 |
|
---|
232 | <varlistentry id="g-ir-generate">
|
---|
233 | <term><command>g-ir-generate</command></term>
|
---|
234 | <listitem>
|
---|
235 | <para>
|
---|
236 | is a GIR generator that uses the repository API
|
---|
237 | </para>
|
---|
238 | <indexterm zone="gobject-introspection g-ir-generate">
|
---|
239 | <primary sortas="b-g-ir-generate">g-ir-generate</primary>
|
---|
240 | </indexterm>
|
---|
241 | </listitem>
|
---|
242 | </varlistentry>
|
---|
243 |
|
---|
244 | <varlistentry id="g-ir-scanner">
|
---|
245 | <term><command>g-ir-scanner</command></term>
|
---|
246 | <listitem>
|
---|
247 | <para>
|
---|
248 | is a tool which generates GIR XML files by parsing headers and
|
---|
249 | introspecting GObject based libraries
|
---|
250 | </para>
|
---|
251 | <indexterm zone="gobject-introspection g-ir-scanner">
|
---|
252 | <primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
|
---|
253 | </indexterm>
|
---|
254 | </listitem>
|
---|
255 | </varlistentry>
|
---|
256 |
|
---|
257 | <varlistentry id="libgirepository-1.0">
|
---|
258 | <term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
|
---|
259 | <listitem>
|
---|
260 | <para>
|
---|
261 | provides an API to access the typelib metadata
|
---|
262 | </para>
|
---|
263 | <indexterm zone="gobject-introspection libgirepository-1.0">
|
---|
264 | <primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
|
---|
265 | </indexterm>
|
---|
266 | </listitem>
|
---|
267 | </varlistentry>
|
---|
268 |
|
---|
269 | </variablelist>
|
---|
270 |
|
---|
271 | </sect2>
|
---|
272 |
|
---|
273 | </sect1>
|
---|