source: general/genlib/gobject-introspection.xml@ eebcdb57

ken/refactor-virt lazarus qt5new trunk upgradedb
Last change on this file since eebcdb57 was eebcdb57, checked in by Bruce Dubbs <bdubbs@…>, 4 months ago

Package updates.
Update to xf86-input-libinput-1.2.0.
Update to asciidoc-9.1.1.
Update to thunar-4.16.10.
Update to vala-0.54.1.
Update to harfbuzz-3.0.0.
Update to libuninameslist-20210917.
Update to gobject-introspection-1.70.0.

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