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

10.0 10.1 11.0 11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since d94bd7f4 was d94bd7f4, checked in by Xi Ruoyao <xry111@…>, 2 years ago

add python3-lib-suffix, and use it instead of hardcoding cpython-38 everywhere

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22845 af4574ff-66df-0310-9fd7-8a98e5e911e0

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